Pool management
You can perform pool management operations such as create, delete, expand, monitor, restore, do tier relocation, and get volume information. A pool is a virtual area created by integrating multiple LDEVs. You can create virtual volumes from a pool, and then allocate or pair the volumes.
Overview of a pool
A pool is a virtual area created by integrating multiple LDEVs. You can create virtual volumes from a pool, and then allocate or pair the volumes.
You can create a virtual volume that has a capacity larger than that of the physical drive, and expand or reduce the size of a virtual volume as necessary. By doing so, you can effectively use the resources of a storage system and reduce the workload of adding and configuring drives. In addition, data is decentralized and stored on multiple drives by integrating multiple physical volumes, thereby improving drive operation efficiency.
HDP pools, HDT pools, and Thin Image pools are created in the REST API. In this manual, HDP pools and HDT pools are referred to as DP pools when differentiation is unnecessary.
The following is a list of operations that can be performed for pools by using the REST API.
- Create pools
Create DP pools or Thin Image pools by specifying LDEVs. You can also set a threshold value for the pool usage rate to be used for issuing a warning when that value is exceeded. Use DP pools to create virtual volumes, and use Thin Image pools to store snapshot data. You can also store snapshot data in HDP pools.
- Change pool settings
Change the pool type from the HDP pool to the HDT pool, change the threshold usage rate of the DP pool or the Thin Image pool, or change the subscription of a virtual volume to DP pool capacity.
- Expand pools
Expand capacity by adding LDEVs to DP pools or Thin Image pools.
- Shrink pools
Reduce capacity by deleting the LDEVs that compose the DP pools or Thin Image pools.
- Perform performance monitoring of HDT pools
Start or stop monitoring of HDT pools at a specific timing so that HDT pool data is appropriately located.
- Perform tier relocation for HDT pools
Based on the performance monitoring information, relocate HDT pool data to an appropriate tier.
- Restore pools
Unblock DP pools or Thin Image pools that have recovered from a failure or other problem.
- Delete pools
Delete DP pools or Thin Image pools that are no longer necessary.
- Get information about pools
Get information about DP pools or Thin Image pools.
You create pools during the procedure to allocate volumes or create Thin Image pairs. Perform other operations on pools according to the status of the pools.
For details on HDP (Dynamic Provisioning) and HDT (Dynamic Tiering), see the Provisioning Guide.
Getting pool information
The following request gets information items such as the pool status, the pool usage rate, and the pool threshold.
Storage Administrator (View Only)
GET base-URL/v1/objects/pools
Object ID
None.
Query parameters
Query parameters can be specified to filter the execution results by the specified condition and also collect additional detailed information about pools.
- When filtering execution results
Parameter
Type
Filter Condition
poolType
string
(Optional) The type of pools about which information will be obtained.
The specifiable types are as follows:
- DP: Information about DP pools is obtained.
- HTI: Information about Thin Image pools is obtained.
If this parameter is omitted, information about all pools will be obtained.
- When collecting additional detailed information
Parameter
Type
Description
detailInfoType
string
(Optional) Type of detailed information to be obtained
To specify multiple types, delimit the values by using commas.
- FMC
Detailed accelerated compression information of pools that consist of pool volumes belonging to the parity group of SSD(FMC) type drives is added.
- tierPhysicalCapacity
Additional detailed information about the physical capacity of the HDT pools in each tier is obtained.
The obtained information is added to the tiers attribute in the response body that is displayed.
- efficiency
Additional detailed information is obtained about the saving efficiency for consumption of capacity (total efficiency) achieved by using the functions for increasing the usage efficiency of a pool (namely, the capacity saving function (dedupe and compression), the accelerated compression function, the creation of backup data by using snapshots, and the virtualization of capacity by using Dynamic Provisioning).
- formattedCapacity
Additional detailed information is obtained about the size of the formatted capacity of the pool.
This parameter can be used in combination with the parameter to filter execution results.
- FMC
- When filtering execution results
Body
None.
Body
The following is an example of the output generated when getting HDP pool information:
{ "data" : [ { "poolId" : 5, "poolStatus" : "POLN", "usedCapacityRate" : 1, "usedPhysicalCapacityRate" : 1, "snapshotCount" : 0, "poolName" : "pool_5", "availableVolumeCapacity" : 32042850, "availablePhysicalVolumeCapacity" : 20006364, "totalPoolCapacity" : 32066496, "totalPhysicalCapacity" : 20009724, "numOfLdevs" : 11, "firstLdevId" : 2304, "warningThreshold" : 70, "depletionThreshold" : 80, "virtualVolumeCapacityRate" : -1, "isMainframe" : false, "isShrinking" : false, "locatedVolumeCount" : 13, "totalLocatedCapacity" : 79951368, "blockingMode" : "NB", "totalReservedCapacity" : 0, "reservedVolumeCount" : 0, "poolType" : "HDP", "duplicationLdevIds" : [ 65269, 65268, 65267, 65266, 65265, 65264, 65263, 65262 ], "duplicationNumber" : 8, "dataReductionAccelerateCompCapacity" : 206783585, "dataReductionCapacity" : 205901472, "dataReductionBeforeCapacity" : 210117216, "dataReductionAccelerateCompRate" : 87, "duplicationRate" : 42, "compressionRate" : 44, "dataReductionRate" : 97, "dataReductionAccelerateCompIncludingSystemData" : { "isReductionCapacityAvailable" : true, "reductionCapacity" : 228372480, "isReductionRateAvailable" : true, "reductionRate" : 97 }, "dataReductionIncludingSystemData" : { "isReductionCapacityAvailable" : true, "reductionCapacity" : 186826752, "isReductionRateAvailable" : true, "reductionRate" : 79 }, "snapshotUsedCapacity" : 0, "suspendSnapshot" : true, "capacitiesExcludingSystemData" : { "usedVirtualVolumeCapacity" : 235253760, "compressedCapacity" : 0, "dedupedCapacity" : 101035296, "reclaimedCapacity" : 129142560, "systemDataCapacity" : 43351104, "preUsedCapacity" : 234393600, "preCompressedCapacity" : 0, "preDedupredCapacity" : 105247408 } } ] }
For a DP pool:
Attribute
Type
Description
poolId
int
Object ID for the pool
poolName
string
Pool name
poolType
string
Pool type
- HDP: HDP pool
- HDT: HDT pool
- RT: active flash pool
- DM: Data Direct Mapping HDP pool
poolStatus
string
One of the following is output as the pool status:
- POLN: Normal (Pool Normal)
- POLF: The pool is in the overflow status exceeding the threshold. (Pool Full)
- POLS: The pool is in the overflow status exceeding the threshold and is suspended. (Pool Suspend)
- POLE: The pool is suspended in the
failure status. (Pool failure)
If the pool status is POLE, pool information cannot be obtained.
usedCapacityRate
int
Usage rate of logical capacity (%)
usedPhysicalCapacityRate
int
Usage rate of physical capacity (%)
availableVolumeCapacity
long
Free logical capacity (MB)
availablePhysicalVolumeCapacity
long
Free physical capacity (MB)
For this attribute, 1 MB is equal to 1,0242 bytes.
totalPoolCapacity
long
Total logical capacity (MB)
totalPhysicalCapacity
long
Total physical capacity (MB)
For this attribute, 1 MB is equal to 1,0242 bytes.
numOfLdevs
int
Number of LDEVs in the pool
firstLdevId
int
The first LDEV number of the LDEVs in the pool
warningThreshold
int
The warning threshold set for the pool
depletionThreshold
int
The depletion threshold set for the pool
suspendSnapshot
boolean
Whether to suspend Thin Image pairs when the depletion threshold is exceeded
- true: Thin Image pairs are suspended when the depletion threshold is exceeded.
- false: Thin Image pairs are not suspended when the depletion threshold is exceeded.
virtualVolumeCapacityRate
int
The maximum subscription limit of a virtual volume relative to pool capacity
- -1: Unlimited
isShrinking
boolean
Whether the pool is shrinking is output.
- true: The pool is shrinking.
- false: The pool is not shrinking.
locatedVolumeCount
int
Total number of DP volumes mapped to the pool
totalLocatedCapacity
long
Total capacity of the DP volumes mapped to the pool (MB)
The value of this attribute does not include the control area.
snapshotCount
int
Total number of snapshot data items mapped to the pool
snapshotUsedCapacity
long
Total size of snapshot data mapped to the pool (MB)
blockingMode
string
Setting the protection function for a virtual volume
When the DP pool is full or when the DP pool volume is blocked, whether the read and write operations can be performed for the DP volume that uses the target DP pool is output.
- 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.
totalReservedCapacity
long
Total capacity of the reserved page (MB) of the DP volume that is related to the DP pool
If the Full Allocation functionality is not supported by the configuration, this attribute is not output.
reservedVolumeCount
int
Number of volumes associated with the DP pool for which the page reservation setting is enabled
If the Full Allocation functionality is not supported by the configuration, this attribute is not output.
poolActionMode
string
Execution mode for the pool
- DEF: The mode in which the monitor is started or stopped by instructions from the REST API server, and the Tier range is specified by automatic calculation of the DKC.
- AUT: The mode in which the monitor is started or stopped at the specified time, and the Tier range is specified by automatic calculation of the DKC (specified by using Storage Navigator).
monitoringMode
string
Performance monitoring execution mode (monitor mode)
- PM: Period mode
- CM: Continuous mode
tierOperationStatus
string
Operation status of performance monitoring and tier relocation is output.
- STP: Performance monitoring and tier relocation are both stopped.
- RLC: Performance monitoring is stopped and tier relocation is operating.
- MON: Performance monitoring is operating and tier relocation is stopped.
- RLM: Performance monitoring and tier relocation are both operating.
dat
string
Status of monitor information
- VAL: Valid
- INV: Invalid
- PND: Pending calculation
tiers
object[]
The following attributes about HDT pool tiers are output for each tier.
- tierNumber (int)
Tier number
- tierLevelRange (string)
Lower limit of the tier
The value is output as the number of I/O operations per hour (IOPH).
- tierDeltaRange (string)
Delta value for the tier
The value is output as the number of I/O operations per hour (IOPH).
- tierUsedPhysicalCapacity (long)
Physical capacity used by the tier (MB)
This information is displayed if tierPhysicalCapacity is specified for the
detailInfoType
query parameter when the request is executed. - tierTotalPhysicalCapacity (long)
Total physical capacity of the tier (MB)
This information is displayed if tierPhysicalCapacity is specified for the
detailInfoType
query parameter when the request is executed. - tierUsedCapacity (long)
Logical capacity used by the tier (MB)
- tierTotalCapacity (long)
Total logical capacity of the tier (MB)
- tablespaceRate (int)
Rate of free space to be used for new allocation
- performanceRate (int)
Performance utilization
- progressOfReplacing (int)
Relocation progress rate
The progress rate of the following tier relocation operation is output as a value from 0 to 99.
- When
the value of the
tierOperationStatus
attribute is RLC or RLM: Progress rate of relocation (being run). - When
the value of the
tierOperationStatus
attribute is STP or MON: Progress rate of relocation (being suspended).
When tier relocation is not run or tier relocation is complete, 100 is output.
- When
the value of the
- bufferRate (int)
Buffer area rate for relocation
duplicationLdevIds
int[]
LDEV numbers of the deduplication system data volumes
duplicationNumber
int
Number of deduplication system data volumes
dataReductionAccelerateCompCapacity
long
Size (in blocks) of data reduction through the capacity saving function (dedupe and compression) or the accelerated compression function
The size of data after reduction does not include the size of metadata and garbage data generated by the storage system.
dataReductionCapacity
long
Size (in blocks) of data reduction through the capacity saving function (compression and deduplication)
The size of data after reduction does not include the size of metadata and garbage data generated by the storage system.
dataReductionBeforeCapacity
long
Size (in blocks) of data before data reduction was performed by using the capacity saving function (compression and deduplication)
dataReductionAccelerateCompRate
int
Percentage (%) of data on which data reduction has been performed by using the capacity saving function (compression and deduplication) or the accelerated compression function
The size of data after reduction does not include the size of metadata and garbage data generated by the storage system.
dataReductionRate
int
Percentage (%) of data on which data reduction has been performed by using the capacity saving function (compression and deduplication)
The size of data after reduction does not include the size of metadata and garbage data generated by the storage system.
dataReductionAccelerateCompIncludingSystemData
object
The attributes related to the size of data reduced by using the capacity saving function (compression and deduplication) or the accelerated compression function are displayed.
These attributes are calculated based on the size of the data (which includes, in addition to user data, metadata and garbage data generated by the storage system) after data reduction is performed.
-
isReductionCapacityAvailable (boolean)
Whether the size of the data can be reduced
-
true: The size of the data can be reduced.
If the value of this attribute is true, the size of the data that has been reduced is displayed for the
reductionCapacity
attribute. -
false: The size of the data cannot be reduced (for example, if the size of the data after data reduction is greater than the size of the data before data reduction).
-
-
reductionCapacity (long)
Size (in blocks) of the data that was reduced
This attribute is displayed when the value of the
isReductionCapacityAvailable
attribute is true. -
isReductionRateAvailable (boolean)
Whether the size of the data can be reduced
-
true: The size of the data can be reduced.
If the value of this attribute is true, the percentage by which the size of the data has been reduced is displayed for the
reductionRate
attribute. -
false: The size of the data cannot be reduced (for example, if the size of the data after data reduction is greater than the size of the data before data reduction).
-
-
reductionRate (int)
Percentage (%) by which the size of the data has been reduced
This attribute is displayed when the value of the
isReductionRateAvailable
attribute is true.
capacitiesExcludingSystemData
object
Attributes related to the capacity saving achieved by using the capacity saving function (dedupe and compression) are displayed.
-
usedVirtualVolumeCapacity (long)
The capacity (in blocks) used by virtual volumes
This does not include the capacity used by the system data volume for the dedupe function.
-
compressedCapacity (long)
The size (in blocks) of data reduced by using compression
This does not include the size of metadata and garbage data generated by the storage system.
-
dedupedCapacity (long)
The size (in blocks) of data reduced by using deduplication (dedupe)
This does not include the size of metadata and garbage data generated by the storage system.
-
reclaimedCapacity (long)
The size (in blocks) of data reduced by reclaiming the specified data pattern
This does not include the size of metadata and garbage data generated by the storage system.
-
systemDataCapacity (long)
The size (in blocks) of system data reduced
This includes the size of metadata and garbage data generated by the storage system.
-
preUsedCapacity (long)
The size (in blocks) of the data before data reduction was performed
-
preCompressedCapacity (long)
The size (in blocks) of the data before compression was performed
-
preDedupredCapacity (long)
The size (in blocks) of the data before dedupe was performed
compressionRate
int
Percentage (%) of data on which data reduction has been performed by using the compression function or the accelerated compression function
duplicationRate
int
Percentage (%) of data on which data reduction has been performed by using the deduplication function
isMainframe
boolean
Displays a pool for the mainframe or the open system
- true: Pool for the mainframe volume
- false: Pool for the open volume
The following is an example of the output generated when getting Thin Image pool information:
{ "data": [ { "poolId" : 35, "poolStatus" : "POLN", "usedCapacityRate" : 1, "usedPhysicalCapacityRate" : 1, "snapshotCount" : 2, "poolName" : "pool_35", "availableVolumeCapacity" : 46704, "availablePhysicalVolumeCapacity" : 46704, "totalPoolCapacity" : 46998, "totalPhysicalCapacity" : 46998, "numOfLdevs" : 1, "firstLdevId" : 18952, "warningThreshold" : 80, "virtualVolumeCapacityRate" : -1, "isMainframe" : false, "isShrinking" : false, "poolType" : "HTI", "capacitiesExcludingSystemData" : { "usedVirtualVolumeCapacity" : 602112 } } ] }
For a Thin Image pool:
Attribute
Type
Description
poolId
int
Object ID for the pool
poolName
string
Pool name
poolType
string
Pool type is output.
HTI: Thin Image pool
poolStatus
string
One of the following is output as the pool status:
- POLN: Normal (Pool Normal)
- POLF: The pool is in the overflow status exceeding the threshold. (Pool Full)
- POLS: The pool is in the overflow status exceeding the threshold and is suspended. (Pool Suspend)
- POLE: The pool is suspended in the
failure status. (Pool failure)
If the pool status is POLE, pool information cannot be obtained.
usedCapacityRate
int
Usage rate of logical capacity (%)
usedPhysicalCapacityRate
int
Usage rate of physical capacity (%)
snapshotCount
int
Number of volumes in the pool
availableVolumeCapacity
long
Free logical capacity (MB)
availablePhysicalVolumeCapacity
long
Free physical capacity (MB)
For this attribute, 1 MB is equal to 1,0242 bytes.
totalPoolCapacity
long
Total logical capacity (MB)
totalPhysicalCapacity
long
Total physical capacity (MB)
For this attribute, 1 MB is equal to 1,0242 bytes.
numOfLdevs
int
Number of LDEVs in the pool
firstLdevId
int
The first LDEV number of the LDEVs in the pool
(Not the first number in ascending order)
warningThreshold
int
The warning threshold set for the pool
virtualVolumeCapacityRate
int
The maximum subscription limit of a virtual volume relative to pool capacity
- -1: Unlimited
isShrinking
boolean
Whether the pool is shrinking is output.
- true: The pool is shrinking.
- false: The pool is not shrinking.
isMainframe
boolean
Displays a pool for the mainframe or the open system
- true: Pool for the mainframe volume
- false: Pool for the open volume
capacitiesExcludingSystemData
object
Attributes related to the saving efficiency for consumption of capacity are displayed.
-
usedVirtualVolumeCapacity (long)
The capacity (in blocks) used by virtual volumes
This does not include the capacity used by the system data volume used for the dedupe function.
The following example shows the output when the detailed information for accelerated compression is obtained:
{ "data" : [ { "poolId" : 40, "poolStatus" : "POLN", "usedCapacityRate" : 0, "usedPhysicalCapacityRate" : 0, "snapshotCount" : 0, "poolName" : "pool_40", "availableVolumeCapacity" : 46998, "availablePhysicalVolumeCapacity" : 46998, "usedPhysicalCapacity" : 0, "totalPoolCapacity" : 46998, "totalPhysicalCapacity" : 46998, "numOfLdevs" : 1, "firstLdevId" : 4095, "warningThreshold" : 70, "depletionThreshold" : 80, "virtualVolumeCapacityRate" : -1, "isMainframe" : false, "isShrinking" : false, "locatedVolumeCount" : 6, "totalLocatedCapacity" : 21672, "blockingMode" : "NB", "totalReservedCapacity" : 0, "reservedVolumeCount" : 0, "poolType" : "HDP", "duplicationNumber" : 0, "dataReductionAccelerateCompCapacity" : 0, "dataReductionCapacity" : 0, "dataReductionBeforeCapacity" : 0, "dataReductionAccelerateCompRate" : 0, "duplicationRate" : 0, "compressionRate" : 0, "dataReductionRate" : 0, "dataReductionAccelerateCompIncludingSystemData" : { "isReductionCapacityAvailable" : true, "reductionCapacity" : 0, "isReductionRateAvailable" : false }, "dataReductionIncludingSystemData" : { "isReductionCapacityAvailable" : true, "reductionCapacity" : 0, "isReductionRateAvailable" : false }, "snapshotUsedCapacity" : 0, "suspendSnapshot" : true, "availablePhysicalFMCPoolVolumesCapacity" : 46998, "usedPhysicalFMCPoolVolumesCapacity" : 4590, "availableFMCPoolVolumesCapacity" : 46998, "usedFMCPoolVolumesCapacity" : 46998, "fmcPoolVolumesCapacitySaving" : 42407, "fmcPoolVolumesCapacitySavingRate" : 90, "fmcPoolVolumesCapacityExpansionRate" : 100, "usedFMCLogicalPoolVolumesCapacity" : 0, "capacitiesExcludingSystemData" : { "usedVirtualVolumeCapacity" : 0, "compressedCapacity" : 0, "dedupedCapacity" : 0, "reclaimedCapacity" : 0, "systemDataCapacity" : 0, "preUsedCapacity" : 0, "preCompressedCapacity" : 0, "preDedupredCapacity" : 0 } } ] }
When the detailed information for accelerated compression is obtained:
When the drive type of the pool volumes that make up the pool is SSD(FMC), if you specify SSD(FMC) for the
detailInfoType
query parameter and then run the request, the following additional information is obtained.Attribute
Type
Description
usedPhysicalCapacity
long
Total physical capacity usage (MB)
When the pool contains pool volumes for which the accelerated compression function is enabled, the compressed data is included in the total usage.
availablePhysicalFMCPoolVolumesCapacity
long
Total physical capacity of pool volumes for which the accelerated compression function is enabled (MB)
The total capacity of pool volumes for which the accelerated compression function is enabled and writing is reserved is output.
usedPhysicalFMCPoolVolumesCapacity
long
Physical capacity usage by pool volumes for which the accelerated compression function is enabled (MB)
The used capacity by pool volumes for which the accelerated compression function is enabled after they are compressed is output.usedFMCLogicalPoolVolumesCapacity
long
Logical capacity usage of pool volumes for which the accelerated compression function is enabled (MB)
The used capacity by pool volumes for which the accelerated compression function is enabled after they are compressed is output.
availableFMCPoolVolumesCapacity
long
Total capacity of pool volumes for which the accelerated compression function is enabled (MB)
From among the volumes that make up the pool, the total capacity of pool volumes for which the accelerated compression function is enabled is output.
usedFMCPoolVolumesCapacity
long
Capacity usage of pool volumes for which the accelerated compression function is enabled (MB)
From among the volumes that make up the pool, the usage of the pool volumes for which the accelerated compression function is enabled is output.
fmcPoolVolumesCapacitySaving
long
Data reduction in capacity of pool volume for which the accelerated compression function is enabled (MB)
From among volumes that make up the pool, the reduction in the capacity of pool volumes for which the accelerated compression function is enabled, obtained by data compression is output.
fmcPoolVolumesCapacitySavingRate
int
Reduction rate of capacity of pool volumes for which the accelerated compression function is enabled (%)
With regard to the pool volumes for which the accelerated compression function is enabled from among the volumes that make up the pool, the percentage (%) that
fmcPoolVolumesCapacitySaving
occupies ofusedFMCPoolVolumesCapacity
is output.fmcPoolVolumesCapacityExpansionRate
int
Capacity expansion rate of pool volumes for which the accelerated compression function is enabled (%)
The percentage (%) that
availableFMCPoolVolumesCapacity
occupies ofavailablePhysicalFMCPoolVolumesCapacity
is output.The following example shows the output when detailed information is obtained about the total efficiency.
{ "data" : [ { "poolId" : 32, "poolStatus" : "POLN", "usedCapacityRate" : 49, "usedPhysicalCapacityRate" : 49, "snapshotCount" : 0, "poolName" : "pool_32", "availableVolumeCapacity" : 8190, "availablePhysicalVolumeCapacity" : 8190, "totalPoolCapacity" : 16254, "totalPhysicalCapacity" : 16254, "numOfLdevs" : 1, "firstLdevId" : 2229, "warningThreshold" : 70, "depletionThreshold" : 80, "virtualVolumeCapacityRate" : -1, "isMainframe" : false, "isShrinking" : false, "locatedVolumeCount" : 11, "totalLocatedCapacity" : 67173456, "blockingMode" : "NB", "totalReservedCapacity" : 0, "reservedVolumeCount" : 0, "poolType" : "HDP", "duplicationLdevIds" : [ 49098, 49097, 49096, 49095, 49094, 49093, 49092, 49091 ], "duplicationNumber" : 8, "dataReductionAccelerateCompCapacity" : 17174250, "dataReductionCapacity" : 17174250, "dataReductionBeforeCapacity" : 17175552, "dataReductionAccelerateCompRate" : 89, "duplicationRate" : 5, "compressionRate" : 84, "dataReductionRate" : 99, "dataReductionAccelerateCompIncludingSystemData" : { "isReductionCapacityAvailable" : true, "reductionCapacity" : 2580480, "isReductionRateAvailable" : true, "reductionRate" : 13 }, "dataReductionIncludingSystemData" : { "isReductionCapacityAvailable" : true, "reductionCapacity" : 2580480, "isReductionRateAvailable" : true, "reductionRate" : 14 }, "snapshotUsedCapacity" : 0, "suspendSnapshot" : true, "efficiency" : { "isCalculated" : true, "totalRatio" : "112.52", "compressionRatio" : "17.07", "snapshotRatio" : "-", "provisioningRate" : "84", "calculationStartTime" : "2016-07-31T20:32:47Z", "calculationEndTime" : "2016-07-31T20:41:09Z", "dedupeAndCompression" : { "totalRatio" : "18.47", "compressionRatio" : "8.61", "dedupeRatio" : "2.03", "reclaimRatio" : "1.05" }, "acceleratedCompression" : { "totalRatio" : "1.00", "compressionRatio" : "1.00", "reclaimRatio" : "1.00" } }, "capacitiesExcludingSystemData" : { "usedVirtualVolumeCapacity" : 19095552, "compressedCapacity" : 15975441, "dedupedCapacity" : 1064681, "reclaimedCapacity" : 1021936, "systemDataCapacity" : 15481578, "preUsedCapacity" : 18063360, "preCompressedCapacity" : 17041424, "preDedupredCapacity" : 1064982 } } ] }
When detailed information is obtained about the total efficiency
If you run the request with efficiency specified for the query parameter
detailInfoType
, the following information is obtained.Attribute
Type
Description
efficiency
object
Attributes related to the total efficiency are displayed.
Calculated results for the period from calculationStartTime to calculationEndTime are obtained.
Only When true is specified for the attribute
isCalculated
, other subordinate attributes are also obtained. If the pool volume for which the calculation is to be performed does not exist, a hyphen (-) indicating an invalid value is displayed for these attributes. If the calculation cannot be performed for the pool because the pool is blocked or some other reason, the value from the previous calculation is displayed.For the attributes that display the total efficiency or the efficiency of capacity saving, these results are displayed as a ratio of the size of data before reduction to the size of data after reduction, where the size of data after reduction is 1.
-
isCalculated (boolean)
Calculation status of the total efficiency
This attribute indicates whether the total efficiency has been calculated.
- true: The values have been calculated.
- false: The values have not been calculated.
-
calculationStartTime (ISO8601string)
The date and time when the calculation of the total efficiency began (UTC)
Displayed in the following format: YYYY-MM-DDThh:mm:ssZ
-
calculationEndTime (ISO8601string)
The date and time when the calculation of the total efficiency ended (UTC)
Displayed in the following format: YYYY-MM-DDThh:mm:ssZ
-
totalRatio (string)
The total efficiency of the entire pool
This does not include the size of metadata, garbage data, and other similar data generated by the storage system.
After a volume is created from pool and before data is written to the volume, the maximum value (92233720368547758.07) is displayed.
-
compressionRatio (string)
The efficiency of capacity saving performed by using the capacity saving function (dedupe and compression) or accelerated compression
This does not include the size of metadata, garbage data, and other similar data generated by the storage system.
-
snapshotRatio (string)
The efficiency of capacity saving performed by using snapshots to back up data
This does not include the size of metadata, garbage data, and other similar data generated by the storage system.
-
provisioningRate (string)
The percentage (%) of the saving efficiency for consumption of capacity achieved by using Dynamic Provisioning to virtualize capacity
This does not include the size of metadata, garbage data, and other similar data generated by the storage system.
-
dedupeAndCompression (object)
Attributes related to the efficiency of capacity saving performed by using the capacity saving function (dedupe and compression) are displayed.
This does not include the size of metadata, garbage data, and other similar data generated by the storage system.
-
totalRatio (string)
total efficiency of capacity saving performed by using the capacity saving function
-
compressionRatio (string)
Efficiency of capacity saving performed by using compression
-
dedupeRatio (string)
Efficiency of capacity saving performed by using deduplication (dedupe)
-
reclaimRatio (string)
Efficiency of capacity saving performed by reclaiming the specified data pattern
-
-
acceleratedCompression (object)
Attributes related to the efficiency of capacity saving performed by using accelerated compression are displayed.
This does not include the size of metadata, garbage data, and other similar data generated by the storage system.
-
totalRatio (string)
total efficiency of capacity saving performed by using accelerated compression
-
compressionRatio (string)
Efficiency of capacity saving performed by using compression
-
reclaimRatio (string)
Efficiency of capacity saving performed by reclaiming the specified data pattern
-
When detailed information is obtained about the formatted capacity of the pool
If you run the request with formattedCapacity specified for the query parameter
detailInfoType
, the following information is obtained.Attribute
Type
Description
formattedCapacity
long
The formatted capacity of the pool (MB) is displayed.
If the information cannot be obtained, -1 is displayed, indicating an invalid value.
For details on the status codes of the request for this operation, see the description on HTTP status codes.
When getting information about all pools:
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/pools
When getting information about DP pools:
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/pools?poolType=DP
Getting information about a specific pool
The following request gets information about a specific pool by specifying the pool number.
Storage Administrator (View Only)
GET base-URL/v1/objects/pools/object-ID
Object ID
Specify the
poolId
value obtained by getting information about the pools.Attribute
Type
Description
poolId
int
(Required) Pool number
Query parameters
None.
Body
None.
Body
The following is an example of the output generated when getting HDP pool information:
{ "poolId": 0, "poolStatus": "POLN", "usedCapacityRate": 14, "usedPhysicalCapacityRate": 14, "snapshotCount": 0, "poolName": "testpool", "availableVolumeCapacity": 40320, "availablePhysicalVolumeCapacity": 40320, "totalPoolCapacity": 46998, "totalPhysicalCapacity": 46998, "numOfLdevs": 1, "firstLdevId": 1, "warningThreshold": 70, "depletionThreshold": 80, "virtualVolumeCapacityRate": -1, "isMainframe": false, "isShrinking": false, "locatedVolumeCount": 9, "totalLocatedCapacity": 67132128, "blockingMode": "NB", "totalReservedCapacity": 0, "reservedVolumeCount": 0, "poolType": "HDP", "duplicationLdevIds": [ 49151, 49150, 49149, 49148, 49147, 49146, 49145, 49144 ], "duplicationNumber": 8, "dataReductionAccelerateCompCapacity": 13072996, "dataReductionCapacity": 13072996, "dataReductionBeforeCapacity": 13074560, "dataReductionAccelerateCompRate": 92, "duplicationRate": 5, "compressionRate": 86, "dataReductionRate": 99, "dataReductionAccelerateCompIncludingSystemData": { "isReductionCapacityAvailable": true, "reductionCapacity": 430080, "isReductionRateAvailable": true, "reductionRate": 3 }, "dataReductionIncludingSystemData": { "isReductionCapacityAvailable": true, "reductionCapacity": 430080, "isReductionRateAvailable": true, "reductionRate": 3 }, "snapshotUsedCapacity": 0, "suspendSnapshot": true }
For a DP pool:
Attribute
Type
Description
poolId
int
Pool number
poolName
string
Pool name
poolType
string
Pool type
- HDP: HDP pool
- HDT: HDT pool
- RT: active flash pool
- DM: Data Direct Mapping HDP pool
poolStatus
string
One of the following is output as the pool status:
- POLN: Normal (Pool Normal)
- POLF: The pool is in the overflow status exceeding the threshold. (Pool Full)
- POLS: The pool is in the overflow status exceeding the threshold and is suspended. (Pool Suspend)
- POLE: The
pool is suspended in the failure status. (Pool failure)
If the pool status is POLE, pool information cannot be obtained.
usedCapacityRate
int
Usage rate of logical capacity (%)
usedPhysicalCapacityRate
int
Usage rate of physical capacity (%)
availableVolumeCapacity
long
Free logical capacity (MB)
availablePhysicalVolumeCapacity
long
Free physical capacity (MB)
For this attribute, 1 MB is equal to 1,0242 bytes.
totalPoolCapacity
long
Total logical capacity (MB)
totalPhysicalCapacity
long
Total physical capacity (MB)
For this attribute, 1 MB is equal to 1,0242 bytes.
numOfLdevs
int
Number of LDEVs in the pool
firstLdevId
int
The first LDEV number of the LDEVs in the pool
warningThreshold
int
The warning threshold set for the pool
depletionThreshold
int
The depletion threshold set for the pool
suspendSnapshot
boolean
Whether to suspend Thin Image pairs when the depletion threshold is exceeded
- true: Thin Image pairs are suspended when the depletion threshold is exceeded.
- false: Thin Image pairs are not suspended when the depletion threshold is exceeded.
virtualVolumeCapacityRate
int
The maximum subscription limit of a virtual volume relative to pool capacity
- -1: Unlimited
isShrinking
boolean
Whether the pool is shrinking is output.
- true: The pool is shrinking.
- false: The pool is not shrinking.
locatedVolumeCount
int
Total number of DP volumes mapped to the pool
totalLocatedCapacity
long
Total capacity of the DP volumes mapped to the pool (MB)
The value of this attribute does not include the control area.
snapshotCount
int
Total number of snapshot data items mapped to the pool
snapshotUsedCapacity
long
Total size of snapshot data mapped to the pool (MB)
blockingMode
string
Setting the protection function for a virtual volume
When the DP pool is full or when the DP pool volume is blocked, whether the read and write operations can be performed for the DP volume that uses the target DP pool is output.
- 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.
totalReservedCapacity
long
Total capacity of the reserved page (MB) of the DP volume that is related to the DP pool
If the Full Allocation functionality is not supported by the configuration, this attribute is not output.
reservedVolumeCount
int
Number of volumes associated with the DP pool for which the page reservation setting is enabled
If the Full Allocation functionality is not supported by the configuration, this attribute is not output.
poolActionMode
string
Execution mode for the pool
- DEF: The mode in which the monitor is started or stopped by instructions from the REST API server, and the Tier range is specified by automatic calculation of the DKC.
- AUT: The mode in which the monitor is started or stopped at the specified time, and the Tier range is specified by automatic calculation of the DKC (specified by using Storage Navigator).
monitoringMode
string
Performance monitoring execution mode (monitor mode)
- PM: Period mode
- CM: Continuous mode
tierOperationStatus
string
Operation status of performance monitoring and tier relocation is output.
- STP: Performance monitoring and tier relocation are both stopped.
- RLC: Performance monitoring is stopped and tier relocation is operating.
- MON: Performance monitoring is operating and tier relocation is stopped.
- RLM: Performance monitoring and tier relocation are both operating.
dat
string
Status of monitor information
- VAL: Valid
- INV: Invalid
- PND: Pending calculation
tiers
object[]
The following attributes about HDT pool tiers are output for each tier.
- tierNumber (int)
Tier number
- tierLevelRange (string)
Lower limit of the tier
The value is output as the number of I/O operations per hour (IOPH).
- tierDeltaRange (string)
Delta value for the tier
The value is output as the number of I/O operations per hour (IOPH).
- tierUsedCapacity (long)
Amount used by the tier (MB)
- tierTotalCapacity (long)
Total capacity of the tier (MB)
- tablespaceRate (int)
Rate of free space to be used for new allocation
- performanceRate (int)
Performance utilization
- progressOfReplacing (int)
Relocation progress rate
The progress rate of the following tier relocation operation is output as a value from 0 to 99.
- When the value of the
tierOperationStatus
attribute is RLC or RLM: Progress rate of relocation (being run). - When the value of the
tierOperationStatus
attribute is STP or MON: Progress rate of relocation (being suspended).
When tier relocation is not run or tier relocation is complete, 100 is output.
- When the value of the
- bufferRate (int)
Buffer area rate for relocation
duplicationLdevIds
int[]
LDEV numbers of the deduplication system data volumes
duplicationNumber
int
Number of deduplication system data volumes
dataReductionAccelerateCompCapacity
long
Size (in blocks) of data reduction through the capacity saving function (dedupe and compression) or the accelerated compression function
The size of data after reduction does not include the size of metadata and garbage data generated by the storage system.
dataReductionCapacity
long
Size (in blocks) of data reduction through the capacity saving function (compression and deduplication)
The size of data after reduction does not include the size of metadata and garbage data generated by the storage system.
dataReductionBeforeCapacity
long
Size (in blocks) of data before data reduction was performed by using the capacity saving function (compression and deduplication)
dataReductionAccelerateCompRate
int
Percentage (%) of data on which data reduction has been performed by using the capacity saving function (compression and deduplication) or the accelerated compression function
The size of data after reduction does not include the size of metadata and garbage data generated by the storage system.
dataReductionRate
int
Percentage (%) of data on which data reduction has been performed by using the capacity saving function (compression and deduplication)
The size of data after reduction does not include the size of metadata and garbage data generated by the storage system.
dataReductionAccelerateCompIncludingSystemData
object
The attributes related to the size of data reduced by using the capacity saving function (compression and deduplication) or the accelerated compression function are displayed.
These attributes are calculated based on the size of the data (which includes, in addition to user data, metadata and garbage data generated by the storage system) after data reduction is performed.
-
isReductionCapacityAvailable (boolean)
Whether the size of the data can be reduced
-
true: The size of the data can be reduced.
If the value of this attribute is true, the size of the data that has been reduced is displayed for the
reductionCapacity
attribute. -
false: The size of the data cannot be reduced (for example, if the size of the data after data reduction is greater than the size of the data before data reduction).
-
-
reductionCapacity (long)
Size (in blocks) of the data that was reduced
This attribute is displayed when the value of the
isReductionCapacityAvailable
attribute is true. -
isReductionRateAvailable (boolean)
Whether the size of the data can be reduced
-
true: The size of the data can be reduced.
If the value of this attribute is true, the percentage by which the size of the data has been reduced is displayed for the
reductionRate
attribute. -
false: The size of the data cannot be reduced (for example, if the size of the data after data reduction is greater than the size of the data before data reduction).
-
-
reductionRate (int)
Percentage (%) by which the size of the data has been reduced
This attribute is displayed when the value of the
isReductionRateAvailable
attribute is true.
dataReductionIncludingSystemData
object
The attributes related to the size of data reduced by using the capacity saving function (compression and deduplication) are displayed.
These attributes are calculated based on the size of the data (which includes, in addition to user data, metadata and garbage data generated by the storage system) after data reduction is performed.
-
isReductionCapacityAvailable (boolean)
Whether the size of the data can be reduced
-
true: The size of the data can be reduced.
If the value of this attribute is true, the size of the data that has been reduced is displayed for the
reductionCapacity
attribute. -
false: The size of the data cannot be reduced (for example, if the size of the data after data reduction is greater than the size of the data before data reduction).
-
-
reductionCapacity (long)
Size (in blocks) of the data that was reduced
This attribute is displayed when the value of the
isReductionCapacityAvailable
attribute is true. -
isReductionRateAvailable (boolean)
Whether the size of the data can be reduced
-
true: The size of the data can be reduced.
If the value of this attribute is true, the percentage by which the size of the data has been reduced is displayed for the
reductionRate
attribute. -
false: The size of the data cannot be reduced (for example, if the size of the data after data reduction is greater than the size of the data before data reduction).
-
-
reductionRate (int)
Percentage (%) by which the size of the data has been reduced
This attribute is displayed when the value of the
isReductionRateAvailable
attribute is true.
compressionRate
int
Percentage (%) of data on which data reduction has been performed by using the compression function or the accelerated compression function
duplicationRate
int
Percentage (%) of data on which data reduction has been performed by using the deduplication function
isMainframe
boolean
Displays a pool for the mainframe or the open system
- true: Pool for the mainframe volume
- false: Pool for the open volume
The following is an example of the output generated when getting Thin Image pool information:
{ "poolId": 3, "poolStatus": "POLN", "usedCapacityRate": 0, "usedPhysicalCapacityRate": 0, "snapshotCount": 0, "poolName": "HTnM_v8.5_SOS_TIPOOL", "availableVolumeCapacity": 6006, "availablePhysicalVolumeCapacity": 6006, "totalPoolCapacity": 6006, "totalPhysicalCapacity": 6006, "numOfLdevs": 1, "firstLdevId": 1026, "warningThreshold": 80, "virtualVolumeCapacityRate": -1, "isMainframe": false, "isShrinking": false, "poolType": "HTI" }
For a Thin Image pool:
Attribute
Type
Description
poolId
int
Pool number
poolName
string
Pool name
poolType
string
Pool type is output.
HTI: Thin Image pool
poolStatus
string
One of the following is output as the pool status:
- POLN: Normal (Pool Normal)
- POLF: The pool is in the overflow status exceeding the threshold. (Pool Full)
- POLS: The pool is in the overflow status exceeding the threshold and is suspended. (Pool Suspend)
- POLE: The
pool is suspended in the failure status. (Pool failure)
If the pool status is POLE, pool information cannot be obtained.
usedCapacityRate
int
Usage rate of logical capacity (%)
usedPhysicalCapacityRate
int
Usage rate of physical capacity (%)
snapshotCount
int
Number of volumes in the pool
availableVolumeCapacity
long
Free logical capacity (MB)
availablePhysicalVolumeCapacity
long
Free physical capacity (MB)
For this attribute, 1 MB is equal to 1,0242 bytes.
totalPoolCapacity
long
Total logical capacity (MB)
totalPhysicalCapacity
long
Total physical capacity (MB)
For this attribute, 1 MB is equal to 1,0242 bytes.
numOfLdevs
int
Number of LDEVs in the pool
firstLdevId
int
The first LDEV number of the LDEVs in the pool
(Not the first number in ascending order)
warningThreshold
int
The warning threshold set for the pool
virtualVolumeCapacityRate
int
The maximum subscription limit of a virtual volume relative to pool capacity
- -1: Unlimited
isShrinking
boolean
Whether the pool is shrinking is output.
- true: The pool is shrinking.
- false: The pool is not shrinking.
isMainframe
boolean
Displays a pool for the mainframe or the open system
- true: Pool for the mainframe volume
- false: Pool for the open volume
For details on the status codes of the request for this operation, see the description on HTTP status codes.
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/pools/18
Creating a pool
The following request creates pools by specifying the LDEV. In the REST API, you can create DP pools and Thin Image pools. You can specify LDEVs by specifying LDEV numbers or a range of consecutive LDEV numbers.
poolType
attribute when
you create the pool.Storage Administrator (Provisioning)
POST base-URL/v1/objects/pools
Object ID
None.
Query parameters
None.
Body
The following coding example creates an HDP pool by specifying the LDEV number:
{ "poolId": 76, "poolName": "pool_for_email_server", "ldevIds": [405], "poolType": "HDP" }
The following coding example creates an HDP pool by specifying a range of consecutive LDEV numbers:
{ "poolId": 76, "poolName": "pool_for_email_server", "startLdevId": 101, "endLdevId": 105, "poolType": "HDP" }
When creating a DP pool:
Attribute
Type
Description
poolId
int
(Required) Specify the pool number with a decimal (base 10) number.
poolName
string
(Required) Pool name
Specify a character string consisting of 1 to 32 characters.
poolType
string
(Required) Pool type
The specifiable values are as follows:
-
HDP: HDP pools
-
HDT: HDT pools
ldevIds
int[]
(Optional) LDEV number
Specify a decimal (base 10) number.
Make sure to specify this attribute when specifying LDEV numbers.
You can specify up to 64 digits. This attribute cannot be specified along with the
startLdevId
andendLdevId
attribute.startLdevId
int
(Optional) The first LDEV number in the range of consecutive LDEV numbers, if such a range is specified
Make sure to specify this attribute when specifying a range of LDEV numbers.
If you specify this attribute, be sure to also specify the
endLdevId
attribute. The value of this attribute must be smaller than that ofendLdevId
.Specify a number such that the range indicated by the
startLdevId
andendLdevId
attributes consists of no more than 64 LDEVs.This attribute cannot be specified along with the
ldevIds
attribute.endLdevId
int
(Optional) The last LDEV number in the range of consecutive LDEV numbers, if such a range is specified
Make sure to specify this attribute when specifying a range of LDEV numbers.
If you specify this attribute, be sure to also specify the
startLdevId
attribute. The value of this attribute must be greater than that ofstartLdevId
.Specify a number such that the range indicated by the
startLdevId
andendLdevId
attributes consists of no more than 64 LDEVs.This attribute cannot be specified along with the
ldevIds
attribute.warningThreshold
int
(Optional) Warning threshold (%)
Specify a value in the range from 1 to 100. Specify a value smaller than that of
depletionThreshold
. If this attribute is omitted, 70 is assumed.depletionThreshold
int
(Optional) Depletion threshold (%)
Specify a value in the range from 1 to 100. Specify a value greater than the value of
warningThreshold
. If this attribute is omitted, 80 is assumed.suspendSnapshot
boolean
(Optional) Specify whether to suspend Thin Image pairs when the depletion threshold is exceeded.
You can specify this attribute if the pool to be created is an HDP pool for storing 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.
If you specify HDP for the
poolType
attribute and omit this attribute, true is assumed.The following coding example creates a Thin Image pool:
{ "poolId":76, "poolName":"pool_for_snapshot_copy", "ldevIds":[405], "poolType": "HTI" }
When creating a Thin Image pool:
Attribute
Type
Description
poolId
int
(Required) Specify the pool number with a decimal (base 10) number.
poolName
string
(Required) Pool name
Specify a character string consisting of 1 to 32 characters.
poolType
string
(Required) Pool type
HTI: Thin Image pools
ldevIds
int[]
(Optional) LDEV number
Specify a decimal (base 10) number.
Make sure to specify this attribute when specifying LDEV numbers.
You can specify up to 64 digits. This attribute cannot be specified along with the
startLdevId
andendLdevId
attribute.startLdevId
int
(Optional) First LDEV number when specifying a range of consecutive LDEV numbers.
Make sure to specify this attribute when specifying a range of LDEV numbers.
If you specify this attribute, be sure to also specify the
endLdevId
attribute. The value of this attribute must be smaller than that ofendLdevId
.Specify a number such that the range indicated by the
startLdevId
andendLdevId
attributes consists of no more than 64 LDEVs.This attribute cannot be specified along with the ldevIds attribute.
endLdevId
int
(Optional) Last LDEV number when specifying a range of consecutive LDEV numbers.
Make sure to specify this attribute when specifying a range of LDEV numbers.
If you specify this attribute, be sure to also specify the
startLdevId
attribute. The value of this attribute must be greater than that ofstartLdevId
.Specify a number such that the range indicated by the
startLdevId
andendLdevId
attributes consists of no more than 64 LDEVs.This attribute cannot be specified along with the
ldevIds
attribute.warningThreshold
int
(Optional) Warning threshold (%)
Specify a value in the range from 20 to 95. If this attribute is omitted, 80 is assumed.
-
Body
A job object is returned. For details on attributes other than
affectedResources
, see the section explaining job objects.Attribute
Description
affectedResources
URL of the created pool
The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the description on HTTP status codes.
Status code |
Message |
Description |
409 |
Conflict |
A pool of the specified pool number has already been created. |
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/pools
Changing pool settings
The following request changes the pool name, pool type, attributes related to an HDT pool tier, and other settings.
Storage Administrator (Provisioning)
PATCH base-URL/v1/objects/pools/object-ID
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.
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 thebufferRate
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)
- HDP: Changes to an HDP pool
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
None.
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. |
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
Expanding a pool
To expand the capacity of a pool, the following request adds LDEVs to the pool.
Storage Administrator (Provisioning)
POST base-URL/v1/objects/pools/object-ID/actions/expand/invoke
Object ID
Specify the
poolId
value obtained by getting information about pools.Attribute
Type
Description
poolId
int
(Required) Pool number
Query parameters
None.
Body
{ "parameters": { "ldevIds": [101,102] } }
Attribute
Type
Description
ldevIds
int[]
(Optional) Specify the LDEV number with a decimal (base 10) number.
You can specify up to 64 numbers. This attribute cannot be specified along with the startLdevId and endLdevId attribute.
startLdevId
int
(Optional) First LDEV number when specifying a range of consecutive LDEV numbers.
If you specify this attribute, be sure to also specify the endLdevId attribute. The value of this attribute must be smaller than that of endLdevId.
Specify a number such that the range indicated by the startLdevId and endLdevId attributes consists of no more than 64 LDEVs.
This attribute cannot be specified along with the ldevIds attribute.
endLdevId
int
(Optional) Last LDEV number when specifying a range of consecutive LDEVs.
If you specify this attribute, be sure to also specify the startLdevId attribute. The value of this attribute must be greater than that of startLdevId.
Specify a number such that the range indicated by the startLdevId and endLdevId attributes consists of no more than 64 LDEVs.
This attribute cannot be specified along with the ldevIds attribute.
Body
A job object is returned. For details on attributes other than
affectedResources
, see the section explaining job objects.Attribute
Description
affectedResources
URL of the expanded pool
GET base-URL/v1/objects/pools/object-ID/actions/expand
For details on the status codes of the request for this operation, see the description on HTTP status codes.
To get an action template:
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/pools/3/actions/expand
To run the request after getting an action template:
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/pools/3/actions/expand/invoke
Shrinking a pool
The following request removes an LDEV from a pool to decrease the pool capacity. Note that you cannot remove all LDEVs from the pool.
Storage Administrator (Provisioning)
POST base-URL/v1/objects/pools/object-ID/actions/shrink/invoke
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
{ "parameters": { "ldevIds": [101,102] } }
Attribute
Type
Description
ldevIds
int[]
(Optional) Specify the LDEV number with a decimal (base 10) number.
You can specify up to 64 numbers. This attribute cannot be specified along with the startLdevId and endLdevId attribute.
startLdevId
int
(Optional) First LDEV number when specifying a range of consecutive LDEV numbers.
If you specify this attribute, be sure to also specify the endLdevId attribute. The value of this attribute must be smaller than that of endLdevId.
Specify a number such that the range indicated by the startLdevId and endLdevId attributes consists of no more than 64 LDEVs.
This attribute cannot be specified along with the ldevIds attribute.
endLdevId
int
(Optional) Last LDEV number when specifying a range of consecutive LDEVs.
If you specify this attribute, be sure to also specify the startLdevId attribute. The value of this attribute must be greater than that of startLdevId.
Specify a number such that the range indicated by the startLdevId and endLdevId attributes consists of no more than 64 LDEVs.
This attribute cannot be specified along with the ldevIds attribute.
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 shrunk pool
GET base-URL/v1/objects/pools/object-ID/actions/shrink
The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the description on HTTP status codes.
Status code |
Message |
Description |
412 |
Precondition Failed |
The specified action cannot be run on the specified pool because there is only one LDEV in the pool. |
To get an action template:
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/pools/3/actions/shrink
To run the request after getting an action template:
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/pools/3/actions/shrink/invoke
Performing performance monitoring of a pool
The following request starts or ends performance monitoring of an HDT pool. By performing performance monitoring, you can collect the I/O performance on each page of a pool as monitoring information to understand the characteristics of the I/O performance on each page allocated to an HDT volume. Perform performance monitoring before tier relocation.
Storage Administrator (Provisioning)
POST base-URL/v1/objects/pools/object-ID/actions/monitor/invoke
Object ID
Specify the
poolId
value obtained by getting information about pools.Attribute
Type
Description
poolId
int
(Required) Pool number
Query parameters
None.
Body
{ "parameters": { "operationType": "start" } }
Attribute |
Type |
Description |
operationType |
string |
(Required) Specify the operation of performance monitoring.
|
Body
A job object is returned. For details on attributes other than
affectedResources
, see the section explaining job objects.Attribute
Description
affectedResources
URL of the pool for which performance monitoring was started or ended
GET base-URL/v1/objects/pools/object-ID/actions/monitor
The following table explains the meanings of the status codes for this API. For details on other status codes, see the section explaining HTTP status codes.
Status code |
Message |
Description |
412 |
Precondition Failed |
The specified action cannot be run because the pool meets either of the following conditions:
|
To get an action template:
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/pools/3/actions/monitor
To run the API request after getting an action template:
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/pools/3/actions/monitor/invoke
Performing tier relocation
The following request relocates HDT pool data (in units of pages) to an appropriate tier, based on the monitoring information collected by performance monitoring. Before performing tier relocation, perform performance monitoring in advance.
Storage Administrator (Provisioning)
POST base-URL/v1/objects/pools/object-ID/actions/relocate/invoke
Object ID
Specify the
poolId
value obtained by getting information about pools.Attribute
Type
Description
poolId
int
(Required) Pool number
Query parameters
None.
Body
{ "parameters": { "operationType": "start" } }
Attribute |
Type |
Description |
operationType |
string |
(Required) Specify the operation of tier relocation.
|
Body
A job object is returned. For details on attributes other than
affectedResources
, see the section explaining job objects.Attribute
Description
affectedResources
URL of the pool for which tier relocation was started or ended
GET base-URL/v1/objects/pools/object-ID/actions/relocate
The following table explains the meanings of the status codes for this API. For details on other status codes, see the section explaining HTTP status codes.
Status code |
Message |
Description |
412 |
Precondition Failed |
The specified action cannot be run because the pool meets either of the following conditions:
|
To get an action template:
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/pools/3/actions/relocate
To run the API request after getting an action template:
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/pools/3/actions/relocate/invoke
Restoring a pool
The following request unblocks a pool after recovery from a failure or other problems.
Storage Administrator (Provisioning)
POST base-URL/v1/objects/pools/object-ID/actions/recover/invoke
Object ID
Specify the
poolId
value obtained by getting information about pools.Attribute
Type
Description
poolId
int
(Required) Pool number
Query parameters
None.
Body
None.
Body
A job object is returned. For details on attributes other than
affectedResources
, see the section explaining job objects.Attribute
Description
affectedResources
URL of the recovered pool
None.
The following table explains the meanings of the status codes for this API. For details on other status codes, see the section explaining HTTP status codes.
Status code |
Message |
Description |
412 |
Precondition Failed |
The specified action cannot be run because the pool meets either of the following conditions:
|
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST https://192.0.2.100/ConfigurationManager/v1/objects/pools/3/actions/recover/invoke -d ""
Initializing the capacity saving function for a pool
The following request initializes, in a batch operation, the capacity saving function (dedupe and compression) for specified pools for which the deduplication function is enabled. This request formats all deduplication system data volumes and volumes for which the capacity saving function (deduplication) is enabled.
- After running this API function, if necessary, change the
status
attribute to the normal status for the volumes for which the capacity saving function (deduplication) is enabled.
Storage Administrator (Provisioning)
POST base-URL/v1/objects/pools/object-ID/actions/data-reduction-initialize/invoke
Object ID
Specify the
poolId
value obtained by getting information about the pools.Attribute
Type
Description
poolId
int
(Required) Pool number
Query parameters
None.
Body
None.
Body
A job object is returned. For details on attributes other than
affectedResources
, see the description of job objects.Attribute
Description
affectedResources
URL of the pool to which the initialized volumes belong
None.
For details on the status codes of the request for this operation, see the description on HTTP status codes.
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST https://192.0.2.100/ConfigurationManager/v1/objects/pools/3/actions/data-reduction-initialize/invoke -d ""
Deleting a pool
The following request deletes a pool by specifying the pool number.
Storage Administrator (Provisioning)
DELETE base-URL/v1/objects/pools/object-ID
Object ID
Specify the
poolId
value obtained by getting information about pools.Attribute
Type
Description
poolId
int
(Required) Pool number
Query parameters
None.
Body
None.
Body
A job object is returned. For details on attributes other than
affectedResources
, see the section explaining job objects.Attribute
Description
affectedResources
URL of the deleted pool
For details on the status codes of the request for this operation, see the description on HTTP status codes.
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X DELETE https://192.0.2.100/ConfigurationManager/v1/objects/pools/3