APIRef_tm_sys_failoverΒΆ
mgmt/tm/sys/failover
Redundant system failover state
REST Endpoints
- Collection URI
/mgmt/tm/sys/failover- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/sys/failover/~resource id- Resource Methods
OPTIONS, GET, POST
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
device |
string | optional | read/write | Specifies the name of the device that should become the active device for the traffic group or for all traffic groups. | |
noPersist |
boolean | optional | read/write | Does not persist the change in status of a unit or cluster. Valid only with offline status. | |
offline |
boolean | optional | read/write | Changes the status of a unit or cluster to Forced Offline. If persist or no-persist are not specified, the change in status will be persisted in-between system restarts. | |
online |
boolean | optional | read/write | Changes the status of a unit or cluster from Forced Offline to either Active or Standby, depending upon the status of the other unit or cluster in a redundant pair. | |
persist |
boolean | optional | read/write | Persists the change in status of a unit or cluster. Valid only with offline status. | |
standby |
boolean | optional | read/write | Specifies that the active unit or cluster fails over to a Standby state, causing the standby unit or cluster to become Active. | |
trafficGroup |
string | optional | read/write | Specifies the name of the traffic-group that the standby command refers to. |
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.
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.