YKQHPATH (gets the I/O path status of a volume)

Business Continuity Manager Web API Reference Guide

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

This command checks the connection status of the I/O path between the host and storage system. It sets in the return code the connection status of the I/O path for a specified volume.

Request body format

{ "action":"submit",
   "cliname":"YKQHPATH",
   "operands":"
     DEVN(device-number)
   "
}

Parameters specified in the request body

DEVN(device-number) ~ <4 hexadecimal characters>

Specify the device number of the volume for which the I/O path connection status is to be acquired.

Notes

If multiple subchannel sets are used, the active subchannel set ID of the volumes with the specified device number must be 0. If the ID is not 0, the YKQHPATH command terminates abnormally with the return code 8.

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

Table. YKQHPATH 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

I/O path of the specified device is available.

4

Acquisition of I/O path status failed because the version of the user SVC routine was too old.

8

  • There was no available I/O path for the specified device.

  • The active subchannel set ID of the volumes with the specified device number is not 0.

16

The specified device was not found, or the specified device was not DASD, or an ALIAS volume of PAV was specified.

44

The command terminated due to a processing error.

48

Termination due to invalid parameters.

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.