Spectra Logic

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

Modify DS3 Target

Description

Modify a DS3 target.

Notes:

§	If an optional request parameter is not included, the previous setting is retained.

§	It is not possible to change the quiesced state directly from NO to YES.

Requests

Syntax

PUT http[s]://{datapathDNSname}/_rest_/ds3_target/{BlackPearl target instance UUID, name, or other unique attribute}​[?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]​[&quiesced=NO|PENDING]​[&replicated_user_default_data_policy={string}]

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

Request Parameters 

Parameter	Description	Required
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 target BlackPearl system’s Spectra 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.	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
quiesced	Request that the system prepare the target to go into an inactive state (PENDING) or return the target to an active state (NO). Values: NO, PENDING	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

<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:

Parameter	Description
Data	The container for the response.
AccessControl 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.
AdminAuthId	The S3 access ID assigned to an Administrator.
AdminSecretKey	The S3 secret key for the account matching the given AdminAuthId.
DataPathEndPoint	The IPv4 address or DNS name for the data path of the DS3 target.
DataPathHttps	Whether the source BlackPearl system uses the HTTPS protocol to setup and replicate data to the target system. Values: TRUE, FALSE
DataPathPort	The value of the port on which the target BlackPearl system’s S3 server is running. If null, the parameter defaults to port 80 for HTTP connections and port 443 for HTTPS connections.
DataPathProxy	The proxy server for the source BlackPearl system to use to connect to the target system.
DataPathVerify 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. Values: TRUE, FALSE
DefaultRead 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.
Id	The UUID for the DS3 target instance. Note: If a DS3 target has its instance identifier reset after it is registered on other BlackPearl systems, the replication link is forever invalid and must be deleted and re-created.
Name	The name for the DS3 target.
PermitGoingOutOfSync	Whether a target is allowed to be out of sync with the source. See permit_going_out_of_sync.
Quiesced	Whether the DS3 target is in a temporarily inactive state. Values: NO, PENDING, YES
ReplicatedUser DefaultDataPolicy	The data policy the target applies as the default data policy for any users replicated to the target.
State	The state of the DS3 target. Values: ONLINE, OFFLINE, LIMITED_ACCESS

Example

Sample Request

This request modifies the DS3 target named ‘TargetDS3’ to have the default read preference MINIMUM_LATENCY.

PUT http[s]://blackpearl-hostname/_rest_/ds3_target/TargetDS3?default_read_preference=MINIMUM_LATENCY HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <AccessControlReplication>NONE</AccessControlReplication>
   <AdminAuthId>c381Y3RyYQ==</AdminAuthId>
   <AdminSecretKey>d7pJBeAN</AdminSecretKey>
   <DataPathEndPoint>192.168.4.8</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>