Execution permission
Storage Administrator (Remote Copy)
Request line
POST base-URL/v1/objects/remote-mirror-copygroups/object-ID/actions/split/invoke
Request message
- 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.
- 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 the doPvolWriteProtect attribute. In the case of UR, you cannot specify true for the doDataSuspend 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 the doPvolWriteProtect attribute. In the case of UR, you cannot specify true for the doDataSuspend 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 and svolOperationMode 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 the svolAccessMode attribute.
Response message
Action template
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.
Status codes
The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the section explaining HTTP status codes.
Status code |
Message |
Description |
---|---|---|
412 |
Precondition Failed |
This status code indicates that operations on the pairs of the specified copy group cannot be performed. |
Coding example
To get an action template:
When the storage system of the P-VOL is specified:
curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-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