Description

The startHASuspend operation handles configuration related to HAStatus model. 

HTTP request

POST /api/fdm/v3/devices/default/action/ha/suspend

Data Parameters

Parameter Required Type Description
nodeRole False string The node role will map to node role configured in HAConfiguration
nodeState False string The current node state fetched from Lina
peerNodeState False string The peer node's state fetched from Lina
configStatus False string
haHealthStatus False string
id False string A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Example

curl -X POST \
    --header "Accept: application/json" \
    --header "Authorization: Bearer ${ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    -d '{
        "configStatus": "IN_SYNC",
        "haHealthStatus": "HEALTHY",
        "id": "string",
        "nodeRole": "HA_PRIMARY",
        "nodeState": "SINGLE_NODE",
        "peerNodeState": "SINGLE_NODE",
        "type": "HAStatus"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v3/devices/default/action/ha/suspend"

from bravado.requests_client import RequestsClient
from bravado.client import SwaggerClient


def get_client(host, token):
    http_client = RequestsClient()
    http_client.ssl_verify = False
    http_client.set_api_key(
        host,
        "Bearer {}".format(token),
        param_name="Authorization",
        param_in="header"
    )
    return SwaggerClient.from_url(
        "https://{}/apispec/ngfw.json".format(host),
        http_client=http_client,
        config={
            "validate_responses": False,
            "validate_swagger_spec": False
        }
    )


def start_ha_suspend(client, body):
    return client.HAAction.startHASuspend(
        body=body
    ).response().result


if __name__ == "__main__":
    host = "ftd.example.com"
    token = "access_token"
    client = get_client(host, token)

    body = {'configStatus': 'IN_SYNC',
 'haHealthStatus': 'HEALTHY',
 'id': 'string',
 'nodeRole': 'HA_PRIMARY',
 'nodeState': 'SINGLE_NODE',
 'peerNodeState': 'SINGLE_NODE',
 'type': 'HAStatus'}

    start_ha_suspend(client, body)