Introduced : BIG-IP_v11.4.0
A representation of the current device&aposs failover status. status, summary, and details are descriptive strings and are not meant for programmatic use. Their formats are subject to change in future BIG-IP releases.
Member Type Description
failover_status HAState Failover status of the device. This states whether the device is actively handling traffic, is acting as a standby device ready to jump in for another device if needed, or other similar states.
color StatusColor The status color of the BIG-IP.
status String The status of the BIG-IP. This describes the traffic groups in which the device is participating and its status in those groups.
summary String A summary of the administrator attention required.
details String [] A more detailed explanation of any necessary administrative actions.

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.