mirror of
https://github.com/Telecominfraproject/ols-ucentral-schema.git
synced 2025-10-29 09:12:20 +00:00
190 lines
6.6 KiB
YAML
190 lines
6.6 KiB
YAML
$id: https://openwrt.org/ucentral.state.json
|
|
$schema: http://json-schema.org/draft-07/schema#
|
|
description: OpenWrt uCentral state schema
|
|
type: object
|
|
properties:
|
|
version:
|
|
type: number
|
|
const: 1
|
|
uuid:
|
|
description:
|
|
The unique ID of the configuration. This is the unix timestamp of when the config was created.
|
|
type: integer
|
|
serial:
|
|
description:
|
|
The unique serial number of the device.
|
|
type: string
|
|
unit:
|
|
$ref: "https://ucentral.io/state/v1/unit/"
|
|
gps:
|
|
$ref: "https://ucentral.io/state/v1/gps/"
|
|
interfaces:
|
|
$ref: "https://ucentral.io/state/v1/interface/"
|
|
lldp-peers:
|
|
type: object
|
|
properties:
|
|
upstream:
|
|
type: object
|
|
patternProperties:
|
|
"^(eth|lan|wan)[0-9]*$":
|
|
$ref: "https://ucentral.io/state/v1/lldp-peers/"
|
|
downstream:
|
|
type: object
|
|
patternProperties:
|
|
"^(eth|lan|wan)[0-9]*$":
|
|
$ref: "https://ucentral.io/state/v1/lldp-peers/"
|
|
dynamic_vlans:
|
|
type: array
|
|
items:
|
|
$ref: "https://ucentral.io/state/v1/dynamic-vlan/"
|
|
link-state:
|
|
type: object
|
|
properties:
|
|
upstream:
|
|
type: object
|
|
patternProperties:
|
|
"^(eth|lan|wan)[0-9]*$":
|
|
$ref: "https://ucentral.io/state/v1/link-state/"
|
|
downstream:
|
|
type: object
|
|
patternProperties:
|
|
"^(eth|lan|wan)[0-9]*$":
|
|
$ref: "https://ucentral.io/state/v1/link-state/"
|
|
mac-address-list:
|
|
$ref: "https://ucentral.io/state/v1/mac-address-list/"
|
|
static-trunks:
|
|
$ref: "https://ucentral.io/state/v1/static-trunks/"
|
|
lacp-trunks:
|
|
$ref: "https://ucentral.io/state/v1/lacp-trunks/"
|
|
uplink_interface:
|
|
type: string
|
|
description:
|
|
Current interface that serves as the Uplink. Example Ethernet2.
|
|
arp-inspect-stats:
|
|
type: object
|
|
description: Statistics related to ARP Inspection activity in the switch.
|
|
properties:
|
|
arp-pkt-rcvd:
|
|
type: integer
|
|
description: Total number of ARP packets received.
|
|
arp-pkt-dropped-rate-limit:
|
|
type: integer
|
|
description: Number of ARP packets dropped due to rate limiting.
|
|
arp-pkt-processed:
|
|
type: integer
|
|
description: Total number of ARP packets processed by ARP Inspection.
|
|
arp-pkt-dropped-src-mac:
|
|
type: integer
|
|
description: Number of ARP packets dropped due to source MAC address validation failures.
|
|
arp-pkt-dropped-dst-mac:
|
|
type: integer
|
|
description: Number of ARP packets dropped due to destination MAC address validation failures.
|
|
arp-pkt-dropped-ip:
|
|
type: integer
|
|
description: Number of ARP packets dropped due to IP address validation failures."
|
|
arp-pkt-dropped-acl:
|
|
type: integer
|
|
description: Number of ARP packets dropped due to ARP ACL rules.
|
|
arp-pkt-dropped-dhcp:
|
|
type: integer
|
|
description: Number of ARP packets dropped due to DHCP snooping validation failures.
|
|
ip-source-guard:
|
|
type: object
|
|
description: Represents the configuration and state of IP Source Guard.
|
|
properties:
|
|
blocked-entries:
|
|
type: array
|
|
description: Displays a list of entries that are currently blocked by IP Source Guard (IPSG).
|
|
items:
|
|
type: object
|
|
properties:
|
|
blocked-mac:
|
|
type: string
|
|
description: The MAC address that has been blocked by IP Source Guard.
|
|
format: "mac-address"
|
|
blocked-ip:
|
|
type: string
|
|
description: The IP address that has been blocked by IP Source Guard.
|
|
format: "ipv4"
|
|
blocked-vlan:
|
|
type: integer
|
|
description: The VLAN ID associated with the blocked IP/MAC entry.
|
|
minimum: 1
|
|
maximum: 4095
|
|
blocked-interface:
|
|
type: string
|
|
description: The interface (e.g., port) where the blocked entry was detected.
|
|
stp:
|
|
description: 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: object
|
|
properties:
|
|
enabled:
|
|
type: boolean
|
|
description: Whether STP is enabled globally on the switch.
|
|
mode:
|
|
type: string
|
|
description: Operational STP mode used across the switch.
|
|
enum:
|
|
- stp
|
|
- rstp
|
|
- mstp
|
|
- pvst
|
|
- rpvstp
|
|
transmission-limit:
|
|
type: integer
|
|
description: Maximum number of BPDUs that can be transmitted per hello time.
|
|
path-cost-method:
|
|
type: string
|
|
description: Indicates whether "Short" or "Long" path cost method is in use.
|
|
enum:
|
|
- short
|
|
- long
|
|
max-hops:
|
|
type: integer
|
|
description: Maximum hop count used in MSTP.
|
|
instances:
|
|
type: array
|
|
description: List of STP instances (e.g., MSTP instances).
|
|
items:
|
|
type: object
|
|
properties:
|
|
instance-id:
|
|
type: integer
|
|
description: Instance number (for MSTP or multiple-instance support).
|
|
vlans:
|
|
type: string
|
|
description: VLAN ranges associated with the STP instance.
|
|
example: "1-4094"
|
|
bridge-priority:
|
|
type: integer
|
|
description: Bridge priority value for STP election.
|
|
bridge-hello-time:
|
|
type: integer
|
|
description: Hello Time interval (in seconds) configured on the bridge.
|
|
bridge-max-age:
|
|
type: integer
|
|
description: Max Age value (in seconds) used for aging STP information.
|
|
bridge-forward-delay:
|
|
type: integer
|
|
description: Delay (in seconds) before transitioning port to forwarding state.
|
|
remaining-hops:
|
|
type: integer
|
|
description: Remaining hop count from the Root Bridge to this bridge.
|
|
root-bridge-id:
|
|
type: string
|
|
description: Bridge ID of the current Root Bridge.
|
|
root-port:
|
|
type: string
|
|
description: Local interface acting as Root Port.
|
|
example:
|
|
- Ëthernet1
|
|
root-cost:
|
|
type: integer
|
|
description: Cumulative cost to reach the Root Bridge.
|
|
topology-changes:
|
|
type: integer
|
|
description: Total number of topology changes detected.
|
|
last-topology-change-seconds:
|
|
type: integer
|
|
description: Time (in seconds) since the last topology change. |