Installing and configuring the Common REST API

Common REST API (CRA) version 2.1 is installed through the Installation System with or without BMC AMI Ops Infrastructure version 7.1. Make sure that you have installed the latest ISU refresh.

Important

By default, the Installation System version 4.02 and later supports 64-bit Java Virtual Machine (JVM) for Common REST API.

Consider the following scenarios:

  • If you installed BMC AMI Ops Infrastructure version 7.1, you can start using the CRA right away. For more information, see Common-REST-API-data-endpoints.
  • If you did not install BMC AMI Ops Infrastructure version 7.1, you can install CRA as a stand-alone application or you can install CRA on an existing IBM WebSphere Liberty server.

Related topics

Managing-Common-REST-API-session-tokens-and-user-tokens

Managing-file-spaces-in-USS-logs

To install and configure CRA

Important

CRA installed on a single LPAR can connect to multiple Host Servers in the Sysplex.

  1. Start the Installation System as instructed inStarting an installation.

  2. Select CRA.
    1. On the Execute Project panel, from the list of installation actions, select Select Products, Solutions, or Infrastructure and press Enter.
    2. In the Cmd field of the Category Selection panel, enter the S (select) line command next to System Management category, and press Enter.
    3. Select any BMC AMI Ops product that uses CRA or select Common RESTful API. 

  3. Generate the installation jobs as instructed inGenerating installation jobs. 

    Important

    The remaining steps documented in this topic apply only when configuring CRA to work as a stand-alone server.

    To configure CRA on the IBM WebSphere Liberty server, follow the steps in Setting-up-CRA-to-work-with-the-IBM-WebSphere-Liberty-server.

  4. Generate the configuration jobs for the infrastructure components as instructed inConfiguring Common REST API options.

  5. Run the generated jobs as instructed inRunning the generated jobs.
    Make sure that you complete all the generated jobs for CRA. The full list of generated jobs is in your JCL library. The $545COPY job is the last job that you need to run. 

  6. To complete the configuration of the CRAserver, from UBMCSAMP, copy PROC that you have specified on theCommon Rest API Options panel(default CRATCSRV) from the JCL data set to your started task proclib.
    The CRAserver starts with the proclib.

  7. Start and stop CRAas explained in To start and stop the CRA server.

Complete the following tasks to customize the CRA application after installation:

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*