Running Business Continuity Manager CLI commands by using the BCM Web API

Request line

For the request body, specify the name of the CLI command and the parameters you want to run, and then run the Business Continuity Manager CLI command.

Note:

You cannot run multiple CLI commands at the same time in the same session (for the same servletKey key value). A new request cannot be accepted until the current request is complete.

If you run a CLI command that takes a long time and a timeout is returned, you will need to issue a receive request. If the sessions are different, the same user can issue the requests.

PUT https://IP-address-of-the-z/OSMF-server/zosmf/tsoApp/app/servletKey/YKAPI

Item	Description
`servletKey`	Specify the value of the `servletKey` key that was returned in the response body when the TSO/E address space was started.

Request body

{
["action":"submit",]
,"cliname":"cliname"
[,"CLIPARMS":["parameter records", ...]]
[,"offset":output start device,pair,or group's offset]
[,"limit":number of devices,pairs,or groups to output]
[,"fields":"category list to output"]
[,"operands":"CLI command parameter string"]
}

Key	Format	Description
action	string	Specify `submit`. If you omit this value, `submit` is assumed.
cliname	string	Specify the name of the CLI command to run by using the BCM Web API. For details on the CLI commands that can be run by using the BCM Web API, see CLI commands supported by the BCM Web API.
CLIPARMS ^#	string array	Specify, in JSON format, the array of records to be input for the following CLI commands. (If you specify this key for some other CLI commands, the key will be ignored.) `YKBLDRMT` `YKBTSCAN` `YKDEFGRP` `YKDEFRMT` `YKDELCNF` `YKDELRMT` `YKDSPRMT` In the array, specify the character strings of the records of the input parameter dataset for the CLI command. Specify character strings consisting of 1 to 80 characters. The square brackets [ ] of ["`parameter records`", ...] indicate the array specification in JSON format.
offset	number	Specify as a positive integer the first sequence number (in order of CU:CCA) of the devices output by `YKGETHDA` or the first sequence number (in order of the index) of the groups and copy pairs output by `YKGETGRP`. If you specify this key for a request other than `YKGETHDA` or `YKGETGRP`, the key will be ignored. For details, see the description of the `YKGETHDA` or `YKGETGRP` request.
limit	number	Specify as a positive integer the number of devices output by `YKGETHDA` or the number of groups and pairs output by `YKGETGRP`. If you specify this key for a request other than `YKGETHDA` or `YKGETGRP`, the key will be ignored. For details, see the description of the `YKGETHDA` or `YKGETGRP` request.
fields	string	From the following values, select and specify the category of the copy group information to be output when `YKGETRGP` is run. (You can specify multiple categories.) `SUMMARY`, `OPTION`, `EXCTG`, `GROUP`, `PAIR` If you specify this key for a request other than `YKGETRGP`, the key will be ignored. For details, see the description of the `YKGETGRP` request.
operands ^#	string	Specify the parameters of the CLI command specified for the `cliname` key.

Note 1: Key names are case sensitive.

Note 2: Key values are not case sensitive except for CLIPARMS.

#: If the key value contains double quotation marks, backslashes, or forward slashes, precede these characters with a backslash. You cannot write control codes or multi-byte codes.

Response body

If the CLI command finishes within the time limit or if an error occurs after the request is received but before the response is sent:

The appData key is output.

{"servletKey":"servletKey",
 "ver":"structure-version",
 "appData":{
   "bcmVer":"BCM-version",
   "vendor":"Hitachi Vantara, Ltd.",
   "rc":0,
   "bcmMsg":[message-output-by-the-BCM-Web-API-server]
   "action":"submit",
   "cliname":"CLI-command-name",
   "operands":"parameter-string-for-the-CLI-command"
   CLI-specific-response-data
  },
 "reused":false, "timeout":false
}

If an error occurs after a request is received but before a response is sent, see message-output-by-the-BCM-Web-API-server and resolve the error.

If the CLI command does not finish within the time limit or if another CLI command is running:

true is output for the timeout key value.

{"servletKey":"servletKey",
 "ver":"structure-version",
 "reused":false, "timeout":true
}

You cannot get the CLI execution results in this case, so get them by using the method described in Getting the results if the CLI command does not finish within the time limit or another CLI command is running.

If an error occurs at a timing other than after a request is received but before the response is sent (for example, during response reception, response sending, or initialization processing):

The tsoData key is output.

{"servletKey":"servletKey",
 "ver":"structure-version",
 "tsoData": [
   {"TSO MESSAGE":
     {"VERSION":"JSON-version",
      "DATA":"msgText"}
   }...],
 "reused":false, "timeout":false
}

See the TSO/E message (msgText) and resolve the error.

If an error occurs before the request is received (if the servletKey key specified in the request is invalid, the session times out, or there is a mistake in the header or URI of the request):

The msgData key is output.

{"servletKey":"servletKey",
 "ver":"structure-version",
 "msgData":[
   {"messageText":"z/OSMF-message",
    "messageId":"z/OSMF-message-ID"}
   ...],
 "reused":false, "timeout":false
}

See the z/OSMF message and resolve the error.

For details on the response body, see Responses of BCM Web API requests that run CLI commands.