YKLOAD (loads a configuration file)

This command loads the configuration file into the BCM Web API server, so that CLI commands that require the configuration file to be loaded can run.

The loaded configuration file is enabled until the YKDROP command deletes it or the BCM Web API server ends.

Request body format

{ "action":"submit",
   "cliname":"YKLOAD",
   "operands":"
    {△1GROUP(copy-group-ID)[△1DAD(DADID)]
         [△1ROUTE(route-list-ID[,{route-label|*}])[△1VIACDEV]]
     |△1PATH(path-set-ID)[[△1DAD(DADID)]
         [△1ROUTE(route-list-ID[,{route-label|*}])[△1VIACDEV]]]
     |△1ROUTE(route-list-ID[,{route-label|*}])[△1DAD(DADID)][△1VIACDEV]
     }
     [△1VAROPT]
     [△1PREFIX(prefix)]
   "
}

Parameters specified in the request body

GROUP(copy-group-id) ~ <GROUP string>

Specify the copy group ID of the copy group to be loaded.

DAD(dad-id) ~ <DAD string>

Specify the device address domain ID (local device address domain ID) of the current host. If you omit this parameter, the value of the default parameter dataset are assumed.

You must specify this parameter when you operate the copy group.

ROUTE(route-list-ID[,{route-label|*}])

Specify the route list ID to be loaded.

This parameter should be specified in the following cases:

• When using the TrueCopy consistency preservation function

• When the Remote DKC Control function is used.

If you omit this parameter, the ROUTEID and ROUTELABEL values of the default parameter are assumed.

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

Specify the route list ID.

{route-label|*} ~ <ROUTELABEL string of 8 or fewer characters>

When you specify a route label, the information about the command devices with the specified route label is loaded.

If * is specified, the information for all command devices is loaded regardless of whether they have a route label.

If both the route label and * are omitted, the information about the command devices with no route label is loaded.

Specify this parameter when issuing the I/O of commands to Gen'ed volumes via a command device.

A route list must be defined for all storage systems that have a volume included in a copy group. If a command is issued to a storage system whose route list is not defined while this parameter is specified, the command is issued directly to Gen'ed volumes on which the operation is to be performed.

PATH(path-set-id) ~ <PATH string>

When you are loading a path set, specify the path set ID.

VAROPT

If you specify this parameter and run the YKLOAD command several times, the loaded information is merged. This saves the processing time and memory required to create multiple items of information.

PREFIX(prefix) ~ <PREFIX string>

Specify the configuration file prefix. If you omit this parameter, the value of the default parameter dataset is assumed.

Notes

• When operating without a route list, to execute the YKLOAD command several times, specify the same device address domain ID for all of the instances of the YKLOAD command. The specified device address domain ID should be the device address domain ID assigned to the storage system connected to the host where Business Continuity Manager is running.

• When operating with a route list, to execute the YKLOAD command several times, specify the ROUTE parameter for only the first executed instance of the YKLOAD command. For the succeeding instances of the YKLOAD command, do not specify ROUTE parameter, but specify the same device address domain ID as for the first instance of the YKLOAD command. Note that if you drop the route list structure, and then execute the YKLOAD command, you need to specify the ROUTE parameter.

• Even if the GROUP parameter is not specified, the YKL007E message is not displayed if the ROUTE or PATH parameter is specified. If none of the GROUP, ROUTE and PATH parameters are specified, the YKL201E message is displayed.

• Do not execute the YKLOAD command by specifying the device address domain ID that was specified for the remote scan or NG scan using the DAD parameter. Doing so will cause an error. This could occur when, for example, a planned switch is made from the Primary site to the Secondary site and the disk configuration definition file of the storage system on the Secondary site (as created by the remote scan) is copied to the secondary host.

Responses

See Responses returned by YKLOAD.

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

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