YKRMTCDV (registers or deletes a remote command device)

Applies to TrueCopy, and Universal Replicator.

The command registers or deletes remote command devices for journal groups in the specified copy group.

Request body format

{ "action":"submit",
   "cliname":"YKRMTCDV",
   "operands":"
     [GROUP(copy-group-ID)]
     [△1{SET|UNSET}]
     [△1SELECT({ALL|COND})]
   "
}

Parameters specified in the request body

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

Specify the ID of the target copy groups that are loaded. If only one copy group is loaded, you can omit this parameter.

SET

Registers remote command devices for the journal groups in a Universal Replicator copy group or for the specified journal groups in a TrueCopy copy group.

UNSET

Deletes the remote command devices from the journal groups in a Universal Replicator copy group or from the specified journal groups in a TrueCopy copy group.

SELECT({ALL|COND})

Specify the selection method for remote command devices to be manipulated by the command. When not specified, ALL is assumed.

ALL

All the remote command devices defined in the copy group are to be manipulated by the command.

COND

The remote command devices to be manipulated by the command depend on their registration status.

If you specify this parameter, you need to run the YKQRYRCD command in advance to acquire the registration status of remote command devices. (If you do not run the command, registration or deletion processing will not be performed.)

If you specify the SET parameter, only remote command devices that are not yet registered will be the targets for registration processing.

If you specify the UNSET parameter, only remote command devices that are registered will be the targets for deletion processing.

Notes

• Registration and deletion processing are performed asynchronously. After running this command, run the YKQRYRCD GOTO(SET) command for registration or the YKQRYRCD GOTO(UNSET) command for deletion to verify that the return code is 0 (make sure that the registration or deletion processing is complete and no error occurs).

• You cannot run this command for a copy group that does not have the remote command device definition.

• You cannot register a remote command device for a journal group that does not have copy pairs.

• If a remote command device is registered for a journal group, you cannot perform registration processing. To make sure that no remote command devices are registered for any journal groups, run the YKQRYRCD GOTO(UNSET) command to verify that the return code is 0. If the return code is not 0, perform deletion processing, and then run this command.

• If you perform deletion processing for a journal group for which a remote command device is not registered, no error occurs and the registration status is not changed.

• The registered remote command device will be deleted automatically when the number of copy pairs in the journal group becomes zero.

Responses

See Responses returned by YKDELETE, YKMAKE, YKRECVER, YKRESYNC, YKSUSPND, or YKRMTCDV.

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

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