Client-level failover EdgeCmd scripts
- Last UpdatedOct 23, 2025
- 1 minute read
- PI System
- Adapter for RDBMS 1.1
- Adapters
The following commands elicit and configure client failover of the system component.
|
EdgeCmd command |
Description |
Examples |
|---|---|---|
|
edgecmd get clientfailover |
Returns the client failover configuration. |
|
|
edgecmd remove clientfailover [-y] |
Deletes the entire client failover configuration. |
|
|
edgecmd add clientfailver [-cid System] -file <filePath> |
Creates a client failover configuration. Fails if the client failover configuration already exists. |
edgecmd add clientfailover -file C:\Users\TestUser\ClientFailover\Configuration.json |
|
edgecmd set clientfailover [-cid System] -file <filePath> |
Replaces the existing client failover configuration. |
edgecmd set clientfailover -file C:\Users\TestUser\ClientFailover\Configuration.json |
|
edgecmd help clientfailover |
Returns the help information for client failover. |
Use the EdgeCmd utility to add and remove the adapter, and to configure facets of the components.
Note: The examples in this topic are using the default port number 5590. If you specified a different port number for your adapter, you need to add it in the command. For example: edgecmd -port 5591 <RestOfTheCommand>
If a command contains slashes, you must add escape characters as follows:
In Windows , add a second slash. style="box-sizing: inherit;">
Example: TestUser\OilCompany becomes TestUser\\OilCompany
In Linux , add three additional slashes. style="box-sizing: inherit;">
Example: TestUser\OilCompany becomes TestUser\\\\OilCompany