Spectra Logic

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

Pair Back Registered DS3 Target

Description

Pairs back the DS3 target with the replication source such that the source points to the DS3 target and the DS3 target points to the source (enabling bidirectional replication). Use optional parameters to modify the registration settings for the pair back.

Note:

If the name parameter is not included, name is set to the BlackPearl system’s serial number. If any other optional request parameter is not included, the setting used to register the original DS3 target is used.

Requests

Syntax

PUT http[s]://{datapathDNSname}/_rest_/ds3_target/{DS3 target instance UUID, name, or other unique attribute}​?operation=PAIR_BACK[&access_control_replication=NONE|USERS]​[admin_auth_id={string][&admin_secret_key={string}]​[&data_path_end_point={string}][&data_path_https=TRUE|FALSE]​[&data_path_port={32‑bit integer}][&data_path_proxy={string}]​[&data_path_verify_certificate=TRUE|FALSE]​[&default_read_preference=MINIMUM_LATENCY|AFTER_ONLINE_POOL|​AFTER_NEARLINE_POOL​|AFTER_NON_EJECTABLE_TAPE​|LAST_RESORT​|NEVER]​[&name={string}][&permit_going_out_of_sync=TRUE|FALSE]​[&replicated_user_default_data_policy={string}]

To determine the UUID for a DS3 target instance, see Get DS3 Targets.

Request Parameters 

Parameter	Description	Required
operation	The operation to perform. For this request, the operation is pair back. Value: PAIR_BACK	yes
access_control_ replication	The access control that is replicated to the DS3 target. Values: § NONE — No access control is replicated. § USERS — The source BlackPearl system replicates its users and passwords to the target system.	no
admin_auth_id	The S3 access ID assigned to an Administrator.	no
admin_secret_key	The S3 secret key for the account matching the given admin_auth_id.	no
data_path_end_ point	The IPv4 address or DNS name for the data path of the DS3 target.	no
data_path_https	Whether the source BlackPearl system uses the HTTPS protocol to setup and replicate data to the target system. Values: TRUE, FALSE	no
data_path_port	The value of the port on which the DS3 target’s S3 server is running. If null, the parameter defaults to port 80 for HTTP connections and port 443 for HTTPS connections.	no
data_path_proxy	The proxy server for the source BlackPearl system to use to connect to the target system.	no
data_path_verify_ certificate	Whether the data path certificate is verified. When DataPathVerifyCertificate and DataPathHttps are both TRUE, the source BlackPearl system fully validates the target system’s certificate. If the certificate is not trusted or problematic in anyway, it is not honored. Do not set this to TRUE if the target system is using the default self-signed SSL certificate. Values: TRUE, FALSE	no
default_read_ preference	When it is preferable to read from the DS3 target rather than the replication source. Values: MINIMUM_LATENCY, AFTER_ONLINE_POOL, AFTER_NEARLINE_POOL, AFTER_NON_EJECTABLE_TAPE, LAST_RESORT, NEVER. See read_preference.	no
name	The name for the DS3 target. Default: system serial number.	no
permit_going_out_of_sync	Whether a target is allowed to be out of sync with the source. By default, if the data policy specifies that the BlackPearl system must replicate local actions, actions that the system cannot replicate fail. You can temporarily set this parameter to TRUE in order to operate in full capacity locally while one or more targets is down for a prolonged period of time. Values: TRUE, FALSE	no
replicated_user_ default_data_ policy	The data policy the target applies as the default data policy for any users replicated to the target.	no

Responses

Response Elements

The operation returns status only.

Notable status codes:

§	204: No Content (success)

§	403: Access Denied

§	404: Not Found

Example

Sample Request

This request pairs back the DS3 target named ‘DS3Target’ using all of the same registration parameters.

PUT http[s]://blackpearl-hostname/_rest_/ds3_target/DS3Target​?operation=PAIR_BACK HTTP/1.1

Sample Response

HTTP/1.1 204 No Content