Spectra Logic

1-800-833-1132 : 1-303-449-6400

Compact Pool

Description

Pool compaction is periodically done automatically in the background. If the pool does not contain data, it is reclaimed in its entirety and unassigned from its current storage domain. This makes the pool available for allocation to any storage domain. If the pool cannot be reclaimed in its entirety, its usage level is checked, and data that is eligible for deletion is deleted as necessary to compact the pool so that it has space for new data.

Use this request to force a compaction to be scheduled immediately for a specified pool, without having to wait for the automatic, periodic scheduling.

Requests

Syntax

PUT http[s]://{datapathDNSname}/_rest_/pool/{pool UUID or other unique attribute}?operation=COMPACT​[&priority=URGENT|HIGH|NORMAL|LOW]

To determine the UUID for a pool, see Get Pools.

Request Parameters

Parameter	Description	Required
operation	The operation to perform. For this request, the operation is to compact the pool. Value: COMPACT	yes
priority	The priority for processing this task. This determines the resources assigned and the processing order. Values: URGENT, HIGH, NORMAL, LOW	no

Responses

Response Elements

<Data>
   <AssignedToStorageDomain>TRUE|FALSE</AssignedToStorageDomain>
   <AvailableCapacity>{64‑bit integer}</AvailableCapacity>
   <BucketId>{string}</BucketId>
   <Guid>{string}</Guid>
   <Health>OK|DEGRADED</Health>
   <Id>{string}</Id>
   <LastAccessed>{YYYY-MM-DDThh:mm:ss.xxxZ}</LastAccessed>
   <LastModified>{YYYY-MM-DDThh:mm:ss.xxxZ}</LastModified>
   <LastVerified>{YYYY-MM-DDThh:mm:ss.xxxZ}</LastVerified>
   <Mountpoint>/{string}</Mountpoint>
   <Name>{string}</Name>
   <PartitionId>{string}</PartitionId>
   <PoweredOn>TRUE|FALSE</PoweredOn>
   <Quiesced>NO|PENDING|YES</Quiesced>
   <ReservedCapacity>{64‑bit integer}</ReservedCapacity>
   <State>
      NORMAL|FOREIGN|IMPORT_IN_PROGRESS|IMPORT_PENDING|LOST
   </State>

   <StorageDomainId>{string}</StorageDomainId>
   <TotalCapacity>{64‑bit integer}</TotalCapacity>
   <Type>NEARLINE|ONLINE</Type>
   <UsedCapacity>{64‑bit integer}</UsedCapacity>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	A container for the response.
AssignedToStorageDomain	Whether the pool is currently assigned to a storage domain. Values: TRUE, FALSE
AvailableCapacity	The amount of unused capacity on the pool in bytes.
BucketId	The UUID for the bucket to which the pool is assigned.
Health	Whether the pool is in good health or degraded. Values: OK, DEGRADED
Id	The UUID for the pool.
LastAccessed	The last date and time the pool was accessed in the format YYYY-MM-DDThh:mm:ss.xxxZ.
LastModified	The last date and time an object in the pool was modified in the format YYYY-MM-DDThh:mm:ss.xxxZ.
LastVerified	The last date and time the checksum of the data was verified in the format YYYY-MM-DDThh:mm:ss.xxxZ.
MountPoint	The logical directory used by the BlackPearl system to access the pool.
Name	The name for the pool.
PartitionId	The UUID of the pool partition.
PoweredOn	Whether the pool is powered on. Values: TRUE, FALSE
Quiesced	Whether the pool is in a temporarily inactive state. Values: NO, PENDING, YES
ReservedCapacity	The capacity reserved for overhead.
State	The status of the pool. Values: BLANK, NORMAL, FOREIGN, IMPORT_IN_PROGRESS, IMPORT_PENDING, LOST. State.
StorageDomainId	The UUID for the storage domain to which the pool is assigned.
TotalCapacity	The total capacity of the pool including used, reserved and available capacity.
Type	The type of pool. Values: NEARLINE (ArcticBlue), ONLINE (SAS)
UsedCapacity	The amount of used capacity on the pool in bytes.

Example

Sample Request

This request compacts the pool with the UUID 77f3f144-be85-48ad-abd8-8e0f2d09f713.

PUT http://blackpearl-hostname/_rest_/pool/77f3f144-be85-48ad-abd8-8e0f2d09f713?operation=COMPACT HTTP/1.1

Sample Response

<Data>
   <AssignedToStorageDomain>FALSE</AssignedToStorageDomain>
   <AvailableCapacity>10000</AvailableCapacity>
   <BucketId/>
   <Guid>9a80574a-2a08-480e-98a6-ff0fa809987a</Guid>
   <Health>OK</Health>
   <Id>77f3f144-be85-48ad-abd8-8e0f2d09f713</Id>
   <LastAccessed/>
   <LastModified/>
   <LastVerified/>
   <Mountpoint>/mountpoint-0</Mountpoint>
   <Name>pool0</Name>
   <PartitionId/>
   <PoweredOn>TRUE</PoweredOn>
   <Quiesced>NO</Quiesced>
   <ReservedCapacity>0</ReservedCapacity>
   <State>NORMAL</State>
   <StorageDomainId/>
   <TotalCapacity>30000</TotalCapacity>
   <Type>NEARLINE</Type>
   <UsedCapacity>20000</UsedCapacity>
</Data>