YKQRYPTH (gets the statuses of physical paths)

Business Continuity Manager Web API Reference Guide

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

Applies to PTH.

This command acquires the status of all physical paths allocated to some or all logical paths in the path set specified by the PATH parameter.

Request body format

{ "action":"submit",
   "cliname":"YKQRYPTH",
   "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.

PSN(storage-system-serial-number) ~ <from 5 to 12 alphanumeric characters>

If this parameter is specified, for each logical path within the path set specified for the PATH parameter, inter-control unit logical paths will be acquired in all cases where the paths treat control units within storage systems (that have the serial number specified by this parameter) as main control units, and inter-disk controller logical paths will be acquired in all cases where the paths treat the storage system (that has the serial number specified by this parameter) as the primary storage system.

If neither this parameter nor any other parameters are specified, the command obtains the status of all logical paths.

If this parameter is specified, out of the logical paths within the path set specified for the PATH parameter, inter-control unit logical paths will be acquired in all cases where the control unit number of the main control unit matches the value specified for this parameter. Inter-disk controller logical paths are not affected by this parameter.

If neither this parameter nor any other parameters are specified, the command acquires all inter-control unit logical paths.

If this parameter is specified, out of the logical paths within the path set specified for the PATH parameter, inter-control unit logical paths will be acquired in all cases where the paths treat control units within storage systems (that have the serial number specified by this parameter) as remote control units, and inter-disk controller logical paths will be acquired in all cases where the paths treat the storage system (that has the serial number specified by this parameter) as the secondary storage system.

If neither this parameter nor any other parameters are specified, the command acquires all logical paths.

If this parameter is specified, out of the logical paths within the path set specified for the PATH parameter, inter-control unit logical paths will be acquired in all cases where the control unit number of the remote control unit matches the value specified for this parameter. Inter-disk controller logical paths are not affected by this parameter.

If neither this parameter nor any other parameters are specified, the command acquires all inter-control unit logical paths.

If this parameter is specified, for each logical path within the path set specified for the PATH parameter, inter-disk controller logical paths that have the path group ID specified for this parameter are acquired. Inter-control unit logical paths are not affected by this parameter.

If neither this parameter nor any other parameters are specified, the command acquires all the logical paths.

Specify the direction of the logical path whose status you want to acquire.

If neither is specified, the command will acquire the status of a bidirectional logical path.

FORWARD

The command acquires the status of forward logical paths that are identified in the path set specified by the PATH parameter, each of which extends from the initiator node defined in the primary storage system to the target node defined in the secondary storage system.

REVERSE

The command acquires the status of reverse logical paths that are identified in the path set specified by the PATH parameter, each of which extends from the initiator node defined in the secondary storage system to the target node defined in the primary storage system.

TYPE({CU|DKC})

This parameter specifies the type (inter-control unit logical path or inter-disk controller logical path) of the logical path for which the status is to be acquired.

If neither this parameter nor any other parameters are specified, the command acquires the status for all logical paths.

CU

Of the logical paths in the path set specified by the PATH parameter, the status of inter-control unit logical paths is acquired.

DKC

Of the logical paths in the path set specified by the PATH parameter, the status of inter-disk controller logical paths is acquired.

Notes

  • Before executing the 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 to 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 the storage system is directly connected to the host, the volume determined based on 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.

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

Table. YKQRYPTH 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. All paths are established.

4

Successful completion. A logical path exists for which not all of the corresponding physical paths are established.

8

  • The port information stored in the REXX variable of the detected logical path does not match the port information that is set on the storage system.

  • The port information recorded in the REXX variable was updated.

12

The command terminated normally, but detected a logical path whose corresponding physical paths include a path with abnormal status.

32

  • One or more I/O error was encountered. None or only some of the logical paths was acquired.

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

36

No target path 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 acquired.

48

Command execution terminated because of an invalid parameter. Acquisition of the status of all logical paths was not successful.

56

Command execution terminated because a dynamic change in an I/O configuration definition was detected.

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.