YKMAKE (creates copy pairs)

Business Continuity Manager Web API Reference Guide

Version
9.8.8
File Size
1.6 MB
Audience
anonymous
Part Number
MK-96HC137-00

Applies to ShadowImage, TrueCopy, and Universal Replicator.

This command creates copy pairs by full copy for the specified copy group and changes the volume status to the DUPLEX status.

For a copy group container with EXCTG ID, journal groups are registered in EXCTG after the copy pairs are created.

Request body format

{ "action":"submit",
   "cliname":"YKMAKE",
   "operands":"
     [GROUP(copy-group-ID)]
     {  [△1{FORWARD|REVERSE}]
     | [△1NOCOPY[△1{FORWARD|REVERSE}]]
     | [△1HOLD[△1FORWARD]]
     }
     [△1SELECT({ALL|COND})]
     [△1DEVN(p-vol-device-number, s-vol-device-number)]
     [△1ONLINE({YES|NO})]
     [△1JNLGRP({LINEAR|DISPERSED})]
     [△1COPYPACE({SLOW|NORMAL|FAST})]
     "
}

Parameters specified in the request body

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

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

{FORWARD|REVERSE}

Specify the copy direction.

FORWARD

The command creates a copy pair directed from the primary site to the secondary site.

REVERSE

Creates a copy pair in the reverse direction, from the secondary site to the primary site.

The command creates a copy pair without copying between P-VOL and S-VOL. The command is used only when the two volume contents are exactly the same.

Applies to Universal Replicator.

The copy pair status is transitioned to the HOLD status.

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

ALL

All the copy pairs in the copy group are to be manipulated by the command. Note that if the DEVN parameter is specified, the copy pair specified for the parameter becomes the execution target of the command. If the ORDER parameter is specified, the copy pairs specified for the ORDER parameter become the execution targets of the command.

COND

The pairs to be manipulated by the command depend on their volume status. If all copy pairs in the copy group are either affected by the command or in the target status, processing terminates with return code 0. If copy pairs that are not affected by the command are included in the copy group, processing terminates with return code 4. For more information about copy groups affected by the command and its target status, see the table "Copy pair statuses for which commands with SELECT(COND) specified are subject to processing" in the Hitachi Business Continuity Manager User Guide.

For a copy group container with EXCTG ID, journal groups not registered in EXCTG are registered even if there is no volume that is manipulated by the command.

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

If this parameter is specified for a copy group container with EXCTG ID, the following operations are performed because journal groups are not registered in EXCTG.

No.

Condition

Operation

1

A journal group specified by the DEVN parameter is already registered in EXCTG.

Copy pairs that have been created are transitioned to the DUPLEX status, and then included in EXCTG.

2

A journal group specified by the DEVN parameter is not registered in EXCTG.

Copy pairs that have been created are not included in EXCTG even after they have transitioned to the DUPLEX status.

ONLINE({YES|NO})

Specify whether to create a copy pair if the copy destination volume is online.

YES

Create a copy pair even if the copy destination volume is online.

NO

Do not create a copy pair if the copy destination volume is online.

Applies to Universal Replicator.

Specifies the order in which the copy pair is created within the storage system. If you specify the ORDER parameter, the JNLGRP parameter is disabled.

LINEAR

Creates the copy pair in the order of definitions in the copy group definition file.

DISPERSED

Creates the copy pair so that the journal group to which the volume belongs is dispersed.

In an environment that meets the following conditions, you can improve performance by dispersing the load on the journal volumes that are being used by executing the YKMAKE command with the DISPERSED parameter specified.

  • Within a copy group, more than one journal group is defined in the same storage system.

  • Within each journal group, 128 or more copy pairs are defined.

  • The line speed is sufficient.

Applies to ShadowImage and TrueCopy.

Specify the copy pace when creating a copy pair. If this parameter is omitted, the copy pace value specified when the copy group was defined will be used.

SLOW

Slows the speed of the copy operation so that the effect of the copy operation on the I/O performance of the host is minimal.

NORMAL

The speed of the copy operation improves. However, update I/O load on P-VOL is high, and this might affect the I/O performance of the host.

FAST

Applies to ShadowImage.

Specifying FAST speeds up the copy operation so that it is faster than NORMAL. However, specifying FAST adversely affects the I/O performance of the host.

Important:

Specifying COPYPACE(FAST) might adversely affect business operations, so we recommend that you perform such a copy operation outside of business hours.

Notes

  • If you specify the NOCOPY parameter when the content of the P-VOL does not match that of the S-VOL, data inconsistencies will occur on the S-VOL when a copy pair is suspended or when a failure occurs. As a result, volumes might not be usable.

  • If ONLINE(YES) is specified, volume corruption might occur because a copy pair can be created even if the S-VOL is being used. Thus, consideration with respect to volume operation is required, such as limiting operation to periods when the S-VOL is not being used.

  • If transition to HOLD status is not performed, this might indicate an environment in which differentials cannot be maintained in the journal. Check the number of TrueCopy copy pairs sharing P-VOL with the specified copy pairs, the number of Universal Replicator copy pairs sharing S-VOL with the specified copy pairs, and the status of copy pairs.

  • Since the EXCTG registration processing is performed asynchronously with the YKMAKE command, an error might occur during EXCTG registration even if the YKMAKE command terminates normally. Therefore, after executing the YKMAKE command on a copy group container with EXCTG ID, execute either the YKEWAIT GOTO(DUPLEX) command or the YKQUERY command to check if an error occurred during EXCTG registration.

  • If the YKMAKE command is executed for a copy group container with EXCTG ID, EXCTG registration might fail with error code 3688 even if a copy pair is successfully created. If error code 3688 occurs when the YKMAKE, YKQUERY, or YKEWAIT command is executed, re-execute the YKMAKE command specifying SELECT(COND) to register the journal group in the EXCTG.

  • When the COPYPACE(FAST) parameter is specified, if a ShadowImage copy group includes storage system volumes for which FAST is not supported, the copy pairs for which FAST is not supported will be copied by using NORMAL. In addition, if FAST is not supported for any of the storage system volumes in the copy group, the YKZ414E message is output and processing ends.

  • When a copy is performed from low-capacity TrueCopy or Universal Replicator volumes to high-capacity volumes, if a failure occurs on the secondary site, a TrueCopy or Universal Replicator copy cannot be performed in the reverse direction (from the Secondary site to the Primary site). We recommend strongly that copying from a small volume to a large volume function be used exclusively for data migration.

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

Table. YKMAKE 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.

4

Since a volume with an invalid status was found in the copy group, processing for the volume will be skipped.

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.

40

An error occurred while a REXX variable was being written.

44

Termination due to processing errors.

48

Termination due to invalid parameters, such as in the following cases:

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

  • When the COPYPACE parameter is specified for Universal Replicator.

  • When the COPYPACE(FAST) parameter is specified for copy types other than ShadowImage.

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.