YKBLDRMT (registers command devices for all routes)

This command registers the command devices in all routes that originate from the specified DAD, regardless of the route label, based on the route list definition file specified in the input parameter.

Request body format

{ "action":"submit",
   "cliname":"YKBLDRMT",
   "CLIPARMS":[
     ["PREFIX△1prefix"]
     [,"DAD△1DADID"]
     [,"ROUTEID△1route-list-ID"]
   ]
}

Parameters specified in the request body

PREFIX prefix ~ <PREFIX string of 16 or fewer characters>

This is a common parameter included in the default parameter dataset. For details, see Creating a default parameter dataset.

DAD DADID ~ <DAD string>

This is a common parameter included in the default parameter dataset. For details, see Creating a default parameter dataset.

ROUTEID route-list-ID ~ <ROUTE string of 8 or fewer characters>

This is a common parameter included in the default parameter dataset. For this command, specify the route list ID of the route list definition file to which command devices are to be registered.

Notes

• To execute this command, you must have permission to execute the YKBLDCMD command.

• This command does nothing for command devices that are already registered. However, when you enter this command, you must confirm that none of the applicable command devices are performing storage system control.

• Before executing this command, establish a path (inter-control unit logical path or inter-disk controller logical path) between storage systems.

• Before executing this command, take the applicable command devices offline.

• When multiple routes are being generated, if an error occurs for some of the routes, this command continues processing for the other routes.

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 when the YKBLDRMT command ends.

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