Files
ols-ucentral-schema/state/unit.yml
Oleksandr Mazur e0d69521d5 MCLAG: extend schema and state with additional fields
Current MCLAG configuration schema looks fine
yet misses some crucial keepalive and session configuration.

Not only that, there's no real state being back-reported
to the Gateway in a state message, which might complicate
remote debugging of configuration applied on the switch itself.

Signed-off-by: Oleksandr Mazur <oleksandr.mazur@plvision.eu>
2025-12-05 15:00:42 +02:00

202 lines
7.4 KiB
YAML

type: object
description:
This section describes the current state of the OS running on the device.
properties:
load:
type: array
description:
This array hold 3 values describing the average system load for the last
1, 5 and 15 minutes.
items:
type: number
cpu_load:
type: array
description:
This array hold the total and per core load in percentage.
items:
type: number
localtime:
type: number
description:
This property contains the current unix time of the device.
memory:
type: object
description:
This section describes the current memory uasge of the device.
properties:
free:
type: number
description:
The amount of free memory.
total:
type: number
description:
The total amount of memory.
cached:
type: number
description:
The total amount of cached memory.
buffered:
type: number
description:
The total amount of buffered memory.
uptime:
type: number
description:
The number of seconds since the unit last booted.
temperature:
description:
The average and maximum thermal reading from the CPU.
type: array
items:
type: number
poe:
description:
This section describes the current state of the PoE unit on the device
type: object
properties:
max-power-budget:
description:
Reports the total power available (power budget) (in watts, W) device's Power sourcing equipment is able to source.
type: number
power-threshold:
description:
Reports configured power alarm threshold value for the Power sourcing equipment (in milliwatts, mW).
type: number
power-consumed:
description:
Reports a total power Powered Devices are draining from the device's Power sourcing equipment (in milliwatts, mW).
type: number
power-status:
description:
Reports power status of the device's Power sourcing equipment.
type: string
examples:
- "ON"
- "OFF"
ieee8021x:
description:
This section describes the global (device-wise) 802.1X (port access control) state and config applied.
type: object
properties:
dynamic-authorization:
description:
Reported DAS-related state info.
type: object
properties:
stats:
description:
Cumulative statistics for all configured DACs.
type: object
properties:
coa_req_received:
description:
Number of CoA requests received.
type: number
coa_ack_sent:
description:
Number of CoA ACK responses sent.
type: number
coa_nak_sent:
description:
Number of CoA NAK responses sent.
type: number
coa_ignored:
description:
Number of CoA requests ignored.
type: number
coa_wrong_attr:
description:
Number of CoA requests received with invalid (unsupported) attributes.
type: number
coa_wrong_attr_value:
description:
Number of CoA requests received with invalid (unsupported) attribute value.
type: number
coa_wrong_session_context:
description:
Number of CoA requests received with inexisting session context.
type: number
administratively_prohibited_req:
description:
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: number
mclag-state:
description:
This section describes the global (switch's device) state of the underlying state of MCLAG system.
type: object
properties:
domains:
description:
holds MCLAG domain state information, including domain ID, role, session status,
peer link status, number of interfaces, and interface statuses.
type: array
items:
type: object
properties:
mclag-domain:
description: Configured domain-id state
type: integer
minimum: 1
maximum: 1024
default: 1
role:
description:
Role of the domain (Configured switch's domain-id state)
Active means local switch posesses primary control responsibility
(handles control protocol exchanges on behalf of the pair and is the default source for any shared virtual MAC addresses if they aren't explicitly configured)
Standby means that local switch is the redundant switch that monitors the Active peer, maintains synchronized state information and is ready to take over full control plane responsibility if the Active peer fails.
type: string
enum:
- active
- standby
session-status:
description:
Logical status of the underlying MCLAG session between local switch and remote peer switch.
The 'up' value shows the underlying session is fully setup.
(peers can exchange keepalive messages - if configured, the synchronization is happening and the overall state of link is operational)
The 'down' value means the logical session's status is <down> - potentially, peers can't establish a connection between each other;
(either through a misconfiguration, a routing problem in the field, or due to keepalive messages not being received)
The 'unknown' value means the state cannot be determined (no ports configured, remote peer issues etc)
type: string
enum:
- up
- down
- unknown
peer-link-status:
description:
Operational state of the physical link(s) directly connecting the two Multi-Chassis Link Aggregation Group (MCLAG) peer switches.
type: string
enum:
- up
- down
- unknown
interface-num:
description: Number of MCLAG interfaces configured within current domain id.
type: integer
interfaces:
description: List of configured interfaces statuses (that are part of this domain id)
type: array
items:
type: object
properties:
port:
description: Port name / identifier.
type: string
examples:
- Ethernet1
local-status:
description: Represents local port's status.
type: string
enum:
- up
- down
- unknown
remote-status:
description: Represents remote peer's port status.
type: string
enum:
- up
- down
- unknown