Modifying Volume Settings

PATCH /volume/{volume_id}

Introduction

Modifies the specified Volume setting.

Caution

  • You cannot specify more than one setting item to modify.

  • Even if the Job for a setting change is Success, the Volume setting may not be modified in the following cases:

    • If you specify a Volume that is not a target to be set (example: setting a Data Container Volume as a Thick Provisioned Volume)

    • Processing such as Data Migration or Zero Reclamation is in progress

    • For tenant users, only the settings of Volumes that belong to the tenant of the current user can be changed.

Request Examples

  • This is an example of renaming Volume ID 3300002 to "sample#02". 
    $ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X PATCH "https://192.168.1.1:5665/api/v1/volume/3300002"
-d
'{"new_name":"sample#02"}'

Response Examples

{
  "job_id": 8192001,
  "job_href": "/api/v1/job/8192001"
}

Parameters

PATH PARAMETERS

volume_id

(required)

integer

Volume ID.

REQUEST BODY

new_name

string

Volume name.

Input criteria:

  • The available number of characters allowed is 1 to 32.

  • Acceptable characters are single byte alphanumeric characters. However, "," and "?" are excluded.

  • You cannot use a Volume name that already exists.

  • The following Volume names are not allowed:

    • Volume name starting with "$VVOL_META".

    • Volume name starting with "$DATA_CNTNR".

    • Volume name starting with "$SYSVOL".
is_exc_enabled

boolean

Extreme Cache Pool configuration.

If true, Extreme Cache Pool is used when the relevant Volume is accessed.

Input criteria:

  • You may specify this item only if the device's or Extreme Cache Pool is enabled.

  • If the Thin Provisioning Pool or RAID Group to which the Volume belongs is configured with an SAS SSD or NVMe SSD, this item cannot be specified.

  • You cannot specify this item if Data Reduction is enabled for the Volume.
alua

string

ALUA (Asymmetric Logical Unit Access) setting.

Specify this item if you want to change the Access Path control to a Volume unit.
Item Description
Follow_Host_Response Follow the Host Response settings.
ACTIVE_ACTIVE ACTIVE/ACTIVE response.
ACTIVE-ACTIVE_PREFERRED_PATH ACTIVE-ACTIVE/PREFERRED PATH response.

Input criteria:

  • This item cannot be set if a Mapping cannot be created for the Volume (Usage is System, or Type is VVOL, ODX Volume, SDPV, or Temporary Volume).
is_thick_provisioned

boolean

Whether the allocation method is Thick.

If true, the volume is allocated physical space of its capacity.

If false, the unused physical space is freed when you perform the volume capacity optimization after executing this API.

Input criteria:

  • This setting can be specified only when the Volume type is TPV or FTV.

  • For TPVs with Data Reduction enabled, the setting cannot be modified.

  • For Volumes whose Usage is System, the setting cannot be modified.

  • If the unused capacity in the Thin Provisioning Pool to which the Volume belongs is less than the Volume Size, the change from Thin to Thick fails.

  • This item terminates with an error while the following operations are running on the volume.

    • RAID Migration

    • TPV/FTRP balancing

    • Capacity Optimization (Only when changing from Thin to Thick)

  • This function cannot be performed when the Status of the Thin Provisioning Pool or Flexible Tier Pool to which the Volume belongs is Broken.
attention

integer

The utilization threshold at which the host sense is reported.

The unit is %.

Input criteria:

  • The allowed values are 1 to 100.

  • This setting can be specified only when the Volume type is TPV or FTV.

Responses

If successful, the HTTP status code is 202 (Accepted) and the response body is returned.

RESPONSE BODY

job_id

integer

Job ID.
job_href

string

Resource link of the job.