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/[?error_message={string}][&id={string}][&last_page]
[&page_length={32-bit integer}][&page_offset={32-bit integer}] [&page_start_marker={string}][&partition_id={string}] [&serial_number={string}][&state=NORMAL|ERROR] [&type=LTO5|LTO6|LTO7|TS1140|TS1150|UNKNOWN]

Request Parameters

Parameter	Description	Required
error_message a	The description of an error.	no
id	The UUID for the tape drive.	no
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
serial_number a	The manufacturer-assigned serial number for the tape drive.	no
state	The status of the tape drive. Values: NORMAL, ERROR	no
type	The tape format and generation of the tape drive. Values: LTO5, LTO6, LTO7, TS1140, TS1150, UNKNOWN	no

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

Responses

Response Elements

<Data>
   <TapeDrive>
      <ErrorMessage>{string}</ErrorMessage>
      <ForceTapeRemoval>TRUE|FALSE</ForceTapeRemoval>
      <Id>{string}</Id>
      <LastCleaned>{YYYY-MM-DDThh:mm:ss.xxxZ}</LastCleaned>
      <PartitionId>{string}</PartitionId>
      <SerialNumber>{string}</SerialNumber>
      <State>NORMAL|ERROR</State>
      <TapeId>{string}</TapeId>
      <Type>LTO5|LTO6|LTO7|TS1140|TS1150|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.
ErrorMessage	A description of the current error, if applicable.
ForceTapeRemoval
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.
SerialNumber	The manufacturer-assigned serial number for the tape drive.
State	The status of the tape drive. Values: NORMAL, ERROR
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, TS1140, TS1150, UNKNOWN

Example

Sample Request

This request retrieves information about all tape drives connected to the Deep Storage Gateway.

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

Sample Response

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