Performing migration for an entire copy group

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 performs migration to copy the data in the source volume (P-VOL) to the target volume (S-VOL) for the entire specified copy group. When the copy operation is complete, the host switches from accessing the target volume to accessing the source volume.
Note:

After copying the data by successfully executing the API request for performing migration, execute the API request for deleting a pair to change the pair status of the source volume and the target volume to SMPL.

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 workflow for performing Volume Migration.

Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/v1/objects/local-clone-copygroups/object-ID/actions/migrate/invoke

Request message

Object ID

Specify the localCloneCopygroupId value obtained by getting the list of copy groups. You can also specify the following attributes and connect them with commas:

copyGroupName,pvolDeviceGroupName,svolDeviceGroupName

Attribute

Type

Description

copyGroupName

string

(Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.

pvolDeviceGroupName

string

(Required) Specify the P-VOL (source volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

svolDeviceGroupName

string

(Required) Specify the S-VOL (target volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

Query parameters

None.

Body

None.

Response message

Body
A job object is returned. See the description for the job object. affectedResources is not displayed for this API. To check whether the migration was successful, execute the API request for obtaining information about a copy group. The possible pair statuses are as follows:
  • If the migration was successful: PSUS
  • If the migration failed: PSUE

Action template

None.

Status codes

For details on the status codes of the API, 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 -d "" https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copygroups/vm-cg,dgp,dgs/actions/migrate/invoke