Creating a pair to be used for Volume Migration

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

To perform migration by using the REST API, create a pair of volumes from the source volume (P-VOL) and the target volume (S-VOL). When the pair is created, the status of the pair is SMPL.

Execution permission

Storage Administrator (Provisioning) and Storage Administrator (Local Copy)

Request line

POST base-URL/v1/objects/local-clone-copypairs

Request message

Object ID: None.

Query parameters: None.

Body

{
  "copyGroupName": "vm-cg",
  "pvolDeviceGroupName": "dgp",
  "svolDeviceGroupName": "dgs",
  "copyPairName": "pair",
  "svolLdevId": 40970,
  "pvolLdevId": 40960,
  "replicationType": "SI",
  "copyMode": "NotSynchronized",
  "isNewGroupCreation": true
}

Attribute	Type	Description
copyGroupName	string	(Required) Specify the copy group name. Value should not exceed 29 characters. The name is case sensitive.
isNewGroupCreation	boolean	(Required) Depending on the value, this attribute specifies whether to add a pair to a newly created copy group or to an existing copy group. Make sure that the Volume Migration pair is not added to a copy group that includes ShadowImage pairs. `true`: Adds the pair to a newly created copy group. `false`: Adds the pair to an existing copy group.
copyPairName	string	(Required) Specify the pair name. Value should not exceed 31 characters. The name is case sensitive.
copyMode	string	(Required) Copy mode Specify `NotSynchronized`.
replicationType	string	(Required) Specify `SI`.
pvolLdevId	int	(Required) Specify the LDEV number of the P-VOL (source volume) with a decimal (base 10) number.
svolLdevId	int	(Required) Specify the LDEV number of the S-VOL (target volume) with a decimal (base 10) number.
pvolDeviceGroupName	string	(Optional) Specify the device group name for the P-VOL. Value should not exceed 31 characters. The name is case sensitive. Specify a device group name that differs from the device group name for the S-VOL. In addition, to add a pair to an existing copy group, specify the device group name for an existing P-VOL. If this value is omitted, `copyGroupNameP_` is assumed.
svolDeviceGroupName	string	(Optional) Specify the device group name for the S-VOL. Value should not exceed 31 characters. The name is case sensitive. Specify a device group name that differs from the device group name for the P-VOL. To add a pair to an existing copy group, specify the device group name for an existing S-VOL. If this value is omitted, `copyGroupNameS_` is assumed.

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 created pair

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/local-clone-copypairs