Spectra Logic

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

Get Physical Placement

Description

Get the list of media on which the specified objects are physically located. Errors are not returned if the object does not exist or if the object does not have a physical placement. If the full_details request parameter is specified, physical placement is shown on a per-object-piece basis. If the full_details request parameter is not specified, a summary physical placement is provided.

Requests

Syntax

PUT http[s]://{datapathDNSname}/_rest_/bucket/{bucket name}/?operation=get_physical_placement[&full_details] [&storage_domain_id={string}]

Request Parameters

Parameter	Description	Required
operation	The operation to perform. For this request, the operation is to get physical placement. Value: GET_PHYSICAL_PLACEMENT	yes
full_details	If included, physical placement is shown on a per-object-piece basis. If not included, a summary physical placement is provided	no

Request Elements

An XML payload, formatted as follows, must be sent to describe the object for which to get physical placement information:

<Objects>
      <Object Name="{string}"/>
      <Object Name="{string}"/>
</Objects>

where the parameters are defined as follows:

Parameter	Description	Required
Objects	The container for information about all objects	yes
Object Name	The name of an object for which you want to get physical placement information.	yes

Responses

Response Elements

<Data>
   <Object Latest="TRUE|FALSE" Length="{64-bit integer}"
      Name="{string}"Offset="{64-bit integer}"
      Version="{64-bit integer}">
      (only if full_details is included)
      <PhysicalPlacement>(only if full_details is included)
         <Pools>
            <Pool>
               <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>
            </Pool>

            ...
         </Pools>

         <Tapes>
            <Tape>
               <AssignedToStorageDomain>
                  TRUE|FALSE
               </AssignedToStorageDomain>
               <AvailableRawCapacity>
                  {64-bit integer}
               </AvailableRawCapacity>
               <BarCode>{string}</BarCode>
               <BucketId>{string}</BucketId>
               <DescriptionForIdentification>
                  {string}
               </DescriptionForIdentification>
               <EjectDate>{YYYY-MM-DDThh:mm:ss.xxxZ}</EjectDate>
               <EjectLabel>{string}</EjectLabel>
               <EjectLocation>{string}</EjectLocation>
               <EjectPending>
                  {YYYY-MM-DDThh:mm:ss.xxxZ}
               </EjectPending>
               <FullOfData>TRUE|FALSE</FullOfData>
               <Id>{string}</Id>
               <LastAccessed>
                  {YYYY-MM-DDThh:mm:ss.xxxZ}
               </LastAccessed>
               <LastCheckpoint>{string}</LastCheckpoint>
               <LastModified>
                  {YYYY-MM-DDThh:mm:ss.xxxZ}
               </LastModified>
               <LastVerified>
                  {YYYY-MM-DDThh:mm:ss.xxxZ}
               </LastVerified>
               <PartitionId>{string}</PartitionId>

               <PreviousState>
                  NORMAL|BAD|BAR_CODE_MISSING|
                  DATA_CHECKPOINT_MISSING|EJECT_FROM_EE_PENDING|
                  EJECT_TO_EE_IN_PROGRESS|EJECTED|FOREIGN|
                  FORMAT_IN_PROGRESS|FORMAT_PENDING|
                  IMPORT_IN_PROGRESS|LOST|LTFS_WITH_FOREIGN_DATA|
                  OFFLINE|ONLINE_IN_PROGRESS|ONLINE_PENDING|
                  PENDING_INSPECTION|SERIAL_NUMBER_MISMATCH|
                  UNKNOWN
               </PreviousState>

               <SerialNumber>{string}</SerialNumber>
               <State>
                  NORMAL|BAD|BAR_CODE_MISSING|
                  DATA_CHECKPOINT_MISSING|EJECT_FROM_EE_PENDING|
                  EJECT_TO_EE_IN_PROGRESS|EJECTED|FOREIGN|
                  FORMAT_IN_PROGRESS|FORMAT_PENDING|
                  IMPORT_IN_PROGRESS|LOST|LTFS_WITH_FOREIGN_DATA|
                  OFFLINE|ONLINE_IN_PROGRESS|ONLINE_PENDING|
                  PENDING_INSPECTION|SERIAL_NUMBER_MISMATCH|
                  UNKNOWN
               </State>

               <StorageDomainId>{string}</StorageDomainId>

               <TakeOwnershipPending>
                  TRUE|FALSE
               </TakeOwnershipPending>

               <TotalRawCapacity>
                  {64-bit integer}
               </TotalRawCapacity>
               <Type>
                  LTO5|LTO6|LTO7|LTO_CLEANING_TAPE|TS_JC|TS_JY|
                  TS_JK|TS_JD|TS_JZ|TS_JL|TS_CLEANING_TAPE|
                  UNKNOWN|FORBIDDEN
               </Type>
               <VerifyPending>
                  CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND
               </VerifyPending>
               <WriteProtected>TRUE|FALSE</WriteProtected>
            </Tape>
         </Tapes>
      </PhysicalPlacement>
   </Object>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	A container for the response.
Object	The container for information about one object.
Latest	Whether this version of the object is the latest. Values: TRUE, FALSE
Length	The length in bytes of the object.
Name	The name of the object.
Offset	The offset in bytes from the start of the object.
Version	The version number of the object.
PhysicalPlacement	The container for the list of tapes containing the object.
Pools	The container for information about all pools.
Pool	The container for information about one pool.
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.
Tapes	The container for information about all tapes.
Tape	The container for information about the tape containing the object.
AssignedToStorageDomain	Whether the tape is currently assigned to a storage domain. Values: TRUE, FALSE
AvailableRaw Capacity	The amount of unused raw capacity on the tape in bytes.
BarCode	The barcode on the label of the tape cartridge.
BucketId	The UUID for the bucket to which the tape is assigned.
DescriptionFor Identification	The LTFS Volume ID and name, if applicable. This is only provided if the BlackPearl gateway cannot identify the tape.
EjectDate	The date and time that the BlackPearl gateway discovered that the tape was ejected, in the format YYYY-MM-DDThh:mm:ss.xxxZ. If the parameter is empty, the tape has not been ejected.
EjectLabel	The user-entered information to assist in the handling of the tape.
EjectLocation	The user-entered information to describe where the ejected tape can be located.
EjectPending	The date and time that the tape was put in the queue to be ejected in the format YYYY-MM-DDThh:mm:ss.xxxZ. If the parameter is empty, the tape has not been queued to be ejected or the eject has started and is no longer cancelable.
FullOfData	Whether the tape is completely full of data. Values: TRUE, FALSE
Id	The UUID for the tape.
LastAccessed	The last date and time the tape was loaded into a tape drive in the format YYYY-MM-DDThh:mm:ss.xxxZ.
LastCheckpoint	An identifier, internal to the BlackPearl gateway, for verifying the application integrity of the tape.
LastModified	The last date and time the object 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.
PartitionId	The UUID for the partition to which the tape belongs.
PreviousState	The previous status of the tape. See State.
SerialNumber	The manufacturer-assigned serial number for the tape.
State	The status of the tape. See State.
StorageDomainId	The UUID for the storage domain to which the tape is assigned.
TakeOwnership Pending	Whether a tape from another BlackPearl gateway is waiting for ownership by the current gateway to be completed. Values: § TRUE — The foreign tape was imported when WriteProtected was TRUE, preventing the tape from being owned. § FALSE — The tape was imported successfully.
TotalRawCapacity	The total raw capacity of the tape in bytes.
Type	The tape format and generation of the tape cartridge. Values: LTO5, LTO6, TS_JC, TS_JY, TS_JK, TS_JD, TS_JZ, TS_JL, UNKNOWN, FORBIDDEN
VerifyPending	The priority for the verify requested, or null if a verify has not been requested. The priority determines the resources assigned and the processing order. Values: CRITICAL, URGENT, HIGH, NORMAL, LOW, BACKGROUND
WriteProtected	Whether the tape is write protected. Values: TRUE, FALSE

Example

Sample Request

This request returns a list of the tapes on which the objects specified in the payload reside.

PUT http://blackpearl-hostname/_rest_/bucket/bucket1/?operation=get_physical_placement&full_details HTTP/1.1

<Objects>
      <Object Name="object1"/>
      <Object Name="object4"/>
</Objects>

Sample Response

HTTP/1.1 200 OK
<Data>
   <Object Latest="TRUE" Length="10" Name="o4" Offset="0"
      Version="1">
      <PhysicalPlacement>
         <Tapes>
            <Tape>
               <AssignedToStorageDomain>
                  FALSE
               </AssignedToStorageDomain>
               <AvailableRawCapacity>
                  2408088338432
               </AvailableRawCapacity>
               <BarCode>018675L6</BarCode>
               <BucketId>
                  0acaac0a-55f9-4d6b-b410-4179d4696f37
               </BucketId>
               <DescriptionForIdentification/>
               <EjectDate/>
               <EjectLabel/>
               <EjectLocation/>
               <EjectPending/>
               <FullOfData>FALSE</FullOfData>
               <Id>1c3fe1dc-95b7-4152-a286-951d0af2a27e</Id>
               <LastAccessed/>
               <LastCheckpoint/>
               <LastModified/>
               <LastVerified/>
               <PartitionId>
                  bd91171d-7738-4aea-b319-7abce892a7b1
               </PartitionId>
               <PreviousState/>
               <SerialNumber>HP-AE1WRUY90E</SerialNumber>
               <State>PENDING_INSPECTION</State>
               <StorageDomainId/>
               <TakeOwnershipPending>FALSE</TakeOwnershipPending>
               <TotalRawCapacity>2408088338432</TotalRawCapacity>
               <Type>LTO6</Type>
               <VerifyPending/>
               <WriteProtected>FALSE</WriteProtected>
            </Tape>
         </Tapes>
      </PhysicalPlacement>
   </Object>
</Data>