Spectra Logic

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

Modify Pool

Description

Modify the partition assignment of the specified pool or the quiesced state.

Notes:

§	If an optional request parameter is not included, the previous setting is retained.

§	It is not possible to change the quiesced state directly from NO to YES.

Requests

Syntax

PUT http[s]://{datapathDNSname}/_rest_/pool/{pool UUID or other unique attribute}[?partition_id={string}][&quiesced=NO|PENDING]

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

Request Parameters

Parameter	Description	Required
partition_id	The UUID, name, or other unique attribute for the pool partition to which to assign the pool.	no
quiesced	Request that the system prepare the pool to go into an inactive state (PENDING) or return the pool to an active state (NO). Values: NO, PENDING	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.
Guid	The ZFS identifier for the pool.
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 to ensure pool performance.
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 changes the partition the pool with the UUID c62cf569-5ff7-45cc-bad3-e2a6bd44760a is assigned to “Partition1”.

PUT http://blackpearl-hostname/_rest_/pool/c62cf569-5ff7-45cc-bad3-e2a6bd44760a?partition_id=Partition1 HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <AssignedToStorageDomain>FALSE</AssignedToStorageDomain>
   <AvailableCapacity>10000</AvailableCapacity>
   <BucketId/>
   <Guid>c8c478ea-7d5e-48d0-97fb-42ed1983cfbd</Guid>
   <Health>OK</Health>
   <Id>c62cf569-5ff7-45cc-bad3-e2a6bd44760a</Id>
   <LastAccessed/>
   <LastModified/>
   <LastVerified/>
   <Mountpoint>/mountpoint-0</Mountpoint>
   <Name>pool0</Name>
   <PartitionId>ba807ff5-ed78-444e-badf-41d5c497e0b5</PartitionId>
   <PoweredOn>TRUE</PoweredOn>
   <Quiesced>NO</Quiesced>
   <ReservedCapacity>0</ReservedCapacity>
   <State>NORMAL</State>
   <StorageDomainId/>
   <TotalCapacity>30000</TotalCapacity>
   <Type>NEARLINE</Type>
   <UsedCapacity>20000</UsedCapacity>
</Data>