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


Advanced Bucket Management Operations : Replication Target Operations : Register DS3 Target

Register DS3 Target
Description
Connect to and register the specified DS3 target as a replication target for the BlackPearl system.
Note:
If a DS3 target has its instance identifier reset (see Reset Instance Identifier) after it is registered on other BlackPearl systems, the replication link is invalid and must be deleted and re-created.
Requests
Syntax
POST http[s]://{datapathDNSname}/_rest_/ds3_target?admin_auth_id={string}&admin_secret_key={string}&data_path_end_point={string}&name={string}[&access_control_replication=NONE|USERS][&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][&permit_going_out_of_sync=TRUE|FALSE][&replicated_user_default_data_policy={string}]
Request Parameters 
§
NONE (default) — No access control is replicated.
§
USERS — The source BlackPearl system replicates its users and passwords to the target system.
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 (default), FALSE
Values: MINIMUM_LATENCY, AFTER_ONLINE_POOL, AFTER_NEARLINE_POOL, AFTER_NON_EJECTABLE_TAPE, LAST_RESORT, NEVER. See read_preference.
Responses
Response Elements
<Data>
   <AccessControlReplication>NONE|USERS</AccessControlReplication>
   <AdminAuthId>{
string}</AdminAuthId>
   <AdminSecretKey>{string}</AdminSecretKey>
   <DataPathEndPoint>{string}</DataPathEndPoint>
   <DataPathHttps>TRUE|FALSE</DataPathHttps>
   <DataPathPort>{16-bit integer}</DataPathPort>
   <DataPathProxy>{string}</DataPathProxy>
   <DataPathVerifyCertificate>
      TRUE|FALSE
   </DataPathVerifyCertificate>
   <DefaultReadPreference>
      MINIMUM_LATENCY|AFTER_ONLINE_POOL|AFTER_NEARLINE_POOL
      |AFTER_NON_EJECTABLE_TAPE|LAST_RESORT|NEVER
   </DefaultReadPreference>
   <Id>{string}</Id>
   <Name>{string}</Name>
   <PermitGoingOutOfSync>TRUE|FALSE</PermitGoingOutOfSync>
   <Quiesced>NO|PENDING|YES</Quiesced>
   <ReplicatedUserDefaultDataPolicy>
      {string}
   </ReplicatedUserDefaultDataPolicy>
   <State>ONLINE|OFFLINE|LIMITED_ACCESS</State>
</Data>
where the response elements are defined as follows:
§
NONE — No access control is replicated.
§
USERS — The source BlackPearl system replicates its users and passwords to the target system.
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.
Values: TRUE, FALSE
Values: MINIMUM_LATENCY, AFTER_ONLINE_POOL, AFTER_NEARLINE_POOL, AFTER_NON_EJECTABLE_TAPE, LAST_RESORT, NEVER. See read_preference.
The state of the DS3 target.
Values: ONLINE, OFFLINE, LIMITED_ACCESS
Example
Sample Request
This request registers a DS3 target with the data path end point ‘DataPath’, the Administrator S3 Access Id ‘c381Y3RyYQ==’, the Administrator S3 Secret Key ‘d7pJBeAN’, and the name ‘TargetDS3’ as a replication target for the BlackPearl system.
POST http[s]://blackpearl-hostname/_rest_/ds3_target?admin_auth_id=c381Y3RyYQ==&admin_secret_key=d7pJBeAN&data_path_end_point=DataPath&name=TargetDS3 HTTP/1.1
Sample Response
HTTP/1.1 201 CREATED
<Data>
   <AccessControlReplication>NONE</AccessControlReplication>
   <AdminAuthId>c381Y3RyYQ==</AdminAuthId>
   <AdminSecretKey>d7pJBeAN</AdminSecretKey>
   <DataPathEndPoint>192.168.15.16</DataPathEndPoint>
   <DataPathHttps>TRUE</DataPathHttps>
   <DataPathPort/>
   <DataPathProxy/>
   <DataPathVerifyCertificate>TRUE</DataPathVerifyCertificate>
   <DefaultReadPreference>MINIMUM_LATENCY</DefaultReadPreference>
   <Id>c927287a-90eb-428e-88ae-faedc3749e17</Id>
   <Name>TargetBP</Name>
   <PermitGoingOutOfSync>FALSE</PermitGoingOutOfSync>
   <Quiesced>NO</Quiesced>
   <ReplicatedUserDefaultDataPolicy/>
   <State>ONLINE</State>
</Data>