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

Get Storage Domains

Description

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

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/storage_domain​[?auto_eject_upon_cron={string}]​[&auto_eject_upon_job_cancellation=TRUE|FALSE]​[&auto_eject_upon_job_completion=TRUE|FALSE]​[&auto_eject_upon_media_full=TRUE|FALSE]​[&last_page]​[&media_ejection_allowed=TRUE|FALSE]​[&name={string}]​[&page_length={32‑bit integer}]​[&page_offset={32‑bit integer}]​[&page_start_marker={string}]​[&secure_media_allocation=TRUE|FALSE]​[&write_optimization=CAPACITY|PERFOMRANCE]

Request Parameters 

Parameter	Description	Required
auto_eject_upon_ cron	A CRON expression to indicate when to auto eject tape cartridges.	no
auto_eject_upon_ job_cancellation	Whether all media assigned to the storage domain, not already pending ejection, is queued for ejection whenever a job is canceled. Values: TRUE, FALSE (default)	no
auto_eject_upon_ job_completion	Whether all media assigned to the storage domain, not already pending ejection, is queued for ejection whenever a job completes. Values: TRUE, FALSE (default)	no
auto_eject_upon_media_full	Whether all media assigned to the storage domain, not already pending ejection, is queued for ejection whenever the media cannot fit the amount of data specified by auto_eject_media_full_threshold. Values: TRUE, FALSE (default)	no
last_page	If included, only the last page of results is returned.	no
media_ejection_ allowed	Whether the storage domain or a piece of media assigned to the storage domain, can be ejected from the BlackPearl system without generating a failure. Values: TRUE (default), FALSE	no
name	The name for the storage domain.	no
page_length	The maximum number of storage domains to list. Default: all items after page_offset.	no
page_offset	The starting point for the first storage domain 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
secure_media_ allocation	Whether media must remain within the storage domain. Values: § TRUE — Media assigned to the storage domain can only be reclaimed for use within the same storage domain. § FALSE (default) — Media assigned to a storage domain can be reclaimed into the general pool if all data on the media is deleted.	no
write_optimization	Whether job chunks are written as quickly as possible or across as few pieces of media as possible. For example, when PERFORMANCE mode is set for a tape partition, job chunks are written as quickly as possible, using all tape drive resources, even if that means that more tapes are allocated to the storage domain than are necessary to write the data. Values: CAPACITY (default), PERFORMANCE	no

Responses

Response Elements

<Data>
   <StorageDomain>
      <AutoEjectMediaFullThreshold>
         {64‑bit integer}
      </AutoEjectMediaFullThreshold>
      <AutoEjectUponCron>{string}</AutoEjectUponCron>
      <AutoEjectUponJobCancellation>
         TRUE|FALSE
      </AutoEjectUponJobCancellation>
      <AutoEjectUponJobCompletion>
         TRUE|FALSE
      </AutoEjectUponJobCompletion>
      <AutoEjectUponMediaFull>
         TRUE|FALSE
      </AutoEjectUponMediaFull>

      <Id>{string}</Id>
      <LtfsFileNaming>OBJECT_ID|OBJECT_NAME</LtfsFileNaming>

      <MaxTapeFragmentationPercent>
         {32‑bit integer}
      </MaxTapeFragmentationPercent>

      <MaximumAutoVerificationFrequencyInDays>
         {32‑bit integer}
      </MaximumAutoVerificationFrequencyInDays>
      <MediaEjectionAllowed>
         TRUE|FALSE
      </MediaEjectionAllowed>
      <Name>{string}</Name>
      <SecureMediaAllocation>TRUE|FALSE</SecureMediaAllocation>
      <VerifyPriorToAutoEject>
         CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND
      </VerifyPriorToAutoEject>
      <WriteOptimization>CAPACITY|PERFORMANCE</WriteOptimization>
   </StorageDomain>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
StorageDomain	The container for information about one storage domain.
AutoEjectMedia FullThreshold	The minimum available capacity (in bytes) at which media is not considered full and eligible for auto-eject.
AutoEjectUpon Cron	The CRON expression that indicate when to auto eject tape cartridges. If set, a CRON job is created based on the CRON string specified. Once the CRON job is executed, all tape cartridges assigned to the storage domain, not already pending ejection are queued for ejection.
AutoEjectUponJobCancellation	Whether all media assigned to the storage domain, not already pending ejection, is queued for ejection whenever a job is canceled. Values: TRUE, FALSE
AutoEjectUponJobCompletion	Whether all media assigned to the storage domain, not already pending ejection, is queued for ejection whenever a job completes. Values: TRUE, FALSE
AutoEjectUpon MediaFull	Whether all media assigned to the storage domain, not already pending ejection, is queued for ejection whenever the media cannot fit the amount of data specified by AutoEjectMediaFullThreshold. Values: TRUE, FALSE
Id	The UUID for the storage domain.
LtfsFileNaming	The LTFS file naming mode used on tapes in the storage domain. Values: OBJECT_ID, OBJECT_NAME. See ltfs_file_naming for descriptions.
MaxTape Fragmentation Percent	Obsolete parameter.
MaximumAuto Verification FrequencyInDays	The number of days since the last verification when a piece of unchanged media is not considered for verification.
Name	The name of the storage domain.
SecureMedia Allocation	Whether media must remain within the storage domain. Values: § TRUE — Media assigned to the storage domain can only be reclaimed for use within the same storage domain. § FALSE — Media assigned to a storage domain can be reclaimed into the general pool if all data on the media is deleted.
VerifyPriorToAuto Eject	The priority for verifying tapes being ejected automatically due to any of the auto-eject triggers. The priority is null if verification is not required prior to ejection. The priority determines the resources assigned and the processing order. Values: CRITICAL, URGENT, HIGH, NORMAL, LOW, BACKGROUND
WriteOptimization	Whether job chunks are written as quickly as possible (PERFORMANCE) or across as few pieces of media as possible (CAPACITY). Values: CAPACITY, PERFORMANCE

Example

Sample Request

This request gets information about all storage domains on the BlackPearl system.

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

Sample Response

HTTP/1.1 200 OK
<Data>
   <StorageDomain>
      <AutoEjectMediaFullThreshold/>
      <AutoEjectUponCron/>
      <AutoEjectUponJobCancellation>
         FALSE
      </AutoEjectUponJobCancellation>
      <AutoEjectUponJobCompletion>
         FALSE
      </AutoEjectUponJobCompletion>
      <AutoEjectUponMediaFull>FALSE</AutoEjectUponMediaFull>
      <Id>b5ef719c-a455-4527-a7b6-6a4780c3f67f</Id>
      <LtfsFileNaming>OBJECT_ID</LtfsFileNaming>
      <MaxTapeFragmentationPercent/>
      <MaximumAutoVerificationFrequencyInDays/>
      <MediaEjectionAllowed>TRUE</MediaEjectionAllowed>
      <Name>sd1</Name>
      <SecureMediaAllocation>FALSE</SecureMediaAllocation>
      </VerifyPriorToAutoEject>
      <WriteOptimization>CAPACITY</WriteOptimization>
   </StorageDomain>
   ...
</Data>