From c63ac1f5d9f285d90aab616d80d58704d9e677b2 Mon Sep 17 00:00:00 2001 From: Mike Hansen Date: Mon, 26 May 2025 08:48:43 -0400 Subject: [PATCH] Update OLS Schema version to 4.1.0, regenerate html Signed-off-by: Mike Hansen --- docs/ucentral-schema.html | 6 +++--- docs/ucentral-state.html | 8 +++++--- docs/ucentral.capabilities.html | 2 +- schema.json | 2 +- 4 files changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/ucentral-schema.html b/docs/ucentral-schema.html index 3da1332..e9a0ff0 100644 --- a/docs/ucentral-schema.html +++ b/docs/ucentral-schema.html @@ -39,10 +39,10 @@

Type: array of object

List of MVR groups (or profiles) configuration.

No Additional Items

Each item of this array must be:

Type: object

Type: string

The name of a MVR group that consists of one or more MVR group addresses

Must be at least 1 characters long

Must be at most 16 characters long

Type: stringFormat: ipv4

Start IP address on the range of MVR group addresses that maps to a profile/MVR group

Type: stringFormat: ipv4

Statically configure all multicast group addresses that will join an MVR VLAN. Map a range of MVR group addresses to a profile

Type: array of integer
No Additional Items

Each item of this array must be:

Type: integer

Value must be greater or equal to 1 and lesser or equal to 10

Type: object

Configuration options for LLDP on a global level in a OLS switch.

Type: boolean Default: true

Enables or disables LLDP globally at a switch level.

Type: integer Default: 4

Configures the time-to-live (TTL) value sent in LLDP advertisements. The TTL tells the receiving LLDP agent how long to retain all information from the sending LLDP agent if it does not transmit updates in a timely manner.

Type: integer Default: 4

Configures how many medFastStart packets are transmitted during the activation process of the LLDP-MED Fast Start mechanism.

Type: integer Default: 30

Configures the periodic transmit interval for LLDP advertisements (in seconds).

Type: integer Default: 2

Configures the delay (in seconds) before reinitializing after LLDP ports are disabled or the link goes down.

Type: integer

Configures a delay (in seconds) between successive transmissions of advertisements initiated by a change in local LLDP state.

Value must be greater or equal to 1 and lesser or equal to 8192

Type: integer Default: 5

Configures the interval (in seconds) for sending SNMP notifications about LLDP changes.

Type: boolean Default: false

Enables MC-LAG or disables it.

Type: object

This section defines the MC-LAG configuration parameters for the switch.

Type: array of object

List of MC-LAG domain configurations for the switch.

No Additional Items

Each item of this array must be:

Type: object

Type: integer Default: 1

Specifies the MC-LAG domain ID to identify the grouping of peer switches.

Value must be greater or equal to 1 and lesser or equal to 1024

Type: object

Configures the MC-LAG group, which binds the interfaces into a multi-chassis LAG.

Type: integer

Defines the unique MC-LAG group identifier.

Value must be greater or equal to 1 and lesser or equal to 128

Type: array of string

List of interfaces that participate in the MC-LAG group.

No Additional Items

Each item of this array must be:

Type: string

Interface names that are part of the MC-LAG group.


Examples:

"eth0"
 
"eth1"
 

Type: object

LACP configuration settings for the MC-LAG group.

Type: boolean Default: true

Enables or disables LACP for the MC-LAG group.

Type: enum (of string) Default: "actor"

Configures the LACP role as 'actor' or 'partner'

Must be one of:

  • "actor"
  • "partner"

Type: enum (of string) Default: "long"

Sets the LACP timeout as either 'short' or 'long'.

Must be one of:

  • "short"
  • "long"

Type: integer Default: 32768

Specifies the system priority used by the switch for LACP negotiations.

Value must be greater or equal to 1 and lesser or equal to 65535

Type: boolean Default: true

Enables dual-active detection to prevent split-brain scenarios in MC-LAG.

Type: object

This parameter enables or disables the overall configuration of the Voice VLAN feature on the switch. When enabled, it allows the system to classify and prioritize voice traffic.

Type: integer

Specifies the VLAN ID assigned to the Voice VLAN. This is the unique identifier for the VLAN that will be used for prioritizing voice traffic.

Value must be greater or equal to 1 and lesser or equal to 4094

Type: integer Default: 1440

Defines the time, in minutes, that a dynamic Voice VLAN entry remains in the VLAN after voice traffic is no longer detected. It helps manage resources by removing inactive voice devices from the VLAN after this time elapses.

Value must be greater or equal to 5 and lesser or equal to 43200

Type: array of object

Configures the Organizationally Unique Identifier (OUI) for identifying the voice devices (like IP phones).

No Additional Items

Each item of this array must be:

Type: object

Type: stringFormat: uc-mac

The specific MAC address pattern that corresponds to voice devices, as determined by the OUI. It is used for identifying and classifying voice traffic.

Type: stringFormat: uc-mac

A mask applied to the MAC address to help match the OUI more precisely. It ensures that the correct portion of the MAC address is evaluated to identify a device as a voice device.

Type: string

A descriptive label or comment for the OUI configuration. This can help administrators keep track of which OUI belongs to which type of voice device or vendor.

Must be at least 1 characters long

Must be at most 32 characters long


Example:

"A VoIP Phone"
-

Type: object

Global configuration for ARP Inspection on the switch.

Type: boolean Default: false

Enable or disable ARP Inspection globally.

Type: boolean

Validate that the destination MAC address in the Ethernet header matches the target MAC address in the ARP body for ARP responses.

Type: boolean

Validate ARP packets for unexpected or invalid IP addresses, such as 0.0.0.0, 255.255.255.255, and IP multicast addresses.

Type: boolean

Allow ARP packets where the sender IP address is 0.0.0.0.

Type: boolean

Validate that the source MAC address in the Ethernet header matches the sender MAC address in the ARP body for both ARP requests and responses.

Type: object

Configuration for IP Source Guard global static bindings in a Layer 2 switch.

Type: array of object

List of static bindings for IP Source Guard.

No Additional Items

Each item of this array must be:

Type: object

Type: enum (of string)

Specifies the mode for adding a static address to the Source Guard ACL or MAC address binding table. It determines whether the binding is based on MAC addresses or ACLs.

Must be one of:

  • "mac"
  • "acl"

Type: stringFormat: uc-mac

A valid unicast MAC address for binding to the Source Guard filtering table.

Type: integer

The VLAN ID associated with the static binding for Source Guard filtering. Must be a valid, configured VLAN on the switch.

Type: stringFormat: ipv4

A valid unicast IPv4 address to associate with the Source Guard filtering table.

Type: string

The physical interface (e.g., ethernet0, ethernet1) where the Source Guard binding applies.

Type: object

Configuration for enabling or disabling specific event categories and their sub-events.

Type: object

Enable/Disable Port Status events.

Type: boolean Default: false

Enable/Disable Port Status category.

Type: object

Type: boolean Default: false

Enable/Disable carrier down event.

Type: boolean Default: false

Enable/Disable carrier up event.

Type: object

Enable/Disable Module events.

Type: boolean Default: false

Enable/Disable Module category.

Type: object

Type: boolean Default: false

Enable/Disable module plugout event.

Type: boolean Default: false

Enable/Disable module plugin event.

Type: object

Enable/Disable STP events.

Type: boolean Default: false

Enable/Disable STP category.

Type: object

Type: boolean Default: false

Enable/Disable loop detected event.

Type: boolean Default: false

Enable/Disable loop cleared event.

Type: boolean Default: false

Enable/Disable state change event.

Type: object

Enable/Disable RSTP events.

Type: boolean Default: false

Enable/Disable RSTP category.

Type: object

Type: boolean Default: false

Enable/Disable loop detected event.

Type: boolean Default: false

Enable/Disable loop cleared event.

Type: boolean Default: false

Enable/Disable state change event.

Type: object

Enable/Disable Firmware Upgrade events.

Type: boolean Default: false

Enable/Disable Firmware Upgrade category.

Type: object

Type: boolean Default: false

Enable/Disable download start event.

Type: boolean Default: false

Enable/Disable download in progress event.

Type: boolean Default: false

Enable/Disable download failed event.

Type: boolean Default: false

Enable/Disable validation start event.

Type: boolean Default: false

Enable/Disable validation success event.

Type: boolean Default: false

Enable/Disable validation failed event.

Type: boolean Default: false

Enable/Disable firmware backup event.

Type: boolean Default: false

Enable/Disable install start event.

Type: boolean Default: false

Enable/Disable install failed event.

Type: boolean Default: false

Enable/Disable reboot start event.

Type: boolean Default: false

Enable/Disable upgrade success event.

Type: object

Enable/Disable DHCP Snooping events.

Type: boolean Default: false

Enable/Disable DHCP Snooping category.

Type: object

Type: boolean Default: false

Enable/Disable DHCP Snooping violation detected event.

Type: boolean Default: false

Enable/Disable DHCP Snooping violation cleared event.

Type: array of object

Contains all the access control rule definitions

All items must be unique

No Additional Items

Each item of this array must be:

Type: object

Type: string

The identifier or name for the Access Control List

Must be at least 1 characters long

Must be at most 32 characters long

Type: enum (of string)

Type of the access control list

Must be one of:

  • "ipv4"
  • "ipv6"
  • "ipv4Ext"
  • "ipv6Ext"
  • "mac"
  • "arp"

Type: object

access control rules under this ACL

Each additional property must conform to the following schema

Type: array of object

All items must be unique

No Additional Items

Each item of this array must be:

Type: object

Type: enum (of string)

Defines whether to permit or deny traffic matching the rule

Must be one of:

  • "permit"
  • "deny"

Type: stringFormat: uc-mac

Specifies the source MAC address to filter on

Type: stringFormat: uc-mac

The mask applied to the source MAC address

Type: stringFormat: uc-mac

Specifies the destination MAC address for the filter

Type: stringFormat: uc-mac

The mask applied to the destination MAC address

Type: enum (of string)

Identifies the protocol encapsulated in the Ethernet frame by its EtherType

Must be one of:

  • "any"
  • "untagged-eth2"
  • "untagged-802.3"
  • "tagged-eth2"
  • "tagged-802.3"

Type: integer

Specifies a VLAN ID to filter traffic from a specific VLAN

Value must be greater or equal to 1 and lesser or equal to 4094

Type: integer

The mask applied to the VLAN ID

Value must be greater or equal to 1 and lesser or equal to 4095

Type: string Default: "800"

Filters packets based on the custom EtherType field (HEX) in the Ethernet frame

Type: string Default: "FFFF"

The mask applied to the EtherType field

Type: integer

Filters based on the Class of Service (CoS) field in the frame

Value must be greater or equal to 0 and lesser or equal to 7

Type: integer

The mask applied to the CoS field

Value must be greater or equal to 0 and lesser or equal to 7

Type: stringFormat: ipv4

The IPv4 address of the source to filter on

Type: stringFormat: ipv4

The subnet mask applied to the source IPv4 address

Type: stringFormat: ipv4

The IPv4 address of the destination to filter on

Type: stringFormat: ipv4

The subnet mask applied to the destination IPv4 address

Type: integer

Filters based on the IP protocol number

Value must be greater or equal to 0 and lesser or equal to 255

Type: array
No Additional Items

Each item of this array must be:

Type: object

This section describes the logical network interfaces of the device. Interfaces as their primary have a role that is upstream, downstream, guest, ....

Type: string

This is a free text field, stating the administrative name of the interface. It may contain spaces and special characters.


Example:

"LAN"
+

Type: object

Global configuration for ARP Inspection on the switch.

Type: boolean Default: false

Enable or disable ARP Inspection globally.

Type: boolean

Validate that the destination MAC address in the Ethernet header matches the target MAC address in the ARP body for ARP responses.

Type: boolean

Validate ARP packets for unexpected or invalid IP addresses, such as 0.0.0.0, 255.255.255.255, and IP multicast addresses.

Type: boolean

Allow ARP packets where the sender IP address is 0.0.0.0.

Type: boolean

Validate that the source MAC address in the Ethernet header matches the sender MAC address in the ARP body for both ARP requests and responses.

Type: object

Configuration for IP Source Guard global static bindings in a Layer 2 switch.

Type: array of object

List of static bindings for IP Source Guard.

No Additional Items

Each item of this array must be:

Type: object

Type: enum (of string)

Specifies the mode for adding a static address to the Source Guard ACL or MAC address binding table. It determines whether the binding is based on MAC addresses or ACLs.

Must be one of:

  • "mac"
  • "acl"

Type: stringFormat: uc-mac

A valid unicast MAC address for binding to the Source Guard filtering table.

Type: integer

The VLAN ID associated with the static binding for Source Guard filtering. Must be a valid, configured VLAN on the switch.

Type: stringFormat: ipv4

A valid unicast IPv4 address to associate with the Source Guard filtering table.

Type: string

The physical interface (e.g., ethernet0, ethernet1) where the Source Guard binding applies.

Type: object

Configuration for enabling or disabling specific event categories and their sub-events.

Type: object

Enable/Disable Port Status events.

Type: boolean Default: false

Enable/Disable Port Status category.

Type: object

Type: boolean Default: false

Enable/Disable carrier down event.

Type: boolean Default: false

Enable/Disable carrier up event.

Type: object

Enable/Disable Module events.

Type: boolean Default: false

Enable/Disable Module category.

Type: object

Type: boolean Default: false

Enable/Disable module plugout event.

Type: boolean Default: false

Enable/Disable module plugin event.

Type: object

Enable/Disable STP events.

Type: boolean Default: false

Enable/Disable STP category.

Type: object

Type: boolean Default: false

Enable/Disable loop detected event.

Type: boolean Default: false

Enable/Disable loop cleared event.

Type: boolean Default: false

Enable/Disable state change event.

Type: object

Enable/Disable RSTP events.

Type: boolean Default: false

Enable/Disable RSTP category.

Type: object

Type: boolean Default: false

Enable/Disable loop detected event.

Type: boolean Default: false

Enable/Disable loop cleared event.

Type: boolean Default: false

Enable/Disable state change event.

Type: object

Enable/Disable Firmware Upgrade events.

Type: boolean Default: false

Enable/Disable Firmware Upgrade category.

Type: object

Type: boolean Default: false

Enable/Disable download start event.

Type: boolean Default: false

Enable/Disable download in progress event.

Type: boolean Default: false

Enable/Disable download failed event.

Type: boolean Default: false

Enable/Disable validation start event.

Type: boolean Default: false

Enable/Disable validation success event.

Type: boolean Default: false

Enable/Disable validation failed event.

Type: boolean Default: false

Enable/Disable firmware backup event.

Type: boolean Default: false

Enable/Disable install start event.

Type: boolean Default: false

Enable/Disable install failed event.

Type: boolean Default: false

Enable/Disable reboot start event.

Type: boolean Default: false

Enable/Disable upgrade success event.

Type: object

Enable/Disable DHCP Snooping events.

Type: boolean Default: false

Enable/Disable DHCP Snooping category.

Type: object

Type: boolean Default: false

Enable/Disable DHCP Snooping violation detected event.

Type: boolean Default: false

Enable/Disable DHCP Snooping violation cleared event.

Type: array of object

Contains all the access control rule definitions

All items must be unique

No Additional Items

Each item of this array must be:

Type: object

Type: string

The identifier or name for the Access Control List

Must be at least 1 characters long

Must be at most 32 characters long

Type: enum (of string)

Type of the access control list

Must be one of:

  • "ipv4"
  • "ipv6"
  • "ipv4Ext"
  • "ipv6Ext"
  • "mac"
  • "arp"

Type: object

access control rules under this ACL

Each additional property must conform to the following schema

Type: array of object

All items must be unique

No Additional Items

Each item of this array must be:

Type: object

Type: enum (of string)

Defines whether to permit or deny traffic matching the rule

Must be one of:

  • "permit"
  • "deny"

Type: stringFormat: uc-mac

Specifies the source MAC address to filter on

Type: stringFormat: uc-mac

The mask applied to the source MAC address

Type: stringFormat: uc-mac

Specifies the destination MAC address for the filter

Type: stringFormat: uc-mac

The mask applied to the destination MAC address

Type: enum (of string)

Identifies the protocol encapsulated in the Ethernet frame by its EtherType

Must be one of:

  • "any"
  • "untagged-eth2"
  • "untagged-802.3"
  • "tagged-eth2"
  • "tagged-802.3"

Type: integer

Specifies a VLAN ID to filter traffic from a specific VLAN

Value must be greater or equal to 1 and lesser or equal to 4094

Type: integer

The mask applied to the VLAN ID

Value must be greater or equal to 1 and lesser or equal to 4095

Type: string Default: "800"

Filters packets based on the custom EtherType field (HEX) in the Ethernet frame

Type: string Default: "FFFF"

The mask applied to the EtherType field

Type: integer

Filters based on the Class of Service (CoS) field in the frame

Value must be greater or equal to 0 and lesser or equal to 7

Type: integer

The mask applied to the CoS field

Value must be greater or equal to 0 and lesser or equal to 7

Type: stringFormat: ipv4

The IPv4 address of the source to filter on

Type: stringFormat: ipv4

The subnet mask applied to the source IPv4 address

Type: stringFormat: ipv4

The IPv4 address of the destination to filter on

Type: stringFormat: ipv4

The subnet mask applied to the destination IPv4 address

Type: integer

Filters based on the IP protocol number

Value must be greater or equal to 0 and lesser or equal to 255

Type: array of string

Define a global list of dns servers.

No Additional Items

Each item of this array must be:

Type: string

Type: array
No Additional Items

Each item of this array must be:

Type: object

This section describes the logical network interfaces of the device. Interfaces as their primary have a role that is upstream, downstream, guest, ....

Type: string

This is a free text field, stating the administrative name of the interface. It may contain spaces and special characters.


Example:

"LAN"
 

Type: enum (of string)

The role defines if the interface is upstream or downstream facing.

Must be one of:

  • "upstream"
  • "downstream"

Type: boolean

This option makes sure that any traffic leaving this interface is isolated and all local IP ranges are blocked. It essentially enforces "guest network" firewall settings.

Type: integer

The routing metric of this logical interface. Lower values have higher priority.

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer

The MTU of this logical interface.

Value must be greater or equal to 1280 and lesser or equal to 1500

Type: array of string

The services that shall be offered on this logical interface. These are just strings such as "ssh", "lldp", "mdns"

No Additional Items

Each item of this array must be:

Type: string

Examples:

"ssh"
 
"lldp"
-

Type: object

Setup additional VLANs inside the bridge

Type: object

This section describes the vlan behaviour of a logical network interface.

Type: integer

This is the pvid of the vlan that shall be assigned to the interface. The individual physical network devices contained within the interface need to be told explicitly if egress traffic shall be tagged.

Value must be lesser or equal to 4050

Type: enum (of string) Default: "802.1q"

Must be one of:

  • "802.1ad"
  • "802.1q"

Type: object

This section describes the bridge behaviour of a logical network interface.

Type: integer

The MTU that shall be used by the network interface.

Value must be greater or equal to 256 and lesser or equal to 65535


Example:

1500
+

Type: object

Setup additional VLANs inside the bridge

Type: object

This section describes the vlan behaviour of a logical network interface.

Type: integer

This is the pvid of the vlan that shall be assigned to the interface. The individual physical network devices contained within the interface need to be told explicitly if egress traffic shall be tagged.

Value must be lesser or equal to 4094

Type: integer

Value must be lesser or equal to 4094

Type: integer

Value must be lesser or equal to 4094

Type: enum (of string) Default: "802.1q"

Must be one of:

  • "802.1ad"
  • "802.1q"

Type: object

This section describes the bridge behaviour of a logical network interface.

Type: integer

The MTU that shall be used by the network interface.

Value must be greater or equal to 256 and lesser or equal to 65535


Example:

1500
 

Type: integer

The Transmit Queue Length is a TCP/IP stack network interface value that sets the number of packets allowed per kernel transmit queue of a network interface device.


Example:

5000
 

Type: boolean Default: false

Isolates the bridge ports from each other.

Type: array
No Additional Items

Each item of this array must be:

Type: object

This section defines the physical copper/fiber ports that are members of the interface. Network devices are referenced by their logical names.

Type: array of string

The list of physical network devices that shall be added to the interface. The names are logical ones and wildcardable. "WAN" will use whatever the hardwares default upstream facing port is. "LANx" will use the "x'th" downstream facing ethernet port. LAN* will use all downstream ports.

No Additional Items

Each item of this array must be:

Type: string

Examples:

"LAN1"
 
"LAN2"
@@ -114,4 +114,4 @@
     "system.ntp.server",
     "1.openwrt.pool.ntp.org"
 ]
-

Type: object

Additional Properties of any type are allowed.

Type: object
\ No newline at end of file +

Type: object

Additional Properties of any type are allowed.

Type: object
\ No newline at end of file diff --git a/docs/ucentral-state.html b/docs/ucentral-state.html index e660a7c..7450c9a 100644 --- a/docs/ucentral-state.html +++ b/docs/ucentral-state.html @@ -1,6 +1,6 @@ Schema Docs
Type: object

OpenWrt uCentral state schema

Type: const
Specific value: 1

Type: integer

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

Type: string

The unique serial number of the device.

Type: object

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

Type: array of number

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

No Additional Items

Each item of this array must be:

Type: number

Type: array of number

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

No Additional Items

Each item of this array must be:

Type: number

Type: number

This property contains the current unix time of the device.

Type: object

This section describes the current memory uasge of the device.

Type: number

The amount of free memory.

Type: number

The total amount of memory.

Type: number

The total amount of cached memory.

Type: number

The total amount of buffered memory.

Type: number

The number of seconds since the unit last booted.

Type: array of number

The average and maximum thermal reading from the CPU.

No Additional Items

Each item of this array must be:

Type: object

This section describes the current state of the PoE unit on the device

Type: number

Reports the total power available (power budget) (in watts, W) device's Power sourcing equipment is able to source.

Type: number

Reports configured power alarm threshold value for the Power sourcing equipment (in milliwatts, mW).

Type: number

Reports a total power Powered Devices are draining from the device's Power sourcing equipment (in milliwatts, mW).

Type: string

Reports power status of the device's Power sourcing equipment.


Examples:

"ON"
 
"OFF"
-

Type: object

This section describes the global (device-wise) 802.1X (port access control) state and config applied.

Type: object

Reported DAS-related state info.

Type: object

Cumulative statistics for all configured DACs.

Type: number

Number of CoA requests received.

Type: number

Number of CoA ACK responses sent.

Type: number

Number of CoA NAK responses sent.

Type: number

Number of CoA requests ignored.

Type: number

Number of CoA requests received with invalid (unsupported) attributes.

Type: number

Number of CoA requests received with invalid (unsupported) attribute value.

Type: number

Number of CoA requests received with inexisting session context.

Type: number

Number of CoA requests that are sent if the NAS is configured to prohibit honoring of CoA-Request or Disconnect-Request packets for the specified session.

Type: object

This section describes the GPS location of the device.

Type: number

The latitude in WGS84.

Type: number

The longitude in WGS84.

Type: number

The elevation above sea level in meters.

Type: array of object

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

No Additional Items

Each item of this array must be:

Type: object

Type: string

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

Type: number

The number of seconds since the interface was brought up.

Type: string

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

Type: string

The upstream NTP server being used by this interface.

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: object

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: string

An IPv4 addreess.

Type: string

The public IP address of internet connection.

Type: number

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

Type: string

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

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

This section describes an IPv4 lease that we have served

Type: string

The IPv4 that has been assigned to the networking client.

Type: string

The unix time stamp when this lease was assigned.

Type: string

The hostname that the client included in his request.

Type: string

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

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

An IPv6 address assigned to this logical interface.

Type: string

The actual IPv6 address/mask

Type: number

How much longer this delegation is valid for.

Type: array of object

This section describes an IPv6 lease that we have served.

No Additional Items

Each item of this array must be:

Type: object

An object, that describes a single served IPv6 address.

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: string

The hostname that the client sent in its solicit message.

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

This section describes a network neighbour.

Type: string

The MAC address of the neighbour.

Type: array of string

The IPv4 addresses that the neighbour is known to use.

No Additional Items

Each item of this array must be:

Type: array of string

The IPv4 addresses that the neighbour is known to use.

No Additional Items

Each item of this array must be:

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: number

How long along was traffic from this neighbour last seen.

Type: object

This section contains the traffic counters of the logical interface.

Type: number

The number of bytes received.

Type: number

The number of packets received.

Type: number

The number of receive errors.

Type: number

The number of received packets that were dropped.

Type: number

The number of bytes transmitted.

Type: number

The number of packets transmitted.

Type: number

The number of transmit errors.

Type: number

The number of transmitted packets that were dropped.

Type: object

This section contains the traffic counters of the logical interface.

Same definition as counters

Type: object

This section contains info about connected mesh nodes.

Type: object

Detailed information about all multicast-related data (groups joined, src address used etc)

Type: object

Detailed information about IGMP configured / joined multicast groups, outgoing interfaces etc.

Type: array of object

List of joined IGMP multicast groups.

No Additional Items

Each item of this array must be:

Type: object

Type: stringFormat: ipv4

Address of single group this interface is member of.


Example:

"225.0.0.1"
+

Type: object

This section describes the global (device-wise) 802.1X (port access control) state and config applied.

Type: object

Reported DAS-related state info.

Type: object

Cumulative statistics for all configured DACs.

Type: number

Number of CoA requests received.

Type: number

Number of CoA ACK responses sent.

Type: number

Number of CoA NAK responses sent.

Type: number

Number of CoA requests ignored.

Type: number

Number of CoA requests received with invalid (unsupported) attributes.

Type: number

Number of CoA requests received with invalid (unsupported) attribute value.

Type: number

Number of CoA requests received with inexisting session context.

Type: number

Number of CoA requests that are sent if the NAS is configured to prohibit honoring of CoA-Request or Disconnect-Request packets for the specified session.

Type: object

This section describes the GPS location of the device.

Type: number

The latitude in WGS84.

Type: number

The longitude in WGS84.

Type: number

The elevation above sea level in meters.

Type: array of object

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

No Additional Items

Each item of this array must be:

Type: object

Type: string

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

Type: number

The number of seconds since the interface was brought up.

Type: string

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

Type: integer

VLAN-ID of the logical interface

Value must be lesser or equal to 4094

Type: string

The upstream NTP server being used by this interface.

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: object

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: string

An IPv4 addreess.

Type: string

The public IP address of internet connection.

Type: number

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

Type: string

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

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

This section describes an IPv4 lease that we have served

Type: string

The IPv4 that has been assigned to the networking client.

Type: string

The unix time stamp when this lease was assigned.

Type: string

The hostname that the client included in his request.

Type: string

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

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

An IPv6 address assigned to this logical interface.

Type: string

The actual IPv6 address/mask

Type: number

How much longer this delegation is valid for.

Type: array of object

This section describes an IPv6 lease that we have served.

No Additional Items

Each item of this array must be:

Type: object

An object, that describes a single served IPv6 address.

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: string

The hostname that the client sent in its solicit message.

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

This section describes a network neighbour.

Type: string

The MAC address of the neighbour.

Type: array of string

The IPv4 addresses that the neighbour is known to use.

No Additional Items

Each item of this array must be:

Type: array of string

The IPv4 addresses that the neighbour is known to use.

No Additional Items

Each item of this array must be:

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: number

How long along was traffic from this neighbour last seen.

Type: object

This section contains the traffic counters of the logical interface.

Type: number

The number of bytes received.

Type: number

The number of packets received.

Type: number

The number of receive errors.

Type: number

The number of received packets that were dropped.

Type: number

The number of bytes transmitted.

Type: number

The number of packets transmitted.

Type: number

The number of transmit errors.

Type: number

The number of transmitted packets that were dropped.

Type: object

This section contains the traffic counters of the logical interface.

Same definition as counters

Type: object

This section contains info about connected mesh nodes.

Type: object

Detailed information about all multicast-related data (groups joined, src address used etc)

Type: object

Detailed information about IGMP configured / joined multicast groups, outgoing interfaces etc.

Type: array of object

List of joined IGMP multicast groups.

No Additional Items

Each item of this array must be:

Type: object

Type: stringFormat: ipv4

Address of single group this interface is member of.


Example:

"225.0.0.1"
 

Type: array of string

List of ports where multicast traffic of this group is being replicated to.

No Additional Items

Each item of this array must be:

Type: object

MVR statistics on interface

Type: boolean

Shows if MVR traffic is being forwarded or discarded.

Type: integer

The number of IGMP membership reports received on this interface.

Type: integer

The number of leave messages received on this interface.

Type: integer

The number of general query messages received on this interface.

Type: integer

The number of group specific or group-and-source specific query messages received on this interface.

Type: integer

The number of times a report, leave, or query was dropped.

Type: integer

The number of times a multicast group was successfully joined.

Type: integer

The number of MVR groups active on this interface.

Type: object

Represents the overall statistics for ACLs on the OLS device.

Type: array of object

A list of ACL-related statistics, each corresponding to a specific interface or port.

No Additional Items

Each item of this array must be:

Type: object

Type: string

The identifier for the interface or port to which the ACL statistics apply.

Type: enum (of string)

Type of the access control list.

Must be one of:

  • "none"
  • "ipv4"
  • "ipv6"
  • "ipv4Ext"
  • "ipv6Ext"
  • "mac"
  • "arp"

Type: enum (of string)

Indicates the action (permit or deny) taken when an ACL rule is matched.

Must be one of:

  • "permit"
  • "deny"

Type: number

The number of times an ACL rule has been matched by traffic.

Type: integer

Shows the percentage of this user-configured ACL rule as a percentage of total ACL rules.

Value must be greater or equal to 0 and lesser or equal to 100

Type: object

Represents the overall resource utilization statistics for ACLs.

Type: integer

Percentage of total ACL consumed resources amongst the resources available.

Value must be greater or equal to 0 and lesser or equal to 100

Type: object

State message entry to show the binding table for DHCP Snooping

Type: array of object

List of DHCP Snooping binding entries

No Additional Items

Each item of this array must be:

Type: object

Type: stringFormat: uc-mac

MAC address of the DHCP client in the DHCP Snooping binding table

Type: stringFormat: ipv4

IP address assigned to the MAC address in the DHCP Snooping binding table

Type: integer

This indicates the lease time in seconds for the IP address assigned to the DHCP client, after which the IP address may be reassigned

Type: enum (of string)

Specifies the type of binding entry, such as dynamic or static, indicating how the IP address was assigned to the client

Must be one of:

  • "dynamic"
  • "static"

Type: integer

VLAN ID associated with the DHCP client’s IP address, which helps in managing network segments

Value must be greater or equal to 1 and lesser or equal to 4094

Type: string

Identifies the interface through which the DHCP client is connected, aiding in network topology management


Examples:

"Ethernet1"
 
"Unit-1/Port-2"
 
"1-2"
@@ -10,7 +10,9 @@
 

Type: object

This section describes the global (device-wise) mac-address-list (FDB table / wired clients).


Example:

{
+

Type: object

This section describes the global (device-wise) mac-address-list (FDB table / wired clients).


Example:

{
     "overflow": true,
     "Ethernet1": {
         "1": [
@@ -25,4 +27,4 @@
         ]
     }
 }
-

Type: boolean

Flag indicates that device could report an amount of FDB entries, which is bigger than what cloud had requested.

Each additional property must conform to the following schema

Type: object

Each additional property must conform to the following schema

Type: array of string

VID (vlan id) identifier

No Additional Items

Each item of this array must be:

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

List of statically created trunks.

Type: integer

Logical identifier for the trunk.

Value must be greater or equal to 1 and lesser or equal to 64

Type: array of string

List of member ports under this static trunk.

No Additional Items

Each item of this array must be:

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

List of dynamically created trunks.

Type: integer

Logical identifier for the trunk.

Value must be greater or equal to 1 and lesser or equal to 64

Type: string

List of member ports under this trunk.

Type: number

LACP System priority.

Type: number

LACP port priority.

Type: string

Port state.

Type: number

Number of LACP Data Units (PDUs) sent.

Type: number

Number of LACP Data Units (PDUs) received.

Type: number

Number of Marker PDUs sent.

Type: number

Number of Marker PDUs received.

Type: number

Number of unknown packets received.

Type: number

Number of illegal packets received.

Type: number

Operational key for the port.

Type: number

Operational key for the partner.

Type: string

Operational state.

Type: string

Operational state of the partner.

Type: object

Statistics related to ARP Inspection activity in the switch.

Type: integer

Total number of ARP packets received.

Type: integer

Number of ARP packets dropped due to rate limiting.

Type: integer

Total number of ARP packets processed by ARP Inspection.

Type: integer

Number of ARP packets dropped due to source MAC address validation failures.

Type: integer

Number of ARP packets dropped due to destination MAC address validation failures.

Type: integer

Number of ARP packets dropped due to IP address validation failures."

Type: integer

Number of ARP packets dropped due to ARP ACL rules.

Type: integer

Number of ARP packets dropped due to DHCP snooping validation failures.

Type: object

Represents the configuration and state of IP Source Guard.

Type: array of object

Displays a list of entries that are currently blocked by IP Source Guard (IPSG).

No Additional Items

Each item of this array must be:

Type: object

Type: stringFormat: mac-address

The MAC address that has been blocked by IP Source Guard.

Type: stringFormat: ipv4

The IP address that has been blocked by IP Source Guard.

Type: integer

The VLAN ID associated with the blocked IP/MAC entry.

Value must be greater or equal to 1 and lesser or equal to 4095

Type: string

The interface (e.g., port) where the blocked entry was detected.

\ No newline at end of file +

Type: boolean

Flag indicates that device could report an amount of FDB entries, which is bigger than what cloud had requested.

Each additional property must conform to the following schema

Type: object

Each additional property must conform to the following schema

Type: array of string

VID (vlan id) identifier

No Additional Items

Each item of this array must be:

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

List of statically created trunks.

Type: integer

Logical identifier for the trunk.

Value must be greater or equal to 1 and lesser or equal to 64

Type: array of string

List of member ports under this static trunk.

No Additional Items

Each item of this array must be:

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

List of dynamically created trunks.

Type: integer

Logical identifier for the trunk.

Value must be greater or equal to 1 and lesser or equal to 64

Type: string

List of member ports under this trunk.

Type: number

LACP System priority.

Type: number

LACP port priority.

Type: string

Port state.

Type: number

Number of LACP Data Units (PDUs) sent.

Type: number

Number of LACP Data Units (PDUs) received.

Type: number

Number of Marker PDUs sent.

Type: number

Number of Marker PDUs received.

Type: number

Number of unknown packets received.

Type: number

Number of illegal packets received.

Type: number

Operational key for the port.

Type: number

Operational key for the partner.

Type: string

Operational state.

Type: string

Operational state of the partner.

Type: object

Statistics related to ARP Inspection activity in the switch.

Type: integer

Total number of ARP packets received.

Type: integer

Number of ARP packets dropped due to rate limiting.

Type: integer

Total number of ARP packets processed by ARP Inspection.

Type: integer

Number of ARP packets dropped due to source MAC address validation failures.

Type: integer

Number of ARP packets dropped due to destination MAC address validation failures.

Type: integer

Number of ARP packets dropped due to IP address validation failures."

Type: integer

Number of ARP packets dropped due to ARP ACL rules.

Type: integer

Number of ARP packets dropped due to DHCP snooping validation failures.

Type: object

Represents the configuration and state of IP Source Guard.

Type: array of object

Displays a list of entries that are currently blocked by IP Source Guard (IPSG).

No Additional Items

Each item of this array must be:

Type: object

Type: stringFormat: mac-address

The MAC address that has been blocked by IP Source Guard.

Type: stringFormat: ipv4

The IP address that has been blocked by IP Source Guard.

Type: integer

The VLAN ID associated with the blocked IP/MAC entry.

Value must be greater or equal to 1 and lesser or equal to 4095

Type: string

The interface (e.g., port) where the blocked entry was detected.

Type: object

Global status and configuration of the Spanning Tree Protocol (STP) across the switch. Supports variants like STP, RSTP, MSTP. Includes bridge-wide parameters and protocol behavior.

Type: boolean

Whether STP is enabled globally on the switch.

Type: enum (of string)

Operational STP mode used across the switch.

Must be one of:

  • "stp"
  • "rstp"
  • "mstp"
  • "pvst"
  • "rpvstp"

Type: integer

Maximum number of BPDUs that can be transmitted per hello time.

Type: enum (of string)

Indicates whether "Short" or "Long" path cost method is in use.

Must be one of:

  • "short"
  • "long"

Type: integer

Maximum hop count used in MSTP.

Type: array of object

List of STP instances (e.g., MSTP instances).

No Additional Items

Each item of this array must be:

Type: object

Type: integer

Instance number (for MSTP or multiple-instance support).

\ No newline at end of file diff --git a/docs/ucentral.capabilities.html b/docs/ucentral.capabilities.html index 1632430..71952c4 100644 --- a/docs/ucentral.capabilities.html +++ b/docs/ucentral.capabilities.html @@ -22,4 +22,4 @@

Type: object

Capabilities of the MC-LAG (Multi-Chassis Link Aggregation) feature in the switch

Type: integer

Defines the maximum number of MC-LAG groups that can be configured on the switch.

Type: integer

Specifies the maximum number of physical ports that can be part of a single MC-LAG group.

Type: integer

Indicates the maximum number of VLANs that can be supported within a single MC-LAG group.

Type: enum (of string)

Describes the dual-active detection mechanism to prevent both switches from becoming active simultaneously.

Must be one of:

  • "ICCP"
  • "Backup-Link"
  • "None"

Type: integer

Specifies the time (in milliseconds) required for traffic to fail over to the secondary switch when there is a failure in the primary switch.

Type: boolean

Indicates whether VLAN synchronization across MC-LAG peers is supported and the number of VLANs that can be synchronized.

Type: integer

Maximum number of MAC address entries that can be synchronized across MC-LAG peers.

Type: object

Description of LLDP capabilities across different switch models/vendors.

Type: array of enum (of string)
No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "lldp-basic-tlv-mgmt-ip-v4"
  • "lldp-basic-tlv-mgmt-ip-v6"
  • "lldp-basic-tlv-port-descr"
  • "lldp-basic-tlv-sys-capab"
  • "lldp-basic-tlv-sys-descr"
  • "lldp-basic-tlv-sys-name"
  • "lldp-dot1-tlv-proto-ident"
  • "lldp-dot1-tlv-proto-vid"
  • "lldp-dot1-tlv-pvid"
  • "lldp-dot1-tlv-vlan-name"
  • "lldp-dot3-tlv-link-agg"
  • "lldp-dot3-tlv-mac-phy"
  • "lldp-dot3-tlv-max-frame"
  • "lldp-dot3-tlv-poe"
  • "lldp-med-location-civic-addr"
  • "lldp-med-tlv-ext-poe"
  • "lldp-med-tlv-inventory"
  • "lldp-med-tlv-location"
  • "lldp-med-tlv-med-cap"
  • "lldp-med-tlv-network-policy"

Type: integer

Maximum number of LLDP neighbors a switch can discover and maintain.


Examples:

64
 
128
 
256
-

Type: array of enum (of string)

List of all features supported by the device

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "VLAN"
  • "VLAN-Voice"
  • "Jumbo-Frames"
  • "Link-Aggregation-LACP"
  • "Link-Aggregation-Static"
  • "Link-Aggregation-MCLAG"
  • "Port-Isolation"
  • "Spanning-Tree"
  • "Spanning-Tree-Rapid"
  • "Spanning-Tree-Per-VLAN"
  • "Spanning-Tree-Per-VLAN-Rapid"
  • "Spanning-Tree-MSTP"
  • "SVI-StaticIPv4"
  • "SVI-StaticIPv6"
  • "Interface-StaticIPv4"
  • "Interface-StaticIPv6"
  • "Routing-VRF"
  • "Routing-IPv4-Route-Blackhole"
  • "Routing-IPv4-Route-Unreachable"
  • "Routing-IPv4-Nexthop"
  • "Routing-IPv4-Broadcast"
  • "Routing-IPv4-Multicast-IGMP-Snooping"
  • "Routing-IPv4-Multicast-IGMP-Querier"
  • "Routing-IPv4-Multicast-IGMP-Static"
  • "Routing-IPv4-DHCP-Server"
  • "Routing-IPv4-DHCP-Relay"
  • "Routing-IPv4-DHCP-Snooping"
  • "Routing-IPv4-Port-Forward"
  • "Routing-IPv6-DHCP-Relay"
  • "Routing-IPv6-DHCP-Stateful"
  • "Routing-IPv6-DHCP-Stateless"
  • "Routing-IPv6-Port-Forward"
  • "Multicast-VLAN-Registration"
  • "PoE-Reset"
  • "Port-Access-Control"
  • "PAC-Dynamic-Auth"
  • "mac-address-bypass"
  • "System-PasswordChange"
  • "System-SwUpdate"
  • "System-SwUpdate-Partial"
  • "Port-Mirroring"
  • "MAC-ACL"
  • "IP-ACL"
  • "Guest-VLAN"
  • "Service-SSH"
  • "Service-RSSH"
  • "Service-Telnet"
  • "Service-LLDP"
  • "Service-HTTP"
  • "Service-HTTPS"
  • "Service-GPS"
  • "Service-IGMP"
  • "Service-NTP"
  • "Service-NTP-Client"
  • "Service-MDNS"
  • "Service-QoS"
  • "Service-Syslog"
  • "Service-PAC"
  • "Service-Wireguard-Overlay"
  • "Service-Radius-Proxy"
  • "Service-Online-Check"
  • "Service-CaptivePortal"
  • "Service-PublicIpCheck"
  • "Tunneling-VxLAN"
  • "Tunneling-GRE"
  • "Tunneling-GRE6"
  • "Tunneling-L2TP"
  • "Tunneling-Mesh"
\ No newline at end of file +

Type: array of enum (of string)

List of all features supported by the device

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "VLAN"
  • "VLAN-Voice"
  • "Jumbo-Frames"
  • "Link-Aggregation-LACP"
  • "Link-Aggregation-Static"
  • "Link-Aggregation-MCLAG"
  • "Port-Isolation"
  • "Spanning-Tree"
  • "Spanning-Tree-Rapid"
  • "Spanning-Tree-Per-VLAN"
  • "Spanning-Tree-Per-VLAN-Rapid"
  • "Spanning-Tree-MSTP"
  • "SVI-StaticIPv4"
  • "SVI-StaticIPv6"
  • "Interface-StaticIPv4"
  • "Interface-StaticIPv6"
  • "Routing-VRF"
  • "Routing-IPv4-Route-Blackhole"
  • "Routing-IPv4-Route-Unreachable"
  • "Routing-IPv4-Nexthop"
  • "Routing-IPv4-Broadcast"
  • "Routing-IPv4-Multicast-IGMP-Snooping"
  • "Routing-IPv4-Multicast-IGMP-Querier"
  • "Routing-IPv4-Multicast-IGMP-Static"
  • "Routing-IPv4-DHCP-Server"
  • "Routing-IPv4-DHCP-Relay"
  • "Routing-IPv4-DHCP-Snooping"
  • "Routing-IPv4-Port-Forward"
  • "Routing-IPv6-DHCP-Relay"
  • "Routing-IPv6-DHCP-Stateful"
  • "Routing-IPv6-DHCP-Stateless"
  • "Routing-IPv6-Port-Forward"
  • "Multicast-VLAN-Registration"
  • "PoE-Reset"
  • "Port-Access-Control"
  • "PAC-Dynamic-Auth"
  • "mac-address-bypass"
  • "System-PasswordChange"
  • "System-SwUpdate"
  • "System-SwUpdate-Partial"
  • "Port-Mirroring"
  • "MAC-ACL"
  • "IP-ACL"
  • "Guest-VLAN"
  • "Service-SSH"
  • "Service-RSSH"
  • "Service-Telnet"
  • "Service-LLDP"
  • "Service-HTTP"
  • "Service-HTTPS"
  • "Service-GPS"
  • "Service-IGMP"
  • "Service-NTP"
  • "Service-NTP-Client"
  • "Service-MDNS"
  • "Service-QoS"
  • "Service-Syslog"
  • "Service-PAC"
  • "Service-Wireguard-Overlay"
  • "Service-Radius-Proxy"
  • "Service-Online-Check"
  • "Service-CaptivePortal"
  • "Service-PublicIpCheck"
  • "Service-Global-DNS"
  • "Tunneling-VxLAN"
  • "Tunneling-GRE"
  • "Tunneling-GRE6"
  • "Tunneling-L2TP"
  • "Tunneling-Mesh"
\ No newline at end of file diff --git a/schema.json b/schema.json index 3dc04a2..67c36a5 100644 --- a/schema.json +++ b/schema.json @@ -1,5 +1,5 @@ { "major": 4, - "minor": 0, + "minor": 1, "patch": 0 }