Creating a pool

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 pools by specifying the LDEV. In the REST API, you can create DP pools and Thin Image pools. You can specify LDEVs by specifying LDEV numbers or a range of consecutive LDEV numbers.
Tip: If you want to store snapshot data in an HDP pool instead of a Thin Image pool, specify HDP for the poolType attribute when you create the pool.

Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/v1/objects/pools

Request message

Object ID

None.

Query parameters

None.

Body

The following coding example creates an HDP pool by specifying the LDEV number:

{
  "poolId": 76,
  "poolName": "pool_for_email_server",
  "ldevIds": [405],
  "poolType": "HDP"
}

The following coding example creates an HDP pool by specifying a range of consecutive LDEV numbers:

{
  "poolId": 76,
  "poolName": "pool_for_email_server",
  "startLdevId": 101,
  "endLdevId": 105,
  "poolType": "HDP"
}

When creating a DP pool:

Attribute

Type

Description

poolId

int

(Required) Specify the pool number with a decimal (base 10) number.

poolName

string

(Required) Pool name

Specify a character string consisting of 1 to 32 characters.

poolType

string

(Required) Pool type

The specifiable values are as follows:

  • HDP: HDP pools

  • HDT: HDT pools

ldevIds

int[]

(Optional) LDEV number

Specify a decimal (base 10) number.

Make sure to specify this attribute when specifying LDEV numbers.

You can specify up to 64 digits. This attribute cannot be specified along with the startLdevId and endLdevId attribute.

startLdevId

int

(Optional) The first LDEV number in the range of consecutive LDEV numbers, if such a range is specified

Make sure to specify this attribute when specifying a range of LDEV numbers.

If you specify this attribute, be sure to also specify the endLdevId attribute. The value of this attribute must be smaller than that of endLdevId.

Specify a number such that the range indicated by the startLdevId and endLdevId attributes consists of no more than 64 LDEVs.

This attribute cannot be specified along with the ldevIds attribute.

endLdevId

int

(Optional) The last LDEV number in the range of consecutive LDEV numbers, if such a range is specified

Make sure to specify this attribute when specifying a range of LDEV numbers.

If you specify this attribute, be sure to also specify the startLdevId attribute. The value of this attribute must be greater than that of startLdevId.

Specify a number such that the range indicated by the startLdevId and endLdevId attributes consists of no more than 64 LDEVs.

This attribute cannot be specified along with the ldevIds attribute.

warningThreshold

int

(Optional) Warning threshold (%)

Specify a value in the range from 1 to 100. Specify a value smaller than that of depletionThreshold. If this attribute is omitted, 70 is assumed.

depletionThreshold

int

(Optional) Depletion threshold (%)

Specify a value in the range from 1 to 100. Specify a value greater than the value of warningThreshold. If this attribute is omitted, 80 is assumed.

suspendSnapshot

boolean

(Optional) Specify whether to suspend Thin Image pairs when the depletion threshold is exceeded.

You can specify this attribute if the pool to be created is an HDP pool for storing snapshot data.

  • true: Suspend Thin Image pairs when the depletion threshold is exceeded.
  • false: Do not suspend Thin Image pairs when the depletion threshold is exceeded.

If you specify HDP for the poolType attribute and omit this attribute, true is assumed.

The following coding example creates a Thin Image pool:

{
  "poolId":76,
  "poolName":"pool_for_snapshot_copy",
  "ldevIds":[405],
  "poolType": "HTI"
}

When creating a Thin Image pool:

Attribute

Type

Description

poolId

int

(Required) Specify the pool number with a decimal (base 10) number.

poolName

string

(Required) Pool name

Specify a character string consisting of 1 to 32 characters.

poolType

string

(Required) Pool type

HTI: Thin Image pools

ldevIds

int[]

(Optional) LDEV number

Specify a decimal (base 10) number.

Make sure to specify this attribute when specifying LDEV numbers.

You can specify up to 64 digits. This attribute cannot be specified along with the startLdevId and endLdevId attribute.

startLdevId

int

(Optional) First LDEV number when specifying a range of consecutive LDEV numbers.

Make sure to specify this attribute when specifying a range of LDEV numbers.

If you specify this attribute, be sure to also specify the endLdevId attribute. The value of this attribute must be smaller than that of endLdevId.

Specify a number such that the range indicated by the startLdevId and endLdevId attributes consists of no more than 64 LDEVs.

This attribute cannot be specified along with the ldevIds attribute.

endLdevId

int

(Optional) Last LDEV number when specifying a range of consecutive LDEV numbers.

Make sure to specify this attribute when specifying a range of LDEV numbers.

If you specify this attribute, be sure to also specify the startLdevId attribute. The value of this attribute must be greater than that of startLdevId.

Specify a number such that the range indicated by the startLdevId and endLdevId attributes consists of no more than 64 LDEVs.

This attribute cannot be specified along with the ldevIds attribute.

warningThreshold

int

(Optional) Warning threshold (%)

Specify a value in the range from 20 to 95. If this attribute is omitted, 80 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 pool

Status codes

The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the description on HTTP status codes.

Status code

Message

Description

409

Conflict

A pool of the specified pool number has already been created.

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