Download OpenAPI specification:Download
F5 Cloud Failover (CFE) is an iControl LX Extension delivered as a TMOS-independent RPM file. Installing the CFE Extension on BIG-IP enables you to declaratively configure BIG-IP devices for automatic failover in cloud environments by POSTing a single JSON declaration to CF’s declarative REST API endpoint.
Information Response
Bad Request Error
Unexpected Error
Inspect Response
Bad Request Error
Unexpected Error
Configuration Response
Bad Request Error
Unexpected Error
class | string Default: "Cloud_Failover" |
environment | string Enum: "azure" "aws" "gcp" |
schemaVersion | string |
externalStorage | object or object |
failoverAddresses | object |
failoverRoutes | object |
controls | object |
Configuration response
Bad Request Error
Unexpected Error
Primarily supported action is dry-run, which returns objects and resources that are updated if failover is triggered. WARNING: Do not use the execute action, it is for use by BIG-IP only.
action | string |
Configuration response
Bad Request Error
Failover task failed
Unexpected Error
Successful failover task
Failover task is running
Bad Request Error
Failed failover task
Unexpected Error
resetStateFile | boolean |
Reset State Response
Bad Request Error
Unexpected Error