Spectra Logic

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

Import Pool

Description

Import the specified pool for use by the BlackPearl gateway.

Requests

Syntax

PUT http[s]://{datapathDNSname}/_rest_/pool/{pool UUID or unique attribute}/?operation=IMPORT [&conflict_resolution_mode=ACCEPT_EXISTING|ACCEPT_IMPORT| ACCEPT_HIGHEST_VERSION|ACCEPT_MOST_RECENT|CANCEL] [&data_policy_id={string}][&storage_domain_id={string}] [&user_id={string}]

 

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 import. Value: IMPORT	yes
conflict_resolution_mode	How the data path backend handles object name conflicts. Values: § ACCEPT_EXISTING — Keep the file currently in the BlackPearl database. § ACCEPT_IMPORT — Keep the file currently being imported. § ACCEPT_HIGHEST_VERSION — Keep the file with the highest version number. § ACCEPT_MOST_RECENT — Keep the file with the most recent creation date. § CANCEL (default) — Cancel the import process.	no
data_policy_id	The UUID, name, or other unique attribute for the data policy to associate with any buckets on the pool that do not already exist on the gateway. Note: If there are new buckets on the pool, the data_policy_id is required.	no
storage_domain_id	The UUID, name, or other unique attribute for the storage domain to associate with the data on the pool. Note: If there are new buckets on the pool and this parameter is not specified, the gateway attempts to determine the most logical storage domain in which to add the pool.	no
user_id	The UUID, name, or other unique attribute for the user to associate with any buckets on the pool that do not already exist on the gateway. Note: If there are new buckets on the pool, the user_id is required.	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>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. See 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 imports the pool with the UUID ea6719df-4d61-4462-89c5-51d6bf44f47d using the data policy ‘dp1’ and the user ‘abc’.

GET http://blackpearl-hostname/_rest_/pool/ea6719df-4d61-4462-89c5-51d6bf44f47d/?operation=IMPORT&data_policy_id=dp1&user_id=abc HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <AssignedToStorageDomain>FALSE</AssignedToStorageDomain>
   <AvailableCapacity>10000</AvailableCapacity>
   <BucketId/>
   <Guid>1cad0b5a-e271-4b70-aca9-a8c614779b18</Guid>
   <Health>OK</Health>
   <Id>ea6719df-4d61-4462-89c5-51d6bf44f47d</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>