YKQUERY (displays the copy pair status)

Business Continuity Manager Web API Reference Guide

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

Applies to ShadowImage, TrueCopy, TrueCopy with the HyperSwap attribute, and Universal Replicator.

This command obtains the copy pair volume status for the specified copy group.

Request body format

{ "action":"submit",
   "cliname":"YKQUERY",
   "operands":"
     [GROUP(copy-group-ID)]
     [△1DEVN(p-vol-device-number, s-vol-device-number)]
     [△1TO({PRIMARY|SECONDARY})]|VERIFY}]
   "
}

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.

DEVN(p-vol-device-number,s-vol-device-number) ~ <4-digit hexadecimal number, 4-digit hexadecimal number>

Specify the device number of the copy pair (P-VOL and S-VOL) to operate.

Note that, for copy group containers with EXCTG IDs, the command checks the EXCTG registration information for all copy group containers.

After specifying an operation-target copy pair, if you want to view information about a different copy pair, run the YKQUERY or YKEWAIT command for all copy pairs.

Specify this parameter if you want to acquire the copy pair information from either the P-VOL or the S-VOL at the time the copy pair was defined. Note that the information you can acquire differs depending on the copy direction of the copy pair and the specified parameters.

PRIMARY

The information is acquired from the P-VOL at the time the copy pair was defined.

SECONDARY

The information is acquired from the S-VOL at the time the copy pair was defined.

If this parameter is specified, the command checks the copy group structure, provided that the copy pair is not in the SIMPLEX status, and allows information to be acquired from the P-VOL. For details about the content that is checked, see the description for "Consistency check between copy group definitions and copy pair configurations" in the Hitachi Business Continuity Manager User Guide.

Notes

  • For a copy group container with EXCTG ID, if you execute the YKDELETE command and then the YKQUERY command to obtain the copy pair status, the YKZ296E message sometimes appears when the dissolving of the copy pair is detected at a different time from the dissolving of EXCTG, but this does not mean that an error has occurred. However, for a copy group container with EXCTG ID, we recommend that you execute the YKDELETE command and then the YKEWAIT GOTO(SIMPLEX) command, wait until the copy pair status changes to SIMPLEX, and then execute the YKQUERY command.

  • If all of the following conditions are satisfied, the status cannot be acquired even if the TO parameter is specified:

    • When the copy type is ShadowImage

    • When the volume is a Non Gen'ed volume

    • When an error occurs in the pair Gen'ed volume

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

Table. YKQUERY 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 completed normally.

8

P-VOL(s) in incompatible status. For example, this includes the following case:

  • The P-VOL is in the offline status.

12

The VERIFY parameter was specified, and the copy group definition was found to be inconsistent with the actual copy group.

16

The P-VOL is in an inconsistent status. For example, this includes the following case:

  • In a ShadowImage copy group, the P-VOL for the copy pair for which processing is attempted already belongs to a copy pair with a third S-VOL other than the S-VOL defined for the copy group.

20

The S-VOL is in an inconsistent status. For example, this includes the following case:

  • The status of the P-VOL is SIMPLEX, and the status of the S-VOL is anything other than SIMPLEX.

24

  • An error occurred when the suspend processing was performed by using the UR ATTIME Suspend function or TC ATTIME Suspend function.

  • The status of the Universal Replicator copy pair was invalid when the suspend processing was performed by using the UR ATTIME Suspend function.

  • The status of the TrueCopy copy pair was invalid when the suspend processing was performed by using the TC ATTIME Suspend function.

  • Timestamp transfer mode of the TrueCopy copy pairs was not enabled when the suspend processing was performed by using the TC ATTIME Suspend function.
  • The suspend processing has started because the timeout period had elapsed when the UR ATTIME Suspend function was executed.

32

  • One or more I/O error was encountered.

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

36

  • Invalid or missing data in a REXX variable structure.

  • An inconsistency was detected between a copy group definition and an actual copy group.

40

An error occurred while a REXX variable was being written.

44

Terminating due to processing errors. For example, this includes the following case:

  • A GETMAIN error has occurred.

  • For a copy group container with EXCTG ID, journal groups have not yet been registered in EXCTG.

48

Termination due to invalid parameters. For example, there is the following case:

  • When the copy pair corresponding to the device number specified with the DEVN parameter is not found.

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.