Spectra Logic

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

Get Tape Drives

Description

Get information about all tape drives. Use parameters as selection criteria to return a subset of the list.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/tape_drive​[?last_page][&page_length={32‑bit integer}][&page_offset={32‑bit integer}]​[&page_start_marker={string}][&partition_id={string}]​[&reserved_task_type=ANY|READ|WRITE][&serial_number={string}][&state=ERROR|NORMAL| NOT_COMPATIBLE_IN_PARTITION_DUE_TO_NEWER_TAPE_DRIVES|OFFLINE]​[&type=LTO5|LTO6|LTO7|LTO8|LTOM8|TS1140|TS1150|TS1155|UNKNOWN]

Request Parameters

Parameter	Description	Required
last_page	If included, only the last page of results is returned.	no
page_length	The maximum number of tape drives to list. The default is all items after page_offset.	no
page_offset	The starting point for the first tape drive to list. The default is 0.	no
page_start_marker	The UUID or other unique attribute for the item just before the first item to list. 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.	no
partition_id	The UUID for the partition.	no
reserved_task_ type	Whether the drive is reserved for reads only or writes only, or can be used for either. Values: ANY, READ, WRITE	no
serial_number a	The manufacturer-assigned serial number for the drive.	no
state	The status of the tape drive. Values: ERROR, NORMAL, NOT_COMPATIBLE_IN_PARTITION_DUE_TO_NEWER_TAPE_DRIVES, OFFLINE	no
type	The tape format and generation of the tape drive. Values: LTO5, LTO6, LTO7, LTO8, TS1140, TS1150, TS1155, UNKNOWN	no

a.	Parameter values can use wild cards (see Wild Card Syntax).

Responses

Response Elements

<Data>
   <TapeDrive>
      <CleaningRequired>TRUE|FALSE</CleaningRequired>
      <ErrorMessage>{string}</ErrorMessage>
      <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>
   </TapeDrive>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	A container for the response.
TapeDrive	A container for information about a single tape drive.
CleaningRequired	Whether the tape drive indicates that it needs to be cleaned. Values: TRUE, FALSE
ErrorMessage	A description of the 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 retrieves information about all tape drives connected to the Converged Storage System.

GET http://blackpearl-hostname/_rest_/tape_drive/ HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <TapeDrive>
      <CleaningRequired>FALSE</CleaningRequired>
      <ErrorMessage/>
      <ForceTapeRemoval>FALSE</ForceTapeRemoval>
      <Id>63d3dbd4-baa8-4e8f-a40d-42a6c3e3bf95</Id>
      <LastCleaned/>
      <PartitionId>
         4e848fa9-6cf5-45c4-ade2-16d96377401f
      </PartitionId>
      <Quiesced>NO</Quiesced>
      <ReservedTaskType>ANY</ReservedTaskType>
      <SerialNumber>68001883</SerialNumber>
      <State>NORMAL</State>
      <TapeId>2d4a2794-8617-4cdc-9e8f-0530fa1abbf2</TapeId>
      <Type>LTO5</Type>
   </TapeDrive>
   ...
</Data>