This command outputs the content of the specified disk configuration definition file in units of CCA.
Request body format
{"action":"submit", "cliname":"YKGETHDA", ["offset":sequence-number-of-first-device-to-be-output,] ["limit":number-of-devices-to-be-output,] "operands":SN(serial-number-of-storage-system) [△1CU(CU-number)] [△1PREFIX(prefix)] [△1DAD(DADID)] " }
Parameters specified in the request body
sequence-number-of-first-device-to-be-output ~ <numeric characters><<0>>
Specify the sequence number of the first device to be output. Sequence numbers are numbers assigned in ascending order of the CU and CCA to the scanned devices in the storage system. If you omit this parameter, output is from the first device.
number-of-devices-to-be-output ~ <numeric characters>
Specify the number of devices to be output. If you omit this parameter, the maximum number of devices that can be stored in the response buffer specified for the default parameter RESPBUFSIZE is assumed.
SN(serial-number-of-storage-system) ~ <5 alphanumeric characters>
Specify the serial number of the storage system of the disk configuration definition file.
Specify the CU number. If you omit this parameter, all CUs will be output.
Specify the prefix of the disk configuration definition file. If you omit this parameter, the value of the default parameter dataset is assumed.
Specify the device address domain ID (host device address domain ID) of the disk configuration definition file. If you omit this parameter, the value of the default parameter dataset is assumed.
The maximum number of characters that can be specified is the smaller of "44 - (13 + prefix length)" and "28".
Responses
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 YKGETHDA command.
Return code |
Meaning |
---|---|
0 |
The command completed normally. |
4 |
Unknown XML attribute(s) or element(s) encountered in input file. |
36 |
Termination due to invalid XML structure encountered in input file, or system symbols are not defined correctly. Termination due to an error during license processing. |
40 |
An error occurred when a file was being read. |
44 |
Termination due to invalid processing. |
48 |
Termination due to invalid parameters. |
52 |
Termination due to improper invocation method. |
For details about return codes set by the BCM Web API server, see Return codes set by the BCM Web API server.