Configure client-level failover

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:<port>/api/v1/ClientFailover",

"username": "UserName1",

"password": "Password1",

"tokenEndpoint": null,

"validateEndpointCertificate": true

}

]

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

Save the file in JSON (JavaScript Object Notation) format. For example, ConfigureClientFailover.json.

Use any of the available Configuration tools to run a PUT command with the contents of the file to the following endpoint:

• Adapter endpoint

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

  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.

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