Get existing high availability configurations

GET /ha-configurations/:id

Retrieve existing high availability configurations.

Request

Path Parameters

id uuidrequired

The UUID of the configuration resource

Responses

application/json

Schema
Example (from schema)

Schema

oneOf

folder
snippet
device

folder stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The folder in which the resource is defined

snippet stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The snippet in which the resource is defined

device stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The device in which the resource is defined

enabled boolean

Default value: true

interface objectrequired

ha1 objectrequired

port stringrequired

HA1 port

ip_address string

HA1 IP address

netmask string

HA1 netmask

gateway string

HA1 default gateway

monitor_hold_time integerrequired

Possible values: >= 1000 and <= 60000

Default value: 3000

HA1 monitor hold time

ha1_backup object

port string

HA1 backup port

ip_address string

HA1 backup IP address

netmask string

HA1 backup netmask

gateway string

HA1 backup default gateway

ha2 objectrequired

port stringrequired

HA2 port

ip_address stringrequired

HA2 IP address

netmask stringrequired

HA2 netmask

gateway string

HA2 default gateway

ha2_backup object

port string

HA2 backup port

ip_address string

HA2 backup IP address

netmask string

HA2 backup netmask

gateway string

HA2 backup default gateway

group objectrequired

group_id integerrequired

Possible values: >= 1 and <= 63

HA group ID

description string

Default value: N/A

HA group description (not currently used)

election_option objectrequired

device_priority integer

Possible values: >= 1 and <= 2

Device priority (1 = primary, 2 = secondary)

ha_role string

Possible values: [primary, secondary]

Device HA role

preemptive boolean

Preemption enabled?

heartbeat_backup boolean

peer_ip stringrequired

Peer HA1 IP address

peer_ip_backup string

Peer HA1 backup IP address

peer_serial stringrequired

Serial number of the HA peer

state_synchronization objectrequired

enabled boolean

Enable session synchronization

transport string

Possible values: [ethernet, ip, udp]

Session synchronization transport

ha2_keep_alive object

enabled boolean

Enable HA2 keep-alives?

action string

Possible values: [log-only, split-datapath]

Keep-alive action

threshold integer

Possible values: >= 5000 and <= 60000

Default value: 10000

Keep-alive threshold (milliseconds)

mode objectrequired

active_passive object

passive_link_state string

Possible values: [shutdown, auto]

Passive link state

monitor_fail_hold_down_time integer

Possible values: >= 1000 and <= 60000

Default value: 3000

Monitor hold time (milliseconds)

monitoring objectrequired

path_monitoring object

enabled boolean

Enable path monitoring?

failure_condition string

Possible values: [any, all]

path_group object

logical_router object[]

Logical router

Array [

name stringrequired

Logical router name

enabled boolean

Default value: true

Enable path group?

failure_condition string

Possible values: [any, all]

Failure condition

ping_interval integer

Possible values: >= 200 and <= 60000

Default value: 200

Ping interval

ping_count integer

Possible values: >= 3 and <= 10

Default value: 10

Ping count

destination_ip_group object[]

Array [

name stringrequired

Destination IP group name

destination_ip string[]

Destination IP addresses

enabled boolean

Enable destination IP group?

failure_condition string

Possible values: [any, all]

Failure condition

]

link_monitoring object

enabled boolean

Enable link monitoring

failure_condition string

Possible values: [any, all]

Failure condition

link_group object[]

Link groups

Array [

name stringrequired

Link group name

enabled boolean

Default value: true

Enable link group?

failure_condition string

Possible values: [any, all]

Failure condition

interface string[]

Interfaces monitored

]

{
  "enabled": true,
  "interface": {
    "ha1": {
      "port": "management",
      "ip_address": "string",
      "netmask": "string",
      "gateway": "string",
      "monitor_hold_time": 3000
    },
    "ha1_backup": {
      "port": "string",
      "ip_address": "string",
      "netmask": "string",
      "gateway": "string"
    },
    "ha2": {
      "port": "string",
      "ip_address": "string",
      "netmask": "string",
      "gateway": "string"
    },
    "ha2_backup": {
      "port": "string",
      "ip_address": "string",
      "netmask": "string",
      "gateway": "string"
    }
  },
  "group": {
    "group_id": 0,
    "description": "N/A",
    "election_option": {
      "device_priority": 0,
      "ha_role": "primary",
      "preemptive": false,
      "heartbeat_backup": true
    },
    "peer_ip": "string",
    "peer_ip_backup": "string",
    "peer_serial": "string",
    "state_synchronization": {
      "enabled": true,
      "transport": "ethernet",
      "ha2_keep_alive": {
        "enabled": false,
        "action": "log-only",
        "threshold": 10000
      }
    },
    "mode": {
      "active_passive": {
        "passive_link_state": "shutdown",
        "monitor_fail_hold_down_time": 3000
      }
    },
    "monitoring": {
      "path_monitoring": {
        "enabled": false,
        "failure_condition": "any",
        "path_group": {
          "logical_router": [
            {
              "name": "string",
              "enabled": true,
              "failure_condition": "any",
              "ping_interval": 200,
              "ping_count": 10,
              "destination_ip_group": [
                {
                  "name": "string",
                  "destination_ip": [
                    "string"
                  ],
                  "enabled": true,
                  "failure_condition": "any"
                }
              ]
            }
          ]
        }
      },
      "link_monitoring": {
        "enabled": false,
        "failure_condition": "any",
        "link_group": [
          {
            "name": "string",
            "enabled": true,
            "failure_condition": "any",
            "interface": [
              "string"
            ]
          }
        ]
      }
    }
  }
}

Bad Request

application/json

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

Input Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Input Format Mismatch: input-format=json",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Output Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Output Format Mismatch: output-format=json Accept=xml",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Missing Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Missing Query Parameter: name",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Query Parameter: location=invalid",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Unauthorized

application/json

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

Not Authenticated

{
  "_errors": [
    {
      "code": "E016",
      "message": "Not Authenticated",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Invalid Credential

{
  "_errors": [
    {
      "code": "E016",
      "message": "Invalid Credential",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Key Too Long

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Too Long",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Key Expired

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Expired",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Need Password Change

{
  "_errors": [
    {
      "code": "E016",
      "message": "The password needs to be changed.",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Forbidden

application/json

Schema
Example (from schema)
auth_unauthorized

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

Unauthorized

{
  "_errors": [
    {
      "code": "E007",
      "message": "Unauthorized",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Not Found

application/json

Schema
Example (from schema)
object_not_present

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

Object Not Present

{
  "_errors": [
    {
      "code": "E005",
      "message": "Object Not Present",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

General Errors

application/json

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

Version Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Version Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Method Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Method Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Action Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Action Not Supported: move",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Bad XPath

{
  "_errors": [
    {
      "code": "E013",
      "message": "Bad XPath",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Invalid Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Malformed Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Malformed Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Session Timeout

{
  "_errors": [
    {
      "code": "4",
      "message": "Session Timeout",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Get existing high availability configurations

/ha-configurations/:id

Request​

Path Parameters

Responses​

Request

Responses