Changing the volume 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 sets the label for the specified volume, tier relocation of HDT volumes, and whether page reservations are enabled for DP volumes.

Execution permission

Storage Administrator (Provisioning)

Request line

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

Request message

Object ID

Specify the value of ldevId that was obtained by the processing to get information about volumes.

Attribute

Type

Description

ldevId

int

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

Query parameters
None.
Body

The following shows an example of code for changing the label for a volume:

{
  "label": "REST_API_10GVolume"
}

The following shows an example of code for setting tier relocation and the new page assignment tier:

{
  "isRelocationEnabled": true,
  "tierLevelForNewPageAllocation": "L"
}

The following shows an example of code for setting the tiering policy (already defined):

{
  "tieringPolicy": {
    "tierLevel": 2
  }
}

The following shows an example of code for setting the tiering policy (custom policy):

{
  "tieringPolicy": {
    "tierLevel": 23,
    "tier1AllocationRateMin": 20,
    "tier1AllocationRateMax": 40,
    "tier3AllocationRateMin": 10,
    "tier3AllocationRateMax": 40
  }
}

The following shows an example of code for enabling the page reservation setting:

{
  "isFullAllocationEnabled": true
}

The following shows an example of code for enabling the capacity saving function (dedupe and compression):

{
  "dataReductionMode": "compression_deduplication"
}

Attribute

Type

Description

label

string

(Optional) Label to be set for the volume

Specify a label consisting of 0 to 32 characters. You can use the following characters.
  • Alphanumeric characters
  • The following symbols:

    ! # $ % & ' ( ) + , - . : = @ [ ] ^ _ ` { } ~ / \

    You can specify a hyphen as the first character of the value.

  • Spaces

    The label cannot start or end with a space.

dataReductionMode

string

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

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

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)#1

The values are not case sensitive.

If this attribute is changed from disabled to compression or compression_deduplication, the following applicable value is set by default for the dataReductionProcessMode attribute (the capacity-saving mode).
  • inline

If you change this attribute from disabled to 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.

dataReductionProcessMode

string

(Optional) Specify the capacity-saving mode.

  • post_process: Post-process mode
  • inline: Inline mode

This attribute can be specified when the capacity saving function is enabled.

This attribute cannot be specified at the same time as any other attribute.

isCompressionAccelerationEnabled

boolean

(Optional) Specify whether to enable the compression accelerator of the capacity saving function (dedupe and compression).#2

  • true: Enable
  • false: Disable

This attribute can be specified when the capacity saving function is enabled.

This attribute cannot be specified at the same time as any other attribute.

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

isRelocationEnabled

boolean

(Optional) Specify whether to enable the tier relocation setting for the HDT volume.

  • true : Enable the tier relocation.
  • false : Disable the tier relocation.

tieringPolicy

object

Specify the tiering policy to be assigned to the HDT volume.

Specifying this attribute automatically enables tier relocations for the HDT volume.

If you specify false for the isRelocationEnabled attribute, you cannot specify this attribute.

  • (Optional) tierLevel (int)

    Level of the tiering policy

    If you specify the tiering policy, you must specify this setting.

    Specify a value from 0 to 31.

    • 0: All tiers are used for relocations.
    • 1 to 5: Relocations are performed by following the tiering policy (levels 1 to 5).
    • 6 to 31: Relocations are performed by following the tiering policy (custom policy).

    When an HDT volume is created, 0 is set.

If you specify a custom policy of 6 to 31 for the tierLevel attribute, you can also specify the percentage of pages to be allocated to each tier.#3

There are four attributes for specifying the percentage. If you specify these attributes, you must specify all of them. Specify a value from 1 to 100.#4

You can specify the following attributes:

  • (Optional) tier1AllocationRateMin (int)

    From among the total capacity of the pages to be allocated when tier relocation is performed, the minimum rate (%) of the capacity to be relocated to tier 1

  • (Optional) tier1AllocationRateMax (int)

    From among the total capacity of the pages to be allocated when tier relocation is performed, the maximum rate (%) of the capacity to be relocated to tier 1

  • (Optional) tier3AllocationRateMin (int)

    From among the total capacity of the pages to be allocated when tier relocation is performed, the minimum rate (%) of the capacity to be relocated to tier 3

  • (Optional) tier3AllocationRateMax (int)

    From among the total capacity of the pages to be allocated when tier relocation is performed, the maximum rate (%) of the capacity to be relocated to tier 3

tierLevelForNewPageAllocation

string

(Optional) Specify which tier of the HDT pool will be prioritized when a new page is allocated.

The type is not case sensitive.

  • H: Higher-level tier (High)
  • M: Middle-level tier (Middle)
  • L: Lower-level tier (Low)

When an HDT volume is created, M is set.

isFullAllocationEnabled

boolean

(Optional) Specify whether to reserve pages of the pool associated with the DP volume by using the Full Allocation functionality.

  • true: Enable the page reservation setting.
  • false: Disable the page reservation setting.

When a DP volume is created, false is set.

isAluaEnabled

boolean

(Optional) Specify whether to enable the ALUA attribute.

You can specify this attribute for a volume used for a global-active device in a cross-path configuration (using a Fibre Channel connection).

  • true: Enable the ALUA attribute.
  • false: Disable the ALUA attribute.

#1: If the data of the volume has been deduplicated, disabling the capacity saving function might take time. For details about the task to disable the capacity saving function, see the Provisioning Guide for Open Systems, or the Provisioning Guide. In addition, use the status of the target resource rather than the status of the job to check whether the settings have been changed.

#2: After the settings of the compression accelerator of the capacity saving function are changed, data conversion processing is performed. This data conversion processing takes time. Thus, if you want to change the settings of the compression accelerator, we recommend that you do so in a planned manner. For details, see the Provisioning Guide for Open Systems, or the Provisioning Guide. In addition, to check the progress of the data conversion processing of a volume, run the API for getting volume information, and then check the values of the isCompressionAccelerationEnabled and dataReductionStatus attributes.

#3: If you do not specify the percentage, the values stored in the storage system are set.

#4: If you specify the value of each attribute, make sure that the value meets the following conditions:
  • The value of the tier1AllocationRateMin attribute is equal to or less than the value of the tier1AllocationRateMax attribute.
  • The value of the tier3AllocationRateMin attribute is equal to or less than the value of the tier3AllocationRateMax attribute.
  • The sum of the values of the tier1AllocationRateMin and tier3AllocationRateMin attributes is equal to or less than 100.
  • The difference between the values of the tier1AllocationRateMax and tier1AllocationRateMin attributes is a multiple of 10.
  • The difference between the values of the tier3AllocationRateMax and tier3AllocationRateMin attributes is a multiple of 10.

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 volume whose settings were changed

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 PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/ldevs/100