Spectra Logic

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

Format Foreign Pool

Description

Format the specified foreign pools, permanently deleting all data on it and taking ownership of it for this gateway.

Requests

Syntax

PUT http[s]://{datapathDNSname}/_rest_/pool/{pool UUID or other unique attribute}/?operation=FORMAT

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 format pool. Value: FORMAT	yes

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>YES|NO|PENDING</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. If this attribute is null, then the object has not yet been completely received into cache.
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 gateway to access the pool.
Name	The name for the pool.
PartitionId	The UUID of the pool partition.
PoweredOn	Whether the pool is powered on. This is always TRUE for pools with type=ONLINE. Values: TRUE, FALSE
Quiesced	Whether the pool is in a temporarily inactive state. Values: YES, NO, PENDING
ReservedCapacity	The capacity reserved ensure pool performance.
State	The status of the pool. Values: § NORMAL — The pool is ready for use. § FOREIGN — A pool from another BlackPearl gateway. This data must be copied into a bucket on this gateway before it is accessible. § IMPORT_IN_PROGRESS — A FOREIGN pool is in the process of being imported into a bucket on this gateway. § IMPORT_PENDING— A FOREIGN pool is waiting to be imported into a bucket on this gateway. § LOST — The pool was removed without first exporting it from a bucket.
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 cancels the pending pool import of the pool with the UUID 426934bb-85ea-41e5-96b5-e56a3f7858e6.

PUT http://blackpearl-hostname/_rest_/pool/426934bb-85ea-41e5-96b5-e56a3f7858e6/?operation=FORMAT HTTP/1.1

Sample Response

<Data>
   <AssignedToStorageDomain>FALSE</AssignedToStorageDomain>
   <AvailableCapacity>10000</AvailableCapacity>
   <BucketId/>
   <Guid>4cb55978-2f13-426b-82db-ac0f37d462bd</Guid>
   <Health>OK</Health>
   <Id>426934bb-85ea-41e5-96b5-e56a3f7858e6</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>