- Before creating the pair, set the reserved attribute of global-active device for the secondary volume by using the API that sets a virtual LDEV number.
- 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.
Execution permission
Storage Administrator (Provisioning) and Storage Administrator (Remote Copy)
Request line
POST base-URL/v1/objects/remote-mirror-copypairs
Request message
- Body
-
The following is a coding example for creating a new copy group and adding a pair to the copy group:
{ "copyGroupName": "remoteCopyGroup3", "copyPairName": "pair1", "replicationType": "GAD", "remoteStorageDeviceId": "886000123789", "pvolLdevId": 1580, "svolLdevId": 2128, "localDeviceGroupName": "remoteCopyGroup3P_", "remoteDeviceGroupName": "remoteCopyGroup3S_", "muNumber": 0, "quorumDiskId": 14, "isNewGroupCreation": true, "fenceLevel": "NEVER", "copyPace": 10, "doInitialCopy": true, "isDataReductionForceCopy": true }The following is a coding example for adding a pair to an existing copy group:
{ "copyGroupName": "remoteCopyGroup3", "copyPairName": "pair2", "replicationType": "GAD", "remoteStorageDeviceId": "886000123789", "pvolLdevId": 1581, "svolLdevId": 2129, "localDeviceGroupName": "remoteCopyGroup3P_", "remoteDeviceGroupName": "remoteCopyGroup3S_", "quorumDiskId": 14, "isNewGroupCreation": false, "fenceLevel": "NEVER", "copyPace": 10, "doInitialCopy": true, "isDataReductionForceCopy": false }Attribute
Type
Description
copyGroupName
string
(Required) Specify a copy group name consisting of 1 to 29 characters. The name is case sensitive.
Set a unique name that is the same for the storage systems on both the local and remote sides.
copyPairName
string
(Required) Specify a copy pair name consisting of 1 to 31 characters. The name is case sensitive.
Set a unique name that is the same for the storage systems in the copy group.
replicationType
string
(Required) Specify the pair type.
GAD: global-active device
remoteStorageDeviceId
string
(Required) Specify the storage device ID of the remote storage system in which the pair is to be created.
pvolLdevId
int
(Required) Specify the LDEV number of the P-VOL with a decimal (base 10) number.
svolLdevId
int
(Required) Specify the LDEV number of the S-VOL for which the reserved attribute of global-active device is set. Specify it with a decimal (base 10) number.
Specify the reserved attribute of global-active device by using the API that sets a virtual LDEV number.
pathGroupId
int
(Optional) Specify the path group ID by using a decimal (base 10) number in the range from 0 to 255.
If you omit this value or specify 0, the lowest path group ID in the specified path group is used.
localDeviceGroupName
string
(Optional) Specify the device group name in the local storage system by using 1 to 31 characters. The name is case sensitive.
If you add the pair to an existing copy group, specify the same device group name as that of the existing local storage system. The name needs to be unique in the local storage system. If this value is omitted, copyGroupNameP_ is assumed.
remoteDeviceGroupName
string
(Optional) Specify the device group name in the remote storage system by using 1 to 31 characters. The name is case sensitive.
If you add the pair to an existing copy group, specify the same device group name as that of the existing remote storage system. The name needs to be unique in the remote storage system. If this value is omitted, copyGroupNameS_ is assumed.
isNewGroupCreation
boolean
(Required) Depending on the value, this attribute specifies whether to add the pair to a new copy group or to an existing copy group.
- true: Adds the pair to a new copy group.
- false: Adds the pair to an existing copy group.
muNumber
int
(Required) Specify the MU (mirror unit) number by using a number from 0 to 3.
This value is used by the P-VOL and the S-VOL. You can specify this attribute only if you add the pair to a new copy group.
quorumDiskId
int
(Required) Specify the quorum disk ID by using a decimal (base 10) number in the range from 0 to 31.
isConsistencyGroup
boolean
(Optional) Depending on the value, this attribute specifies whether to register the new pair in a consistency group.
- true: Registers the pair in a consistency group.
- false: Does not register the pair in a consistency group.
If you add the pair to an existing copy group, specify the same value as that of the existing copy pair. 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 this value is omitted, false is assumed.
consistencyGroupId
int
(Optional) Specify the consistency group ID by using a decimal (base 10) number.
If you omit this value when registering the new pair in a consistency group, the value is automatically assigned.
If you add the pair to an existing copy group, specify the same value as that of the existing copy pair. 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
(Optional) Fence level
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 this value is omitted, 3 is assumed.
doInitialCopy
boolean
(Optional) Specify whether to perform initial copy when creating a pair.
- true: Performs initial copy.
- false: Does not perform initial copy.
If this value is omitted, true is assumed.
isDataReductionForceCopy
boolean
(Optional) Specify whether to forcibly create a pair for a volume for which the capacity saving function (dedupe and compression) is enabled.
When creating a pair for a volume for which the capacity saving function is enabled, always specify true.
- true: Forcibly create a pair #
- false: Do not forcibly create a pair
When the attribute is omitted, false is assumed.
#: If you create a pair by using volumes for which the capacity saving function (compression or deduplication) is enabled, data that has been compressed or deduplicated will be copied and, as a result, the performance of the copying processing or the I/O performance of the host might decrease.
Response message
Status codes
For details on the status codes of the request for this operation, see the section explaining HTTP status codes.
Coding example
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