remote (data type for replication link failoverSettings remote property)
The local
data type in this section describes the remote
property of the failoverSettings
data type.
Replication link failoverSettings remote data type properties
The following table describes the properties included in the remote
data type that describes the remote
property of the failoverSettings
data type.
Property name | Data type | Description | Notes |
autoCompleteRecovery | Boolean |
For an active/passive link, specifies whether the complete recovery phase starts automatically while data is being recovered from the remote system for the replication link to the local system. Valid values are:
The default is false. | This property is optional on a PUT request to create an active/passive link. It is not valid on a PUT or POST request for an active/active link and is not returned by any GET request for an active/active link. |
autoCompleteRecovery Minutes | Integer |
For an active/passive link, specifies the number of minutes the up-to-date-as-of time for the replication link must be less than before HCP automatically starts the complete recovery phase while data is being recovered from the remote system for the link to the local system. Valid values are integers in the range one through 9,999. The default is 120. The up-to-date-as-of time is the difference between:
| This property is optional on a PUT request to create an active/passive link. It is not valid on a PUT or POST request for an active/active link and is not returned by any GET request for an active/active link. |
autoFailover | Boolean |
Specifies whether the replication link automatically fails over to the remote system for the link after a loss of connectivity to the local system. Valid values are:
The default is false. | This property is optional on a PUT request to create a replication link. |
autoFailoverMinutes | Integer | Specifies the number of minutes HCP waits before automatically failing over the replication link to the remote system for the link after a loss of connectivity to the local. Valid values are integers in the range seven through 9,999. The default is 120. | This property is optional on a PUT request to create a replication link. |
Example
Here’s an XML example of the remote
data type that describes the remote
property of the failoverSettings
data type; the properties shown are those that are returned by a GET request sent to the primary system for an active/passive link:
<remote> <autoFailover>true</autoFailover> <autoFailoverMinutes>120</autoFailoverMinutes> <autoCompleteRecovery>false</autoCompleteRecovery> <autoCompleteRecoveryMinutes>60</autoCompleteRecoveryMinutes> </remote>