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

Inspect Tape

Description

Add the specified tape to the inspection queue if it is not already in the queue.

Requests

Syntax

PUT http[s]://{datapathDNSname}/_rest_/tape/{tape UUID or barcode}​?operation=INSPECT[task_priority=URGENT|HIGH|NORMAL|LOW]

To determine the UUID for a tape, see Get Tapes.

Request Parameters

Parameter	Description	Required
operation	The operation to perform. For this request, the operation is inspect. Value: INSPECT	yes
task_priority	The priority for processing this task. The task_priority determines the resources assigned and the processing order. Values: URGENT, HIGH, NORMAL, LOW	no

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>

   <PartiallyVerifiedEndOfTape>
      {YYYY-MM-DDThh:mm:ss.xxxZ}
   </PartiallyVerifiedEndOfTape>

   <PartitionId>{string}</PartitionId>
   <PreviousState>
      NORMAL|AUTO_COMPACTION_IN_PROGRESS|BAD|BAR_CODE_MISSING|       CANNOT_FORMAT_DUE_TO_WRITE_PROTECTION|       DATA_CHECKPOINT_FAILURE|       DATA_CHECKPOINT_FAILURE_DUE_TO_READ_ONLY|       DATA_CHECKPOINT_MISSING|EJECT_FROM_EE_PENDING|       EJECT_TO_EE_IN_PROGRESS|EJECTED|FOREIGN|FORMAT_IN_PROGRESS|       FORMAT_PENDING|IMPORT_IN_PROGRESS|IMPORT_PENDING|       INCOMPATIBLE|LOST|LTFS_WITH_FOREIGN_DATA|OFFLINE|       ONLINE_IN_PROGRESS|ONLINE_PENDING|PENDING_INSPECTION|       RAW_IMPORT_IN_PROGRESS|RAW_IMPORT_PENDING|       SERIAL_NUMBER_MISMATCH|UNKNOWN
   </PreviousState>
   <SerialNumber>{string}</SerialNumber>
   <State>
      NORMAL|AUTO_COMPACTION_IN_PROGRESS|BAD|BAR_CODE_MISSING|       CANNOT_FORMAT_DUE_TO_WRITE_PROTECTION|       DATA_CHECKPOINT_FAILURE|       DATA_CHECKPOINT_FAILURE_DUE_TO_READ_ONLY|       DATA_CHECKPOINT_MISSING|EJECT_FROM_EE_PENDING|       EJECT_TO_EE_IN_PROGRESS|EJECTED|FOREIGN|FORMAT_IN_PROGRESS|       FORMAT_PENDING|IMPORT_IN_PROGRESS|IMPORT_PENDING|       INCOMPATIBLE|LOST|LTFS_WITH_FOREIGN_DATA|OFFLINE|       ONLINE_IN_PROGRESS|ONLINE_PENDING|PENDING_INSPECTION|       RAW_IMPORT_IN_PROGRESS|RAW_IMPORT_PENDING|       SERIAL_NUMBER_MISMATCH|UNKNOWN
   </State>
   <StorageDomainMemberId>{string}</StorageDomainMemberId>
   <TakeOwnershipPending>TRUE|FALSE</TakeOwnershipPending>
   <TotalRawCapacity>{64‑bit integer}</TotalRawCapacity>
   <Type>
      LTO5|LTO6|LTO7|LTO8|LTOM8|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:

Parameter	Description
Data	A container for the response.
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 system cannot identify the tape.
EjectDate	The date and time that the BlackPearl system 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 system, for verifying the application integrity of the tape.
LastModified	The last date and time the tape was modified in the format YYYY-MM-DDThh:mm:ss.xxxZ.
LastVerified	The last date and time the checksum of the data was verified in the format YYYY-MM-DDThh:mm:ss.xxxZ.
PartiallyVerified EndOfTape	The last date and time the BlackPearl system verified the data on a specified percentage of the tape capacity before the EOD marker 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.
StorageDomain MemberId	The UUID for the storage domain member.
TakeOwnership Pending	Whether a tape from another BlackPearl system is waiting for the current system to complete taking ownership. Values: § TRUE — The foreign tape was imported when WriteProtected was TRUE, preventing the tape from being claimed by the current system. § 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, LTO7, LTO8, LTOM8, LTO_CLEANING_TAPE, TS_JC, TS_JD, TS_JK, TS_JL, TS_JY, TS_JZ, TS_CLEANING_TAPE, 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 queues the tape with the UUID 1c3fe1dc-95b7-4152-a286-951d0af2a27e to be inspected.

PUT http://blackpearl-hostname/_rest_/tape/1c3fe1dc-95b7-4152-a286-951d0af2a27e?operation=INSPECT 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/>
   <PartiallyVerifiedEndOfTape/>
   <PartitionId>bd91171d-7738-4aea-b319-7abce892a7b1</PartitionId>
   <PreviousState/>
   <SerialNumber>HP-AE1WRUY90E</SerialNumber>
   <State>PENDING_INSPECTION</State>
   <StorageDomainMemberId/>
   <TakeOwnershipPending>FALSE</TakeOwnershipPending>
   <TotalRawCapacity>2408088338432</TotalRawCapacity>
   <Type>LTO6</Type>
   <VerifyPending/>
   <WriteProtected>FALSE</WriteProtected>
</Data>