YKBLDCMD (registers a command device)

Applies to CMD.

The command registers, into the storage system, the command device that was specified in the route list that was loaded before this command was executed.

Request body format

{"action":"submit",
   "cliname":"YKBLDCMD",
   "operands" : "
     {SN(storage-system-serial-number)
     |SN(storage-system-serial-number)△₁CU(CU-number)△₁CCA(CCA-number)
      △₁APID(APID)
     |DEVN(device-number)△₁APID(APID)}
   "
}

Parameters specified in the request body

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

When you register the command devices for a storage system in the route list, specify the storage system serial number.

When you specify and register a command device in the route list, specify the serial number of the storage system, CU number, CCA number, and APID for the command device.

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

CU(CU-number) ~ <two-digit hexadecimal number>: Specify the CU number.

CCA(CCA-number) ~ <two-digit hexadecimal number>: Specify the CCA number.

APID(APID) ~ <four-digit hexadecimal number>: Specify the APID.

When you specify and register a command device, specify the device number and the APID of the command device.

Only when you specify this parameter you do not have to load the route list. The DEVN parameter cannot be specified for remotely connected storage systems.

DEVN(device-number) ~ <4- or 5-digit hexadecimal number>((00000-3FFFF))

Specify the device number.

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.

APID(APID) ~ <4-digit hexadecimal number>: Specify the APID.

Notes

Execute the YKBLDCMD command only once after turning on the storage system. Even if this command is entered multiple times, only the first time is effective, and entry after the first time does not take effect. However, before this command is entered, make sure that storage system control with the corresponding command device did not take place.
For the YKBLDCMD command, you need to input the storage system for the Primary site and Secondary site, according to the site order defined in the route list. Enter for the Primary site first, and then for the Secondary site.
If multiple command devices have been defined for a storage system, when you register the command devices for the storage system, processing continues even if an error occurs for one or more of the command devices.
Do not delete paths (inter-control unit logical paths or inter-disk controller logical paths) among storage systems when a command device is registered.
The corresponding command device should be offline before the YKBLDCMD command is executed.

Responses

See Responses common to all CLI commands.

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

Table. YKBLDCMD 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. A change to an I/O configuration definition was detected.
`40`	An error occurred while a REXX variable was being written.
`44`	Termination due to processing errors.
`48`	Termination due to invalid parameters.
`128`	The command terminated abnormally. Alternatively, the user does not have permission to execute this command.