YKQEXCTG (gets EXCTG information)

Business Continuity Manager Web API Reference Guide

Version
9.9.1
Audience
anonymous
Part Number
MK-96HC137-03

Applies to Universal Replicator.

Information about the copy group container with EXCTG ID is acquired from the supervisor disk controller at the site specified for the TO parameter.

Request body format

{ "action":"submit",
   "cliname":"YKQEXCTG",
   "operands":"
     [GROUP(copy-group-ID)]
     [△1TO({SECONDARY|PRIMARY}) ]
   "
}

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.

TO({SECONDARY|PRIMARY})

Specifies the site where the supervisor disk controller from which EXCTG information will be acquired is located.

SECONDARY

Acquires information from the supervisor disk controller defined for the secondary site when defining a copy pair. If the current copy direction is the forward direction, information is valid for the copy group container with EXCTG ID for the forward direction.

PRIMARY

Acquires information from the supervisor disk controller defined for the primary site when defining a copy pair. If the current copy direction is the reverse direction, information is valid for the copy group container with EXCTG ID for the reverse direction.

Notes

Before using the YKQEXCTG command to acquire EXCTG information, use the YKQUERY command to confirm that consistency is preserved for EXCTG. If consistency is not preserved for EXCTG, the exctg2 key might not be output. For details about how to verify whether consistency is preserved for EXCTG, see the description of EXCTG in the Hitachi Business Continuity Manager User Guide.

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

Table. YKQEXCTG command return code list

Return code

Meaning

-3

The module cannot be loaded. Possible causes are as follows:

  • The library dataset has not been linked.

  • The module is protected by the RACF program control function.

-1

An interruption occurred during execution.

0

The command terminated normally.

32

  • An I/O error occurred.

  • A change was detected in the I/O configuration definition.

36

Invalid or missing data in a REXX variable structure.

40

An error occurred while performing a REXX variable write operation.

44

The command terminated due to a processing error.

48

The command terminated due to invalid parameters.

128

The command terminated abnormally. Alternatively, the user does not have permission to execute this command.

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