Skip to Content

Customizing a GME connection for other REST API service providers (for advanced users)


Error
Warning

We recommend that only advanced users, with knowledge about Unix and are familiar with the REST API, attempt to establish a connection between BMC Impact Integration for z/OS (BiiZ) and other REST API service providers.

You can customize a GME connection to send information from BMC AMI Ops Automation Rules and EXECs to other REST API web service providers. The event key names and key value will be sent in json format. 

Related topic

Integrating-BiiZ-with-REST-API

Prerequisites 

You must have the following items before you can integrate with any REST API server: 

  • A working curl  program, for example the freeware cURL for z/OS from Rocket Software 
  • A user ID and password or other appropriate credentials 
  • In the BBPARM member BBISSPxx for the PAS, you must specify the following product code: 
    • PRODUCT=AAO
Warning

Important

This functionality is not available in Biiz standalone.

Configuring BiiZ: create a GME connection to a REST service provider

Edit BBPARM member AAOGME00 and specify values for the following parameters: 

Parameter

Description

TGTIP 

Specify the connection name  

TGTBIMCF 

Specify a new UBBPARM member IIMRSTxx, which is the configuration member for this REST API service provider. 

In the IIMRSTxx member, specify values for the FORMAT= <new_IIMFRMxx> and the DICTIONARY=<new_IIMDICxx_members> parameters.

TGTTYPE 

Specify the value: RESTAPI

Edit BBPARM member IIMRSTxx and specify values for the following parameters:  

Parameter

Description

Server_event_path

(Optional)

Specify the URL to the web service.

For example: /events-service/api/v1.0/events 

API_Key

(Optional)

Specify the API key used to post the event.

For example: f8fcfdc0-9248-478a-b5f3-e69a3803f8c7

Server_event_port       

(Optional)

Specify the remote port number.

The default value is 443.

Server_event_url

(Required)

Specify the server URM including the HTTP/HTTPS part.

For example:

https://restapi.bmc.com/ , http://web-service-product.mycompany.com 

Curl_path


(Required)

Specify the full path name, including the curl command to be used to send the events.

For example: /usr/bin/curl

Curl_parms

(Optional)

Specify the curl parameters.

Default value: --insecure --connect-timeout 10 --use-ascii

Dictionary

(Required)

Specify the dictionary file name.

BBPARM member IIMDIC00 is a sample format file and contains more information you should review. 

Copy member IIMDIC00 from BBPARM to UBBPARM and specify a new xx suffix.

Enter the value: DD:BBIPARM(IIMDICxx)

Use the dictionary file to manage the following information: 

  • Specify the key names you want to send, and rename these key names to match the key names on the remote system. 
  • Specify the USS environment variables that can be used in IIMFRMxx. 

To override these variables in a BMC AMI OpsA Rule or EXEC, you can specify IIMDIC_<variableName> in one of the event or ALERT slots.

For example:
IIMDIC_USERNAME=user1           

Format

(Required)

Specify the format file that controls the format used to obtain the token (if needed), and the format of the POST request that to sends the event or ALERT.

BBPARM member IIMFRM00 is a sample format file and contains more information you should review. 

Copy member IIMFRM00 from BBPARM to UBBPARM and specify a new xx suffix.

Enter the value: DD:BBIPARM(IIMFRMxx)

 

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

BMC AMI Ops Automation 8.4