Creating a Thin Image 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 Thin Image pair in the specified snapshot group. After the pair is created, you can get snapshot data or clone the pair.

Execution permission

Storage Administrator (Local Copy)

Request line

POST base-URL/v1/objects/snapshots

Request message

Object ID

None.

Query parameters

None.

Body

The following is an example of coding used for creating a Thin Image pair.

If the secondary volume does not exist :

{
  "snapshotGroupName": "snapshotGroup",
  "snapshotPoolId": 13,
  "pvolLdevId": 100,
  "isConsistencyGroup": true,
  "autoSplit": true,
  "isDataReductionForceCopy": true
}

If the secondary volume exists:

{
  "snapshotGroupName": "snapshotGroup",
  "snapshotPoolId": 13,
  "pvolLdevId": 100,
  "svolLdevId": 101,
  "isConsistencyGroup": true,
  "autoSplit": true,
  "isDataReductionForceCopy": true
}

Attribute

Type

Description

snapshotGroupName

string

(Required) Specify the name of the snapshot group for which the Thin Image pair is to be created.

Specify a character string consisting of 1 to 32 characters. The name is case sensitive. If you specify a new group name, a snapshot group is also created at the same time.

snapshotPoolId

int

(Required) Specify the ID of the pool in which snapshot data is to be created.

Specify the ID of a Thin Image pool or an HDP pool by using a decimal (base 10) number equal to or greater than 0.

pvolLdevId

int

(Required) Specify the LDEV number of the P-VOL of the Thin Image pair to be created.

Specify a decimal (base 10) number equal to or greater than 0.

svolLdevId

int

(Optional) Specify the LDEV number of the S-VOL of the Thin Image pair to be created.

This item is required when true is specified for the isClone attribute.

If you specified true for the isClone attribute or the canCascade attribute, specify the LDEV number of the DP volume.

Specify a decimal (base 10) number equal to or greater than 0.

If you do not specify this item, a Thin Image pair that does not have the S-VOL will be created.

isConsistencyGroup

boolean

(Optional) Regarding the snapshot group for which the Thin Image pair is to be created, specify whether the snapshot group is to be created in the consistency group mode (CTG mode).

  • true: Creates the snapshot group in the CTG mode.
  • false: Does not create the snapshot group in the CTG mode.

If you do not specify this item, false will be set.

autoSplit

boolean

(Optional) Specify whether the Thin Image pair is to be split after it is created.
  • true: Splits the pair.
  • false: Does not split the pair.

If you specify true, the pair is split and snapshot data is stored.

If you specify true for this attribute, you cannot specify true for the isClone attribute.

If you do not specify this item, false will be set.

canCascade boolean
(Optional) Specify whether the pair can be cascaded.
  • true: The pair can be cascaded.
  • false: The pair cannot be cascaded.

If you specify true for the isClone attribute, also specify true for this attribute.

If you do not specify this item, the same value as for the isClone attribute will be set.

isClone boolean
(Optional) Specify whether to create a pair that has the clone attribute specified.
  • true: Creates a pair that has the clone attribute specified.
  • false: Creates a pair that does not have the clone attribute specified.

If you specify true for this attribute, do not specify the autoSplit attribute.

If you specify true for this attribute, specify true for the canCascade attribute.

If you do not specify this item, false will be set.

clonesAutomation boolean

(Optional) Specify whether the pair is to be cloned after the pair is created.

You can specify this item when true is specified for the isClone attribute.

  • true: Clones the pair.
  • false: Does not clone the pair.

If you do not specify this item, false will be set.

copySpeed string

(Optional) Specify the copy speed at which the created pair is to be cloned.

You can specify this item when true is specified for both the isClone attribute and the clonesAutomation attribute.

  • slower: Low speed
  • medium: Medium speed
  • faster: High speed

This item is not case sensitive.

If you do not specify this item, medium will be set.

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 for data reduplication volumes.#
  • false: Do not forcibly create a pair for data reduplication volumes.

If you do not specify this item, false will be set.

muNumber

int

(Optional) Specify the MU number of the P-VOL of the Thin Image pair to be created.

Specify a value in the range from 0 to 1023. You cannot specify a MU number that is already in use.

If you do not specify this item, an available MU number will be assigned.

#: 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. In addition, if false is specified for the autoSplit attribute, use the status of the target resource rather than the status of the job to check whether the pair has been created.

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 Thin Image 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/snapshots