Spectra Logic

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

Clean Tape Drive

Description

Clean the specified tape drive.

Requests

Syntax

PUT http[s]://{datapathDNSname}/_rest_/tape_drive/{tape_drive_id}​?operation=CLEAN

To determine the UUID for a tape drive, see Get Tape Drives.

Request Parameters

Parameter	Description	Required
operation	The operation to perform. For this request, the operation is to clean the drive. Value: CLEAN	yes

Responses

Response Elements

<Data>
   <ErrorMessage>{string}</ErrorMessage>
   <CleaningRequired>TRUE|FALSE</CleaningRequired>
   <ForceTapeRemoval>TRUE|FALSE</ForceTapeRemoval>
   <Id>{string}</Id>
   <LastCleaned>{YYYY-MM-DDThh:mm:ss.xxxZ}</LastCleaned>
   <PartitionId>{string}</PartitionId>
   <Quiesced>NO|PENDING|YES</Quiesced>
   <ReservedTaskType>ANY|READ|WRITE</ReservedTaskType>
   <SerialNumber>{string}</SerialNumber>
   <State>
      ERROR|NORMAL|
      NOT_COMPATIBLE_IN_PARTITION_DUE_TO_NEWER_TAPE_DRIVES|OFFLINE
   </State>
   <TapeId>{string}</TapeId>
   <Type>
      LTO5|LTO6|LTO7|LTO8|LTOM8|TS1140|TS1150|TS1155|UNKNOWN
   </Type>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	A container for the response.
CleaningRequired	Whether the tape drive indicates that it needs to be cleaned. Values: TRUE, FALSE
Error Message	A description of any current error, if applicable.
ForceTapeRemoval	Whether the tape drive is in an error state and asking that the tape in it be forcibly removed. If required, this is performed before any other operations. Values: TRUE, FALSE
ID	The UUID for the tape drive.
LastCleaned	The last date and time the tape drive was cleaned in the format YYYY-MM-DDThh:mm:ss.xxxZ.
PartitionId	The UUID for the partition to which the drive belongs.
Quiesced	Whether the tape drive is in a temporarily inactive state. Values: NO, PENDING, YES
ReservedTaskType	Whether the drive is reserved for reads only or writes only, or can be used for either. Values: ANY, READ, WRITE
SerialNumber	The manufacturer-assigned serial number for the tape drive.
State	The status of the tape drive. Values: ERROR, NORMAL, NOT_COMPATIBLE_IN_PARTITION_DUE_TO_NEWER_TAPE_DRIVES, OFFLINE
TapeId	The UUID for the tape in the tape drive, if present.
Type	The tape format and generation of the tape drive. Values: LTO5, LTO6, LTO7, LTO8, TS1140, TS1150, TS1155, UNKNOWN

Example

Sample Request

This request cleans the tape drive with the UUID ab9146b8-feca-4023-8c45-0d60268ad115.

PUT http://blackpearl-hostname/_rest_/tape_drive/ab9146b8-feca-4023-8c45-0d60268ad115?operation=CLEAN HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <CleaningRequired>FALSE</CleaningRequired>
   <ErrorMessage/>
   <ForceTapeRemoval>FALSE</ForceTapeRemoval>
   <Id>ab9146b8-feca-4023-8c45-0d60268ad115</Id>
   <LastCleaned/>
   <PartitionId>703a0ad2-a86d-4d2a-97c9-56c2a59a718f</PartitionId>
   <Quiesced>NO</Quiesced>
   <ReservedTaskType>ANY</ReservedTaskType>
   <SerialNumber>68001883</SerialNumber>
   <State>NORMAL</State>
   <TapeId/>
   <Type>UNKNOWN</Type>
</Data>