Spectra Logic

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

Get Tape Partitions

Description

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

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/tape_partition​[?full_details][&import_export_configuration=NOT_SUPPORTED|​SUPPORTED][&last_page][&library_id={string}][?minimum_read_reserved_drives={32-bit integer}] [&minimum_write_reserved_drives={32-bit integer}][&name={string}][&page_length={32‑bit integer}][&page_offset={32‑bit integer}]​[&page_start_marker={string}][&quiesced=NO|PENDING|YES]​[&serial_number={string}][&state=ONLINE|OFFLINE]

Request Parameters

Parameter	Description	Required
full_details	If included, then additional information about the tape partition is included in the response.	no
import_export_ configuration	Whether the import and export configuration of the tape library is supported by the BlackPearl system. If a T50e or T120 library with multiple partitions is associated with a BlackPearl system, you cannot use the BlackPearl system to eject the tapes because of the library’s shared eject port. In this situation, see Spectra BlackPearl system User Guide for instructions for manually ejecting tapes from the BlackPearl system. Values: SUPPORTED, NOT_SUPPORTED	no
last_page	If included, only the last page of results is returned.	no
minimum_read_ reserved_drives	The minimum number of drives in the partition reserved for reads.	no
minimum_write_ reserved_drives	The minimum number of drives in the partition reserved for writes.	no
name a	The name of the partition.	no
page_length	The maximum number of tape partitions to list. The default is all items after page_offset.	no
page_offset	The starting point for the first tape partition 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
quiesced	Whether the partition is in a temporarily inactive state. Values: NO, PENDING, YES	no
serial_number a	The serial number of the library partition.	no
state	The status of the tape partition. Values: ONLINE, OFFLINE	no

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

Responses

Response Elements

<Data>
   <TapePartition>
      <DriveType>
         LTO5|LTO6|LTO7|LTO8|TS1140|TS1150|TS1155|UNKNOWN
      </DriveType>

      <ErrorMessage>{string}</ErrorMessage>
      <Id>{string}</Id>
      <ImportExportConfiguration>
         SUPPORTED|NOT_SUPPORTED
      </ImportExportConfiguration>
      <LibraryId>{string}</LibraryId>
      <MinimumReadReservedDrives>
         {32-bit integer}
      </MinimumReadReservedDrives>
      <MinimumWriteReservedDrives>
         {32-bit integer}
      </MinimumWriteReservedDrives>
      <Name>{string}</Name>
      <Quiesced>NO|PENDING|YES</Quiesced>
      <SerialId>{string}</SerialId>
      <SerialNumber>{string}</SerialNumber>
      <State>ONLINE|OFFLINE</State>

      <TapeTypes> (only if full_details is included)
         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
      </TapeTypes>
   </TapePartition>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
TapePartition	The container for information about one tape partition.
DriveType	The drive type used by the BlackPearl system. Values: LTO5, LTO6, LTO7, LTO8, TS1140, TS1150, TS1155, UNKNOWN
Error Message	The description of any current error.
Id	The UUID for the partition.
ImportExport Configuration	Whether the import and export configuration of the tape library is supported by the BlackPearl system. If a T50e or T120 library with multiple partitions is associated with a BlackPearl system, you cannot use the BlackPearl system to eject the tapes because of the library’s shared eject port. In this situation, see Spectra BlackPearl system User Guide for instructions for manually ejecting tapes from the BlackPearl system. Values: SUPPORTED, NOT_SUPPORTED
LibraryId	The UUID for the library.
MinimumRead ReservedDrives	The minimum number of drives in the partition reserved for reads.
MinimumWrite ReservedDrives	The minimum number of drives in the partition reserved for writes.
Name	The name of the partition.
Quiesced	Whether the partition is in a temporarily inactive state. Values: NO, PENDING, YES
SerialID	A unique representation of the library partition serial number that remains the same even if the partition exporter is replaced.
SerialNumber	The serial number of the library partition.
State	The status of the tape partition. Values: ONLINE, OFFLINE
TapeTypes	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

Example

Sample Request

This request retrieves a list of tape partitions.

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

Sample Response

HTTP/1.1 200 OK
<Data>
   <TapePartition>
      <ErrorMessage/>
      <Id>9a0a67cd-9e42-43fc-afa6-95cb3f630251</Id>
      <ImportExportConfiguration>
         SUPPORTED
      </ImportExportConfiguration>
      <LibraryId>ab5b482f-1119-4a96-ab72-9e8ceda7d22f</LibraryId>
      <MinimumReadReservedDrives>0</MinimumReadReservedDrives>
      <MinimumWriteReservedDrives>0</MinimumWriteReservedDrives>
      <Name>Tape partition</Name>
      <Quiesced>NO</Quiesced>
      <SerialId>01000090A5000950</SerialId>
      <SerialNumber>21130090A5000950</SerialNumber>
      <State>ONLINE</State>
   </TapePartition>
   ...
</Data>