Type: object

OpenWrt uCentral state schema

root version
Type: const
Specific value: 1

root uuid
Type: integer

The unique ID of the configuration. This is the unix timestamp of when the config was created.

root serial
Type: string

The unique serial number of the device.

root unit
Type: object

This section describes the current state of the OS running on the device.

root unit load
Type: array of number

This array hold 3 values describing the average system load for the last 1, 5 and 15 minutes.

Each item of this array must be:

root unit load load items
Type: number

root unit cpu_load
Type: array of number

This array hold the total and per core load in percentage.

Each item of this array must be:

root unit cpu_load cpu_load items
Type: number

root unit localtime
Type: number

This property contains the current unix time of the device.

root unit memory
Type: object

This section describes the current memory uasge of the device.

root unit memory free
Type: number

The amount of free memory.

root unit memory total
Type: number

The total amount of memory.

root unit memory cached
Type: number

The total amount of cached memory.

root unit memory buffered
Type: number

The total amount of buffered memory.

root unit uptime
Type: number

The number of seconds since the unit last booted.

root unit temperature
Type: array of number

The average and maximum thermal reading from the CPU.

Each item of this array must be:

root unit temperature temperature items
Type: number

root unit boottime
Type: number

This property contains the current unix time of the device.

root gps
Type: object

This section describes the GPS location of the device.

root gps latitude
Type: number

The latitude in WGS84.

root gps longitude
Type: number

The longitude in WGS84.

root gps elevation
Type: number

The elevation above sea level in meters.

root radios
Type: array of object

An array containing the current operational state of all wifi radios that the unit has.

Each item of this array must be:

root radios radios items
Type: object

root radios radios items channel
Type: number

The primary channel that the radio is currently operating on.

root radios radios items channels
Type: array of number

The list of all channels that the radio is currently operating on.

Each item of this array must be:

root radios radios items channels channels items
Type: number

root radios radios items frequency
Type: array of number

The list of all frequencies that the radio is currently operating on.

Each item of this array must be:

root radios radios items frequency frequency items
Type: number

root radios radios items channel_width
Type: enum (of integer)

The channel width currently being used.

Must be one of:

  • 20
  • 40
  • 80
  • 160
  • 320

root radios radios items tx_power
Type: number

The currently configure TX power of the radio in dBm.

root radios radios items phy
Type: string

The unique path identifying the radio

root radios radios items band
Type: array of string

The wireless band that the radio is currently operating on.

Each item of this array must be:

root radios radios items band band items
Type: string

root radios radios items temperature
Type: number

The current temperature of the Wireless radio.

root radios radios items survey
Type: array of object

The result of the site-survey call.

Each item of this array must be:

root radios radios items survey survey items
Type: object

root radios radios items survey survey items busy
Type: number

Channel busy time.

root radios radios items survey survey items frequency
Type: number

The frequency of this channel.

root radios radios items survey survey items noise
Type: number

The noise on this frequency.

root radios radios items survey survey items time
Type: number

Channel active time.

root radios radios items survey survey items time_rx
Type: number

Channel receive time.

root radios radios items survey survey items time_tx
Type: number

Channel transmit time

root interfaces
Type: array of object

An array containing the runtime state of all logical interfaces.items

Each item of this array must be:

root interfaces interfaces items
Type: object

root interfaces interfaces items location
Type: string

The json-schema path within the configuration where this logical interface is located.

root interfaces interfaces items uptime
Type: number

The number of seconds since the interface was brought up.

root interfaces interfaces items name
Type: string

The administrative name of this logical interface. This field is freetext

root interfaces interfaces items ntp_server
Type: string

The upstream NTP server being used by this interface.

root interfaces interfaces items dns_servers
Type: array of string

The list of remote DNS servers that this logical interface uses for domain name resolution.

Each item of this array must be:

root interfaces interfaces items dns_servers dns_servers items
Type: string

root interfaces interfaces items ipv4
Type: object

root interfaces interfaces items ipv4 addresses
Type: array of string

The list of IPv4 addresses being used by this logical interface.

Each item of this array must be:

root interfaces interfaces items ipv4 addresses addresses items
Type: string

An IPv4 addreess.

root interfaces interfaces items ipv4 leasetime
Type: number

This is the leasetime if the IPv4 address of this logical interface was acquired via DHCPv4.

root interfaces interfaces items ipv4 dhcp_server
Type: string

The IPv4 address of the DHCPv4 server that assigned the active lease.

root interfaces interfaces items ipv4 leases
Type: array of object

Each item of this array must be:

root interfaces interfaces items ipv4 leases leases items
Type: object

This section describes an IPv4 lease that we have served

root interfaces interfaces items ipv4 leases leases items address
Type: string

The IPv4 that has been assigned to the networking client.

root interfaces interfaces items ipv4 leases leases items assigned
Type: string

The unix time stamp when this lease was assigned.

root interfaces interfaces items ipv4 leases leases items hostname
Type: string

The hostname that the client included in his request.

root interfaces interfaces items ipv4 leases leases items mac
Type: string

The MAC address of the client that this lease was assigned to.

root interfaces interfaces items ipv6_addresses
Type: array of object

Each item of this array must be:

root interfaces interfaces items ipv6_addresses ipv6_addresses items
Type: object

An IPv6 address assigned to this logical interface.

root interfaces interfaces items ipv6_addresses ipv6_addresses items address
Type: string

The actual IPv6 address/mask

root interfaces interfaces items ipv6_addresses ipv6_addresses items valid
Type: number

How much longer this delegation is valid for.

root interfaces interfaces items ipv6_leases
Type: array of object

Each item of this array must be:

root interfaces interfaces items ipv6_leases ipv6_leases items
Type: object

This section describes an IPv6 lease that we have served.

root interfaces interfaces items ipv6_leases ipv6_leases items addresses
Type: array of string

A list of all IPv6 addresses that were assigned to this host.

Each item of this array must be:

root interfaces interfaces items ipv6_leases ipv6_leases items addresses addresses items
Type: string

root interfaces interfaces items ipv6_leases ipv6_leases items hostname
Type: string

The hostname that the client sent in its solicit message.

root interfaces interfaces items clients
Type: array of object

Each item of this array must be:

root interfaces interfaces items clients clients items
Type: object

This section describes a network neighbour.

root interfaces interfaces items clients clients items mac
Type: string

The MAC address of the neighbour.

root interfaces interfaces items clients clients items ipv4_addresses
Type: array of string

The IPv4 addresses that the neighbour is known to use.

Each item of this array must be:

root interfaces interfaces items clients clients items ipv4_addresses ipv4_addresses items
Type: string

root interfaces interfaces items clients clients items ipv6_addresses
Type: array of string

The IPv4 addresses that the neighbour is known to use.

Each item of this array must be:

root interfaces interfaces items clients clients items ipv6_addresses ipv6_addresses items
Type: string

root interfaces interfaces items clients clients items ports
Type: array of string

The physical network devices that that the neighbour has been seen on.

Each item of this array must be:

root interfaces interfaces items clients clients items ports ports items
Type: string

root interfaces interfaces items clients clients items last_seen
Type: number

How long along was traffic from this neighbour last seen.

root interfaces interfaces items counters
Type: object

This section contains the traffic counters of the logical interface.

root interfaces interfaces items counters rx_bytes
Type: number

The number of bytes received.

root interfaces interfaces items counters rx_packets
Type: number

The number of packets received.

root interfaces interfaces items counters rx_errors
Type: number

The number of receive errors.

root interfaces interfaces items counters rx_dropped
Type: number

The number of received packets that were dropped.

root interfaces interfaces items counters tx_bytes
Type: number

The number of bytes transmitted.

root interfaces interfaces items counters tx_packets
Type: number

The number of packets transmitted.

root interfaces interfaces items counters tx_errors
Type: number

The number of transmit errors.

root interfaces interfaces items counters tx_dropped
Type: number

The number of transmitted packets that were dropped.

root interfaces interfaces items delta_counters
Type: object

This section contains the traffic counters of the logical interface.

Same definition as counters

root interfaces interfaces items mesh-path
Type: object

This section contains info about connected mesh nodes.

root interfaces interfaces items ssids
Type: array of object

Each item of this array must be:

root interfaces interfaces items ssids ssids items
Type: object

This section contains the current state of a SSID being brodcasted or connected to by this device.

root interfaces interfaces items ssids ssids items bssid
Type: string

The BSSID used by this BSS instance.

root interfaces interfaces items ssids ssids items location
Type: string

The json-schema path within the configuration where this logical interface is located.

root interfaces interfaces items ssids ssids items phy
Type: string

The unique path identifying the radio

root interfaces interfaces items ssids ssids items band
Type: string

The wireless band that the radio is currently operating on.

root interfaces interfaces items ssids ssids items ssid
Type: string

The SSID that we are broadcasting or connecting to.

root interfaces interfaces items ssids ssids items iface
Type: string

The physical network device used.

root interfaces interfaces items ssids ssids items vlan_ifaces
Type: array of object

The list of dynamic vlan interfaces.

Each item of this array must be:

root interfaces interfaces items ssids ssids items vlan_ifaces vlan_ifaces items
Type: object

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^wlan-v
root interfaces interfaces items ssids ssids items vlan_ifaces vlan_ifaces items interface.counter
Type: object

This section contains the traffic counters of the logical interface.

Same definition as counters

root interfaces interfaces items ssids ssids items mode
Type: enum (of string)

The operational mode of the BSS.

Must be one of:

  • "ap"
  • "sta"
  • "mesh"
  • "wds"

root interfaces interfaces items ssids ssids items radio
Type: object

A reference to the section describing the physical radio within this document. (#/radios/X)

root interfaces interfaces items ssids ssids items frequency
Type: array of number

The list of all frequencies that the radio is currently operating on.

Each item of this array must be:

root interfaces interfaces items ssids ssids items frequency frequency items
Type: number

root interfaces interfaces items ssids ssids items associations
Type: array

A list all OBSS that this BSS is connected to. The contained entries depend opertational mode. * AP - all associated stationd * STA - the remote AP * mesh - all mesh peers that we can see * wds - the remote wds peer

Each item of this array must be:

root interfaces interfaces items ssids ssids items associations associations items
Type: object

An explanation about the purpose of this instance.

root interfaces interfaces items ssids ssids items associations associations items bssid
Type: string

The BSSID of the remote BSS.

root interfaces interfaces items ssids ssids items associations associations items station
Type: string

The MAC address of the station.

root interfaces interfaces items ssids ssids items associations associations items dynamic_vlan
Type: number

The VID in case the association is on a dynamic VLAN.

root interfaces interfaces items ssids ssids items associations associations items rssi
Type: number

The RX signal strength of the remore BSS. (dBm)

root interfaces interfaces items ssids ssids items associations associations items rx_bytes
Type: number

The number of bytes received.

root interfaces interfaces items ssids ssids items associations associations items rx_packets
Type: number

The number of packets received.

root interfaces interfaces items ssids ssids items associations associations items tx_packets
Type: number

The number of packets received.

root interfaces interfaces items ssids ssids items associations associations items tx_bytes
Type: number

The number of bytes transmitted.

root interfaces interfaces items ssids ssids items associations associations items tx_failed
Type: number

The number of packets transmitted.

root interfaces interfaces items ssids ssids items counters
Type: object

This section contains the traffic counters of the logical interface.

Same definition as counters

root interfaces interfaces items ssids ssids items delta_counters
Type: object

This section contains the traffic counters of the logical interface.

Same definition as counters

root lldp-peers
Type: object

root lldp-peers upstream
Type: object

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^(eth|lan|wan)[0-9]*$
root lldp-peers upstream lldp-peers
Type: array of object

Each item of this array must be:

root lldp-peers upstream ^(eth|lan|wan)[0-9]*$ ^(eth|lan|wan)[0-9]*$ items
Type: object

A list of all LLDP peers that this logical interface is connected to.

root lldp-peers upstream ^(eth|lan|wan)[0-9]*$ ^(eth|lan|wan)[0-9]*$ items capability
Type: array of string

The device capabilities that our neighbour is announcing.

Each item of this array must be:

root lldp-peers upstream ^(eth|lan|wan)[0-9]*$ ^(eth|lan|wan)[0-9]*$ items capability capability items
Type: string

root lldp-peers upstream ^(eth|lan|wan)[0-9]*$ ^(eth|lan|wan)[0-9]*$ items description
Type: string

The chassis description that our neighbour is announcing.

root lldp-peers upstream ^(eth|lan|wan)[0-9]*$ ^(eth|lan|wan)[0-9]*$ items mac
Type: string

The chassis ID/MAC that our neighbour is announcing.

root lldp-peers upstream ^(eth|lan|wan)[0-9]*$ ^(eth|lan|wan)[0-9]*$ items management_ips
Type: array of string

The management IPs that our neighbour is announcing.

Each item of this array must be:

root lldp-peers upstream ^(eth|lan|wan)[0-9]*$ ^(eth|lan|wan)[0-9]*$ items management_ips management_ips items
Type: string

root lldp-peers upstream ^(eth|lan|wan)[0-9]*$ ^(eth|lan|wan)[0-9]*$ items port
Type: string

The physical network port that we see this neighbour on.

root lldp-peers downstream
Type: object

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^(eth|lan|wan)[0-9]*$
root lldp-peers downstream lldp-peers
Type: array of object
Same definition as lldp-peers_upstream_pattern1

root dynamic_vlans
Type: array

Each item of this array must be:

root dynamic_vlans dynamic-vlan
Type: object

This section contains the traffic counters of the logical interface.

root dynamic_vlans dynamic_vlans items rx_bytes
Type: number

The number of bytes received.

root dynamic_vlans dynamic_vlans items rx_packets
Type: number

The number of packets received.

root dynamic_vlans dynamic_vlans items tx_bytes
Type: number

The number of bytes transmitted.

root dynamic_vlans dynamic_vlans items tx_packets
Type: number

The number of packets transmitted.