Creating a Thin Provisioning Pool

POST /tpp

Introduction

Creates a new Thin Provisioning Pool.

Caution
  • You cannot create a Thin Provisioning Pool in any of the following conditions.

    • The Thin Provisioning function is not enabled.

    • The sum of the physical capacities of Thin Provisioning Pools and Flexible Tier Pools exceeds the Maximum Pool Capacity.

    • The maximum number of Thin Provisioning Pools for the device have been created.

    • The device does not have enough resources (RAID Groups, Volumes, etc.) to create a Thin Provisioning Pool.

  • You can find the Href of the created Thin Provisioning Pool in resource_href_list of GET /job/{job_id}.

  • Tenant users cannot execute this command.

Request Examples

  • This is an example of creating a RAID 5 Thin Provisioning Pool.

    $ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X POST "https://192.168.1.1:5665/api/v1/tpp"
    -d
    '{"name" : "tpp_raid5","level" : "RAID5","raidgroup_list": [{   "drive_id_list": ["0000","0100","0200,"0300"]},{   "drive_id_list": ["0001","0101","0201","0301"]}]
    }'
  • This is an example of creating a RAID 6 Thin Provisioning Pool.

    $ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X POST "https://192.168.1.1:5665/api/v1/tpp"
    -d
    '{  "name" : "tpp_raid6fr","level" : "RAID6FR" ,"raidgroup_list" : [{    "drive_id_list" : ["0000","0001","0102","0103","0204","0205","0306","0307","0408","0409","0510","0511","0612"]}],"raid6fr_configuration_priority" : "capacity"}'
  • This is an example of creating a RAID 5 Thin Provisioning Pool using the Drive Auto-Selection feature.

    $ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X POST "https://192.168.1.1:5665/api/v1/tpp"
    -d
    '{"name" : "tpp_raid5","level" : "RAID5","is_auto_drive_selection": true,"drive_type" : "SSD","minimum_capacity" : 307200}'

Response Examples

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

Parameters

REQUEST BODY

name

(required)

string

Thin Provisioning Pool name.

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 Thin Provisioning Pool name that already exists.

level

(required)

string

The RAID Level of the RAID Groups that configure the Thin Provisioning Pool.
Items Description
RAID0 Striping
RAID1 Mirroring
RAID5 High Capacity
RAID6 High Reliability
RAID10 High Performance
RAID6FR RAID6 (Fast Recovery)
warning_threshold

integer

Default: 90

Warning threshold.

The unit is %.

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

Input criteria:

  • The range of allowed values is 5 to 99.

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

attention_threshold

integer

Default: 75

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 will transition to Attention.

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

Input criteria:

  • The range of allowed values is 5 to 80.

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

is_cm_encryption_enabled

boolean

Default: false

Encryption via CM.

If true, the data in the Thin Provisioning Pool is encrypted by the CM.

Input criteria:

  • This item cannot be specified if the Drive configuring the Thin Provisioning Pool is a SAS HDD SED, SAS SSD SED, or NVMe SSD SED.

  • This setting can be specified only when the encryption mode of the device is enabled.

is_compression_disabled

boolean

Default: false

Whether Compression is disabled.

If true, the data in the TPP will not be compressed.

Input criteria:

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

is_deduplication_disabled

boolean

Default: false

Whether Deduplication is disabled.

If true, the data in the TPP will not be deduplicated.

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.

is_auto_drive_selection

boolean

Default: false

Whether the system automatically determines which drives comprise the Thin Provisioning Pool.

If true, the Drive will be automatically selected to create a Thin Provisioning Pool.

Input criteria:

  • If true, drive_type and minimum_capacity must be specified.

    The raidgroup_list cannot be specified.

  • If false, raidgroup_list must be specified.

    You cannot specify drive_type and minimum_capacity.

Caution

For automatic drive selection, a TPP is created without distinguishing between AF compatible and non-AF compatible drives. If both drives are used, select Drives manually.

raidgroup_list

Array of objects

Input criteria:

  • You can specify up to 5 values.

drive_id_list

Array of strings

ID of the drive that configures the RAID Group.

Input criteria:

  • The format of the Drive ID is as follows:.
    • Drive in CE w0yy
      • w - Hexadecimal CE ID (0 to b)

      • yy - Hexadecimal Slot ID (00 to 17)

    • Drive in DE xxyy
      • xx - Hexadecimal DE ID (00 to ff)

      • yy - Hexadecimal Slot ID (00 to 17)

  • You cannot specify a Drive that does not exist.

  • The number of drives you can specify is as follows:.

    Indicates D: Data, M: Mirror, and P: Parity.

    • RAID10 : 4 (2D+2M), 8 (4D+4M), 16 (8D+8M), 24 (12D+12M)

    • RAID5 : 4 (3D+1P), 5 (4D+1P), 7 (6D+1P), 8 (7D+1P), 9 (8D+1P), 13 (12D+1P)

    • RAID6 : 6 (4D+2P), 8 (6D+2P), 9 (7D+2P), 10 (8D+2P)

    • RAID6FR : 13 ((4D+2P)x2+1HS), 17 ((6D+2P)x2+1HS), 31 ((8D+2P)x3+1HS or (4D+2P)x5+1HS))

    • RAID1 : 2 (1D+1M)

    • RAID0 : 4 (4D)

  • The drives in a RAID Group must be the same type. However, you can only mix Online Drives and Nearline Drives.

  • The RAID Groups that comprise the same Thin Provisioning Pool must have the same number of Member Drives.

  • For the ETERNUS DX 8900 S6, the following conditions must be met for Drive location.

    RAID Level Restriction
    RAID1

    You cannot specify more than half of the drives in a RAID Group within the same DE.

    RAID10

    You cannot specify more than half of the drives in a RAID Group within the same DE.

    RAID5 You cannot specify two or more Drives in the same DE.
    RAID6, RAID6FR You cannot specify three or more Drives in the same DE.
  • If the RAID Level is 10 or 5, you cannot select a Drive that has a capacity of 6 TB or larger.

assigned_cm

string

Default: "Automatically selected."

ID of the CM assigned to the RAID Group.

Specifies the CM assigned to the RAID Group.

It is usually determined automatically to distribute the load per CM, so no specification is required.

Specify this value if you want a specific CM to be the assigned CM.

To use CE#0-CM#0, specify "00"; or to use CE#a-CM#1, specify "a1".

If there is only one CE, it is assumed to be CE#0.

Input criteria:

  • You cannot specify a CM that does not exist.

  • A CM in an abnormal state cannot be specified.

raid6fr_configuration_priority

string

RAID 6-FR Drive configuration priority.
Items Description
capacity The space efficiency takes precedence in determining the Drive configuration
rebuild The Rebuild speed takes precedence in determining the Drive configuration.

Input criteria:

  • It must be specified if all of the following conditions are met.

    • RAID Level is RAID 6FR.

    • One of the following conditions is satisfied.

      • is_auto_drive_selection is true.

      • The number of Drives specified in drive_id_list is 31.

  • If the above conditions are not met, it cannot be specified.

drive_type

string

The type of Drive to be selected when Drives are automatically selected.

Required if is_auto_drive_selection is true.
Items Description
Online Online HDD
Nearline Nearline HDD
SSD SAS SSD
NVMe_SSD NVMe SSD
Online_SED Online HDD SED
Nearline_SED Nearline HDD SED
SSD_SED SAS SSD SED
NVMe_SSD_SED NVMe SSD SED

Input criteria:

  • Cannot be set unless is_auto_drive_selection is true.

minimum_capacity

integer

Minimum capacity of Thin Provisioning Pool.

The unit is MB.

When selecting Drive automatically, determine the Drive configuration that meets the minimum amount of space set in this item.

Required if is_auto_drive_selection is true.

Input criteria:

  • The range of allowed values is 24 to 50331648.

  • Cannot be set unless is_auto_drive_selection is true.

  • The expansion operation will fail if there are not enough unused drives on the device.

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.