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


Hardware Operations : Tape Library and Component Operations : Get Tapes

Get Tapes
Description
Get a list of all tapes. Use parameters as selection criteria to return a subset of the list.
Requests
Syntax
GET http[s]://{datapathDNSname}/_rest_/tape/[?assigned_to_storage=TRUE|FALSE][&bar_code={string}] [&bucket_id={string}][&eject_label={string}] [&eject_location={string}][&full_details] [&full_of_data=TRUE|FALSE][&last_page]
[&page_length={32-bit integer}][&page_offset={32-bit integer}] [&page_start_marker={string}][&partition_id={string}]
[&previous_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|INCOMPATIBLE|LOST|
LTFS_WITH_FOREIGN_DATA|OFFLINE|ONLINE_IN_PROGRESS|ONLINE_PENDING| PENDING_INSPECTION| SERIAL_NUMBER_MISMATCH|UNKNOWN]
[&serial_number={string}] [&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|INCOMPATIBLE|LOST| LTFS_WITH_FOREIGN_DATA|OFFLINE|ONLINE_IN_PROGRESS|
ONLINE_PENDING| PENDING_INSPECTION| SERIAL_NUMBER_MISMATCH|
UNKNOWN][&storage_domain_id={string}]
[&type=LTO5|LTO6|LTO7|LTO_CLEANING_TAPE|TS_JC|TS_JD|TS_JK|TS_JL| TS_JZ|TS_JL|TS_CLEANING_TAPE|UNKNOWN|FORBIDDEN] [&write_protected=TRUE|FALSE]
Request Parameters
Notes:  
§
Specifying both page_offset and page _start_marker causes an error.
§
If neither page_offset, nor page_start_marker are specified, the page_offset default is used.
The tape format and generation of the tape cartridge.
Values:
LTO5, LTO6, LTO7, LTO_CLEANING_TAPE, TS_JC, TS_JD, TS_JK, TS_JL, TS_JY, TS_JZ, TS_CLEANING_TAPE, UNKNOWN, FORBIDDEN
a.
Responses
Response Elements
<Data>
   <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>
      <MostRecentFailure> (only if full_details is included)
         <Date>{YYYY-MM-DDThh:mm:ss.xxxZ}</Date>
         <ErrorMessage>{string}</ErrorMessage>
         <Id>{string}</Id>
         <TapeDriveId>{string}</TapeDriveId>
         <TapeId>{string}</TapeId>
         <Type>
            BAR_CODE_CHANGED|BAR_CODE_DUPLICATE|BLOB_READ_FAILED|
            DATA_CHECKPOINT_FAILURE|
            DATA_CHECKPOINT_FAILURE_DUE_TO_READ_ONLY|
            DATA_CHECKPOINT_MISSING|DELAYED_OWNERSHIP_FAILURE|
            DRIVE_CLEAN_FAILED|DRIVE_CLEANED|FORMAT_FAILED|
            GET_TAPE_INFORMATION_FAILED|IMPORT_FAILED|
            IMPORT_FAILED_DUE_TO_TAKE_OWNERSHIP_FAILURE|
            IMPORT_FAILED_DUE_TO_DATA_INTEGRITY|INSPECT_FAILED|
            READ_FAILED| REIMPORT_REQUIRED|SERIAL_NUMBER_MISMATCH|
            VERIFY_FAILED| WRITE_FAILED
         </Type>
      </MostRecentFailure>
      <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|INCOMPATIBLE|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|INCOMPATIBLE|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_JD|TS_JK|TS_JL|
         TS_JY|TS_JZ|TS_CLEANING_TAPE|UNKNOWN|FORBIDDEN
      </Type>
      <VerifyPending>
         CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND
      </VerifyPending>
      <WriteProtected>TRUE|FALSE</WriteProtected>
   </Tape>
   ...
</Data>
where the response elements are defined as follows:
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.
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.
The last manufacturer-assigned 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.
The type of tape error message. Values: BAR_CODE_CHANGED, BAR_CODE_DUPLICATE, BLOB_READ_FAILED, DATA_CHECKPOINT_FAILURE, DATA_CHECKPOINT_FAILURE_DUE_TO_READ_ONLY, DATA_CHECKPOINT_MISSING, DELAYED_OWNERSHIP_FAILURE, DRIVE_CLEAN_FAILED, DRIVE_CLEANED, FORMAT_FAILED, GET_TAPE_INFORMATION_FAILED, IMPORT_FAILED, IMPORT_FAILED_DUE_TO_TAKE_OWNERSHIP_FAILURE, IMPORT_FAILED_DUE_TO_DATA_INTEGRITY, INSPECT_FAILED, READ_FAILED, REIMPORT_REQUIRED, SERIAL_NUMBER_MISMATCH, VERIFY_FAILED, WRITE_FAILED
§
TRUE — The foreign tape was imported when WriteProtected was TRUE, preventing the tape from being owned.
§
FALSE — The tape was imported successfully.
The tape format and generation of the tape cartridge.
Values:
LTO5, LTO6, LTO7, LTO_CLEANING_TAPE, TS_JC, TS_JD, TS_JK, TS_JL, TS_JY, TS_JZ, TS_CLEANING_TAPE, UNKNOWN, FORBIDDEN
Example
Sample Request
This request retrieves information about all tapes associated with the BlackPearl Deep Storage Gateway.
GET http://blackpearl-hostname/_rest_/tape/ HTTP/1.1
Sample Response
HTTP/1.1 200 OK
<Data>
   <Tape>
      <AssignedToStorageDomain>FALSE</AssignedToStorageDomain>
      <AvailableRawCapacity>12385779712</AvailableRawCapacity>
      <BarCode>018675L6</BarCode>
      <BucketId>0acaac0a-55f9-4d6b-b410-4179d4696f37</BucketId>
      <DescriptionForIdentification/>
      <EjectDate/>
      <EjectLabel/>
      <EjectLocation/>
      <EjectPending/>
      <FullOfData>FALSE</FullOfData>
      <Id>d441e3f3-35d1-4081-aa91-c618b2ed7fc9</Id>
      <LastAccessed>2014-12-16 15:56:36.803</LastAccessed>
      <LastCheckpoint>
         1da169f7-b608-4e6e-93d7-6c0710842da8:25
      </LastCheckpoint>
      <LastModified>2014-12-16 15:56:36.803</LastModified>
      <LastVerified/>
      <MostRecentFailure>
         <Date>2015-02-18 10:11:53.114</Date>
         <ErrorMessage>Read failed.</ErrorMessage>
         <Id>d3282672-c68d-4016-8af9-eb4cbd902197</Id>
         <TapeDriveId>
               0414054e-f20b-478d-8f4f-5d995df9388d
         </TapeDriveId>
         <TapeId>0a05e8b9-4d6c-49d4-977f-32053f4a2a04</TapeId>
         <Type>BLOB_READ_FAILED</Type>
      </MostRecentFailure>
      <PartitionId>
         bd91171d-7738-4aea-b319-7abce892a7b1
      </PartitionId>
      <SerialNumber>HP-AE1WRUY90E</SerialNumber>
      <State>NORMAL</State>
      <StorageDomainId/>
      <TakeOwnershipPending>FALSE</TakeOwnershipPending>
      <TotalRawCapacity>2408088338432</TotalRawCapacity>
      <Type>LTO6</Type>
      <VerifyPending/>
      <WriteProtected>FALSE</WriteProtected>
   </Tape>
   ...
</Data>