Get Element Status for Tenant (v2.3)

GET 
/sdwan/v2.3/api/elements/:element_id/status

Get the specific element status for a tenant.

Request

Path Parameters

element_id stringrequired

The element ID.

Responses

200

Successful Operation

application/json

Schema

Schema

analytics_backlog_connected boolean

The analytics backlog is connected. True or False.

analytics_backlog_connected_on_utc int64

The analytics backlog is connected on utc.

analytics_backlog_disconnected_on_utc int64

The analytics backlog is disconnected on utc.

analytics_backlog_from string

The IPv4 address of the analytics backlog.

analytics_live_connected boolean

The live analytics is connected. True or False.

analytics_live_connected_on_utc int64

The live analytics is connected on utc.

analytics_live_disconnected_on_utc int64

The live analytics is disconnected on utc.

analytics_live_from string

The IPv4 address of the live analytics.

cdl_connection_state CDLConnectionState

Cdl Connection State

connected boolean

Connected

state_change_time int64

State Change Time

config_and_events_connected boolean

The config and events are connected. True or False.

config_and_events_connected_on_utc int64

The config and events are connected on utc.

config_and_events_disconnected_on_utc int64

The config and events are disconnected on utc.

config_and_events_from string

The IPv4 address for config and events.

controller_connection_intf string

Controller Connection Intf

device_mode string

Possible values: [none, l3-mode, l2-mode]

Device Mode

element_id string

The element ID.

flows_backlog_connected boolean

The flows backlog is connected. True or False.

flows_backlog_connected_on_utc int64

The flows backlog is connected on utc.

flows_backlog_disconnected_on_utc int64

The flows backlog is disconnected on utc.

flows_backlog_from string

The IPv4 address of the flow backlog.

flows_live_connected boolean

The live flows is connected. True or False.

flows_live_connected_on_utc int64

The live flows are connected on utc.

flows_live_disconnected_on_utc int64

The live flows are disconnected on utc.

flows_live_from string

The IPV4 address of live flows.

id string

The element ID.

last_disconnected_time int64

The last disconnected time.

last_rebooted_info string

Information on the last reboot.

last_rebooted_time int64

The last reboot time.

logs_backlog_connected boolean

The backlog logs are connected. True or False.

logs_backlog_connected_on_utc int64

The backlog logs are connected on utc.

logs_backlog_disconnected_on_utc int64

The backlog logs disconnected on utc.

logs_backlog_from string

The IPV4 address for logs backlog.

logs_live_connected boolean

The connected live logs. True or False.

logs_live_connected_on_utc int64

The live logs are connected on utc.

logs_live_disconnected_on_utc int64

The live logs are disconnected on utc.

logs_live_from string

The IPv4 address from the live logs.

main_max_power_supported int32

The main max power supported.

main_power_allocated float

The main power allocated.

main_power_usage_threshold int32

The main power usage threshold.

poe_state string

The poe_state.

site_id stringrequired

The site ID.

switch_state SwitchState

The switch state.

bridge_id string

The switch bridge ID

default_vlan_id int32

Default VLAN ID is 1.

designated_bridge_id string

The designated bridge ID.

last_topology_change string

Last topology change.

max_hops int32

Max Hops

mstp_enabled boolean

The MSTP enabled. True or False.

root_bridge_id string

Root Bridge Id

root_path_cost int32

Root Path Cost

root_port string

Root Port

stp_aging_timer int32

The STP aging Timer between 10 - 1000000 seconds.

stp_forward_delay int32

Forward Delay is the length of time spent in listening state, set the value between 4 - 30 seconds.

stp_hello_time int32

Hello Time is the time Interval between BPDU transmission, set the value between 1-10 seconds.

stp_max_age int32

The length of Max Age time that the switch retains information learned from BPDUs, set the value between 6 - 40 seconds.

stp_mode string

The STP Mode is RSTP, default STP mode is RSTP

stp_priority int32

The Priority value is between 0 - 61440, in multiples of 4096.

Example (from schema)

{
  "analytics_backlog_connected": true,
  "analytics_backlog_connected_on_utc": 0,
  "analytics_backlog_disconnected_on_utc": 0,
  "analytics_backlog_from": "string",
  "analytics_live_connected": true,
  "analytics_live_connected_on_utc": 0,
  "analytics_live_disconnected_on_utc": 0,
  "analytics_live_from": "string",
  "cdl_connection_state": {
    "connected": true,
    "state_change_time": 0
  },
  "config_and_events_connected": true,
  "config_and_events_connected_on_utc": 0,
  "config_and_events_disconnected_on_utc": 0,
  "config_and_events_from": "string",
  "controller_connection_intf": "string",
  "device_mode": "none",
  "element_id": "string",
  "flows_backlog_connected": true,
  "flows_backlog_connected_on_utc": 0,
  "flows_backlog_disconnected_on_utc": 0,
  "flows_backlog_from": "string",
  "flows_live_connected": true,
  "flows_live_connected_on_utc": 0,
  "flows_live_disconnected_on_utc": 0,
  "flows_live_from": "string",
  "id": "string",
  "last_disconnected_time": 0,
  "last_rebooted_info": "string",
  "last_rebooted_time": 0,
  "logs_backlog_connected": true,
  "logs_backlog_connected_on_utc": 0,
  "logs_backlog_disconnected_on_utc": 0,
  "logs_backlog_from": "string",
  "logs_live_connected": true,
  "logs_live_connected_on_utc": 0,
  "logs_live_disconnected_on_utc": 0,
  "logs_live_from": "string",
  "main_max_power_supported": 0,
  "main_power_allocated": 0,
  "main_power_usage_threshold": 0,
  "poe_state": "string",
  "site_id": "string",
  "switch_state": {
    "bridge_id": "string",
    "default_vlan_id": 0,
    "designated_bridge_id": "string",
    "last_topology_change": "string",
    "max_hops": 0,
    "mstp_enabled": true,
    "root_bridge_id": "string",
    "root_path_cost": 0,
    "root_port": "string",
    "stp_aging_timer": 0,
    "stp_forward_delay": 0,
    "stp_hello_time": 0,
    "stp_max_age": 0,
    "stp_mode": "string",
    "stp_priority": 0
  }
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "ELEMENT_STATUS_NOT_FOUND"
      }
    ]
  }
}

Loading...