YKDEFRMT (defines a route list)

This command generates route list definition files and command device definition files according to the input parameters.

Request body format

{ "action":"submit",
   "cliname":"YKDEFRMT",
   "CLIPARMS":[
     "ROUTE△1APID(APID)[△1LABEL(route-label)]"
     ,"CDEV△1DAD(DADID)△1DEVN(device-number)△1SN(serial-number-of-the-storage-system)△1SSID(SSID)△1CU(CU-number)△1CCA(CCA-number) "
     [,"CDEV△1DAD(DADID) [△1DUMMY(dummy-device-number)]△1SN(serial-number-of-the-storage-system)△1SSID(SSID)△1CU(CU-number)△1CCA(CCA-number) "]
     [,"CDEV△1DAD(DADID) [△1DUMMY(dummy-device-number)]△1SN(serial-number-of-the-storage-system)△1SSID(SSID)△1CU(CU-number)△1CCA(CCA-number) "]

     [,"ROUTE△1APID(APID)[△1LABEL(route-label)]"
     [,"CDEV△1DAD(DADID)△1DEVN(device-number)△1SN(serial-number-of-the-storage-system)△1SSID(SSID)△1CU(CU-number)△1CCA(CCA-number) "]
     [,"CDEV△1DAD(DADID) [△1DUMMY(dummy-device-number)]△1SN(serial-number-of-the-storage-system)△1SSID(SSID)△1CU(CU-number)△1CCA(CCA-number) "]
     [,"CDEV△1DAD(DADID) [△1DUMMY(dummy-device-number)]△1SN(serial-number-of-the-storage-system)△1SSID(SSID)△1CU(CU-number)△1CCA(CCA-number) "]]...

     [,"PREFIX△1prefix"]
     [,"ROUTEID△1route-list-ID"]
     [,"STORCLAS△1storage-class-name"]
     [,"VOLUME△1volume-serial-number"]
     [,"UNIT△1device-type"]
     [,"CFGUPDTE△1{INPLACE|REALLOC}"]
   ]
}

Parameters specified in the request body

ROUTE

Specify the APID of the command device line and the route label.

APID(APID) ~ <four-digit hexadecimal number>

Specify the APID.

LABEL(route-label) ~ <ROUTELABEL string of 8 or fewer characters>

Specify the route label.

CDEV

Specify volume information about the command device. The command device specified here is the one whose APID was specified for the ROUTE parameter above. Define this parameter in the order of connection.

DAD(DADID) ~ <DAD string>

Specify the DADID to which the command device belongs. The specified string must consist of no more than 28 characters or 44 - (13 + PREFIX length) characters, whichever is smaller.

DEVN(device-number) ~ <four- or five-digit hexadecimal number> ((00000 ~ 3FFFF))

Specify the device number of the command device and the subchannel set ID.

DUMMY(dummy-device-number) ~ <four- or five-digit hexadecimal number> ((00000 ~ 3FFFF))

Specify the dummy device number of the command device and the dummy subchannel set ID.

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

Specify the serial number of the storage system to which the command device belongs.

SSID(SSID) ~ <four-digit hexadecimal number>

Specify the SSID of the CU to which the command device belongs.

CU(CU-number) ~ <two-digit hexadecimal number>

Specify the CU number of the CU to which the command device belongs.

CCA(CCA-number) ~ <two-digit hexadecimal number>

Specify the CCA number of the command device.

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.

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 be generated.

STORCLAS storage-class-name ~ <storage class name string>

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

VOLUME volume-serial-number ~ <volume serial number string>

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

UNIT device-type ~ <device type string>

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

CFGUPDTE {INPLACE|REALLOC}

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

Notes

If you omit the SN, SSID, CU, and CCA operands for a CDEV parameter for which the DEVN operand is specified, a local scan including a scan of command devices must be completed in advance.

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 YKDEFRMT command ends.

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