HA Reset

Overview

You can use the HA Reset API to reset a primary or the secondary BIG-IQ in an HA configuration to the standalone mode. You can use this API from the primary or secondary BIG-IQ you need to reset to standalone mode. This API is used primarily to recover from error states. 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.

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.

REST Endpoint: /mgmt/shared/ha/reset-task

Requests

POST /mgmt/shared/ha/reset-task

To reset a primary or secondary BIG-IQ in a HA configuration to the standalone mode, you can send a POST request to the reset-task endpoint with an empty body.

Request Parameters

None

The body of the POST request can be empty.

Query Parameters

None

Response

The JSON in the response can contain the following parameters.

HTTP/1.1 200 OK

Name Type Description
id string The uuid identifier of the task.
identityReferences object References to users provided as links.
     link string URL to user
ownerMachineId string GUID identifier
selfLink string Reference link to the task.
status string Status of the task. Initially, this value can be “STARTED” and eventually updates to “FINISHED”. When there is an error encountered in the task, the status changes to “FAILED”.
step string Initially set to STARTED.
userReferences object Reference to the user that initiated the action.
     link string A URL to the user which started the task.

Permissions

Role Allow
admin Yes

GET /mgmt/shared/ha/reset-task

To check the task’s status, you can send a GET request to the reset-task endpoint.

Request Parameters

None

Query Parameters

None

Response

The JSON in the response can contain the following parameters.

HTTP/1.1 200 OK

Name Type Description
id string The uuid identifier of the task.
identityReferences object References to users provided as links.
     link string URL to user
ownerMachineId string GUID identifier
progress string Explanation of the step field.
selfLink string Reference link to the task.
status string Status of the task. Initially, this value can be “STARTED” and eventually updates to “FINISHED”. When there is an error encountered in the task, the status changes to “FAILED”.
step string The value of step indicates the action performed by the task. See the the Step Values section for an explanation of the values.
userReference object Reference to the user who initiated the action.
     link string A URL to the user which started the task.

Step Values

The step parameter indicates the action performed by the task. step can have the following values.

Value Meaning
DELETE_FILE_SYNC_SCHEDULE Deleting file synchronization schedule.
DONE Done
GET_PEER Resolving the peer device
REMOVE_FROM_ES Removing the peer from the ES cluster
REMOVE_PEER Removing peer device trust
RUN_RESET_SCRIPT Resetting database configuration to standalone.
STARTING Starting

Permissions

Role Allow
admin Yes

Examples

POST to reset BIG-IQ to standalone

The following example shows how to remove standby mode from secondary BIG-IQ in HA configuration.

POST https://192.0.2.0/mgmt/shared/ha/reset-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

{
    "id": "e83e22ed-38f0-471b-a59b-c9a4107fc71a",
    "status": "STARTED",
    "userReference": {
            "link": "https://localhost/mgmt/shared/authz/users/admin"
    },
    "identityReferences": [{
            "link": "https://localhost/mgmt/shared/authz/users/admin"
    }],
    "ownerMachineId": "a72bf801-d555-45f8-b2c2-d90eea73e141",
    "taskWorkerGeneration": 1,
    "generation": 1,
    "lastUpdateMicros": 1562194862715813,
    "kind": "shared:ha:reset-task:resettaskitemstate",
    "selfLink": "https://localhost/mgmt/shared/ha/reset-task/e83e22ed-38f0-471b-a59b-c9a4107fc71a"
}

GET to retrieve task’s status

The following example shows how to check the status of the task.

GET https://192.0.2.0/mgmt/shared/ha/reset-task

Response

The JSON in the response to the POST can look similar to the following example.

HTTP/1.1 200 OK

{
    "items": [{
            "endDateTime": "2019-07-03T11:44:20.988-0700",
            "generation": 8,
            "id": "5769640e-01b6-41c8-b137-6789a700ab71",
            "identityReferences": [],
            "kind": "shared:ha:reset-task:resettaskitemstate",
            "lastUpdateMicros": 1562179461037978,
            "ownerMachineId": "1ceb4f18-8cb3-40bb-b5af-10ca093cfaac",
            "progress": "Done",
            "selfLink": "https://localhost/mgmt/shared/ha/reset-task/5769640e-01b6-41c8-b137-6789a700ab71",
            "startDateTime": "2019-07-03T11:44:00.480-0700",
            "status": "FINISHED",
            "step": "DONE"
    }],
    "generation": 3,
    "kind": "shared:ha:reset-task:resettaskcollectionstate",
    "lastUpdateMicros": 1562194862802705,
    "selfLink": "https://localhost/mgmt/shared/ha/reset-task"
}