Creating a ShadowImage pair

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 creates a ShadowImage pair in the target storage system. The ShadowImage pair is either added to a newly created copy group or to an existing copy group.
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 (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": "localCopyGroup1",
  "copyPairName": "pair1",
  "replicationType": "SI",
  "pvolLdevId": 10,
  "pvolMuNumber": 0,
  "svolLdevId": 20,
  "pvolDeviceGroupName": "localCopyGroup1P_",
  "svolDeviceGroupName": "localCopyGroup1S_",
  "isNewGroupCreation": true,
  "copyPace": 1,
  "isConsistencyGroup": true,
  "consistencyGroupId": 1,
  "quickMode": false,
  "autoSplit": false,
  "isDataReductionForceCopy": true
}

Attribute

Type

Description

copyGroupName

string

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

copyPairName

string

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

replicationType

string

(Required) Specify SI (ShadowImage) as the pair type.

pvolLdevId

int

(Required) Specify the LDEV number of the P-VOL with a decimal (base 10) number.

svolLdevId

int

(Required) Specify the LDEV number of the S-VOL 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 ShadowImage 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 ShadowImage pair to an existing copy group, specify the device group name for an existing S-VOL.

If this value is omitted, copyGroupNameS_ is assumed.

isNewGroupCreation

boolean

(Required) Depending on the value, this attribute specifies whether to add a ShadowImage pair to a newly created copy group or to an existing copy group.

Make sure that the ShadowImage pair is not added to a copy group that includes Volume Migration pairs.

  • true: Adds the ShadowImage pair to a newly created copy group.
  • false: Adds the ShadowImage pair to an existing copy group.

pvolMuNumber

int

(Optional) Specify the MU number of the P-VOL.

If you specify true for the isNewGroupCreation attribute, make sure to specify this attribute. If you specify false for the isNewGroupCreation attribute, you cannot specify this attribute.

  • If the S-VOL is in layer 1, specify a value in the range from 0 to 2.
  • If the S-VOL is in layer 2, specify 1 or 2.

copyPace

int

(Optional) Specify a value in the range from 1 to 15 to be the copy speed. The larger the value, the higher the speed.

If this value is omitted, 3 is assumed.

isConsistencyGroup

boolean

(Optional) Depending on the value, this attribute specifies whether to register the new pair in a consistency group. If a pair that is already registered in the consistency group exists in the copy group, you can register the new pair in the same consistency group.

  • true: Registers the pair in a consistency group.
  • false: Does not register the pair in a consistency group.

When the value of the autoSplit attribute is true, you cannot specify true for this item.

If this value is omitted, false is assumed.

consistencyGroupId

int

(Optional) To register the new pair in the consistency group, specify the consistency group ID (0 to 127). If a pair is already registered in a consistency group in a copy group, specify the ID of the consistency group to which the existing pair belongs.

If you specify true for the isConsistencyGroup attribute and do not specify this attribute, a new consistency group ID is assigned.

autoSplit

boolean

(Optional) Depending on the value, this attribute specifies whether to split the pair automatically after the operation finishes.
  • true: Splits the pair after the operation finishes
  • false: Does not split the pair after the operation finishes

When the value of the isConsistencyGroup attribute is true, you cannot specify true for this item.

If this value is omitted, false is assumed.

quickMode

boolean

(Optional) Specify whether to run in quick mode.
  • true: Performs execution in quick mode.
  • false: Performs execution in normal mode.

You can specify true for this item only when the value of the autoSplit attribute is true.

If this value is omitted, false is assumed.

isDataReductionForceCopy

boolean

(Optional) Specify whether to forcibly create a pair for a volume for which the capacity saving function (dedupe and compression) is enabled.

When creating a pair for a volume for which the capacity saving function is enabled, always specify true.

  • true: Forcibly create a pair#
  • false: Do not forcibly create a pair

When the attribute is omitted, false is assumed.

#: If you create a pair by using volumes for which the capacity saving function (compression or deduplication) is enabled, data that has been compressed or deduplicated will be copied and, as a result, the performance of the copying processing or the I/O performance of the host might decrease.

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