HA Remove Standby¶
Overview¶
You can use the the HA Remove Standby API to remove all BIG-IQs in an HA configuration from standby mode. All BIG-IQs will then be in standalone mode and all the HA configuration will be removed from both BIG-IQs. You can only use this API from the primary BIG-IQ. 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 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¶
Step Values¶
The step parameter indicates the action performed by the task. step can have the following values.
Value | Meaning |
---|---|
DELETE_FILE_REPLICATION_SCHEDULE | Disabling file replication schedule. |
DONE | Done |
GET_FAILOVER_STATE | Get current failover state. |
GET_PEER_DEVICE | Getting the peer device |
RUN_REMOVE_PEER_SCRIPT | Disabling database replication. |
REMOVE_PEER_FROM_DEVICE_GROUP | Removing peer from BIG-IQ device group |
STARTING | Starting |
TEARDOWN_PRIMARY_HA_DEVICE | Remove previous HA configuration on primary device |
TEARDOWN_QUORUM_HA_DEVICE | Remove previous HA configuration on quorum device |
TEARDOWN_SECONDARY_HA_DEVICE | Remove previous HA configuration on secondary device |
VERIFY_SECONDARY_AVAILABLE | Verifying secondary BIG-IQ is available. An error occurs if the request is sent from the secondary BIG-IQ. |
WAIT_FOR_PEER_RESTJAVAD_UP | Waiting for peer BIG-IQ to restart. |
Permissions¶
Role | Allow |
---|---|
admin | Yes |
Examples¶
POST to remove standby mode¶
The following example shows how to remove standby mode from the BIG-IQs in an HA configuration. Both BIG-IQs will then be in standalone mode and all the HA configuration will be removed from both BIG-IQs.
POST https://192.0.2.0/mgmt/shared/ha/remove-peer-task
The JSON in the body of the POST request can empty.
{}
Response¶
The JSON in the response to the POST can look similar to the following example.
HTTP/1.1 200 OK
{
"step": "STARTING",
"id": "8e7fe183-72a1-4ae7-b771-553d9a838ace",
"status": "STARTED",
"userReference": {
"link": "https://localhost/mgmt/shared/authz/users/admin"
},
"identityReferences": [{
"link": "https://localhost/mgmt/shared/authz/users/admin"
}],
"ownerMachineId": "1ceb4f18-8cb3-40bb-b5af-10ca093cfaac",
"taskWorkerGeneration": 1,
"generation": 1,
"lastUpdateMicros": 1562190660895876,
"kind": "shared:ha:remove-peer-task:removepeertaskitemstate",
"selfLink": "https://localhost/mgmt/shared/ha/remove-peer-task/8e7fe183-72a1-4ae7-b771-553d9a838ace"
}
GET to retrieve task’s status¶
The following example polls for the task’s status.
GET https://192.0.2.0/mgmt/shared/ha/remove-peer-task
Response¶
The JSON in the response to the GET can look similar to the following example.
HTTP/1.1 200 OK
{
"items": [{
"endDateTime": "2019-07-03T11:29:12.375-0700",
"generation": 13,
"id": "821f3a20-5990-489a-9cc9-005bd2d15176",
"identityReferences": [{
"link": "https://localhost/mgmt/shared/authz/users/admin"
}],
"kind": "shared:ha:remove-peer-task:removepeertaskitemstate",
"lastUpdateMicros": 1562178552425489,
"ownerMachineId": "1ceb4f18-8cb3-40bb-b5af-10ca093cfaac",
"progress": "Done",
"selfLink": "https://localhost/mgmt/shared/ha/remove-peer-task/821f3a20-5990-489a-9cc9-005bd2d15176",
"startDateTime": "2019-07-03T11:26:57.177-0700",
"status": "FINISHED",
"step": "DONE",
"userReference": {
"link": "https://localhost/mgmt/shared/authz/users/admin"
},
"username": "admin"
}],
"generation": 2,
"kind": "shared:ha:promote-task:removepeertaskcollectionstate",
"lastUpdateMicros": 1562180801706686,
"selfLink": "https://localhost/mgmt/shared/ha/remove-peer-task"
}