Spectra Logic

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

Get Data Policies

Description

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

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/data_policy​[?always_force_put_job_creation=TRUE|FALSE]​[&always_minimize_spanning_across_media=TRUE|FALSE]​[&checksum_type=CRC_32|CRC_32C|MD5|SHA_256|SHA_512]​[&end_to_end_crc_required=TRUE|FALSE][&last_page][&name={string}]​[&page_length={32‑bit integer}][&page_offset={32‑bit integer}]​[&page_start_marker={string}]

Request Parameters 

Parameter	Description	Required
always_force_put_ job_creation	Whether all PUT jobs created for this data policy are created even if one or more storage domains and/or replication targets the BlackPearl system must PUT to is unavailable, or if there are global issues that would likely prevent the completion of the job. Values: TRUE, FALSE	no
always_minimize_ spanning_across_media	Whether all PUT jobs created using this data policy are configured to minimize spanning across tape media. Values: TRUE, FALSE. See always_minimize_ spanning_across_media.	no
checksum_type	The type of checksum used to verify data integrity for any operations involving this data policy and the type of checksum required for end-to-end CRC, if specified. Values: CRC_32, CRC_32C, MD5, SHA_256, SHA_512	no
end_to_end_crc_ required	Whether or not clients are required to compute and send an end-to-end CRC. Values: TRUE, FALSE	no
last_page	If included, only the last page of results is returned.	no
name a	The name for the data policy.	no
page_length	The maximum number of data policies to list. Default: all items after page_offset.	no
page_offset	The starting point for the first data policy 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

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

Responses

Response Elements

<Data>
   <DataPolicy>
      <AlwaysForcePutJobCreation>
         TRUE|FALSE
      </AlwaysForcePutJobCreation>
      <AlwaysMinimizeSpanningAcrossMedia>
         TRUE|FALSE
      </AlwaysMinimizeSpanningAcrossMedia>
      <BlobbingEnabled>TRUE</BlobbingEnabled>
      <ChecksumType>
         CRC_32|CRC_32C|MD5|SHA_256|SHA_512
      </ChecksumType>
      <CreationDate>YYYY-MM-DDThh:mm:ss.xxxZ</CreationDate>
      <DefaultBlobSize>{64‑bit integer}</DefaultBlobSize>
      <DefaultGetJobPriority>
         CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND
      </DefaultGetJobPriority>
      <DefaultPutJobPriority>
         CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND
      </DefaultPutJobPriority>
      <DefaultVerifyAfterWrite>
         TRUE|FALSE
      </DefaultVerifyAfterWrite>
      <DefaultVerifyJobPriority>
         CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND
      </DefaultVerifyJobPriority>

      <EndToEndCrcRequired>TRUE|FALSE</EndToEndCrcRequired>
      <Id>{string}</Id>
      <Name>{string}</Name>

      <RebuildPriority>
         CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND
      </RebuildPriority>
      <Versioning>NONE|KEEP_LAST</Versioning>

   </DataPolicy>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
DataPolicy	The container for information about one data policy.
AlwaysForcePutJobCreation	Whether all PUT jobs created for this data policy are created even if one or more storage domains and/or replication targets the BlackPearl system must PUT to is unavailable, or if there are global issues that would likely prevent the completion of the job. Values: TRUE, FALSE
AlwaysMinimize SpanningAcross Media	Whether all PUT jobs created for this data policy are created to minimize spanning across media. Values: TRUE, FALSE. See always_minimize_ spanning_across_media.
BlobbingEnabled	Whether or not blobbing is enabled.
ChecksumType	Type of checksum used to verify data integrity for any operations involving this data policy. Values: CRC_32, CRC_32C, MD5, SHA_256, SHA_512
CreationDate	The date and time the data policy was created in the format YYYY-MM-DDThh:mm:ss.xxxZ.
DefaultBlobSize	The maximum blob size.
DefaultGetJob Priority	The default GET job priority for the data policy. The job priority determines the resources assigned and the processing order. Values: CRITICAL, URGENT, HIGH, NORMAL, LOW, BACKGROUND
DefaultPutJob Priority	The default PUT job priority for the data policy. The job priority determines the resources assigned and the processing order. Values: CRITICAL, URGENT, HIGH, NORMAL, LOW, BACKGROUND
DefaultVerifyAfterWrite	Whether data is verified by default after it is written. Values: TRUE, FALSE
DefaultVerifyJob Priority	The default verify job priority for the data policy. The job priority determines the resources assigned and the processing order. Values: CRITICAL, URGENT, HIGH, NORMAL, LOW, BACKGROUND
EndToEndCrc Required	Whether or not clients are required to compute and send an end-to-end CRC. Values: TRUE, FALSE
Id	The UUID for the data policy.
Name	The name of the data policy.
RebuildPriority	The rebuild priority for the data policy. The rebuild priority determines the relative priority compared to other jobs being processed. Values: CRITICAL, URGENT, HIGH, NORMAL, LOW, BACKGROUND
Versioning	The mode of versioning used by the data policy. Values: NONE, KEEP_LATEST see versioning.

Example

Sample Request

This request gets information about all data policies on the BlackPearl system.

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

Sample Response

HTTP/1.1 200 OK
<Data>
   <DataPolicy>
      <AlwaysForcePutJobCreation>FALSE</AlwaysForcePutJobCreation>
      <AlwaysMinimizeSpanningAcrossMedia>
         FALSE
      </AlwaysMinimizeSpanningAcrossMedia>
      <BlobbingEnabled>TRUE</BlobbingEnabled>
      <ChecksumType>MD5</ChecksumType>
      <CreationDate>2015-07-29 16:26:12.768</CreationDate>
      <DefaultBlobSize/>
      <DefaultGetJobPriority>HIGH</DefaultGetJobPriority>
      <DefaultPutJobPriority>NORMAL</DefaultPutJobPriority>
      <DefaultVerifyJobPriority>LOW</DefaultVerifyJobPriority>
      <EndToEndCrcRequired>FALSE</EndToEndCrcRequired>
      <Id>43d40cce-bb94-4b73-a504-8811f37d8012</Id>
      <Name>policy1</Name>
      <RebuildPriority>LOW</RebuildPriority>
      <Versioning>NONE</Versioning>
   </DataPolicy>
   ...
</Data>