Creating a volume

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 volume by using the specified parity groups or pools. Specify a parity group for creating a basic volume, an external parity group (external volume group) for creating the external volume, and a pool for creating a virtual volume (a DP volume or a virtual volume for Thin Image).
Tip:

If you want to simultaneously execute multiple requests for creating DP volumes, we recommend that you execute the corresponding jobs in parallel by specifying true for the isParallelExecutionEnabled attribute. If you do not specify this setting, the jobs will be executed sequentially, which takes more time than parallel execution.

Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/v1/objects/ldevs

Request message

Object ID

None.

Query parameters

None.

Body

The following coding example creates an LDEV (basic volume) by specifying the parity group:

{
  "ldevId": 0,
  "parityGroupId": "1-1",
  "byteFormatCapacity": "1G"
}

The following coding example creates an external volume by specifying an external parity group:

{
  "ldevId": 3,
  "externalParityGroupId": "1-1",
  "byteFormatCapacity": "1G"
}

The following coding example creates a DP volume for which the capacity saving function (dedupe and compression) is enabled by specifying a pool:

{
  "ldevId": 1,
  "poolId": 0,
  "byteFormatCapacity": "1G",
  "dataReductionMode": "compression_deduplication"
}

Attribute

Type

Description

ldevId

int

(Optional) Specify an LDEV number that is not implemented with a decimal (base 10) number.

This attribute cannot be specified at the same time as the isParallelExecutionEnabled attribute.

If this attribute is omitted, the minimum LDEV number that is not implemented is assumed.

isParallelExecutionEnabled

boolean

(Optional) If you want to execute multiple requests at the same time, specify whether to execute the corresponding jobs in parallel.

You can specify this attribute only when you are creating DP volumes.

  • true: Execute jobs in parallel.
  • false: Do not execute jobs in parallel. (Execute jobs sequentially.)

If this attribute is omitted, the value false is assumed.

If you specify the ldevId attribute, parityGroupId attribute, or externalParityGroupId attribute, you cannot specify this attribute.

If you specify this attribute, an unused LDEV number is automatically assigned to the created LDEV.

If there are LDEV numbers that cannot be used, exclude those numbers by using the startLdevId and endLdevId attributes.

startLdevId

int

(Optional) The first LDEV number in the range of LDEV numbers to be automatically assigned, if such a range is specified

You can specify this attribute if the isParallelExecutionEnabled attribute is set to true. If you specify this attribute, you must also specify the endLdevId attribute. The value of this attribute must be smaller than that of the endLdevId attribute.

endLdevId

int

(Optional) The last LDEV number in the range of LDEV numbers to be automatically assigned, if such a range is specified

You can specify this attribute if the isParallelExecutionEnabled attribute is set to true. If you specify this attribute, you must also specify the startLdevId attribute. The value of this attribute must be greater than that of the startLdevId attribute.

parityGroupId

string

(Optional) Parity group number

Be sure to specify this attribute when creating an LDEV (basic volume).

Specify concatenated parity groups in the same way as the above.

If the concatenated parity groups are 1-3-1, 1-3-2, or 1-3-3, specify as follows:

"parityGroupId": "1-3"

If you specify the isParallelExecutionEnabled attribute, you cannot specify this attribute.

externalParityGroupId

string

(Optional) External parity group number

Be sure to specify this attribute when creating an external volume.

If you specify the isParallelExecutionEnabled attribute, you cannot specify this attribute.

poolId

int

(Optional) Pool number

Be sure to specify this item when creating a virtual volume from a pool.

  • To create a DP volume: For the DP pool number, specify a decimal (base 10) number equal to or greater than 0.

  • To create a virtual volume for Thin Image: Specify -1.

dataReductionMode

string

(Optional) Whether to enable the capacity saving function (dedupe and compression)

If you enable this attribute, a DP volume for which the capacity saving function (compression or deduplication) is enabled is created.

The specifiable values are as follows:

  • compression: Enable the capacity saving function (compression)
  • compression_deduplication: Enable the capacity saving function (compression and deduplication)
  • disabled: Disable the capacity saving function (compression and deduplication)

If you specify compression or compression_deduplication and the storage system is one for which a compression accelerator can be used, the capacity saving function that uses a compression accelerator will be automatically enabled.

The values are not case sensitive. If this attribute is omitted, disabled will be set.

isCompressionAccelerationEnabled

boolean

(Optional) Whether to enable the compression accelerator of the capacity saving function (dedupe and compression)

  • true: Enable
  • false: Disable

If you enable the capacity saving function and the storage system is one for which a compression accelerator can be used, the capacity saving function that uses a compression accelerator will be enabled even if you omit this attribute.

If you specify this attribute and simultaneously execute multiple requests, the corresponding jobs will be executed in parallel.

byteFormatCapacity

string

(Optional) Capacity of the volume to be created, and the unit of the capacity.

You must specify either this attribute or the blockCapacity attribute.

The following units can be specified:

  • T or t
  • G or g
  • M or m
  • K or k

To allocate all free space, specify "all".

The following is an example of specifying a capacity of 1 GB:

"byteFormatCapacity":"1G"

blockCapacity

long

(Optional) Capacity of the volume to be created in blocks (1 block = 512 bytes).

You must specify either this attribute or the byteFormatCapacity attribute.

The following is an example of specifying a capacity of 1 GB:

"blockCapacity":2097152

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 volume

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/ldevs