Introduced : BIG-IP_v9.0
The Failover interface enables you to manipulate a device&aposs fail-over states. For example, you can get the state, active or standby, in which a device is running in a redundant configuration. You can also switch a device&aposs state from active to standby. This interface does not support transactions.


Method Description Introduced
get_failover_mode Gets the current fail-over mode that the device is running in. BIG-IP_v9.0
get_failover_state Gets the current fail-over state that the device is running in. BIG-IP_v9.0
get_peer_address Gets the Connection Mirroring peer IP address(es) in a redundant pair. There may be a primary address and possibly a secondary address. The primary will be the first entry in the returned list. If Connection Mirroring is not configured, null results will be returned. BIG-IP_v9.0
get_version Gets the version information for this interface. BIG-IP_v9.0
is_redundant Checks to see if this device is part of a redundant pair. BIG-IP_v9.0
set_failback Restores an active-active device configuration after a failure. You can only use this command after the DB key “Failover.ManFailBack” has been created, and set to a value of “enable”. BIG-IP_v9.0
set_offline Sets the device to “forced offline” state. BIG-IP_v10.0.0
set_offline_release Sets the device to release the “forced offline” state. BIG-IP_v10.0.0
set_standby Sets the device to standby mode. BIG-IP_v9.0
set_standby_to_device Sets the device to standby mode for all traffic groups and requests the specified device to become active for all traffic groups. BIG-IP_v11.2.0
set_standby_traffic_group Sets the specified traffic groups to standby mode. If the list of traffic groups is empty, all traffic groups will be set to standby. BIG-IP_v11.0.0
set_standby_traffic_group_to_device Sets the specified traffic groups to standby mode. The traffic groups become active on the given device. If the list of traffic groups is empty, all traffic groups will be set to standby and will become active on the specified device. BIG-IP_v11.2.0


Structure Description


Enumeration Description
FailoverMode A list of fail-over modes of operation.
FailoverState A list of fail-over states.


Exception Description


Constant Type Value Description


Alias Type Description
FailoverModeSequence FailoverMode [] A sequence of fail-over modes.
FailoverStateSequence FailoverState [] A sequence of fail-over states.

See Also


The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.