Spectra Logic

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

Get Storage Domain

Description

Get information about the specified storage domain.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/storage_domain/{storage domain UUID, name, or other unique attribute}/

To determine the UUID for a storage domain, see Get Storage Domains.

Responses

Response Elements

<Data>
   <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>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
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	Not currently used.
MaximumAuto Verification FrequencyInDays	The number of days since the last verification when a piece of unchanged media is not considered for verification.
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 the storage domain with the name “sd1”.

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

Sample Response

HTTP/1.1 200 OK
<Data>
   <AutoEjectMediaFullThreshold/>
   <AutoEjectUponCron/>
   <AutoEjectUponJobCancellation>
      FALSE
   </AutoEjectUponJobCancellation>
   <AutoEjectUponJobCompletion>FALSE</AutoEjectUponJobCompletion>
   <AutoEjectUponMediaFull>FALSE</AutoEjectUponMediaFull>
   <Id>30313cfa-f8b2-4093-830c-3c8d06db6f6b</Id>
   <LtfsFileNaming>OBJECT_ID</LtfsFileNaming>
   <MaxTapeFragmentationPercent>65</MaxTapeFragmentationPercent>
   <MaximumAutoVerificationFrequencyInDays>
      365
   </MaximumAutoVerificationFrequencyInDays>
   <MediaEjectionAllowed>TRUE</MediaEjectionAllowed>
   <Name>sd1</Name>

   <SecureMediaAllocation>FALSE</SecureMediaAllocation>
   <VerifyPriorToAutoEject/>
   <WriteOptimization>CAPACITY</WriteOptimization>
</Data>