Spectra Logic

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

Modify DS3 Data Replication Rule

Description

Modify a DS3 data replication rule for a data policy.

Note:

If the modify command does not include an optional request parameter, the replication rules retains the previous setting.

Requests

Syntax

PUT http[s]://{datapathDNSname}/_rest_/ds3_data_replication_rule/{data replication rule UUID or other unique attribute}​[replicate_deletes=TRUE|FALSE][?target_data_policy={text}][&type=PERMANENT|RETIRED]

Request Parameters 

Parameter	Description	Required
replicate_deletes	Whether objects deleted from buckets are also deleted from the replication target. Values: TRUE (default) — Any delete received locally always replicates on the Azure target. If the local BlackPearl system cannot communicate with one or more targets, the delete fails. FALSE— Any deletes received locally do not replicate to the target.	no
target_data_policy	The Blackpearl target data policy name, UUID, or other unique attribute.	no
type	The type of replication rule. Values: § PERMANENT — A copy of the data is replicated to the target. § RETIRED — A copy of already replicated data is maintained, but the rule is not applied to new data.	no

Responses

Response Elements

<Data>
   <DataPolicyId>{string}</DataPolicyId>
   <Id>{string}</Id>
   <ReplicateDeletes>TRUE|FALSE</ReplicateDeletes>
   <State>NORMAL</State>

   <TargetDataPolicy>{string}</TargetDataPolicy>

   <TargetId>{string}</TargetId>
   <Type>PERMANENT|RETIRED</Type>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
DataPolicyId	The UUID for the data policy.
Id	The UUID for the DS3 replication rule.
ReplicateDeletes	Whether objects deleted from local buckets are also deleted from the replication target. Values: TRUE, FALSE
State	The state of the persistence rule. Value: NORMAL — The persistence rule is in a normal, included state.
TargetDataPolicy	The UUID for the data policy on the Blackpearl target.
TargetId	The UUID for the Blackpearl target.
Type	The type of replication rule. Values: Values: § PERMANENT — A copy of the data is replicated to the target. § RETIRED — A copy of already replicated data is maintained, but the rule is not applied to new data.

Example

Sample Request

This request retires the DS3 replication rule with the UUID 34dde4ff-8603-4c44-b0e9-39150f9cc3ad.

POST http://blackpearl-hostname/_rest_/ds3_data_replication_rule/34dde4ff-8603-4c44-b0e9-39150f9cc3ad?type=RETIRED HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <DataPolicyId>
      88832b42-731e-4a82-be8d-3d787117ca7d
   </DataPolicyId>
   <Id>34dde4ff-8603-4c44-b0e9-39150f9cc3ad</Id>
   <ReplicateDeletes>TRUE</ReplicateDeletes>
   <State>NORMAL</State>

   <TargetDataPolicy/>
   <TargetId>e4858769-57e0-4f34-a2d0-3f7ad57aa80f</TargetId>
   <Type>RETIRED</Type>
</Data>