local (data type for replication link failoverSettings local property)

Content Platform Tenant Management Help

Version
9.7.x
File Size
4269 KB
Audience
anonymous
Part Number
MK-95HCPH002-19

The local data type in this section describes the local property of the failoverSettings data type that describes the failoverSettings property of the replication link resource.

Replication link failoverSettings local data type properties

The following table describes the properties included in the local data type that describes the local 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 local system to the remote system for the replication link. Valid values are:

true
The complete recovery phase starts automatically.
false
The complete recovery phase does not start automatically.

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 local system to the remote system for the link. 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:

  • The date and time before which configuration changes and changes to namespace content are guaranteed to have been sent to the remote system
  • The current date and time
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 local system after a loss of connectivity to the remote system for the link. Valid values are:

true
The link automatically fails over.
false
The link does not fail over automatically.

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 local system after a loss of connectivity to the remote system for the link. 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 local data type that describes the local property of the failoverSettings data type; the properties shown are those that are returned by a GET request sent to the replica for an active/passive link:

<local>
    <autoFailover>true</autoFailover>
    <autoFailoverMinutes>120</autoFailoverMinutes>
    <autoCompleteRecovery>false</autoCompleteRecovery>
    <autoCompleteRecoveryMinutes>60</autoCompleteRecoveryMinutes>
</local>