Configure client-level failover

To configure client failover:

1. Use a text editor and create a file that contains a client failover configuration. For all available parameters, see Client failover parameters.

   The following is an example of a complete client failover configuration:

   {

   "failoverGroupId": "FailoverGroup1",

   "name": "NameExample",

   "description": "DescriptionExample",

   "failoverTimeout": "00:01:00",

   "mode": "Hot",

   "endpoint": "https://test-endpoint.com",

   "username": "UserName1",

   "password": "Password1",

   "tokenEndpoint": null,

   "validateEndpointCertificate": true

   }

   Note: Mode parameter is case sensitive and must be defined as "Hot", "Warm" or "Cold".

2. Save the file in JSON format. For example, ConfigureClientFailover.json.

3. Use any of the available Configuration tools to run a PUT command with the contents of the file to either of the following endpoints:

   • Client failover service endpoint

     https://<hostname>:<ClientFailoverPort>/api/v1/ClientFailover

     Note: In this endpoint, 5590 is the default port number. If you select a different port number, replace it with that value.

     For example, if you use the EdgeCmd utility:

     edgecmd -port 5590 set clientfailover -cid System -file
     C:\Users\testuser\ClientFailover\ConfigureClientFailover.json

     If you were using Postman:

     PUT "https://<hostname>:<ClientFailoverPort>/api/v1/ClientFailover"

     Note: Run this command from the same directory where the file is located.

   • CONNECT data services failover endpoint

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

     In this endpoint, <namespace region> indicates the region you are located as indicated in the following table:

     Region	URL
     West US	uswe.datahub.connect.aveva.com
     Northern Europe	euno.datahub.connect.aveva.com
     East Australia	auea.datahub.connect.aveva.com

4. When successful, the client failover change takes effect immediately during runtime.