Suspending global-active device pairs in units of copy groups

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

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request suspends global-active device pairs by using the specified copy group. You can specify a copy group on the primary volume side to suspend pairs. Alternatively, you can specify a copy group on the secondary volume side to suspend pairs. If a copy group includes the primary volume and the secondary volume, you cannot specify the copy group to suspend pairs. Also, when suspending pairs by copy group, do not simultaneously perform other operations on the copy group or the pairs in that copy group on which a pair suspending operation is performed.
Tip: We recommend specifying Job-Mode-Wait-Configuration-Change:NoWait in the request header of this API function. For details, see the description of the flow of operations for the pairs.

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.

Query parameters

None.

Body

The following coding example is for simply suspending pairs. After pairs are suspended, I/O is continued on the P-VOL.

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

The following coding example is for suspending pairs by specifying the S-VOL. After pairs are suspended, I/O is continued on the S-VOL.

{
  "parameters": {
    "replicationType": "GAD",
    "svolOperationMode": "SSWS"
  }
}

Attribute

Type

Description

replicationType

string

(Required) Specify the pair type.

GAD: global-active device

svolOperationMode

string

(Optional) Specify the volume that continues I/O after pairs are suspended. Specify the following value.
  • SSWS: The S-VOL continues I/O.

    Specify the S-VOL to suspend a pair.

If this attribute is omitted, the P-VOL continues I/O. In this case, specify the P-VOL to suspend a pair.

Response message

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

Attribute

Description

affectedResources

URL of the copy group of the suspended global-active device pairs

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 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 object 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