YKBLDPTH (establishes logical paths)

Business Continuity Manager Web API Reference Guide
Version
9.9.1
Audience
anonymous
Part Number
MK-96HC137-03

Applies to PTH.

The command establishes some or all logical paths in the path set specified by the PATH parameter.

Request body format

{ "action":"submit",
   "cliname":"YKBLDPTH",
   "operands" : "
     [PATH(path-set-ID)]
     [△1PSN(storage-system-serial-number)[△1PCU(cu-number)]]
     [△1SSN(storage-system-serial-number)[△1SCU(cu-number)]]
     [△1PTID(path-group-ID)]
     [△1{FORWARD|REVERSE}]
     [△1TYPE({CU|DKC})]
}

Parameters specified in the request body

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

Specify the ID of the target path sets that are loaded. If only one path set is loaded, you can omit this parameter.

Notes

  • Before you execute this command, create and load the path set definition file.

  • If a message that contains sense information for the storage system is output, see the list of error codes in the Hitachi Storage Management Software for Mainframe Messages and then eliminate the cause of the error. Alternatively, in the Edit Logical Path Definition panel, specify a different, valid volume on which a device scan has been performed, in control unit, SSID, and CCA in the path set definition file for the command execution target.

  • If all of the volumes in the control unit are Non Gen'ed volumes, load the route list before executing the command.

  • If the storage system is directly connected to the host, the volume determined by the following conditions is used as the I/O destination volume regardless of the specification of the YKLOAD command's VIACDEV parameter.

    • If the route list has been loaded and the command device has been defined for the target storage system, the command device is used.

    • If the route list has not been loaded, or if the route list has been loaded but the command device has not been defined for the target storage system, the volume specified in the path set definition file is used.

    • If the route list has not been loaded, or if the route list has been loaded but the command device has not been defined for the target storage system, and no volume is specified in the path set definition file, the volume specified in the disk configuration definition file is used.

Responses

See Responses returned by YKBLDPTH or YKDELPTH.

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 YKBLDPTH command.

Table. YKBLDPTH command return code list

Return code

Meaning

-3

The module cannot be loaded. Possible causes are as follows:

  • The library dataset has not been linked.

  • The module is protected by the RACF program control function.

-1

An interruption occurred during execution.

0

The command completed normally.

32

  • I/O error(s) were encountered. None or only some of the logical paths were established.

  • A change to an I/O configuration definition was detected.

36

  • Processing was interrupted because a REXX variable with an invalid value was encountered. No logical paths were established.

  • No path to be established was found.

40

An error occurred while a REXX variable was being read or written.

44

Command execution terminated abnormally due to insufficient capacity or some other internal cause. None or only some of the logical paths were established.

48

Command execution terminated because of an invalid parameter. No logical paths were established.

128

The command terminated abnormally. Alternatively, the user does not have permission to execute this command.

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