HA Failover State¶
Overview¶
You can use the HA Failover State API to get the current HA failover state of the BIG-IQ high-availability (HA) configuration. Use the HA Add Peer API to add a BIG-IQ to the BIG-IQ HA configuration. Use the HA Remove Standby API to remove the standby mode from all BIG-IQs in the HA configuration. Use the HA Promote API to promote the secondary BIG-IQ into the primary BIG-IQ. Use the HA Reset API to reset a primary or secondary BIG IQ in a HA configuration to the standalone mode.
A BIG-IQ high availability (HA) configuration can ensure the continuous management of your BIG-IPs, by a standby BIG-IQ, in the event your primary BIG-IQ goes down. BIG-IQ offers the options of either manual failover mode or auto failover mode. When using the manual failover mode, manual intervention is required to promote the secondary BIG-IQ to become the primary BIG-IQ managing your BIG-IPs. To use manual failover mode, you require two BIG-IQs to act as the primary and secondary and both must be in the same network segment and have the same configuration. When using the auto failover mode, if the primary BIG-IQ goes down, a quorum DCD decides automatically to promote the secondary BIG-IQ to become the primary BIG-IQ. To use the auto failover mode, you require two BIG-IQs to act as primary and secondary BIG-IQs and a data collection device (DCD) to act as the quorum device.
Requests¶
haMonitorStatus¶
The haMonitorStatus object reflects the status of the daemons used to configure auto failover, corosync and pacemaker. All of the following fields apply only for auto failover.
| Name | Type | Description |
|---|---|---|
| canFailover | boolean | Failover can happen but can be overridden. |
| clusterHealth | string | The health of the auto failover HA. The health of the cluster is determined by the status of the resources managed by the nodes and the nodes’ health. It can have one of the following values: “healthy” - The HA cluster is healthy. “warning” - There are some warnings in the cluster state. “degraded” - The quorum device is offline. “failed” - When the primary or the secondary node is down. “down” - If the current node is down. “unconfigured” - Auto failover HA is not configured. |
| failureCauses | string | Reasons for failure. |
| fenceAction | string | Fence action that was taken on the node. It can have one of the following values: “none” - No fencing. “world” - the node has been fenced from the world. “primary” - fence action is recommended but can be overridden. |
| hasFailedOver | boolean | If the secondary node is the current primary after the failing over. |
| isConfigured | boolean | If true, the corosync and pacemaker daemons are configured. |
| isQuorate | boolean | If true, a quorum device has been added to the HA configuration. |
| isRunning | boolean | If true, the corosync and pacemaker daemons are running. |
| nodeHealth | string | Node health in the auto failover HA configuration. It can have one of the following values: “healthy”, “warning”, “degraded”, “failed”, “down”, “unconfigured” |
| offlineNodes | array | An array of nodes that are offline in the auto failover HA configuration. |
| onlineNodes | array | An array of nodes that are online in the auto failover HA configuration. |
| primaryResources | string | Resources managed by the primary node in the HA configuration. |
| role | string | Node’s role in HA as recorded in the configuration. |
| secondaryResources | string | Resources managed by the secondary node in the HA configuration. |
| shouldFailover | boolean | If true, the failover criteria have been met. This will then trigger the auto failover mechanism. |
Permissions¶
| Role | Allow |
|---|---|
| admin | Yes |
Examples¶
GET to retrieve status of the HA configuration¶
The following example shows a GET request sent to the BIG-IQ to retrieve the status of the HA configuration.
GET https://192.0.2.0/mgmt/shared/failover-state
Response if HA is in auto failover mode¶
The JSON in the response can look similar to the following example.
HTTP/1.1 200 OK
{
"systemMode": "HA",
"nodeRole": "PRIMARY",
"primaryMachineID": "1ceb4f18-8cb3-40bb-b5af-10ca093cfaac",
"secondaryMachineID": "a72bf801-d555-45f8-b2c2-d90eea73e141",
"useQuorumHA": true,
"haStatus": {
"currentState": "OPERATIONAL",
"currentStatusTimestamp": 1562174388714862,
"peerAvailable": true,
"primaryStatus": {
"nodeState": "OPERATIONAL",
"timestamp": 1562174387835685,
"replicationStatus": {
"set": "bigiq0",
"date": {
"$date": 1562174387000
},
"myState": 1,
"members": [{
"_id": 0,
"name": "10.145.68.228:27017",
"health": 1.0,
"state": 1,
"stateStr": "PRIMARY",
"uptime": 63766,
"optimeDate": {
"$date": 1562174386876
},
"lastGTID": "GTID(1, 282042)",
"lastUnappliedGTID": "GTID(1, 282042)",
"minLiveGTID": "GTID(1, 282043)",
"minUnappliedGTID": "GTID(1, 282043)",
"oplogVersion": 4,
"highestKnownPrimaryInReplSet": 1,
"self": true
},
{
"_id": 1,
"name": "10.145.68.214:27017",
"health": 1.0,
"state": 2,
"stateStr": "SECONDARY",
"uptime": 63267,
"optimeDate": {
"$date": 1562174385936
},
"lastGTID": "GTID(1, 282032)",
"lastUnappliedGTID": "GTID(1, 282032)",
"minLiveGTID": "GTID(1, 282033)",
"minUnappliedGTID": "GTID(1, 282033)",
"oplogVersion": 4,
"highestKnownPrimaryInReplSet": 1,
"lastHeartbeat": {
"$date": 1562174385000
},
"lastHeartbeatRecv": {
"$date": 1562174385000
},
"pingMs": 0,
"syncingTo": "10.145.68.228:27017"
}
],
"ok": 1.0
}
},
"secondaryStatus": {
"nodeState": "OPERATIONAL",
"timestamp": 1562174378739703,
"replicationStatus": {
"set": "bigiq0",
"date": {
"$date": 1562174378000
},
"myState": 2,
"syncingTo": "10.145.68.228:27017",
"members": [{
"_id": 0,
"name": "10.145.68.228:27017",
"health": 1.0,
"state": 1,
"stateStr": "PRIMARY",
"uptime": 63218,
"optimeDate": {
"$date": 1562174375728
},
"lastGTID": "GTID(1, 281996)",
"lastUnappliedGTID": "GTID(1, 281996)",
"minLiveGTID": "GTID(1, 281997)",
"minUnappliedGTID": "GTID(1, 281997)",
"oplogVersion": 4,
"highestKnownPrimaryInReplSet": 1,
"lastHeartbeat": {
"$date": 1562174377000
},
"lastHeartbeatRecv": {
"$date": 1562174377000
},
"pingMs": 0
},
{
"_id": 1,
"name": "10.145.68.214:27017",
"health": 1.0,
"state": 2,
"stateStr": "SECONDARY",
"uptime": 63259,
"optimeDate": {
"$date": 1562174375728
},
"lastGTID": "GTID(1, 281996)",
"lastUnappliedGTID": "GTID(1, 281996)",
"minLiveGTID": "GTID(1, 281997)",
"minUnappliedGTID": "GTID(1, 281997)",
"oplogVersion": 4,
"highestKnownPrimaryInReplSet": 1,
"self": true
}
],
"ok": 1.0
}
},
"localNodeStatus": {
"nodeState": "OPERATIONAL",
"timestamp": 1562174387835685,
"replicationStatus": {
"set": "bigiq0",
"date": {
"$date": 1562174387000
},
"myState": 1,
"members": [{
"_id": 0,
"name": "10.145.68.228:27017",
"health": 1.0,
"state": 1,
"stateStr": "PRIMARY",
"uptime": 63766,
"optimeDate": {
"$date": 1562174386876
},
"lastGTID": "GTID(1, 282042)",
"lastUnappliedGTID": "GTID(1, 282042)",
"minLiveGTID": "GTID(1, 282043)",
"minUnappliedGTID": "GTID(1, 282043)",
"oplogVersion": 4,
"highestKnownPrimaryInReplSet": 1,
"self": true
},
{
"_id": 1,
"name": "10.145.68.214:27017",
"health": 1.0,
"state": 2,
"stateStr": "SECONDARY",
"uptime": 63267,
"optimeDate": {
"$date": 1562174385936
},
"lastGTID": "GTID(1, 282032)",
"lastUnappliedGTID": "GTID(1, 282032)",
"minLiveGTID": "GTID(1, 282033)",
"minUnappliedGTID": "GTID(1, 282033)",
"oplogVersion": 4,
"highestKnownPrimaryInReplSet": 1,
"lastHeartbeat": {
"$date": 1562174385000
},
"lastHeartbeatRecv": {
"$date": 1562174385000
},
"pingMs": 0,
"syncingTo": "10.145.68.228:27017"
}
],
"ok": 1.0
}
},
"primary": {
"nodeState": "OPERATIONAL",
"nodeRole": "PRIMARY",
"machineID": "1ceb4f18-8cb3-40bb-b5af-10ca093cfaac",
"hostname": "bigiq-ha1-active.com",
"address": "10.145.68.228",
"version": "7.0.0"
},
"secondary": {
"nodeState": "OPERATIONAL",
"nodeRole": "SECONDARY",
"machineID": "a72bf801-d555-45f8-b2c2-d90eea73e141",
"hostname": "bigiq-ha2-standby.com",
"address": "10.145.68.214",
"version": "7.0.0"
},
"quorum": {
"nodeState": "OPERATIONAL",
"statusMessage": "Quorum device is online",
"nodeRole": "QUORUM",
"machineID": "97f6bcfe-ec63-42cc-96c6-f6023aac8339",
"hostname": "bigiq-ha3-quorum.com",
"address": "10.145.66.52",
"version": "7.0.0"
},
"pcsStatus": {
"enabled": true,
"config": {
"primaryIPAddress": "10.145.68.228",
"secondaryIPAddress": "10.145.68.214",
"quorumIPAddress": "10.145.66.52",
"floatingIPAddress": "10.145.66.51"
},
"haMonitorStatus": {
"role": "primary",
"isConfigured": true,
"isRunning": true,
"isQuorate": true,
"clusterHealth": "healthy",
"nodeHealth": "healthy",
"fenceAction": "none",
"shouldFailOver": false,
"canFailOver": false,
"onlineNodes": [
"ha-primary",
"ha-quorum",
"ha-secondary"
],
"offlineNodes": [],
"primaryResources": [
"FLOATING_IP",
"RESTJAVAD",
"SEARCHMOND",
"WEBD"
],
"secondaryResources": [
"RESTJAVAD",
"SEARCHMOND",
"WEBD"
],
"failureCauses": [],
"hasFailedOver": false
}
}
},
"syncIntervalSeconds": 30,
"lastSuccessfulSync": "2019-07-03T10:19:44.815-07:00",
"nextSync": "2019-07-03T10:19:54.752-07:00",
"generation": 16,
"lastUpdateMicros": 1562111366596225,
"kind": "shared:failover-state:failoverstate",
"selfLink": "https://localhost/mgmt/shared/failover-state"
}
Response if HA is in manual failover mode¶
The JSON in the response can look similar to the following example.
HTTP/1.1 200 OK
{
"systemMode": "HA",
"nodeRole": "PRIMARY",
"primaryMachineID": "1ceb4f18-8cb3-40bb-b5af-10ca093cfaac",
"secondaryMachineID": "a72bf801-d555-45f8-b2c2-d90eea73e141",
"useQuorumHA": false,
"haStatus": {
"currentState": "OPERATIONAL",
"currentStatusTimestamp": 1562179702961412,
"peerAvailable": true,
"primaryStatus": {
"nodeState": "OPERATIONAL",
"timestamp": 1562179700448380,
"replicationStatus": {
"set": "bigiq0",
"date": {
"$date": 1562179700000
},
"myState": 1,
"members": [{
"_id": 0,
"name": "10.145.68.228:27017",
"health": 1.0,
"state": 1,
"stateStr": "PRIMARY",
"uptime": 295,
"optimeDate": {
"$date": 1562179699036
},
"lastGTID": "GTID(1, 1388)",
"lastUnappliedGTID": "GTID(1, 1388)",
"minLiveGTID": "GTID(1, 1389)",
"minUnappliedGTID": "GTID(1, 1389)",
"oplogVersion": 4,
"highestKnownPrimaryInReplSet": 1,
"self": true
},
{
"_id": 1,
"name": "10.145.68.214:27017",
"health": 1.0,
"state": 2,
"stateStr": "SECONDARY",
"uptime": 96,
"optimeDate": {
"$date": 1562179699036
},
"lastGTID": "GTID(1, 1388)",
"lastUnappliedGTID": "GTID(1, 1388)",
"minLiveGTID": "GTID(1, 1389)",
"minUnappliedGTID": "GTID(1, 1389)",
"oplogVersion": 4,
"highestKnownPrimaryInReplSet": 1,
"lastHeartbeat": {
"$date": 1562179700000
},
"lastHeartbeatRecv": {
"$date": 1562179699000
},
"pingMs": 0,
"lastHeartbeatMessage": "syncing to: 10.145.68.228:27017",
"syncingTo": "10.145.68.228:27017"
}
],
"ok": 1.0
}
},
"secondaryStatus": {
"nodeState": "OPERATIONAL",
"timestamp": 1562179690789048,
"replicationStatus": {
"set": "bigiq0",
"date": {
"$date": 1562179690000
},
"myState": 2,
"syncingTo": "10.145.68.228:27017",
"members": [{
"_id": 0,
"name": "10.145.68.228:27017",
"health": 1.0,
"state": 1,
"stateStr": "PRIMARY",
"uptime": 47,
"optimeDate": {
"$date": 1562179687799
},
"lastGTID": "GTID(1, 1339)",
"lastUnappliedGTID": "GTID(1, 1339)",
"minLiveGTID": "GTID(1, 1340)",
"minUnappliedGTID": "GTID(1, 1340)",
"oplogVersion": 4,
"highestKnownPrimaryInReplSet": 1,
"lastHeartbeat": {
"$date": 1562179689000
},
"lastHeartbeatRecv": {
"$date": 1562179690000
},
"pingMs": 0
},
{
"_id": 1,
"name": "10.145.68.214:27017",
"health": 1.0,
"state": 2,
"stateStr": "SECONDARY",
"uptime": 88,
"optimeDate": {
"$date": 1562179687799
},
"lastGTID": "GTID(1, 1339)",
"lastUnappliedGTID": "GTID(1, 1339)",
"minLiveGTID": "GTID(1, 1340)",
"minUnappliedGTID": "GTID(1, 1340)",
"oplogVersion": 4,
"highestKnownPrimaryInReplSet": 1,
"errmsg": "syncing to: 10.145.68.228:27017",
"self": true
}
],
"ok": 1.0
}
},
"localNodeStatus": {
"nodeState": "OPERATIONAL",
"timestamp": 1562179700448380,
"replicationStatus": {
"set": "bigiq0",
"date": {
"$date": 1562179700000
},
"myState": 1,
"members": [{
"_id": 0,
"name": "10.145.68.228:27017",
"health": 1.0,
"state": 1,
"stateStr": "PRIMARY",
"uptime": 295,
"optimeDate": {
"$date": 1562179699036
},
"lastGTID": "GTID(1, 1388)",
"lastUnappliedGTID": "GTID(1, 1388)",
"minLiveGTID": "GTID(1, 1389)",
"minUnappliedGTID": "GTID(1, 1389)",
"oplogVersion": 4,
"highestKnownPrimaryInReplSet": 1,
"self": true
},
{
"_id": 1,
"name": "10.145.68.214:27017",
"health": 1.0,
"state": 2,
"stateStr": "SECONDARY",
"uptime": 96,
"optimeDate": {
"$date": 1562179699036
},
"lastGTID": "GTID(1, 1388)",
"lastUnappliedGTID": "GTID(1, 1388)",
"minLiveGTID": "GTID(1, 1389)",
"minUnappliedGTID": "GTID(1, 1389)",
"oplogVersion": 4,
"highestKnownPrimaryInReplSet": 1,
"lastHeartbeat": {
"$date": 1562179700000
},
"lastHeartbeatRecv": {
"$date": 1562179699000
},
"pingMs": 0,
"lastHeartbeatMessage": "syncing to: 10.145.68.228:27017",
"syncingTo": "10.145.68.228:27017"
}
],
"ok": 1.0
}
},
"primary": {
"nodeState": "OPERATIONAL",
"nodeRole": "PRIMARY",
"machineID": "1ceb4f18-8cb3-40bb-b5af-10ca093cfaac",
"hostname": "bigiq-ha1-active.com",
"address": "10.145.68.228",
"version": "7.0.0"
},
"secondary": {
"nodeState": "OPERATIONAL",
"nodeRole": "SECONDARY",
"machineID": "a72bf801-d555-45f8-b2c2-d90eea73e141",
"hostname": "bigiq-ha2-standby.com",
"address": "10.145.68.214",
"version": "7.0.0"
},
"pcsStatus": {
"enabled": false,
"config": {},
"haMonitorStatus": {
"role": "none",
"isConfigured": false,
"isRunning": false,
"isQuorate": false,
"clusterHealth": "unconfigured",
"nodeHealth": "unconfigured",
"fenceAction": "primary",
"shouldFailOver": false,
"canFailOver": false,
"onlineNodes": [],
"offlineNodes": [],
"primaryResources": [],
"secondaryResources": [],
"failureCauses": [
"unconfigured - Cluster host names are not set",
"unconfigured - Cluster is not configured",
"unconfigured - Pacemaker daemon is not running",
"unconfigured - Primary node is offline",
"unconfigured - Secondary node is offline",
"unconfigured - Quorum node is offline",
"unconfigured - Restjavad is down on primary node",
"unconfigured - Webd is down on primary node",
"unconfigured - Searchmon is down on primary node",
"unconfigured - Restjavad is down on secondary node",
"unconfigured - Webd is down on secondary node",
"unconfigured - Searchmon is down on secondary node",
"unconfigured - This node does not have quorum"
],
"hasFailedOver": false
}
}
},
"syncIntervalSeconds": 30,
"lastSuccessfulSync": "2019-07-03T11:43:14.826-07:00",
"nextSync": "2019-07-03T11:44:24.752-07:00",
"generation": 26,
"lastUpdateMicros": 1562179687740661,
"kind": "shared:failover-state:failoverstate",
"selfLink": "https://localhost/mgmt/shared/failover-state"
}
PATCH to change the file sync interval¶
The following example shows how a PATCH request can be sent to a BIG-IQ to change change the file sync interval
PATCH https://192.0.2.0/mgmt/shared/failover-state
The JSON in the body of the PATCH request can look similar to the following example.
{
"syncIntervalSeconds": 35
}
Response¶
The JSON in the response can look similar to the following example.
HTTP/1.1 200 OK
{
"syncIntervalSeconds": 35
}