UniInt failover parameters
- Last UpdatedApr 03, 2023
- 2 minute read
Interfaces use failover parameters to control how failover operates. Some parameters require values. Failover settings for UniInt failover include the following parameters:
-
Do not failover (ufo_dnfbpi)
Syntax: /ufo_dnfbpi
If both interface instances lose connectivity to Data Archive, do not attempt failover.
Enabling this option ensures that if both instances lose connectivity to Data Archive, incoming data is buffered by a single interface instance to prevent the buffer from being split.
-
Interface failover ID (ufo_id)
Syntax: /ufo_id=failoverID#
Required: Specifies the failover ID for this interface instance.
The active ID point maintains the failover ID of the interface that is currently primary in a failover configuration. Valid values: integer from 1 to 4,294,967,295.
Note: The interface failover ID (ufo_id) and interface ID (id) parameters are different settings.
-
Other interface failover ID (ufo_otherid)
Syntax: /ufo_otherid=otherID#
Required: Specifies the failover ID of the other interface instance in the failover configuration.
The otherID# value must be different from the value specified for ufo_id. Valid values: integer from 1 to 99.
-
Synchronization file path (ufo_sync)
Syntax: /ufo_sync=path\[filename]
Required: Specifies the path to the directory containing the shared file used for failover synchronization and an optional filename that overrides the default filename. Each node in the failover configuration must specify the same path and filename and must have read, write, and file creation rights to the shared directory. If the file does not exist, the first interface instance to start creates the file.
The default filename is executablename_pointsource_interfaceID.dat.
The path value can be one of the following types:
-
Fully qualified machine name and directory
-
Mapped drive letter
-
Local path, if the shared file is on one of the interface nodes
The path value must end with either a slash or backslash . The interface interprets path names without a terminating slash as a filename value.
Note: If you specify the file name, omit the trailing slash.
If there are spaces in the path or filename, enclose the entire path and filename in double quotes. If you quote a path, use two backslashes at the end of the path.
-
-
Failover type (ufo_type)
Syntax: /ufo_type=type
Required: Specifies the type of failover. Type values can be HOT, WARM, or COLD. If an interface does not support the requested type of failover, the interface logs an error and shuts down.
-
Failover interval (ufo_interval)
Syntax: /ufo_interval=time
Specifies time, in milliseconds, for how often the interface checks and updates the failover heartbeat points.
The time value must be the same on both interface computers. Minimum is 50, maximum is 20,000, and the default is 5000 milliseconds.
-
Output failover-specific debug messages (ufo_debug)
Syntax: /UFO_Debug=x
Debug off (default) = 0x00
Debug ActiveID = 0x01
Debug this Heartbeat = 0x02
Debug other Heartbeat = 0x04
Debug shared file = 0x08
Debug other DeviceStatus = 0x10
Debug reads from PI = 0x20
Debug max = 0xFF
-
Host name (host)
When failover is enabled, the host parameter has additional meaning. For more information, see Standard parameters.