Spectra Logic

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

Import BlackPearl Foreign Tape

Description

Import the specified tape with data from a different BlackPearl system. If one or more buckets being imported does not already exist, the user ID and data policy to use for any new buckets must be specified. The storage domain to use may optionally be specified. If not specified, the BlackPearl system attempts to automatically determine the most logical storage domain in which to add the tape.

Notes:

§	When importing tapes, it is possible that buckets and objects with the same name may already exist on the current BlackPearl system. If so, when an object is imported, it may replace the existing object. Users should ensure their import settings in regards to conflict resolution are properly set.

§	To import non-BlackPearl foreign tapes, see Import LTFS Foreign Tape.

Requests

Syntax

PUT http[s]://{datapathDNSname}/_rest_/tape/{tape UUID or barcode}​?operation=IMPORT[&conflict_resolution_mode=ACCEPT_EXISTING|​ACCEPT_MOST_RECENT|CANCEL]​[&data_policy_id={string}]​[&priority=CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND]​[&storage_domain_id={string}][&user_id={string}]​[&verify_data_after_import=CRITICAL|URGENT|HIGH|NORMAL|LOW|​BACKGROUND][&verify_data_prior_to_import=TRUE|FALSE]

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 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_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 tape that do not already exist on the BlackPearl system. Note: If there are new buckets on the tape, the data_policy_id is required.	no
priority	The priority for processing the import. The priority determines the resources assigned and the processing order. Imports can be interrupted every 30 minutes if a job with a higher priority is received. Values: URGENT, HIGH, NORMAL, LOW	no
storage_domain_id	The UUID, name, or other unique attribute for the storage domain to associate with the data on the tape. Note: If this parameter is not specified, the BlackPearl system attempts to determine the most logical storage domain in which to add the tape. If the tape could be imported into multiple storage domains, the import fails, unless storage_domain_id is provided.	no
user_id	The UUID, name, or other unique attribute for the user to associate with any buckets on the tape that do not already exist on the BlackPearl system. Note: If there are new buckets on the tape, the user_id is required.	no
verify_data_after_ import	The priority for verifying the data after import. This determines the resources assigned and the processing order. Values: URGENT, HIGH, NORMAL, LOW	no
verify_data_before_import	Whether the data must be verified before the tape is imported. Values: TRUE, FALSE Note: It is recommended to verify data prior to import whenever it is possible that the tapes being imported contain objects with the same name as objects already in the bucket. Without verifying data prior to import, it is possible for the existing object to be replaced with the one being imported, even if the one being imported is partially corrupt and cannot be read.	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|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|INSPECTION_PENDING|LOST|
      LTFS_WITH_FOREIGN_DATA|OFFLINE|ONLINE_IN_PROGRESS|
      ONLINE_PENDING|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|INSPECTION_PENDING|LOST|
      LTFS_WITH_FOREIGN_DATA|OFFLINE|ONLINE_IN_PROGRESS|
      ONLINE_PENDING|SERIAL_NUMBER_MISMATCH|UNKNOWN
   </State>
   <StorageDomainId>{string}</StorageDomainId>

   <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.
StorageDomainId	The UUID for the storage domain to which the tape is assigned.
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 imports the tape with the UUID 1c3fe1dc-95b7-4152-a286-951d0af2a27e.

PUT http://blackpearl-hostname/_rest_/tape/1c3fe1dc-95b7-4152-a286-951d0af2a27e?operation=IMPORT 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>INSPECTION_PENDING</State>
   <StorageDomainId/>
   <TakeOwnershipPending>FALSE</TakeOwnershipPending>
   <TotalRawCapacity>2408088338432</TotalRawCapacity>
   <Type>LTO6</Type>
   <VerifyPending/>
   <WriteProtected>FALSE</WriteProtected>
</Data>