Enabling volumes at the secondary site to take over work 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
If a failure occurs at the primary site, the following request switches the roles between the primary volumes and the secondary volumes of Universal Replicator pairs (in units of copy groups) to enable data to be written in the secondary volumes so that work can be taken over and continued at the secondary site. This API request runs on the storage system of the secondary site.
Note:
  • 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.

Execution permission

Storage Administrator (Remote Copy)

Request line

POST base-URL/v1/objects/remote-mirror-copygroups/object-ID/actions/takeover/invoke

Request message

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.

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 Universal Replicator pairs that were switched

Action template

None.

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

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