Managing TrueCopy pairs or Universal Replicator pairs
Overview of TrueCopy and Universal Replicator
TrueCopy
By synchronizing with the data of the local storage system, TrueCopy copies the data to the remote storage system. Therefore, if the volumes of the local storage system (primary volumes) and the volumes of the remote storage system (secondary volumes) are in the PAIR status, the data is consistent.
A pair consists of a primary volume and a secondary volume. You can perform operations on pairs in units of copy groups. A copy group is a group made up of copy pairs. Each copy group consists of a device group made up of primary volumes, and a device group made up of secondary volumes.
For details on TrueCopy, see the Hitachi TrueCopy® User Guide.
Universal Replicator
Universal Replicator asynchronously copies the data of the local storage system to the data of the remote storage system. The updated data (journal data) is stored in the master journal volume, and is copied to the data of the secondary volumes via the restore journal volume.
For Universal Replicator, the primary volumes and the master journal volume are called the master journal, and the secondary volumes and the restore journal volume are called the restore journal. Perform operations on pairs in units of mirrors (copy groups) that are the correspondence relationship between the master journal and the restore journal. A mirror (copy group) is a group made up of copy pairs. Each mirror (copy group) consists of a device group made up of primary volumes, and a device group made up of secondary volumes.
For details on Universal Replicator, see the Hitachi Universal Replicator User Guide.
Workflow for operating TrueCopy pairs or Universal Replicator pairs
If you perform operations on or get information about TrueCopy or Universal Replicator pairs, specify Remote-Authorization for the request header.
Creating a pair
Create a pair, and then copy all of the data in the P-VOL to the S-VOL. The pair is synchronized. Create a pair in a new copy pair (mirror), or add a pair to an existing copy group.
Getting information about a copy group (mirror) or pair
For TrueCopy, you can perform operations on the pair in units of copy groups or pairs. For Universal Replicator, perform operations on the pair in units of copy groups (mirrors).
Splitting a pair
Split the pair to suspend data copy.
Resynchronizing a pair
Copy the differential data to resynchronize the pair.
NoteResynchronization can be performed in units of copy groups or pairs. For TrueCopy, if you want to register pairs to a consistency group during resynchronization, perform resynchronization in units of copy groups. Do not perform resynchronization in units of pairs.
Deleting a pair
Dissolve the pair status of the volumes.
During the creation, splitting, and resynchronizing of pairs, if multiple asynchronous processing requests are issued at the same time, jobs might get stuck and the job status might not change to Completed because data copying takes a long time. In such cases, specify Job-Mode-Wait-Configuration-Change:NoWait in the request header so that the job status changes to Completed without waiting for data copying to finish, and the next job starts. At this time, data copying continues even after job execution ends. To check whether data copying has finished, check the pair status of the target resource instead of the job status. For details about the pair status, see the description of the pair status transitions.
Flow of recovery operations to be performed when a failure occurs at the primary site of a Universal Replicator pair
The operations for recovering the Universal Replicator pair can be divided into three general phases:
- Perform a failover to switch operations over to the secondary site.
- Copy data from the secondary site to the primary site.
- Return the pair relationship between the primary site and the secondary site to the state it was in before the failure occurred.
After a failure is detected at the primary site, switch the roles of the primary volume and the secondary volume of the Universal Replicator pair, so that data can be written to the secondary volume, and business operations can continue at the secondary site.
The following figure shows the flow of operations:
Stop the business system
When a failure is detected at the primary site, stop the business system, and make sure that there is no I/O to or from the hosts.
Get copy group information or pair information
Get a list of the copy groups on the storage system of the secondary site. Then, based on this information, get copy pair information for the secondary site. When executing these API requests, you need to specify remote storage system information for the query parameter or object ID. In this situation, specify NotSpecified.
Identify the pair to which business operations are to be switched over
Based on the pair information for the secondary site, identify the pair to which business operations are to be switched over.
Switch over business operations to a volume at the secondary site
Specify the pair or copy group, and then switch the roles of the primary volume and the secondary volume. Data can now be written to the secondary volume.
NoteWhen auto is specified as the takeover execution mode, the storage systems at the secondary site automatically try to resynchronize with the storage systems at the primary site. If the resynchronization succeeds, you do not need to split and then resynchronize the pair by performing the following flow of operations (the flow of operations for copying data from the secondary site to the primary site). To check whether the resynchronization was successful, get pair information.Restart the business system (at the secondary site)
Restart the operations of the business system at the secondary site.
After recovery is complete for the primary site, apply the data that was written to the secondary site during the failure to the primary site. The following figure shows the flow of operations:
Stop the business system
Stop the business system, and make sure that there is no I/O to or from the hosts.
Get copy group information or pair information
Get copy pair information based on the copy group information, and then check the pair status.
Split or delete the pair
Perform one of the following operations if necessary, according to the pair status:
- If the pair status of the S-VOL is SSWS, split the pair.
- If the pair status of the P-VOL or the S-VOL is SMPL, delete the pair.
Resynchronize or re-create the pair
Perform one of the following operations if necessary, according to the pair status:
- If the pair status of the S-VOL is SSWS, resynchronize the pair at
the secondary site (the S-VOL). At this time, specify true
for
doSwapSvol
. - If the pair status of both the primary site and the secondary site is SMPL, create a pair by specifying the P-VOL for the secondary site.
- If the pair status of the S-VOL is SSWS, resynchronize the pair at
the secondary site (the S-VOL). At this time, specify true
for
When all pair statuses are PAIR and all data on the secondary site is applied to the primary site, normal operation can be restarted at the primary site. The following figure shows the flow of operations:
Get copy group information or pair information
Get pair information based on copy group information, and make sure that the status of the target pair is PAIR.
Split the pair
Split the pair.
Resynchronize the pair
Resynchronize the pair at the primary site (P-VOL). Specify true for
doSwapSvol
.Get copy group information or pair information
Get pair information based on copy group information, and make sure that the status of the target pair is PAIR.
The pair relationship between the primary site and the secondary site and the copy direction are returned to the state they were in before the failure, and the business system can now be restarted.
Pair status (TrueCopy and Universal Replicator)
The following explains the operations and status transitions for TrueCopy pairs.
Pair status |
Description |
Access to the P-VOL |
Access to the S-VOL |
SMPL |
Unpaired volumes |
-- |
-- |
COPY |
A pair is being created. An initial copy or resynchronization is being performed. |
R/W enabled |
R enabled |
PAIR |
Paired volumes The initial copy finished, and the pair volumes are synchronized. |
R/W enabled |
R enabled |
PSUS |
The pair is split by operation, or deleted from the storage system on the secondary site. (This value is output for the P-VOL.) |
R/W enabled | R/W enabled #1 |
SSUS |
The pair is split by operation, or deleted from the storage system on the secondary site. (This value is output for the S-VOL.) |
R/W enabled | R/W enabled #1 |
PSUE |
The pair is split due to a failure. | R/W enabled #2 |
R enabled |
SSWS |
The P-VOL and S-VOL are switched, and the S-VOL is writable. |
R enabled |
R/W enabled |
#1: When you split a pair, you can specify whether to permit read-write or read-only.
#2: When the fence level of the P-VOL is DATA (S-VOL data), read-only is permitted.
If you delete a pair, the pair status changes to SMPL.
The following explains the operations and status transitions for Universal Replicator pairs.
Universal Replicator pairs have specific pair statuses because Universal Replicator pairs use the journal volume to asynchronously copy data.
Pair status |
Description |
Access to the P-VOL |
Access to the S-VOL |
SMPL |
Unpaired volumes | -- | -- |
COPY |
A pair is being created. An initial copy or resynchronization is being performed. |
R/W enabled |
R enabled |
PAIR |
Paired volumes The initial copy is finished, and the pair volumes are synchronized. |
R/W enabled |
R enabled |
PSUS |
The pair is split by operation, or deleted from the storage system on the secondary site. (This value is output for the P-VOL.) |
R/W enabled | R/W enabled # |
SSUS |
The pair is split by operation, or deleted from the storage system on the secondary site. (This value is output for the S-VOL.) |
R/W enabled | R/W enabled # |
PSUE |
The pair is split due to a failure. |
R/W enabled |
R enabled |
SSWS |
The P-VOL and S-VOL are switched, and the S-VOL is writable. |
R enabled |
R/W enabled |
PFUL |
The amount of the data in the journal volume exceeds the threshold (80%). The pair is not split, and data continues to be copied. |
R/W enabled |
R enabled |
PFUS |
The amount of the data in the journal volume reaches 100%, and the pair is split. You must review the configurations of remote paths and the journal volume. |
R/W enabled | R enabled # |
#: This is determined by the secondary volume's access mode that is specified to split the pair. (Default: Read is enabled.)
If you delete a pair, the pair status changes to SMPL.
In the following cases, if you perform an operation on a pair, the request successfully returns a response, but the details specified in the request body are not actually applied:
- When you perform a pair splitting operation on a pair for which the status is PSUS or SSUS
- When you perform a pair resynchronization operation on a pair for which the status is COPY or PAIR
Getting a list of remote copy groups
Storage Administrator (View Only)
GET base-URL/v1/objects/remote-mirror-copygroups
Object ID
None.
Query parameters
You can get only a list of remote copy groups, or you can get detailed information about remote copy pairs in addition to a list of remote copy groups.
-
To get a list of remote copy groups only:
Parameter
Type
Filter condition
remoteStorageDeviceId
string
(Required) Storage device ID of the remote storage system
If a failure occurs in a remote storage system and you then specify NotSpecified, only the information about the local storage system is obtained. In this situation (when a failure occurs and you specify NotSpecified), you do not need to specify the Remote-Authorization header.
If you specify NotSpecified for this parameter, you cannot specify the detailInfoType parameter.
To obtain additional detailed information:
Parameter
Type
Description
detailInfoType
string
(Optional) Type of detailed information to be obtained
- pair
Gets additional detailed information# about remote copy pairs.
You can specify this item for VSP 5000 series.
To get up-to-date information, you must run the API request that refreshes the storage system's cache before running this request. For details, see "Updating the cache of storage system configuration information".
If you specify NotSpecified for the remoteStorageDeviceId parameter, you cannot specify this parameter.
# If the remote storage system is a VSP G350, G370, G700, G900 or VSP F350, F370, F700, F900 model storage system, you might not be able to get some of the information about the remote storage system.
- pair
-
Body
None.
Body
{ "data" : [ { "remoteMirrorCopyGroupId" : "886000123789,remoteCopyGroup1,remoteCopyGroup1S_,remoteCopyGroup1P_", "copyGroupName" : "remoteCopyGroup1", "muNumber" : 0, "remoteStorageDeviceId" : "886000123789", "localDeviceGroupName" : "remoteCopyGroup1S_", "remoteDeviceGroupName" : "remoteCopyGroup1P_" }, { "remoteMirrorCopyGroupId" : "886000123789,remoteCopyGroup2,remoteCopyGroup2P_,remoteCopyGroup2S_", "copyGroupName" : "remoteCopyGroup2", "muNumber" : 0, "remoteStorageDeviceId" : "886000123789", "localDeviceGroupName" : "remoteCopyGroup2P_", "remoteDeviceGroupName" : "remoteCopyGroup2S_" }, { "remoteMirrorCopyGroupId" : "886000123789,remoteCopyGroup3,remoteCopyGroup3P_,remoteCopyGroup3S_", "copyGroupName" : "remoteCopyGroup3", "muNumber" : 0, "remoteStorageDeviceId" : "886000123789", "localDeviceGroupName" : "remoteCopyGroup3P_", "remoteDeviceGroupName" : "remoteCopyGroup3S_" } ] }
Attribute
Type
Description
remoteStorageDeviceId
string
Storage device ID of the remote storage system
If you specify NotSpecified for remoteStorageDeviceId, NotSpecified is output.
copyGroupName
string
Copy group name
localDeviceGroupName
string
Device group name in the local storage system
remoteDeviceGroupName
string
Device group name in the remote storage system
If you specify NotSpecified for remoteStorageDeviceId, NotSpecified is output.
muNumber
int
MU (mirror unit) number
If the MU number cannot be obtained, information is not output.
remoteMirrorCopyGroupId
string
Object ID of the remote copy group
The following attributes are output, separated by commas:
remoteStorageDeviceId
copyGroupName
localDeviceGroupName
remoteDeviceGroupName
If you run the request with pair specified for the query parameter
detailInfoType
, you can get the following information, in addition to information about remote copy groups:Attribute
Type
Description
copyPairs
object[]
Detailed information about the remote copy pair is output.
If information cannot be acquired, the attributes under the
copyPairs
object are not output.- copyGroupName (string)
Copy group name
- copyPairName (string)
Copy pair name
- replicationType (string)
Pair type
- TC: TrueCopy
- UR: Universal Replicator
- GAD: global-active device
If the pair status is SMPL, information is not output.
- pvolLdevId (int)
LDEV number of P-VOL
- svolLdevId (int)
LDEV number of S-VOL
- fenceLevel (string)
Fence level
- DATA: S-VOL data
- STATUS: S-VOL status
- NEVER: None
- ASYNC: Asynchronous
If the fence level cannot be obtained, information is not output.
- pvolJournalId (int)
Journal ID of the P-VOL
A value from 0 to 255 is output only in the case of Universal Replicator. This information is not output if the pair type cannot be obtained.
- svolJournalId (int)
Journal ID of the S-VOL
A value from 0 to 255 is output only in the case of Universal Replicator. This information is not output if the pair type cannot be obtained.
- quorumDiskId (int)
ID of the Quorum disk
A value from 0 to 31 is output only in the case of global-active device. This information is not output if the pair type cannot be obtained.
- pvolStatus (string)
Pair status of the P-VOL
For details, see the section explaining on pair status (TrueCopy and Universal Replicator) or pair status (global-active device).
If the pair status cannot be obtained, information is not output.
In the case of Universal Replicator, if the transition status of the Universal Replicator pair is Suspending or Deleting, information is not output.
- svolStatus (string)
Pair status of the S-VOL
For details, see the section explaining on pair status (TrueCopy and Universal Replicator) or pair status (global-active device).
If the pair status cannot be obtained, information is not output.
In the case of Universal Replicator, if the transition status of the Universal Replicator pair is Suspending or Deleting, information is not output.
- consistencyGroupId (int)
Consistency group ID
If no consistency group consists, information is not output.
- pvolIOMode (string)
I/O mode of the P-VOL
- L/M: Mirror (RL)
- L/L: Local
- B/B: Block
Information is output only in the case of global-active device. If the pair status is SMPL, information is not output.
- svolIOMode (string)
I/O mode of the S-VOL
- L/M: Mirror (RL)
- L/L: Local
- B/B: Block
Information is output only in the case of global-active device. If the pair status is SMPL, information is not output.
- pvolStorageDeviceId (string)
Storage device ID of the storage system on the P-VOL
- svolStorageDeviceId (string)
Storage device ID of the storage system on the S-VOL
- remoteMirrorCopyPairId (string)
Object ID of the remote copy pair
The following attributes are output, separated by commas:
remoteStorageDeviceId
copyGroupName
localDeviceGroupName
remoteDeviceGroupName
copyPairName
-
transitionStatus (string)
The transition status of a pair is output for a Universal Replicator pair.
- None: The pair is not in transition.
- Suspending: The pair is being split.
- Deleting: The pair is being deleted.
This is not output if the copy pair is not a Universal Replicator pair.
-
copyPace (int)
Copy speed
This is not output if copy pair is Universal Replicator.
-
pathGroupId (int)
ID of the RCU path group
This is not output if CU is specified for the remote path connection setting.
This is not output if the pair status of the P-VOL or the S-VOL is
SMPL
. -
deltaStatus (string)
Status of the 3DC multi-target configuration that uses delta resync
This is output if the pair type is Universal Replicator and the 3DC multi-target configuration that uses delta resync is used.
- HOLD: Universal Replicator delta resync pair (normal)
- HLDE: Universal Replicator delta resync pair (failed)
- HOLDING: In the process of being changed to a Universal Replicator delta resync pair
For details on the status codes of the request for this operation, see the description on HTTP status codes.
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-copygroups?remoteStorageDeviceId=886000123789
Getting information about a specific remote copy group
Storage Administrator (View Only)
GET base-URL/v1/objects/remote-mirror-copygroups/object-ID
Object ID
Specify the value of
remoteMirrorCopyGroupId
that was obtained by the processing to get information about the remote copy group. You can also specify the attributes and connect them with commas as follows:remoteStorageDeviceId,copyGroupName,localDeviceGroupName,remoteDeviceGroupName
Attribute
Type
Description
remoteStorageDeviceId
string
(Required) Storage device ID of the remote storage system#
Specify a decimal (base 10) number equal to or greater than 0.
copyGroupName
string
(Required) Copy group name
Specify a character string consisting of 1 to 31 characters. The name is case sensitive.
localDeviceGroupName
string
(Required) Device group name in the local storage system
Specify a character string consisting of 1 to 31 characters. The name is case sensitive.
remoteDeviceGroupName
string
(Required) Device group name in the remote storage system#
Specify a character string consisting of 1 to 31 characters. The name is case sensitive.
#: If you specify NotSpecified in cases such as when a failure occurs in a remote storage system, only information about the local storage system can be acquired. If you specify NotSpecified, copy pair information about attributes of volumes that belong to the remote storage system will not be output. In this case, you do not need to specify the Remote-Authorization header.
Query parameters
Parameter
Type
Description
detailInfoType
string
(Optional) Type of detailed information to be obtained
-
class
Adds additional information# from the storage system's cache.
You can specify this item for VSP 5000 series.
To get up-to-date information, you must run the API request that refreshes the storage system's cache before running this request. For details, see "Updating the cache of storage system configuration information".
# If the remote storage system is a VSP G350, G370, G700, G900 or VSP F350, F370, F700, F900 model storage system, you might not be able to get some of the information about the remote storage system.
-
Body
None.
Body
The following is an example of the output when information about TrueCopy pairs is obtained:
{ "remoteMirrorCopyGroupId" : "886000123789,remoteCopyGroup1,remoteCopyGroup1P_,remoteCopyGroup1S_", "copyGroupName" : "remoteCopyGroup1", "copyPairs" : [ { "copyGroupName" : "remoteCopyGroup1", "copyPairName" : "pair1", "replicationType" : "TC", "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup1,remoteCopyGroup1P_,remoteCopyGroup1S_,pair1", "pvolLdevId" : 2108, "svolLdevId" : 1581, "fenceLevel" : "DATA", "pvolStatus" : "PAIR", "svolStatus" : "PAIR", "consistencyGroupId": 5, "pvolStorageDeviceId" : "886000123456", "svolStorageDeviceId" : "886000123789" }, { "copyGroupName" : "remoteCopyGroup1", "copyPairName" : "pair2", "replicationType" : "TC", "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup1,remoteCopyGroup1P_,remoteCopyGroup1S_,pair2", "pvolLdevId" : 2109, "svolLdevId" : 1582, "fenceLevel" : "DATA", "pvolStatus" : "PSUS", "svolStatus" : "SMPL", "consistencyGroupId": 5, "pvolStorageDeviceId" : "886000123456", "svolStorageDeviceId" : "886000123789" } ], "remoteStorageDeviceId" : "886000123789", "localDeviceGroupName" : "remoteCopyGroup1P_", "remoteDeviceGroupName" : "remoteCopyGroup1S_" }
The following is an example of the output when information about Universal Replicator pairs is obtained:
{ "remoteMirrorCopyGroupId" : "886000123789,remoteCopyGroup2,remoteCopyGroup2P_,remoteCopyGroup2S_", "copyGroupName" : "remoteCopyGroup2", "copyPairs" : [ { "copyGroupName" : "remoteCopyGroup2", "copyPairName" : "pair1", "replicationType" : "UR", "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup2,remoteCopyGroup2P_,remoteCopyGroup2S_,pair1", "consistencyGroupId" : 10, "pvolLdevId" : 1569, "pvolJournalId" : 13, "svolLdevId" : 2835, "svolJournalId" : 36, "fenceLevel" : "ASYNC", "pvolStatus" : "PAIR", "svolStatus" : "PAIR", "pvolStorageDeviceId" : "886000123456", "svolStorageDeviceId" : "886000123789" } ], "remoteStorageDeviceId" : "886000123789", "localDeviceGroupName" : "remoteCopyGroup2P_", "remoteDeviceGroupName" : "remoteCopyGroup2S_" }
The following is an example of the output when information about global-active device pairs is obtained:
{ "remoteMirrorCopyGroupId" : "886000123789,remoteCopyGroup3,remoteCopyGroup3P_,remoteCopyGroup3S_", "copyGroupName" : "remoteCopyGroup3", "copyPairs" : [ { "copyGroupName" : "remoteCopyGroup3", "copyPairName" : "pair1", "replicationType" : "GAD", "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup3,remoteCopyGroup3P_,remoteCopyGroup3S_,pair1", "quorumDiskId" : 14, "pvolLdevId" : 1580, "svolLdevId" : 2128, "fenceLevel" : "NEVER", "pvolStatus" : "PAIR", "svolStatus" : "PAIR", "pvolIOMode" : "L/M", "svolIOMode" : "L/M", "pvolStorageDeviceId" : "886000123456", "svolStorageDeviceId" : "886000123789" } ], "remoteStorageDeviceId" : "886000123789", "localDeviceGroupName" : "remoteCopyGroup3P_", "remoteDeviceGroupName" : "remoteCopyGroup3S_" }
Attribute
Type
Description
remoteStorageDeviceId
string
Storage device ID of the remote storage system
If you specify a value that includes NotSpecified for the object ID, NotSpecified is output.
copyGroupName
string
Copy group name
localDeviceGroupName
string
Device group name in the local storage system
remoteDeviceGroupName
string
Device group name in the remote storage system
If you specify a value that includes NotSpecified for the object ID, NotSpecified is output.
remoteMirrorCopyGroupId
string
Object ID of the remote copy group
The following attributes are output, separated by commas:
remoteStorageDeviceId
copyGroupName
localDeviceGroupName
remoteDeviceGroupName
copyPairs
object[]
The detailed information about the copy pair is output.
- copyGroupName
(string)
Copy group name
- copyPairName
(string)
Copy pair name
- replicationType
(string)
Pair type
- TC: TrueCopy
- UR: Universal Replicator
- GAD: global-active device
If the pair status is SMPL, information is not output.
- pvolLdevId
(int)
LDEV number of P-VOL
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.
- svolLdevId
(int)
LDEV number of S-VOL
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.
- fenceLevel
(string)
Fence level
- DATA: S-VOL data
- STATUS: S-VOL status
- NEVER: None
- ASYNC: Asynchronous
If the fence level cannot be obtained, information is not output.
- pvolJournalId (int)
Journal ID of the P-VOL
A value from 0 to 255 is output only in the case of Universal Replicator. If the pair status is SMPL, information is not output.
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.
- svolJournalId (int)
Journal ID of the S-VOL
A value from 0 to 255 is output only in the case of Universal Replicator. If the pair status is SMPL, information is not output.
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.
- quorumDiskId
(int)
ID of the Quorum disk
A value from 0 to 31 is output only in the case of global-active device. If the pair status is SMPL, information is not output.
- pvolStatus (string)
Pair status of the P-VOL
For details, see the section explaining on pair status (TrueCopy and Universal Replicator) or pair status (global-active device).
If the pair status cannot be obtained, information is not output.
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.
- svolStatus (string)
Pair status of the S-VOL
For details, see the section explaining on pair status (TrueCopy and Universal Replicator) or pair status (global-active device).
If the pair status cannot be obtained, information is not output.
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.
- consistencyGroupId
(int)
Consistency group ID
If no consistency group consists, information is not output.
- pvolIOMode
(string)
I/O mode of the P-VOL
- L/M: Mirror (RL)
- L/L: Local
- B/B: Block
Information is output only in the case of global-active device. If the pair status is SMPL, information is not output.
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.
- svolIOMode
(string)
I/O mode of the S-VOL
- L/M: Mirror (RL)
- L/L: Local
- B/B: Block
Information is output only in the case of global-active device. If the pair status is SMPL, information is not output.
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.
- pvolStorageDeviceId
(string)
Storage device ID of the storage system on the P-VOL
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.
- svolStorageDeviceId
(string)
Storage device ID of the storage system on the S-VOL
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.
- copyProgressRate
(int)
Copy progress rate
Information is output only when the pair status of the P-VOL is COPY (a pair is being created or resynchronized).
This attribute is not output if you specify a value that includes NotSpecified for the object ID.
- remoteMirrorCopyPairId
(string)
Object ID of the remote copy pair#
The following attributes are output, separated by commas:
remoteStorageDeviceId
copyGroupName
localDeviceGroupName
remoteDeviceGroupName
copyPairName
#: We recommend that you save the object ID information you obtain in case a failure occurs. When you need to perform a takeover to recover the system, you can use the saved information to identify the pair that you need to work on, even if you cannot get information about the failed storage system.
If you run this request with class specified for
detailInfoType
in the query parameters, additional information from the storage system's cache is also obtained.Type
Attribute
Description
object[]
copyPairs
Attributes related to the detailed information about the copy pair
-
transitionStatus (string)
The transition status of a pair is output for a Universal Replicator pair.
- None: The pair is not in transition.
- Suspending: The pair is being split.
- Deleting: The pair is being deleted.
This is not output if the copy pair is not a Universal Replicator pair.
-
copyPace (int)
Copy speed
This is not output for a Universal Replicator pair.
-
pathGroupId (int)
ID of the RCU path group
This is not output if CU is specified for the remote path connection setting.
This is not output if the pair volume status of the P-VOL or S-VOL (the value of the
pvolStatus
attribute of thesvolStatus
attribute) isSMPL
. -
deltaStatus (string)
Status of the 3DC multi-target configuration that uses delta resync
This is output if the value of replicationType for the copyPairs attribute of the replicationType attribute, which is the pair type for the detailed information about the remote copy pairs, is Universal Replicator, and if you are using a 3DC multi-target configuration that uses delta resync.
- HOLD: Universal Replicator delta resync pair (normal)
- HLDE: Universal Replicator delta resync pair (failed)
- HOLDING: In the process of being changed to a Universal Replicator delta resync pair
For details on the status codes of the request for this operation, see the description on HTTP status codes.
For TrueCopy:
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-copygroups/886000123789,remoteCopyGroup1,remoteCopyGroup1P_,remoteCopyGroup1S_
For Universal Replicator:
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-copygroups/886000123789,remoteCopyGroup2,remoteCopyGroup2P_,remoteCopyGroup2S_
For global-active device:
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-copygroups/886000123789,remoteCopyGroup3,remoteCopyGroup3P_,remoteCopyGroup3S_
Getting information about a specific remote copy pair
Storage Administrator (View Only)
GET base-URL/v1/objects/remote-mirror-copypairs/object-ID
Object ID
Specify the value of
remoteMirrorCopyPairId
that was obtained by the processing to get information about the remote copy group. 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 #
Specify a decimal (base 10) number equal to or greater than 0.
copyGroupName
string
(Required) Copy group name
Specify a character string consisting of 1 to 31 characters. The name is case sensitive.
localDeviceGroupName
string
(Required) Device group name in the local storage system
Specify a character string consisting of 1 to 31 characters. The name is case sensitive.
remoteDeviceGroupName
string
(Required) Device group name in the remote storage system #
Specify a character string 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.
#: If you specify NotSpecified in cases such as when a failure occurs in a remote storage system, only information about the local storage system can be acquired. If you specify NotSpecified, copy pair information about attributes of volumes that belong to the remote storage system will not be output. In this case, you do not need to specify the Remote-Authorization header.
Query parameters
None.
Body
None.
Body
The following is an example of the output when information about TrueCopy pairs is obtained:
{ "copyGroupName" : "remoteCopyGroup1", "copyPairName" : "pair1", "replicationType" : "TC", "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup1,remoteCopyGroup1P_,remoteCopyGroup1S_,pair1", "pvolLdevId" : 2108, "svolLdevId" : 1581, "fenceLevel" : "DATA", "pvolStatus" : "PAIR", "svolStatus" : "PAIR", "pvolStorageDeviceId" : "886000123456", "svolStorageDeviceId" : "886000123789" }
The following is an example of the output when information about Universal Replicator pairs is obtained:
{ "copyGroupName" : "remoteCopyGroup2", "copyPairName" : "pair1", "replicationType" : "UR", "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup2,remoteCopyGroup2P_,remoteCopyGroup2S_,pair1", "consistencyGroupId" : 10, "pvolLdevId" : 1569, "pvolJournalId" : 13, "svolLdevId" : 2835, "svolJournalId" : 36, "fenceLevel" : "ASYNC", "pvolStatus" : "PAIR", "svolStatus" : "PAIR", "pvolStorageDeviceId" : "886000123456", "svolStorageDeviceId" : "886000123789" }
The following is an example of the output when information about global-active device pairs is obtained:
{ "copyGroupName" : "remoteCopyGroup3", "copyPairName" : "pair1", "replicationType" : "GAD", "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup3,remoteCopyGroup3P_,remoteCopyGroup3S_,pair1", "quorumDiskId" : 14, "pvolLdevId" : 1580, "svolLdevId" : 2128, "fenceLevel" : "NEVER", "pvolStatus" : "PAIR", "svolStatus" : "PAIR", "pvolIOMode" : "L/M", "svolIOMode" : "L/M", "pvolStorageDeviceId" : "886000123456", "svolStorageDeviceId" : "886000123789" }
Attribute
Type
Description
copyGroupName
string
Copy group name
copyPairName
string
Copy pair name
replicationType
string
Pair type
- TC: TrueCopy
- UR: Universal Replicator
- GAD: global-active device
If the pair status is SMPL, information is not output.
pvolLdevId
int
LDEV number of P-VOL
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.
svolLdevId
int
LDEV number of S-VOL
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.
fenceLevel
string
Fence level
- DATA: S-VOL data
- STATUS: S-VOL status
- NEVER: None
- ASYNC: Asynchronous
If the fence level cannot be obtained, information is not output.
pvolJournalId
int
Journal ID of the P-VOL
A value from 0 to 255 is output only in the case of UR. If the pair status is SMPL, information is not output.
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.
svolJournalId
int
Journal ID of the S-VOL
A value from 0 to 255 is output only in the case of UR. If the pair status is SMPL, information is not output.
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.
quorumDiskId
int
ID of the Quorum disk
A value from 0 to 31 is output only in the case of global-active device. If the pair status is SMPL, information is not output.
pvolStatus
string
Pair status of the P-VOL
For details, see the section explaining on pair status (TrueCopy and Universal Replicator) or pair status (global-active device).
If the pair status cannot be obtained, information is not output.
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.
svolStatus
string
Pair status of the S-VOL
For details, see the section explaining on pair status (TrueCopy and Universal Replicator) or pair status (global-active device).
If the pair status cannot be obtained, information is not output.
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.
consistencyGroupId
int
Consistency group ID
If no consistency group consists, information is not output.
pvolIOMode
string
I/O mode of the P-VOL
- L/M: Mirror (RL)
- L/L: Local
- B/B: Block
Information is output only in the case of global-active device. If the pair status is SMPL, information is not output.
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.
svolIOMode
string
I/O mode of the S-VOL
- L/M: Mirror (RL)
- L/L: Local
- B/B: Block
Information is output only in the case of global-active device. If the pair status is SMPL, information is not output.
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.
pvolStorageDeviceId
string
Storage device ID of the storage system on the P-VOL
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.
svolStorageDeviceId
string
Storage device ID of the storage system on the S-VOL
If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.
copyProgressRate
int
Copy progress rate
Information is output only when the pair status of the P-VOL is COPY (a pair is being created or resynchronized).
This attribute is not output if you specify a value that includes NotSpecified for the object ID.
remoteMirrorCopyPairId
string
Object ID of the remote copy pair#
The following attributes are output, separated by commas:
remoteStorageDeviceId
copyGroupName
localDeviceGroupName
remoteDeviceGroupName
copyPairName
#: We recommend that you save the object ID information you obtain in case a failure occurs. When you need to perform a takeover to recover the system, you can use the saved information to identify the pair that you need to work on, even if you cannot get information about the failed storage system.
For details on the status codes of the request for this operation, see the description on HTTP status codes.
For TrueCopy:
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,remoteCopyGroup1,remoteCopyGroup1P_,remoteCopyGroup1S_,pair1
For Universal Replicator:
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,remoteCopyGroup2,remoteCopyGroup2P_,remoteCopyGroup2S_,pair1
For global-active device:
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,remoteCopyGroup3,remoteCopyGroup3P_,remoteCopyGroup3S_,pair1
Getting TrueCopy or Universal Replicator pair information
Administrator user group (built-in user group)
GET base-URL/v1/objects/remote-copypairs
Object ID
None.
Query parameters
Parameter
Type
Filter Condition
replicationType
string
(Required) Specify the pair type.
- TC: TrueCopy
- UR: Universal Replicator
headLdevId
int
(Optional) Specify, as a decimal (base 10) number, the number of the first LDEV for which you want to acquire information about the pair.
Specify a value in the range from 0 to 65279.
If this attribute is omitted, 0 is set.
count
int
(Optional) Specify the number of LDEVs about which information is to be obtained. Specify this by a decimal (base 10) number.
Specify a value in the range from 0 to 500.
If this attribute is omitted, 500 is set.
Body
None.
Body
{ "data" : [ { "replicationType" : "TC", "ldevId" : 49153, "remoteSerialNumber" : "10088", "remoteStorageTypeId" : "R9", "remoteLdevId" : 51712, "primaryOrSecondary" : "P-VOL", "muNumber" : 0, "status" : "PSUS", "serialNumber" : "10011", "storageTypeId" : "R9", "isMainframe" : false } ] }
Attribute
Type
Description
replicationType
string
Pair type
- TC: TrueCopy
- UR: Universal Replicator
ldevId
int
LDEV number of the volume on the local storage system.
remoteSerialNumber
string
Serial number of the remote storage system
remoteStorageTypeId
string
ID corresponding to the model of the remote storage system
-
R8: VSP G1000, VSP G1500, or VSP F1500
- R9: VSP 5000 series
-
M8: VSP Gx00 models or VSP Fx00 models
remoteLdevId
int
LDEV number of the volume on the remote storage system
primaryOrSecondary
string
Attribute of the volume on the local storage system
- P-VOL
- S-VOL
muNumber
int
MU number
status
string
Pair status of the volume on the local storage system
For details, see the section about pair status transition (TrueCopy and Universal Replicator).
serialNumber
string
Serial number of the local storage system
storageTypeId
string
ID indicating the model of the local storage system
- R9: VSP 5000 series
-
M8: VSP Gx00 models or VSP Fx00 models
isMainframe
boolean
Whether the pair is for mainframe use
- true: Pair for mainframe use
- false: Not a pair for mainframe use
For details on the status codes for the request that performs this operation, see the description of HTTP status codes.
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-copypairs?replicationType=TC
Creating a TrueCopy pair or Universal Replicator pair
Storage Administrator (Provisioning) and Storage Administrator (Remote Copy)
POST base-URL/v1/objects/remote-mirror-copypairs
Object ID
None.
Query parameters
None.
Body
The following are coding examples for creating a TrueCopy pair.
When creating a new copy group and adding a pair to the copy group:
{ "copyGroupName": "remoteCopyGroup1", "copyPairName": "pair1", "replicationType": "TC", "remoteStorageDeviceId": "886000123789", "pvolLdevId": 2108, "svolLdevId": 1581, "localDeviceGroupName": "remoteCopyGroup1P_", "remoteDeviceGroupName": "remoteCopyGroup1S_", "isNewGroupCreation": true, "fenceLevel": "DATA", "isConsistencyGroup": true, "consistencyGroupId": 5, "copyPace": 10, "pathGroupId": 3, "doInitialCopy": true, "isDataReductionForceCopy": true }
When adding a pair to an existing copy group:
{ "copyGroupName": "remoteCopyGroup1", "copyPairName": "pair2", "replicationType": "TC", "remoteStorageDeviceId": "886000123789", "pvolLdevId": 2109, "svolLdevId": 1582, "localDeviceGroupName": "remoteCopyGroup1P_", "remoteDeviceGroupName": "remoteCopyGroup1S_", "isNewGroupCreation": false, "fenceLevel": "DATA", "isConsistencyGroup": true, "consistencyGroupId": 5, "copyPace": 10, "doInitialCopy": true, "isDataReductionForceCopy": false }
The following table describes attributes for a TrueCopy pair.
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.
TC: TrueCopy
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 with a decimal (base 10) 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. If this value is omitted, copyGroupNameP_ is set. The name needs to be unique in the local storage system.
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. If this value is omitted, copyGroupNameS_ is set. The name needs to be unique in the remote storage system.
isNewGroupCreation
boolean
(Required) Depending on the value, this attribute specifies whether to add the pair to a newly created copy group or to an existing copy group.
- true: Adds the pair to a newly created copy group.
- false: Adds the pair to an existing copy group.
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 set.
consistencyGroupId
int
(Optional) Specify the consistency group ID by using a decimal (base 10) number in the range from 0 to 255.
If you omit this value when registering the new pair in a consistency group, the value of the consistency group ID 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
(Required) Fence level
The specifiable values are as follows:
- DATA: S-VOL data
- STATUS: S-VOL status
- NEVER: None
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 the volume for which the capacity saving function (dedupe and compression) is enabled.
- true: Forcibly create a pair #
- false: Do not forcibly create a pair
When the attribute is omitted, false is assumed.
#: Copying data of the volume for which the capacity saving function (compression or deduplication) is enabled might take up to several months, depending on the amount of data. Be sure to take this into account when planning when to create such a pair.
The following are coding examples for creating a Universal Replicator pair.
When creating a new copy group and adding a pair to the copy group:
{ "copyGroupName": "remoteCopyGroup2", "copyPairName": "pair1", "replicationType": "UR", "remoteStorageDeviceId": "886000123789", "pvolLdevId": 1569, "svolLdevId": 2835, "pvolJournalId": 13, "svolJournalId": 36, "localDeviceGroupName": "remoteCopyGroup2P_", "remoteDeviceGroupName": "remoteCopyGroup2S_", "isNewGroupCreation": true, "fenceLevel": "ASYNC", "muNumber": 0, "consistencyGroupId": 10, "doInitialCopy": true, "doDeltaResyncSuspend": false, "isDataReductionForceCopy": true }
When adding a pair to an existing copy group:
{ "copyGroupName": "remoteCopyGroup2", "copyPairName": "pair2", "replicationType": "UR", "remoteStorageDeviceId": "886000123789", "pvolLdevId": 1570, "svolLdevId": 2836, "localDeviceGroupName": "remoteCopyGroup2P_", "remoteDeviceGroupName": "remoteCopyGroup2S_", "isNewGroupCreation": false, "fenceLevel": "ASYNC", "consistencyGroupId": 10, "doInitialCopy": true, "doDeltaResyncSuspend": false, "isDataReductionForceCopy": false }
The following table describes attributes for a Universal Replicator pair.
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.
UR: Universal Replicator
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 with a decimal (base 10) 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 of 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. If this value is omitted, copyGroupNameP_ is set. The name needs to be unique in the local storage system.
remoteDeviceGroupName
string
(Optional) Specify the device group name of 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. If this value is omitted, copyGroupNameS_ is set. The name needs to be unique in the remote storage system.
isNewGroupCreation
boolean
(Required) Depending on the value, this attribute specifies whether to add the pair to a newly created copy group or to an existing copy group.
- true: Adds the pair to a newly created 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 newly created copy group.
pvolJournalId
int
(Required) Specify the journal ID of the P-VOL by using a decimal (base 10) number in the range from 0 to 255.
Make sure to specify this attribute if you add the pair to a newly created copy group.
svolJournalId
int
(Required) Specify the journal ID of the S-VOL by using a decimal (base 10) number in the range from 0 to 255.
Make sure to specify this attribute if you add the pair to a newly created copy group.
consistencyGroupId
int
(Optional) Specify the consistency group ID by using a decimal (base 10) number in the range from 0 to 255.
If you omit this value when adding the pair to a newly created copy group, the value of the consistency group ID 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.
fenceLevel
string
(Optional) Fence level
ASYNC is automatically set.
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 the volume for which the capacity saving function (dedupe and compression) is enabled.
- true: Forcibly create a pair #
- false: Do not forcibly create a pair
When the attribute is omitted, false is assumed.
doDeltaResyncSuspend
boolean
(Optional) For the 3DC multi-target configuration, specify whether to use delta resync between the storage systems of the secondary sites.
- true: Uses delta resync.
- false: Does not use delta resync.
If true is specified, a journal volume of the Universal Replicator pair to be used for delta resync will be created in the initial status without initial copy performed. If this value is omitted, false is set.
#: Copying data of the volume for which the capacity saving function (compression or deduplication) is enabled might take up to several months, depending on the amount of data. Be sure to take this into account when planning when to create such a pair.
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 created TrueCopy pairs or Universal Replicator pairs
For details on the status codes of the request for this operation, see the description on HTTP status codes.
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
Splitting TrueCopy pairs or Universal Replicator pairs in units of copy groups
Storage Administrator (Remote Copy)
POST base-URL/v1/objects/remote-mirror-copygroups/object-ID/actions/split/invoke
Object ID
Specify the value of
remoteMirrorCopyGroupId
that was obtained by the processing to get information about the remote copy group. You can also specify the attributes and connect them with commas as follows:remoteStorageDeviceId,copyGroupName,localDeviceGroupName,remoteDeviceGroupName
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.
Query parameters
None.
Body
The following is a coding example for simply splitting pairs:
{ "parameters": { "replicationType": "TC" } }
The following is a coding example for splitting pairs by specifying the S-VOL, and forcibly changing the status of the pairs of the S-VOL to SSWS:
{ "parameters": { "replicationType": "UR", "svolOperationMode": "SSWS" } }
The following is a TrueCopy coding example for splitting pairs and prohibiting write operations for the P-VOL:
{ "parameters": { "replicationType": "TC", "doPvolWriteProtect": true } }
The following is a Universal Replicator coding example for splitting pairs and forcibly stopping operations on a journal volume:
{ "parameters": { "replicationType": "UR", "doDataSuspend": true } }
Attribute
Type
Description
replicationType
string
(Required) Specify the pair type.
- TC: TrueCopy
- UR: Universal Replicator
svolAccessMode
string
(Optional) Specify the access mode for the S-VOL after pairs are split.
- r: Read only
- rw: Read and write
If the value is not specified, r will be set.
If you specify this attribute, you cannot specify the
svolOperationMode
attribute. In the case of TC, you cannot specify true for thedoPvolWriteProtect
attribute. In the case of UR, you cannot specify true for thedoDataSuspend
attribute.svolOperationMode
string
(Optional) Specify this attribute to forcibly change the status of the pairs of the S-VOL in cases such as if a failure occurs in the storage system of the primary site. Issue a request from the storage system of the secondary site.
- SSWS: Change to SSWS mode.
- PSUS: Change to PSUS (PSUE or PSUS) mode.
If you specify this attribute, you cannot specify the
svolAccessMode
attribute. In the case of TC, you cannot specify true for thedoPvolWriteProtect
attribute. In the case of UR, you cannot specify true for thedoDataSuspend
attribute.doPvolWriteProtect
boolean
(Optional) In the case of TC, specify whether to forcibly disable write operations for the P-VOL. Issue a request from the storage system of the secondary site.
- true: Disable write operations for P-VOL.
- false: Do not disable write operations for P-VOL.
If the value is not specified, false will be set.
If you specify true for this attribute, you cannot specify the
svolAccessMode
andsvolOperationMode
attributes.doDataSuspend
boolean
(Optional) In the case of UR, specify whether to forcibly stop operations on a journal when the amount of access to the journal increases. Issue a request from the storage system of the primary site.
- true: Forcibly stop operations on the journal.
Data is not copied to the group on the S-VOL. The data of the master journal volume and the restore journal volume is deleted.
- false: Do not forcibly stop operations on the journal.
If the value is not specified, false will be set.
If you specify true for this attribute, you cannot specify the
svolOperationMode
attribute. However, you can specify only rw for thesvolAccessMode
attribute.
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 copy group of the split TrueCopy pairs or Universal Replicator pairs
GET base-URL/v1/objects/remote-mirror-copygroups/object-ID/actions/split
This action template returns only the specifiable attributes, depending on the following: the type of the pairs of the copy group specified for the object ID, and whether the volume in the copy group of the local storage system is the primary volume or the secondary volume.
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 pairs of the specified copy group cannot be performed. |
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-copygroups/886000123789,remoteCopyGroup,remoteCopyGroupP_,remoteCopyGroupS_/actions/split
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-copygroups/886000123456,remoteCopyGroup,remoteCopyGroupS_,remoteCopyGroupP_/actions/split
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-copygroups/886000123789,remoteCopyGroup,remoteCopyGroupP_,remoteCopyGroupS_/actions/split/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-copygroups/886000123456,remoteCopyGroup,remoteCopyGroupS_,remoteCopyGroupP_/actions/split/invoke
Splitting a TrueCopy pair or Universal Replicator pair
Storage Administrator (Remote Copy)
POST base-URL/v1/objects/remote-mirror-copypairs/object-ID/actions/split/invoke
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 of 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 splitting pairs:
{ "parameters": { "replicationType": "UR" } }
The following is a coding example for splitting a pair and permitting write operations for the S-VOL:
{ "parameters": { "replicationType": "TC", "svolAccessMode": "rw" } }
The following is a coding example for splitting a pair by specifying the S-VOL, and forcibly changing the status of the pair of the S-VOL:
{ "parameters": { "replicationType": "TC", "svolOperationMode": "PSUS" } }
Attribute
Type
Description
replicationType
string
(Required) Specify the pair type.
- TC: TrueCopy
- UR: Universal Replicator
svolAccessMode
string
(Optional) Specify the access mode for the S-VOL after pairs are split.
- r: Read only
- rw: Read and write
If the value is not specified, r will be set.
If you specify this attribute, you cannot specify the
svolOperationMode
attribute. In the case of TC, you cannot specify true for thedoPvolWriteProtect
attribute. In the case of UR, you cannot specify true for thedoDataSuspend
attribute.svolOperationMode
string
(Optional) Specify this attribute to forcibly change the status of the pairs of the S-VOL in cases such as if a failure occurs in the storage system of the primary site. Issue a request from the storage system of the secondary site.
- SSWS: Change to SSWS mode.
- PSUS: Change to PSUS (PSUE or PSUS) mode.
If you specify this attribute, you cannot specify the
svolAccessMode
attribute. In the case of TC, you cannot specify true for thedoPvolWriteProtect
attribute. In the case of UR, you cannot specify true for thedoDataSuspend
attribute.doPvolWriteProtect
boolean
(Optional) In the case of TC, specify whether to forcibly disable write operations for the P-VOL. Issue a request from the storage system of the secondary site.
- true: Disable write operations for P-VOL.
- false: Do not disable write operations for P-VOL.
If the value is not specified, false will be set.
If you specify true for this attribute, you cannot specify the
svolAccessMode
andsvolOperationMode
attributes.doDataSuspend
boolean
(Optional) In the case of UR, specify whether to forcibly stop operations on a journal when the amount of access to the journal increases. Issue a request from the storage system of the primary site.
- true: Forcibly stop operations on the journal.
Data is not copied to the S-VOL. The data of the master journal volume and the restore journal volume is deleted.
- false: Do not forcibly stop operations on the journal.
If the value is not specified, false will be set.
If you specify true for this attribute, you cannot specify the
svolOperationMode
attribute. However, you can specify only rw for thesvolAccessMode
attribute.
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 split TrueCopy pairs or Universal Replicator pairs
GET base-URL/v1/objects/remote-mirror-copypairs/object-ID/actions/split
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.
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. |
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/split
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/split
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/split/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/split/invoke
Resynchronizing TrueCopy pairs or Universal Replicator pairs in units of copy groups
If the model of either or both of the storage systems is 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.
Storage Administrator (Remote Copy)
POST base-URL/v1/objects/remote-mirror-copygroups/object-ID/actions/resync/invoke
Object ID
Specify the value of
remoteMirrorCopyGroupId
that was obtained by the processing to get information about the remote copy group. You can also specify the attributes and connect them with commas as follows:remoteStorageDeviceId,copyGroupName,localDeviceGroupName,remoteDeviceGroupName
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.
Query parameters
None.
Body
The following is a coding example for simply resynchronizing pairs:
{ "parameters": { "replicationType": "TC" } }
The following is a coding example for resynchronizing pairs by specifying the MU (mirror unit) number of the copy group to be failed back:
{ "parameters": { "replicationType": "UR", "doFailback": true, "failbackMuNumber": 1 } }
The following is a coding example for reversing and resynchronizing pairs by specifying the P-VOL:
{ "parameters": { "replicationType": "UR", "doSwapPvol": true } }
The following is a TrueCopy coding example for newly registering the specified copy group in a consistency group and resynchronizing pairs:
{ "parameters": { "replicationType": "TC", "fenceLevel": "STATUS", "isConsistencyGroup": true, "consistencyGroupId": 123 } }
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
anddoSwapPvol
attributes. In the case of TC, you cannot specify thefenceLevel
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
anddoFailback
attributes. In the case of TC, you also cannot specify thefenceLevel
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
anddoFailback
attributes. In the case of TC, you also cannot specify thefenceLevel
attribute.isConsistencyGroup
boolean
(Optional) In the case of TC, specify the value as follows according to whether the copy group is registered in a consistency group:
- If the copy group is not registered
in a consistency group
- true: Registers the copy group in a consistency group. #
- false: Leaves the copy group as it is without registering it in a consistency group.
- If the copy group is registered in a
consistency group
- true: Leaves the copy group registered in a consistency group.
- false: Cancels the registration of the copy group in a consistency group, and places it in an unregistered state.
If the value is not specified, false will be set. To leave the copy group registered in a consistency group, be sure to specify true for this attribute. If this attribute is omitted, the registration of the copy group in a consistency group is canceled.
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 copy group is already registered in a consistency group.
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, make 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
, anddoSwapPvol
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 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.
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 copy group of the resynchronized TrueCopy pairs or Universal Replicator pairs
GET base-URL/v1/objects/remote-mirror-copygroups/object-ID/actions/resync
This action template returns only the specifiable attributes depending on the following: the type of the pairs of the copy group specified for the object ID, and whether the volume in the copy group of the local storage system is the primary volume or the secondary volume.
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 pairs of the specified copy group cannot be performed. |
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-copygroups/886000123789,remoteCopyGroup,remoteCopyGroupP_,remoteCopyGroupS_/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-copygroups/886000123456,remoteCopyGroup,remoteCopyGroupS_,remoteCopyGroupP_/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-copygroups/886000123789,remoteCopyGroup,remoteCopyGroupP_,remoteCopyGroupS_/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-copygroups/886000123456,remoteCopyGroup,remoteCopyGroupS_,remoteCopyGroupP_/actions/resync/invoke
Resynchronizing a TrueCopy pair or Universal Replicator pair
If the model of either or both of the storage systems is 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.
Storage Administrator (Remote Copy)
POST base-URL/v1/objects/remote-mirror-copypairs/object-ID/actions/resync/invoke
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
anddoSwapPvol
attributes. In the case of TC, you cannot specify thefenceLevel
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
anddoFailback
attributes. In the case of TC, you also cannot specify thefenceLevel
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
anddoFailback
attributes. In the case of TC, you also cannot specify thefenceLevel
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. If this attribute is omitted, the registration of the pair in a consistency group is canceled.
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, make 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
, anddoSwapPvol
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 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.
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
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.
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. |
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
Deleting TrueCopy pairs or Universal Replicator pairs in units of copy groups
Storage Administrator (Provisioning) and Storage Administrator (Remote Copy)
DELETE base-URL/v1/objects/remote-mirror-copygroups/object-ID
Object ID
Specify the value of
remoteMirrorCopyGroupId
that was obtained by the processing to get information about the remote copy group. You can also specify the attributes and connect them with commas as follows:remoteStorageDeviceId,copyGroupName,localDeviceGroupName,remoteDeviceGroupName
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.
Query parameters
None.
Body
None.
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 copy group of the deleted TrueCopy pairs or Universal Replicator pairs
For details on the status codes of the request for this operation, see the description on HTTP status codes.
curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X DELETE --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copygroups/886000123789,remoteCopyGroup,remoteCopyGroupP_,remoteCopyGroupS_
Deleting a TrueCopy pair or Universal Replicator pair
Storage Administrator (Provisioning) and Storage Administrator (Remote Copy)
DELETE base-URL/v1/objects/remote-mirror-copypairs/object-ID
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
None.
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 deleted TrueCopy pairs or Universal Replicator pairs
For details on the status codes of the request for this operation, see the description on HTTP status codes.
curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X DELETE --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123789,remoteCopyGroup,remoteCopyGroupP_,remoteCopyGroupS_,pair1
Enabling volumes at the secondary site to take over work in units of copy groups
- Valid targets are Universal Replicator pairs that are not in a cascade configuration.
- When running this API request, you do not need to specify Remote-Authorization for the request header.
- If you specify Job-Mode-Wait-Configuration-Change:NoWait for the request header, specify forceSplit for mode in the request body. When these are specified, the value specified for timeout is ignored.
Storage Administrator (Remote Copy)
POST base-URL/v1/objects/remote-mirror-copygroups/object-ID/actions/takeover/invoke
Object ID
Specify the
remoteMirrorCopyGroupId
value obtained by getting information about the remote copy group. You can also specify the attributes separated by commas as follows:remoteStorageDeviceId,copyGroupName,localDeviceGroupName,remoteDeviceGroupName
Attribute
Type
Description
remoteStorageDeviceId
string
(Required) Storage device ID of the remote storage system
For this API request, specify NotSpecified.
copyGroupName
string
(Required) Copy group name
Specify a character string of 1 to 31 characters. The name is case sensitive.
localDeviceGroupName
string
(Required) Device group name at the local storage system
Specify a character string of 1 to 31 characters. The name is case sensitive.
remoteDeviceGroupName
string
(Required) Device group name at the remote storage system
For this API request, specify NotSpecified.
Query parameters
None.
Body
{ "parameters": { "mode": "auto" } }
Attribute
Type
Description
mode
string
(Required) Execution mode at takeover
After the P-VOL and the S-VOL are switched, the pair is in a split status (SSWS) and writable. For the subsequent transition of the pair status, specify one of the following values:
- forceSplit: Does not change from the status in which the pair is split (SSWS).
- auto: Resynchronize the pair if possible according to the status of the storage system.
If you specify Job-Mode-Wait-Configuration-Change:NoWait for the request header, specify forceSplit.
timeout
int
(Optional) Timeout period for waiting for completion of synchronization of differential data (seconds)
Specify the timeout time for the processing that synchronizes the differential data with the S-VOL if the journal contains differential data.
Specify a value in the range from 1 to 10000.
If you do not specify a value, 7200 is assumed.
If you specify Job-Mode-Wait-Configuration-Change:NoWait for the request header, the value specified for this attribute is ignored.
If the synchronization of the pairs does not finish within the specified time, the REST API job fails. However, on the storage system, the synchronization processing and the splitting processing after the synchronization is completed continue to be performed. To check whether the synchronization of the pairs has finished, obtain the information about the target pairs.
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 copy group of the Universal Replicator pairs that were switched
None.
For details on the status codes of the request for this operation, see the description on HTTP status codes.
curl -v -H "Accept: application/json" -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-copygroups/NotSpecified,copyGroup,localDeviceGroup,NotSpecified/actions/takeover/invoke
Enabling volumes at the secondary site to take over work in units of copy pairs
- Valid targets are Universal Replicator pairs that are not in a cascade configuration.
- When running this API request, you do not need to specify Remote-Authorization for the request header.
- If you specify Job-Mode-Wait-Configuration-Change:NoWait for the request header, specify forceSplit for mode in the request body. When these are specified, the value specified for timeout is ignored.
Storage Administrator (Remote Copy)
POST base-URL/v1/objects/remote-mirror-copypairs/object-ID/actions/takeover/invoke
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
For this API request, specify NotSpecified.
copyGroupName
string
(Required) Copy group name
Specify a character string of 1 to 31 characters. The name is case sensitive.
localDeviceGroupName
string
(Required) Device group name at the local storage system
Specify a character string of 1 to 31 characters. The name is case sensitive.
remoteDeviceGroupName
string
(Required) Device group name at the remote storage system
For this API request, specify NotSpecified.
copyPairName
string
(Required) Copy pair name
Specify a name consisting of 1 to 31 characters. The name is case sensitive.
Query parameters
None.
Body
{ "parameters": { "mode": "auto" } }
Attribute
Type
Description
mode
string
(Required) Execution mode at takeover
After the P-VOL and the S-VOL are switched, the pair is in a split status (SSWS) and writable. For the subsequent transition of the pair status, specify one of the following values:
- forceSplit: Does not change from the status in which the pair is split (SSWS).
- auto: Resynchronize the pair if possible according to the status of the storage system.
If you specify Job-Mode-Wait-Configuration-Change:NoWait for the request header, specify forceSplit.
timeout
int
(Optional) Timeout period for waiting for completion of synchronization of differential data (seconds)
Specify the timeout time for the processing that synchronizes the differential data with the S-VOL if the journal contains differential data.
Specify a value in the range from 1 to 10000.
If you do not specify a value, 7200 is assumed.
If you specify Job-Mode-Wait-Configuration-Change:NoWait for the request header, the value specified for this attribute is ignored.
If the synchronization of the pairs does not finish within the specified time, the REST API job fails. However, on the storage system, the synchronization processing and the splitting processing after the synchronization is completed continue to be performed. To check whether the synchronization of the pairs has finished, obtain the information about the target pairs.
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 copy group of the Universal Replicator pairs that were switched
None.
For details on the status codes of the request for this operation, see the description on HTTP status codes.
curl -v -H "Accept: application/json" -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/NotSpecified,copyGroup,localDeviceGroup,NotSpecified,pair/actions/takeover/invoke