Spectra Logic

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

Create DS3 Data Replication Rule

Description

Create a DS3 data replication rule for a data policy. Each DS3 replication rule targets a specified Blackpearl target.

You cannot specify the same Blackpearl target multiple times in different replication rules applied to the same data policy. You can reference the same Blackpearl target across different data policies.

You must create the data policy and register the Blackpearl target before creating the replication rule. See Create Data Policy and Register DS3 Target.

Requests

Syntax

POST http[s]://{datapathDNSname}/_rest_/ds3_data_replication_rule​?data_policy_id={string}&target_id={string}​&type=PERMANENT[&target_data_policy={string}][&replicate_deletes=TRUE|FALSE]

Request Parameters 

Parameter	Description	Required
data_policy_id	Data policy name, UUID, or other unique attribute.	yes
target_id	BlackPearl target name, UUID, or other unique attribute.	yes
type	The type of replication rule to create. Value: PERMANENT Note: Replication rules can be modified to have a type of RETIRED, but cannot be created as RETIRED.	yes
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

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</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 data 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: PERMANENT

Example

Sample Request

This request creates a permanent data replication rule for the data policy named “ds3policy1” for the BlackPearl target with the name “ds3target1” using the default data policy for the target.

POST http://blackpearl-hostname/_rest_/ds3_data_replication_rule​?data_policy_id=ds3policy1&target_id=ds3target1&type=PERMANENT HTTP/1.1

Sample Response

HTTP/1.1 200 OK

<Data>
   <DataPolicyId>
      a1e39fc5-a752-4740-b9f0-4ae5c3b97e81
   </DataPolicyId>
   <Id>2b44efc8-02f9-48b0-bd4d-5e8033333e18</Id>
   <ReplicateDeletes>TRUE</ReplicateDeletes>

   <State>NORMAL</State>

   <TargetDataPolicy>
     3a24ffb7-15f7-33c1-fd3d-6d812513f10
   </TargetDataPolicy>
   <TargetId>sfqc4721-6370-2122-949e-92515e7a320f</TargetId>
   <Type>PERMANENT</Type>
</Data>