Modifying Thin Provisioning Pool Settings

PATCH /tpp/{tpp_id}

Introduction

Modifies the specified Thin Provisioning Pool settings.

Caution

Tenant users cannot execute this command.

Request Examples

  • This is an example of enabling Deduplication for a Thin Provisioning Pool with a Thin Provisioning Pool ID of 5.

    $ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X PATCH "https://192.168.1.1:5665/api/v1/tpp/5"
    -d
    '{"is_deduplication_enabled" : true}'

Response Examples

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

Parameters

PATH PARAMETERS

tpp_id

(required)

integer

Thin Provisioning Pool ID.

REQUEST BODY

new_name

string

Friendly Name of the Thin Provisioning Pool.

Input criteria:

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

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

  • You cannot use a name that already exists.

warning_threshold

integer

Warning threshold.

The unit is %.

If the Thin Provisioning Pool utilization (percentage of used capacity to the total physical capacity) exceeds this threshold, the usage transitions to Warning.

Input criteria:

  • The allowed values are 5 to 99.

  • A value that is less than or equal to the Attention threshold cannot be set.

attention_threshold

integer

Attention threshold.

The unit is %.

If the Thin Provisioning Pool utilization (percentage of used capacity to the total physical capacity) exceeds this threshold, the usage transitions to Attention.

If this item is set to 0, the Attention threshold is not set.

Input criteria:

  • The allowed values are 5 to 80.

  • A value that is larger than or equal to the Warning threshold cannot be set.

is_deduplication_enabled

boolean

Whether to enable Deduplication.

If true, a Deduplication-enabled Volume can be created in this TPP.

Input criteria:

  • Available only when the Data Reduction feature of the device is enabled.

  • This item cannot be specified for the ETERNUS DX8900 S6/DX900 S6.

  • If you cannot secure the resources required to create a Data Container Volume, you cannot enable Deduplication.
    • You need at least 4GB of free space in TPP.

    • The initial logical capacity of the Data Container volume is 32 TB.
      • If the total logical capacity of TPV, FTV, and Data Container Volumes present in the device exceeds the Max Pool Capacity, a Data Container Volume cannot be created.

  • You cannot enable Deduplication if:
    • The maximum number of Thin Provisioning Pools for which you can enable Data Reduction has been reached.

    • Compression is enabled.

    • Eco Schedule is set.

    • Thin Provisioning Pool Status is abnormal.

  • You cannot disable Deduplication if:
    • Thin Provisioning Pool Status is abnormal.

    • A Volume with Data Reduction enabled exists.

    • Compression is enabled and is_compression_enable is not set to false.

    • The Data Container Volume state is abnormal.

is_compression_enabled

boolean

Whether to enable Compression.

If true, a Compression-enabled Volume can be created in this TPP.

Input criteria:

  • Available only when the Data Reduction feature of the device is enabled.

  • If you cannot secure the resources required to create a Data Container Volume, you cannot enable Deduplication.
    • You need at least 4GB of free space in TPP.

    • The initial logical capacity of the Data Container volume is 32 TB.
      • If the total logical capacity of TPV, FTV, and Data Container Volumes present in the device exceeds the Max Pool Capacity, a Data Container Volume cannot be created.

  • You cannot enable Compression for the following.

    • The maximum number of Thin Provisioning Pools for which you can enable Data Reduction has been reached.

    • Deduplication is enabled.

    • Eco Schedule is set.

    • Thin Provisioning Pool Status is abnormal.

  • You cannot disable Compression for the following.

    • A Volume with Data Reduction enabled exists.

    • Deduplication is enabled and is_deduplication_enable is not set to false.

    • The Data Reduction function is abnormal.

    • The Data Container Volume state is abnormal.

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.