Client failover parameters

failoverGroupId

Required

string

In the adapter instance, the ID of the failover group where the adapter is registered.

Allowed value: <any string identifier>
Default value: null

name

Optional

string

The friendly name of the failover group

Allowed value: <any string value>
Default value: null

description

Optional

string

The description of the failover group

Allowed value: <any string value>
Default value: null

failoverTimeout

Required

datetime

The failover timeout value of the failover group. This defines how frequently the adapter sends a heartbeat to the failover endpoint. The heartbeat is sent at every FailoverTimeout / 2 interval.

Allowed value: a string representation of date time using hh:mm:ss

mode

Required

string

The failover mode of the registered adapter.

Note: This parameter is case sensitive.

Allowed value: Hot, Warm, Cold

For additional information on each type of failover, see Failover modes.

endpoint

Required

string

The URL of a destination that supports client failover registration. Supported destinations include CONNECT data services and on-premise Failover Service.

Default value: null
Allowed value: well-formed http or https endpoint string. For example:

• Client Failover Service

  http://<hostname>:<port>/api/v1/configuration/System/ClientFailover

• CONNECT data services

  <namespace region>.datahub.connect.aveva.com/api/v1/Tenants/<tenant id>/Namespaces/<namespace id>/ClientFailover/

username

Optional

string

The username used for Basic authentication to on-premise Failover Service endpoint.

Allowed value: any string
Default value: null

Note: If your username contains a backslash, you must add an escape character. For example, OilCompany\TestUser should be entered as OilCompany\\TestUser.

password

Optional

string

The password used for Basic authentication to on-premise Failover Service endpoint.

Allowed value: any string or {{<secretId>}} (see How to reference secrets)
Default value: null

clientId

Required for CONNECT data services endpoint

string

The clientId used for Bearer authentication to CONNECT data services endpoint.

Allowed value: any string, can be null if the endpoint URL schema is HTTP
Default value: null

clientSecret

Required for CONNECT data services endpoint

string

The clientSecret used for Bearer authentication to CONNECT data services endpoint.

Allowed value: any string or {{<secretId>}} (see How to reference secrets)
Default value: null

tokenEndpoint

Optional

string

An optional token endpoint where the adapter retrieves a bearer token. When null or not specified, the adapter uses a well-known Open ID URL to retrieve it.

Allowed value: well-formed http or https endpoint string
Default value: null

validateEndpointCertificate

Optional

boolean

An optional Boolean flag where, when set to false, the adapter disables the verification of the server certificate.

Note: AVEVA strongly recommends only disabling server certificate validation for testing purposes.

Allowed value: true or false
Default value: true