YKQRYDEV (gets volume information)

Applies to ShadowImage, TrueCopy, TrueCopy with the HyperSwap attribute, Universal Replicator, and CMD.

Storage system information about the specified volume is obtained from the storage system. For a copy pair, you can specify this for either the P-VOL or the S-VOL.

If the specified volume is not found or storage system information cannot be obtained due to an I/O error, an error messages is created and a non-zero return code is returned.

Request body format

{ "action":"submit",
   "cliname":"YKQRYDEV",
   "operands":"
     { SN(storage-system-serial-number)△1CU(cu-number)△1CCA(cca-number)
     | DEVN(device-number)  }
      [△1PATH[△1SSN(serial-number)△1SMODEL({VSP|VSPG1000|VSPG1500|VSPF1500|VSP5100|VSP5200|VSP5500|VSP5600|VSP5100H|VSP5200H|VSP5500H|VSP5600H})]]
   "
}

Parameters specified in the request body

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

Specify the serial number of the storage system to which the volume obtaining storage system information belongs.

When this parameter is specified, the route list must be loaded before the command is executed.

Specify the control unit number of the volume for obtaining storage system information.

When this parameter is specified, the route list needs to be loaded before the command is executed.

Specify the command control address number of the volume for obtaining storage system information.

When this parameter is specified, the route list needs to be loaded before the command is executed.

Specify the device number of the volume for obtaining storage system information.

When multiple subchannel sets are used, specify this parameter as a 5-digit number by adding the 1-digit subchannel set ID before the device number. If the subchannel set ID is omitted, 0 is assumed.

This parameter can only be specified for locally connected devices. It cannot be specified for Non Gen'ed volumes.

PATH

Specify this parameter if you want to obtain information on inter-control unit or inter-disk controller logical paths. If this parameter is specified, the command obtains information on the inter-disk controller logical paths that are established from storage systems to which the volume specified by the DEVN parameter or the SN, CU, and CCA parameters belongs. Additionally, the command also obtains information on inter-control unit logical paths established from control units to which this volume belongs.

To obtain information on an inter-disk controller logical path, specify the serial number of the secondary storage system for the inter-disk controller logical path you want to obtain. You can obtain information on inter-disk controller logical paths with a primary storage system to which the volume specified by the DEVN parameter or the SN, CU, and CCA parameters belongs, and with a secondary storage system is one that has the serial number specified by the SSN parameter. If this parameter is omitted, even if the PATH parameter is specified, the command will only acquire inter-control unit logical path information (without acquiring inter-disk controller logical path information).

To obtain information on an inter-disk controller logical path, specify the model of the secondary storage system for the inter-disk controller logical path you want to obtain. If this parameter is omitted, VSP is assumed.

Responses

See Responses returned by YKQRYDEV.

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

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