link
The link
data type describes the links
resource.
link data type properties
The following table describes the properties included in the link
data type.
Property name | Data type | Description | Notes |
compression | Boolean |
Specifies whether HCP should compress data before transmitting it to the other system involved in the replication link. For an active/active link, this setting applies to data being replicated in both directions on the link. Valid values are:
The default is false. | This property is optional on a PUT request. |
connection | connection | Identifies the remote system for the replication link and specifies how the two systems should communicate with each other. | This property is required on a PUT request. |
description | String |
Specifies a description of the replication link. This description is optional. The default is no description. To remove a description from an existing link, specify the description property with no value. | This property is optional on a PUT request. |
encryption | Boolean |
Specifies whether HCP should encrypt data before transmitting it to the other system involved in the replication link. For an active/active link, this setting applies to data being replicated in both directions on the link. Valid values are:
The default is false. | This property is optional on a PUT request. |
failoverSettings |
failover Settings | Specifies the automatic failover and failback settings for the replication link. | This property is optional on a PUT request. |
id | String | Specifies the system-supplied unique ID for the replication link. HCP generates this ID automatically when you create a link. | This property is not valid on a PUT or POST request. It is returned only by a verbose GET request. |
name | String |
Specifies the name of the replication link. Link names must be from one through 64 characters long and can contain any valid UTF-8 characters, including white space. Link names are not case sensitive. Link names must be unique within a replication topology. | This property is required on a PUT request. |
priority | String |
Specifies whether priority should be given to objects with the oldest changes, regardless of namespace, or processing should be balanced across namespaces. For an active/active link, this setting applies to both systems involved in the link. Valid values are:
The default is OLDEST_FIRST. These values are not case-sensitive. | This property is optional on a PUT request. |
statistics | statistics | Specifies information about activity on the replication link. | This property is not valid on a PUT or POST request. It is returned only by a verbose GET request. |
status | String |
Specifies the general state of the replication link. Possible values are:
| This property is not valid on a PUT or POST request. It is returned only by a verbose GET request. |
statusMessage | String |
Specifies text describing the current state of the replication link. Possible values are:
| This property is not valid on a PUT or POST request. It is returned only by a verbose GET request. |
suspended | Boolean |
Specifies whether the replication link is currently suspended. Possible values are:
| This property is not valid on a PUT or POST request. It is returned only by a verbose GET request. |
type | String |
Specifies the replication link type. Valid values are:
These values are not case-sensitive. |
This property is required on a PUT request. You can change the value of this property from OUTBOUND or INBOUND to ACTIVE_ACTIVE. You cannot change the value from: •ACTIVE_ACTIVE to OUTBOUND or INBOUND •OUTBOUND to INBOUND •INBOUND to OUTBOUND |
Example
Here’s an XML example of the link
data type; the properties shown are those that are returned by a verbose GET request for an active/active link:
<link> <compression>false</compression> <connection> <localHost> 192.168.210.16, 192.168.210.17, 192.168.210.18, 192.168.210.19 </localHost> <localPort>5748</localPort> <remoteHost>replication.admin.hcp-ca.example.com</remoteHost> <remotePort>5748</remotePort> </connection> <description>Active/active link between systems in MA and CA</description> <encryption>false</encryption> <failoverSettings> <local> <autoFailover>true</autoFailover> <autoFailoverMinutes>60</autoFailoverMinutes> </local> <remote> <autoFailover>true</autoFailover> <autoFailoverMinutes>60</autoFailoverMinutes> </remote> </failoverSettings> <id>2de89eec-0ec0-4f98-b852-0778dfeee792</id> <name>MA-CA</name> <priority>OLDEST_FIRST</priority> <statistics> <upToDateAsOfString>2017-02-18T10:47:59-0400 </upToDateAsOfString> <upToDateAsOfMillis>1395154079640</upToDateAsOfMillis> <bytesPending>189027593061</bytesPending> <bytesPendingRemote>319740</bytesPendingRemote> <bytesReplicated>72254119306967</bytesReplicated> <bytesPerSecond>56215390</bytesPerSecond> <objectsPending>534</objectsPending> <objectsPendingRemote>2</objectsPendingRemote> <objectsReplicated>295661</objectsReplicated> <operationsPerSecond>119.1</operationsPerSecond> <errors>0</errors> <errorsPerSecond>0.0</errorsPerSecond> <objectsVerified>402200</objectsVerified> <objectsReplicatedAfterVerification>0</objectsReplicatedAfterVerification> </statistics> <status>GOOD</status> <statusMessage>Synchronizing data</statusMessage> <suspended>false</suspended> <type>ACTIVE_ACTIVE</type> </link>
Query parameters for replication link actions
To perform actions on replication links, you use these query parameters:
suspend
Suspend activity on the link.
resume
Resume activity on a suspended link.
failOver
Fail over the link to the remote system.
failBack
For an active/active link, fail back the link.
beginRecover
For an active/passive link, begin data recovery.
completeRecovery
For an active/passive link, complete data recovery.
restore
Restore the link to the remote system.
You use these query parameters with a POST request against the link
resource. You cannot include a request body with this request.
Here’s a sample POST request that suspends activity on the replication link named MA-CA:
curl -k -iX POST -H "Authorization: HCP YWxscm9sZXM=:04EC9F614D89FF5C7126D32ACB448382" "https://admin.hcp-ma.example.com:9090/mapi/services/replication/links/MA-CA ?suspend"