Introduced : BIG-IP_v11.4.0
Gets the failover status of the system. This shows whether this device is active on any traffic groups (that is, currently handling traffic for them) or standby (ready to handle traffic if the active device fails over).


FailoverStatus get_failover_status(



Parameter Type Description

Return Type

Type Description
FailoverStatus The failover status.


Exception Description
Common::AccessDenied Raised if the client credentials are not valid.
Common::InvalidArgument Raised if an argument is invalid.
Common::OperationFailed Raised if an operation error occurs.

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.