Resynchronizing a TrueCopy pair or Universal Replicator 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 TrueCopy pair or Universal Replicator pair. If the pair is resynchronized, the differential data that was accumulated after the pair was split is copied from the primary volume to the secondary volume, so that the data is consistent between the two volumes. Do not simultaneously perform other operations on the copy group or the pairs in that copy group 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 pairs.
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 TrueCopy pairs in a consistency group when performing a TrueCopy 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": "UR"
  }
}

The following is a coding example for resynchronizing a pair to be failed back by specifying the MU (mirror unit) number of the pair:

{
  "parameters": {
    "replicationType": "TC",
    "doFailback": true,
    "failbackMuNumber": 1
  }
}

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

{
  "parameters": {
    "replicationType": "TC",
    "doSwapSvol": true
  }
}

Attribute

Type

Description

replicationType

string

(Required) Specify the pair type.
  • TC: TrueCopy
  • UR: Universal Replicator

doFailback

boolean

(Optional) Specify whether to perform a failback if a failure occurs in a 3DC cascade configuration.

  • true: A failback is performed.
  • false: A failback is not performed.

If the value is omitted, false is assumed.

If you specify true for this attribute, you cannot specify true for the doSwapSvol and doSwapPvol attributes. In the case of TC, you cannot specify the fenceLevel attribute.

failbackMuNumber

int

(Optional) Specify the MU (mirror unit) number of the volume to be failed back.

You can specify this attribute only if the doFailback attribute is set to true.

doSwapSvol

boolean

(Optional) Specify the resynchronization method if the pairs on the specified S-VOL are split. Issue a request from the storage system of the secondary site.

  • true: Resynchronize pairs by specifying the S-VOL (swap resync).

    Reverse the P-VOL and the S-VOL. Copy the data of the new P-VOL to the S-VOL to resynchronize the pairs.

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

    Copy the data of the P-VOL to the S-VOL to resynchronize the pairs.

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

If you specify true for this attribute, you cannot specify true for the doSwapPvol and doFailback attributes. In the case of TC, you also cannot specify the fenceLevel attribute.

doSwapPvol

boolean

(Optional) Specify the resynchronization method if the pairs in the specified P-VOL are split. Issue a request from the storage system of the primary site.

  • true: Resynchronize pairs by specifying the P-VOL (swap resync).

    Reverse the P-VOL and the S-VOL. Copy the data of the new P-VOL to the S-VOL to resynchronize the pairs.

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

    Copy the data of the P-VOL to the S-VOL to resynchronize the pairs.

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

If you specify true for this attribute, you cannot specify true for the doSwapSvol and doFailback attributes. In the case of TC, you also cannot specify the fenceLevel attribute.

isConsistencyGroup

boolean

(Optional) In the case of TC, specify the value as follows according to whether the pair is registered in a consistency group:

  • If the pair is not registered in a consistency group
    • 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 registered in a consistency group
    • true: Leaves the pair registered in a consistency group.
    • false: Cancels the registration of the pair in a consistency group, and places it in an unregistered state.

If the value is not specified, false will be set. To leave the pair registered in a consistency group, be sure to specify true for this attribute. To cancel registration in a consistency group, specify false for this attribute and, at the same time, specify the fenceLevel 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, make sure to also specify the fenceLevel attribute.

consistencyGroupId

int

(Optional) In the case of TC, specify the consistency group ID by using a decimal (base 10) number in the range from 0 to 255.

Use this attribute when registering the specified copy group in a consistency group.

You cannot specify this attribute if the specified pair is already registered 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.

When specifying this attribute, make sure to specify true for the isConsistencyGroup attribute.

fenceLevel

string

(Required) In the case of TC, specify the fence level.

  • DATA: S-VOL data
  • STATUS: S-VOL status
  • NEVER: None

If you specify true for the isConsistencyGroup attribute, or if you cancel the registration by specifying false for isConsistencyGroup, be sure to specify this attribute. When you specify this attribute, if there is no change in the fence level, specify the value of the existing fence level.

To change the fence level, specify the new value.

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

copyPace

int

(Optional) In the case of TC, 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 section explaining job objects.

Attribute

Description

affectedResources

URL of the resynchronized TrueCopy pairs or Universal Replicator 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 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 section explaining HTTP status codes.

Status code

Message

Description

412

Precondition Failed

This status code 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