Resynchronizing a global-active device pair

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request resynchronizes the specified global-active device pair. You can specify the primary volume to resynchronize pairs. Alternatively, you can specify the secondary volume to resynchronize pairs. Also, when resynchronizing pairs, do not simultaneously perform other operations on the copy group or pairs on which a pair resynchronization operation is performed.
Tip:
  • We recommend specifying Job-Mode-Wait-Configuration-Change:NoWait in the request header of this API function. For details, see the description of the flow of operations for the pairs.
  • For data migration that uses global-active device pairs, one volume is paired with two different volumes to form one pair for migration from the global-active device pair that is in use, and to form one migration destination pair from one pair for migration. In this case, the pair statuses of the pair for migration and the migration destination pair might not change even after the copying processing finishes. For this reason, when performing operations on a pair for migration or a migration destination pair, specify Job-Mode-Wait-Configuration-Change:NoWait in the request header of the API function. For details, see the description of the flow of operations for the pairs. For details on data migration that uses global-active device pairs, see the Global-Active Device User Guide.
Note:

If the model of either or both of the storage systems is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900, to register pairs in a consistency group when performing a pair resynchronization operation, the number of pairs in the target copy group must be 1,000 or less. If the number of pairs exceeds 1,000, delete all pairs in the copy group, and then register pairs in a consistency group when you re-create the pairs. Alternatively, delete some pairs so that the number of pairs decreases to 1,000 or less, perform a pair resynchronization operation, and then register the pairs in a consistency group when you re-create the pairs that you deleted.

Execution permission

Storage Administrator (Remote Copy)

Request line

POST base-URL/v1/objects/remote-mirror-copypairs/object-ID/actions/resync/invoke

Request message

Object ID

Specify the value of remoteMirrorCopyPairId that was obtained by the processing to get information about the remote copy pair. You can also specify the attributes and connect them with commas as follows:

remoteStorageDeviceId,copyGroupName,localDeviceGroupName,remoteDeviceGroupName,copyPairName

Attribute

Type

Description

remoteStorageDeviceId

string

(Required) Storage device ID of the remote storage system

copyGroupName

string

(Required) Copy group name

Specify a name consisting of 1 to 31 characters. The name is case sensitive.

localDeviceGroupName

string

(Required) Device group name in the local storage system

Specify a name consisting of 1 to 31 characters. The name is case sensitive.

remoteDeviceGroupName

string

(Required) Device group name in the remote storage system

Specify a name consisting of 1 to 31 characters. The name is case sensitive.

copyPairName

string

(Required) Copy pair name

Specify a name consisting of 1 to 31 characters. The name is case sensitive.

Query parameters

None.

Body

The following is a coding example for simply resynchronizing pairs:

{
  "parameters": {
    "replicationType": "GAD"
  }
}

The following is a coding example for reversing and resynchronizing pairs by specifying the P-VOL:

{
  "parameters": {
    "replicationType": "GAD",
    "doSwapPvol": true
  }
}

Attribute

Type

Description

replicationType

string

(Required) Specify the pair type.

GAD: global-active device

doSwapSvol

boolean

(Optional) Specify the volume to be specified for a pair resynchronization operation. Use this attribute when the S-VOL side is used as the local storage system.
  • true: Resynchronize pairs by specifying the S-VOL (swap resync).

    You can use this value if the pairs in the specified S-VOL are suspended. Reverse the P-VOL and the S-VOL, and then copy data of the new P-VOL to the new S-VOL.

  • false: Resynchronize pairs by specifying the P-VOL.

If the value is not specified, false will be set.

If this attribute is set to true, you cannot specify true for the doSwapPvol and isConsistencyGroup attributes.

doSwapPvol

boolean

(Optional) Specify the volume to be specified for a pair resynchronization operation. Use this attribute when the P-VOL side is used as the local storage system.
  • true: Resynchronize pairs by specifying the P-VOL (swap resync).

    You can use this value if the pairs in the specified P-VOL are suspended. Reverse the P-VOL and the S-VOL, and then copy data of the new P-VOL to the new S-VOL.

  • false: Resynchronize pairs by specifying the P-VOL.

If the value is not specified, false will be set.

If this attribute is set to true, you cannot specify true for the doSwapSvol and isConsistencyGroup attributes.

isConsistencyGroup

boolean

(Optional) If the pair is not registered in a consistency group, you can specify the value as follows:

  • true: Registers the pair in a consistency group. #
  • false: Leaves the pair as it is without registering it in a consistency group.

If the pair is already registered in a consistency group, you do not need to specify this attribute to maintain the registered state, regardless of the value specified for this attribute. Note that, if false is specified, registration of the consistency group cannot be canceled.

To register the pair in a consistency group, you must also specify the consistencyGroupId attribute.

Make sure that each copy group contains either only pairs that are registered to a consistency group or only pairs that are not registered to a consistency group. If a copy group includes both pairs that are registered in a consistency group and pairs that are not registered in a consistency group, pair operations by consistency group cannot be correctly performed.

If you specify true for this attribute, you cannot specify the doSwapSvol and doSwapPvol attributes.

consistencyGroupId

int

(Optional) Specify the consistency group ID by using a decimal (base 10) number.

Be sure to specify this attribute when registering the pair in a consistency group.

Unify the consistency group ID within the copy group. If a copy group includes a pair whose consistency group ID differs, pair operations by consistency group cannot be correctly performed.

fenceLevel

string

(Optional) Specify NEVER for the fence level.

If you specify true for the isConsistencyGroup attribute, NEVER is automatically set.

copyPace

int

(Optional) Copy speed

Specify a decimal (base 10) number in the range from 1 to 15 for the size of tracks to be copied. The larger the value you specify, the faster the copy speed.

#: If the model of either or both of the storage systems is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900, this value can be specified only if the number of pairs in the copy group is 1,000 or less.

Response message

Body
A job object is returned. For details on attributes other than affectedResources, see the description on job objects.

Attribute

Description

affectedResources

URL of the resynchronized global-active device pairs

Action template

GET base-URL/v1/objects/remote-mirror-copypairs/object-ID/actions/resync

This action template returns only the specifiable attributes, depending on the following: the type of the copy pair specified for the object ID, and whether the volume in the local storage system is the primary volume or the secondary volume.

Status codes

The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the description on HTTP status codes.

Status code

Message

Description

412

Precondition Failed

This object indicates that operations on the specified pair cannot be performed.

Coding example

To get an action template:

When the storage system of the P-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123789,remoteCopyGroup,remoteCopyGroupP_,remoteCopyGroupS_,pair1/actions/resync

When the storage system of the S-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123456,remoteCopyGroup,remoteCopyGroupS_,remoteCopyGroupP_,pair1/actions/resync

To run the request after getting an action template:

When the storage system of the P-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123789,remoteCopyGroup,remoteCopyGroupP_,remoteCopyGroupS_,pair1/actions/resync/invoke

When the storage system of the S-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123456,remoteCopyGroup,remoteCopyGroupS_,remoteCopyGroupP_,pair1/actions/resync/invoke