YKQRYRCD (gets remote command device information)

Applies to TrueCopy, and Universal Replicator.

• Whether a remote command device is registered
• LDEVID of the registered remote command device
• Error code when the remote command device was registered or deleted by the YKRMTCDV command

Request body format

{ "action":"submit",
   "cliname":"YKQRYRCD",
   "operands":"
     [GROUP(copy-group-ID)]
     [△1GOTO({SET|UNSET})]
   "
}

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.

GOTO({SET|UNSET})

SET

If a remote command device is registered for all journal groups, the command returns 0 as the return code. If a remote command device is not registered for a journal group, the command returns 4 as the return code. Specify this parameter if you want to verify that the registration processing was completed after running the YKRMTCDV command with the SET parameter specified.

UNSET

If a remote command device is not registered for all journal groups, the command returns 0 as the return code. If a remote command device is registered for a journal group, the command returns 4 as the return code. Specify this parameter if you want to verify that the deletion processing was completed after running the YKRMTCDV command with the UNSET parameter specified.

If you omit the GOTO parameter, the command gets the registration status of remote command devices for all journal groups. If no error occurs, the command returns 0 as the return code.

Notes

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

• If an error occurred during the processing to register or delete a remote command device that was performed immediately before, the command returns 12 as the return code, and sets an error code for the errCode key. If the processing was successfully performed, the command sets 0000 for the errCode key.

Responses

See Responses returned by YKQRYRCD.

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

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