Spectra Logic

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

Get Storage Domain Members

Description

Get information about all storage domain members. Use parameters as selection criteria to return a subset of the list.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/storage_domain_member/ [?last_page][&page_length={32-bit integer}]
[&page_offset={32-bit integer}][&page_start_marker={string}] [&pool_partition_id={string}][&state={string}] [&storage_domain_id={string}][&tape_partition_id={string}] [&tape_type=LTO5|LTO6|LTO7|LTO_CLEANING_TAPE|TS_JC|TS_JY|TS_JK| TS_JD|TS_JZ|TS_JL|TS_CLEANING_TAPE|UNKNOWN|FORBIDDEN] [&write_preference=HIGH|NORMAL|LOW|NEVER_SELECT]

Request Parameters 

Parameter	Description	Required
last_page	If included, only the last page of results is returned.	no
page_length	The maximum number of storage domain members to list. Default: all items after page_offset.	no
page_offset	The starting point for the first storage domain member to list. Default: 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
pool_partition_id	The UUID for the pool partition assigned as a member.	no
state	The state of the storage domain member. Values: § NORMAL — The storage domain member is included normally. § EXCLUSION_IN_PROGRESS — The storage domain member is in the process of being excluded (data that resides on it is being copied to other storage domain members).	no
storage_domain_id	The UUID for the storage domain to which the storage domain member is assigned.	no
tape_partition_id	Tape partition UUID, name, or other unique attribute.	no
tape_type	The tape media type. Values: LTO5, LTO6, LTO7, LTO_CLEANING_TAPE, TS_JC, TS_JY, TS_JK, TS_JD, TS_JZ, TS_JL, TS_CLEANING_TAPE, UNKNOWN, FORBIDDEN	no
write_preference	The preferred usage of the tape partition when additional capacity is needed. The gateway uses a partition with HIGH write_preference before a partition with a NORMAL write_preference, and so on. A value of NEVER_SELECT indicates that the partition is read-only. Values: HIGH, NORMAL, LOW, NEVER_SELECT	no

Responses

Response Elements

<Data>
   <StorageDomainMember>
      <Id>{string}</Id>
      <PoolPartitionId>{string}</PoolPartitionId>
      <State>NORMAL</State>
      <StorageDomainId>{string}</StorageDomainId>
      <TapePartitionId>{string}</TapePartitionId>
      <TapeType>{string}</TapeType>
      <WritePreference>
         HIGH|NORMAL|LOW|NEVER_SELECT
      </WritePreference>
   </StorageDomainMember>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
StorageDomain Member	The container for information about one storage domain member.
Id	The UUID for the storage domain member.
PoolPartitionId	The UUID for the pool partition.
StorageDomainId	The UUID for the storage domain assigned the pool partition member.
State	The state of the pool partition member. Values: § NORMAL — The storage domain member is included normally.
TapePartitionId	The UUID for the tape partition.
TapeType	The type of tape used by this tape storage domain member. Values: LTO5, LTO6, LTO7, LTO_CLEANING_TAPE, TS_JC, TS_JY, TS_JK, TS_JD, TS_JZ, TS_JL, TS_CLEANING_TAPE, UNKNOWN, FORBIDDEN
WritePreference	The preferred usage of the pool partition when additional capacity is needed. The gateway uses a partition with HIGH write_preference before a partition with a NORMAL write_preference, and so on. A value of NEVER_SELECT indicates that the partition is read-only. Values: HIGH, NORMAL, LOW, NEVER_SELECT

Example

Sample Request

This request gets information about all storage domain members on the gateway.

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

Sample Response

HTTP/1.1 200 OK
<Data>
   <StorageDomainMember>
      <Id>c3e680ac-8426-4424-bdcc-e5a6b0d66638</Id>
      <PoolPartitionId>
         f58631f4-db97-4686-850f-5db17d509625
      </PoolPartitionId>
      <State>NORMAL</State>
      <StorageDomainId>
         aca7aecf-5bf6-4b03-bb7d-996df3963f39
      </StorageDomainId>
      <TapePartitionId/>
      <TapeType/>
      <WritePreference>NORMAL</WritePreference>
   </StorageDomainMember>
   <StorageDomainMember>
      <Id>d9a2f5c6-19b8-4818-9b89-495190a4b0f3</Id>
      <PoolPartitionId/>
      <State>NORMAL</State>
      <StorageDomainId>
         a3f0888c-9d0c-455c-ae8c-050970c2dab9
      </StorageDomainId>
      <TapePartitionId>
         8fff1c7e-8a3e-4e00-8b16-8585b130300f
      </TapePartitionId>
      <TapeType>LTO5</TapeType>
      <WritePreference>HIGH</WritePreference>
   </StorageDomainMember>
</Data>