Changing pool settings

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 changes the pool name, pool type, attributes related to an HDT pool tier, and other settings.

Execution permission

Storage Administrator (Provisioning)

Request line

PATCH base-URL/v1/objects/pools/object-ID

Request message

Object ID
Specify the value of poolId that was obtained by the processing to get information about pools.

Attribute

Type

Description

poolId

int

(Required) Pool number

Query parameters
None.
Body

The following coding example changes the warning threshold and depletion threshold of a DP pool,:

{
  "warningThreshold": 75,
  "depletionThreshold": 85
}

The following coding example sets the attributes related to a specific tier of an HDT pool:

{
  "tier": {
    "tierNumber": 1,
    "tablespaceRate": 30,
    "bufferRate": 30
  }
}

Attribute

Type

Description

poolName

string

(Optional) Pool name

Specify the pool name by using 1 to 32 characters.

poolType

string

(Optional) Changes the pool type

You can specify the following values:

  • HDP: Changes to an HDP pool

    You cannot specify this value for pools for active flash.

  • HDT: Changes to an HDT pool

    You cannot specify this value for HDP pools for which Thin Image pairs have been created.

  • RT: Changes to a pool for active flash

    You cannot specify this value for HDP pools.

You cannot specify this attribute for Thin Image pools or for data direct mapping HDP pools.

warningThreshold

int

(Optional) New warning threshold (%)

Depending on the pool type, specify the following values:

  • For DP pools: 1 to 100

    Specify this attribute together with the depletionThreshold attribute.

  • For Thin Image pools: 20 to 95

You cannot specify this value for data direct mapping HDP pools.

depletionThreshold

int

(Optional) New depletion threshold (%)

Specify a value in the range from 1 to 100.

For DP pools, specify this attribute together with the warningThreshold attribute.

You cannot specify this value for Thin Image pools or for data direct mapping HDP pools.

suspendSnapshot

boolean

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

You can specify this attribute for HDP pools that contain 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.

virtualVolumeCapacityRate

int

(Optional) The subscription limit of a virtual volume to pool capacity (%)

You can use this attribute for VSP 5000 series, VSP E series.

Specify a value in the range from 0 to 65534. If you specify -1, the subscription limit is unlimited.

You cannot specify this value for Thin Image pools.

blockingMode

string

(Optional) Setting the protection function for a virtual volume

If a DP pool is full or a DP pool volume is blocked, specify whether it is possible to perform read and write operations for a DP volume that uses the target DP pool.

  • PF: Pool Full

    If the DP pool is full, read and write operations are not possible.

    If the DP pool volume is blocked, read and write operations are possible.

  • PB: Pool vol Blockade

    If the DP pool volume is blocked, read and write operations are not possible.

    If the DP pool is full, read and write operations are possible.

  • FB: Full or Blockade

    If the DP pool is full or the DP pool volume is blocked, read and write operations are not possible.

  • NB: No Blocking

    Even if the DP pool is full or the DP pool volume is blocked, read and write operations are possible for the target DP volume.

You cannot specify this value for Thin Image pools.

tier

object

(Optional) HDT pool tier attribute

  • tierNumber (int)

    Tier number

    Specify a number from 1 to 3. This must be specified if you want to change the tablespaceRate attribute or the bufferRate attribute.

  • tablespaceRate (int)

    Ratio of free space for new tiering (in percentage)

    Specify a value from 0 to 50. If you specify this attribute, you must also specify the tierNumber attribute.

  • bufferRate (int)

    Ratio of buffer areas for reallocation (in percentage)

    Specify a value from 2 to 40. If you specify this attribute, you must also specify the tierNumber attribute.

monitoringMode

string

(Optional) Execution mode for performance monitoring (monitor mode)

If the pool type is HDT, the following values can be specified:

  • PM: Periodic mode (Period Mode)
  • CM: Continuous mode (Continuous Mode)

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the description on job objects.

Attribute

Description

affectedResources

URL of the pool whose settings were changed

Action template

None.

Status codes

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

Status code

Message

Description

409

Conflict

The specified pool name already exists.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/pools/88