YKGETPTH (gets path set definitions)

Business Continuity Manager Web API Reference Guide

Version
9.9.1
Audience
anonymous
Part Number
MK-96HC137-03

The command outputs the content of the specified path set definition file. Unlike the YKQRYPTH command, you can obtain the path set definitions without issuing I/O to obtain the path status.

Request body format

{"action":"submit",
   "cliname":"YKGETPTH",
   "operands":"[PATH(path-set-ID)]"
}

Parameters specified in the request body

PATH(path-set-ID) ~ <dataset prefix of 40 or fewer characters>

Specify the path set ID of the path set definition file. If the path set definition file is not loaded, an error occurs. If only one path set definition file is loaded, you can omit this parameter.

Return code

If the CLI command has finished running, the return code of the CLI command is set in the rc key of the response. If an error occurs before the CLI command is run, the BCM Web API server sets the return code.

The following table lists and describes the return codes of the YKGETPTH command.

Table. YKGETPTH command return code list

Return code

Meaning

0

The command completed normally.

36

The request could not run because one of the following was met:

  • The path set definition file is not loaded.
  • A configuration file having another prefix is already loaded.

48

A parameter specified for the Operands key has an error. Alternatively, a required parameter is missing.

In addition to those listed in the preceding table, return codes of the YKLOAD command might be output.

For details about return codes set by the BCM Web API server, see Return codes set by the BCM Web API server.