Spectra Logic

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

Verify DS3 Target

Description

Verifies connectivity to the DS3 target and that the Administrator credentials are correct. If full_details is specified, the operation verifies that all data expected to reside on the target does in fact reside there.

Requests

Syntax

PUT http[s]://{datapathDNSname}/_rest_/ds3_target/{BlackPearl target instance UUID, name, or other unique attribute}​?operation=VERIFY[&full_details]

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 verify. Value: VERIFY	yes
full_details	If included, the operation verifies that all data expected to reside on the target does in fact reside there.	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 DS3 target’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 DS3 target.
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 confirms connectivity to the DS3 target and verifies the credentials of the administrator.

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

Sample Response

HTTP/1.1 200 OK
<Data>
   <AccessControlReplication>NONE</AccessControlReplication>
   <AdminAuthId>c381Y3RyYQ==</AdminAuthId>
   <AdminSecretKey>d7pJBeAN</AdminSecretKey>
   <DataPathEndPoint>192.168.108.108</DataPathEndPoint>
   <DataPathHttps>TRUE</DataPathHttps>
   <DataPathPort/>
   <DataPathProxy/>
   <DataPathVerifyCertificate>TRUE</DataPathVerifyCertificate>
   <DefaultReadPreference>MINIMUM_LATENCY</DefaultReadPreference>
   <Id>c927287a-90eb-428e-88ae-faedc3749e17</Id>
   <Name>DS3Target</Name>
   <PermitGoingOutOfSync>FALSE</PermitGoingOutOfSync>
   <Quiesced>NO</Quiesced>
   <ReplicatedUserDefaultDataPolicy/>
   <State>ONLINE</State>
</Data>