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


Hardware Operations : Tape Library and Component Operations : Format Tape

Format Tape
Description
Format a tape. Tapes are not eligible if they have a state of EJECTED, LOST, EJECT_PENDING, or OFFLINE. In addition, the force parameter must be used to format a tape that contains data written by another BlackPearl gateway, to format a tape before it is inspected, to format a tape that has already been formatted by a BlackPearl gateway, or to format a tape that currently has reads or writes scheduled. If the tape contains data written by the current BlackPearl gateway, you must delete the objects and buckets before formatting the tape even if the force parameter is included.
*
The force parameter is not required to format a tape with the state UNKNOWN (see State). Any data on the tape media is lost during the format operation.
Requests
Syntax
PUT http[s]://{datapathDNSname}/_rest_/tape/{tape UUID or barcode}/?operation=FORMAT[&force]
To determine the UUID for a tape, see Get Tapes.
Request Parameters
Responses
Response Elements
<Data>
   <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|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>
</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.
§
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 queues the tape with the UUID 1c3fe1dc-95b7-4152-a286-951d0af2a27e to be formatted.
PUT http://blackpearl-hostname/_rest_/tape/1c3fe1dc-95b7-4152-a286-951d0af2a27e/?operation=FORMAT HTTP/1.1
Sample Response
HTTP/1.1 200 OK
<Data>
   <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>
   <StorageDomainId/>
   <TakeOwnershipPending>FALSE</TakeOwnershipPending>
   <State>FORMAT_PENDING</State>
   <TotalRawCapacity>2408088338432</TotalRawCapacity>
   <Type>LTO6</Type>
   <VerifyPending/>
   <WriteProtected>FALSE</WriteProtected>
</Data>