mirror of
https://github.com/Telecominfraproject/ols-ucentral-schema.git
synced 2025-10-29 17:22:23 +00:00
Compare commits
23 Commits
OLS-556-Sp
...
v4.0.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
d8d4380977 | ||
|
|
c63ac1f5d9 | ||
|
|
37b9152b6e | ||
|
|
5db059b95b | ||
|
|
5a7f055793 | ||
|
|
2b7ce76453 | ||
|
|
d1ab8b453b | ||
|
|
e80a6d2166 | ||
|
|
6469510af1 | ||
|
|
d84e5ee624 | ||
|
|
029cdb4ed9 | ||
|
|
cd7d50997c | ||
|
|
f394cb4019 | ||
|
|
5e345b22a3 | ||
|
|
dcd935359c | ||
|
|
362e03a363 | ||
|
|
51c5b1b9f4 | ||
|
|
5d50740f98 | ||
|
|
01d4c80824 | ||
|
|
1d052a18c2 | ||
|
|
cb0069a356 | ||
|
|
59ad89be0f | ||
|
|
548b76a948 |
@@ -300,6 +300,7 @@ properties:
|
||||
- Service-Online-Check
|
||||
- Service-CaptivePortal
|
||||
- Service-PublicIpCheck
|
||||
- Service-Global-DNS
|
||||
# Tunneling
|
||||
- Tunneling-VxLAN
|
||||
- Tunneling-GRE
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"major": 3,
|
||||
"minor": 2,
|
||||
"patch": 7
|
||||
"major": 4,
|
||||
"minor": 1,
|
||||
"patch": 0
|
||||
}
|
||||
|
||||
@@ -368,6 +368,32 @@ properties:
|
||||
type: boolean
|
||||
description: Enables the transmission of SNMP trap notifications about LLDP changes.
|
||||
default: false
|
||||
ip-arp-inspect-port:
|
||||
type: object
|
||||
description: Configuration for ARP Inspection on specific interfaces or ports in the switch.
|
||||
properties:
|
||||
rate-limit-pps:
|
||||
type: integer
|
||||
description: Sets a rate limit (packets per second) for the ARP packets received on a port. Ensures that the port does not process ARP packets beyond the configured limit.
|
||||
minimum: 0
|
||||
maximum: 65535
|
||||
trusted:
|
||||
type: boolean
|
||||
description: Configures the port as trusted, exempting it from ARP Inspection. Trusted ports bypass ARP validation checks.
|
||||
rate-limit-port:
|
||||
type: object
|
||||
description: Configuration for ingress and egress rate limiting on a specific port (in kbps)
|
||||
properties:
|
||||
ingress-kbps:
|
||||
type: integer
|
||||
description: Sets the maximum allowed ingress (input) traffic rate for the port, in kilobits per second (kbps).
|
||||
minimum: 64
|
||||
maximum: 1000000000
|
||||
egress-kbps:
|
||||
type: integer
|
||||
description: Sets the maximum allowed egress (output) traffic rate for the port, in kilobits per second (kbps).
|
||||
minimum: 64
|
||||
maximum: 1000000000
|
||||
ip-source-guard-port:
|
||||
type: object
|
||||
description: Configuration of IP Source Guard (IPSG) on a physical interface in a Layer 2 switch.
|
||||
|
||||
14
schema/interface.ipv4.arp-inspect.yml
Normal file
14
schema/interface.ipv4.arp-inspect.yml
Normal file
@@ -0,0 +1,14 @@
|
||||
type: object
|
||||
description: Configuration for ARP Inspection on specific VLANs in the switch.
|
||||
properties:
|
||||
vlan-enable:
|
||||
type: boolean
|
||||
description: Enable or disable ARP Inspection for a specified VLAN.
|
||||
vlan-acl-rule:
|
||||
type: string
|
||||
description: Specifies an ARP ACL to apply to one or more VLANs.
|
||||
maxLength: 32
|
||||
minLength: 1
|
||||
vlan-acl-nodhcp-bindings:
|
||||
type: boolean
|
||||
description: Validate ARP packets against only the specified ACL without checking address bindings in the DHCP snooping database.
|
||||
@@ -200,6 +200,8 @@ properties:
|
||||
description: "Enables DHCP Snooping on a VLAN"
|
||||
type: boolean
|
||||
default: false
|
||||
ip-arp-inspect-vlan:
|
||||
$ref: "https://ucentral.io/schema/v1/interface/ipv4/arp-inspect/"
|
||||
dhcp:
|
||||
$ref: "https://ucentral.io/schema/v1/interface/ipv4/dhcp/"
|
||||
dhcp-leases:
|
||||
|
||||
@@ -8,7 +8,15 @@ properties:
|
||||
The individual physical network devices contained within the interface
|
||||
need to be told explicitly if egress traffic shall be tagged.
|
||||
type: integer
|
||||
maximum: 4050
|
||||
maximum: 4094
|
||||
range-start:
|
||||
decription: Start vlan-id of the specified range
|
||||
type: integer
|
||||
maximum: 4094
|
||||
range-end:
|
||||
decription: End vlan-id of the specified range
|
||||
type: integer
|
||||
maximum: 4094
|
||||
proto:
|
||||
decription:
|
||||
The L2 vlan tag that shall be added (1q,1ad)
|
||||
|
||||
19
schema/switch.arp-inspect.yml
Normal file
19
schema/switch.arp-inspect.yml
Normal file
@@ -0,0 +1,19 @@
|
||||
type: object
|
||||
description: Global configuration for ARP Inspection on the switch.
|
||||
properties:
|
||||
ip-arp-inspect:
|
||||
type: boolean
|
||||
description: Enable or disable ARP Inspection globally.
|
||||
default: false
|
||||
validate-dst-mac:
|
||||
type: boolean
|
||||
description: Validate that the destination MAC address in the Ethernet header matches the target MAC address in the ARP body for ARP responses.
|
||||
validate-ip:
|
||||
type: boolean
|
||||
description: Validate ARP packets for unexpected or invalid IP addresses, such as 0.0.0.0, 255.255.255.255, and IP multicast addresses.
|
||||
validate-allow-zeros:
|
||||
type: boolean
|
||||
description: Allow ARP packets where the sender IP address is 0.0.0.0.
|
||||
validate-src-mac:
|
||||
type: boolean
|
||||
description: 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.
|
||||
@@ -537,9 +537,16 @@ properties:
|
||||
minLength: 1
|
||||
examples:
|
||||
- "A VoIP Phone"
|
||||
arp-inspect:
|
||||
$ref: "https://ucentral.io/schema/v1/switch/arp-inspect/"
|
||||
ip-source-guard:
|
||||
$ref: "https://ucentral.io/schema/v1/switch/ip-source-guard/"
|
||||
rt-events:
|
||||
$ref: "https://ucentral.io/schema/v1/switch/rtevent/"
|
||||
acl:
|
||||
$ref: "https://ucentral.io/schema/v1/switch/acl/"
|
||||
dns:
|
||||
description: Define a global list of dns servers.
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
|
||||
@@ -15,8 +15,11 @@ items:
|
||||
name:
|
||||
type: string
|
||||
description:
|
||||
The administrative name of this logical interface. This field is
|
||||
freetext
|
||||
The administrative name of this logical interface. This field is freetext
|
||||
vlan_id:
|
||||
description: VLAN-ID of the logical interface
|
||||
type: integer
|
||||
maximum: 4094
|
||||
ntp_server:
|
||||
type: string
|
||||
description:
|
||||
|
||||
@@ -191,3 +191,75 @@ properties:
|
||||
description:
|
||||
Max power (in Watts) module can drain.
|
||||
type: number
|
||||
loop-detect-protocol:
|
||||
description: Status and protocol information for loop detection or prevention mechanisms
|
||||
active on this interface. Includes STP/xSTP/MSTP, Loopback Detection (LBD), etc.
|
||||
type: object
|
||||
properties:
|
||||
stp:
|
||||
description: Spanning Tree Protocol (IEEE 802.1D/RSTP/MSTP) state on the port.
|
||||
type: object
|
||||
properties:
|
||||
protocol:
|
||||
type: string
|
||||
description: Variant of STP running (e.g., STP, RSTP, MSTP, RPVST+).
|
||||
examples:
|
||||
- RSTP
|
||||
- MSTP
|
||||
state:
|
||||
type: string
|
||||
description: STP state of the port.
|
||||
enum:
|
||||
- disabled
|
||||
- blocking
|
||||
- listening
|
||||
- learning
|
||||
- forwarding
|
||||
role:
|
||||
type: string
|
||||
description: Role of the port in STP topology.
|
||||
enum:
|
||||
- root
|
||||
- designated
|
||||
- alternate
|
||||
- backup
|
||||
- disabled
|
||||
bridge-id:
|
||||
type: string
|
||||
description: STP Bridge ID
|
||||
root-bridge-id:
|
||||
type: string
|
||||
description: STP Root Bridge ID for the instance.
|
||||
oper-edge-port:
|
||||
type: boolean
|
||||
description: Whether the port is operating as an edge port (no BPDU expected).
|
||||
cost:
|
||||
type: integer
|
||||
description: Operational path cost of the port.
|
||||
designated-cost:
|
||||
type: integer
|
||||
description: Cost advertised by the designated port.
|
||||
transitions:
|
||||
type: integer
|
||||
description: Number of STP state transitions (forwarding/discarding) on this port.
|
||||
lbd:
|
||||
description: Loopback Detection (LBD) status on this port.
|
||||
type: object
|
||||
properties:
|
||||
enabled:
|
||||
type: boolean
|
||||
description: Whether LBD is enabled on this port.
|
||||
state:
|
||||
type: string
|
||||
description: Current loop detection status.
|
||||
enum:
|
||||
- no_loop
|
||||
- loop_detected
|
||||
- disabled
|
||||
action:
|
||||
type: string
|
||||
description: Action taken when loop is detected (e.g., block, shutdown).
|
||||
enum:
|
||||
- none
|
||||
- block
|
||||
- shutdown
|
||||
104
state/state.yml
104
state/state.yml
@@ -60,6 +60,34 @@ properties:
|
||||
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.
|
||||
@@ -85,4 +113,78 @@ properties:
|
||||
maximum: 4095
|
||||
blocked-interface:
|
||||
type: string
|
||||
description: The interface (e.g., port) where the blocked entry was detected.
|
||||
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.
|
||||
@@ -361,6 +361,7 @@
|
||||
"Service-Online-Check",
|
||||
"Service-CaptivePortal",
|
||||
"Service-PublicIpCheck",
|
||||
"Service-Global-DNS",
|
||||
"Tunneling-VxLAN",
|
||||
"Tunneling-GRE",
|
||||
"Tunneling-GRE6",
|
||||
|
||||
@@ -589,6 +589,40 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"ip-arp-inspect-port": {
|
||||
"type": "object",
|
||||
"description": "Configuration for ARP Inspection on specific interfaces or ports in the switch.",
|
||||
"properties": {
|
||||
"rate-limit-pps": {
|
||||
"type": "integer",
|
||||
"description": "Sets a rate limit (packets per second) for the ARP packets received on a port. Ensures that the port does not process ARP packets beyond the configured limit.",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"trusted": {
|
||||
"type": "boolean",
|
||||
"description": "Configures the port as trusted, exempting it from ARP Inspection. Trusted ports bypass ARP validation checks."
|
||||
}
|
||||
}
|
||||
},
|
||||
"rate-limit-port": {
|
||||
"type": "object",
|
||||
"description": "Configuration for ingress and egress rate limiting on a specific port (in kbps)",
|
||||
"properties": {
|
||||
"ingress-kbps": {
|
||||
"type": "integer",
|
||||
"description": "Sets the maximum allowed ingress (input) traffic rate for the port, in kilobits per second (kbps).",
|
||||
"minimum": 64,
|
||||
"maximum": 1000000000
|
||||
},
|
||||
"egress-kbps": {
|
||||
"type": "integer",
|
||||
"description": "Sets the maximum allowed egress (output) traffic rate for the port, in kilobits per second (kbps).",
|
||||
"minimum": 64,
|
||||
"maximum": 1000000000
|
||||
}
|
||||
}
|
||||
},
|
||||
"ip-source-guard-port": {
|
||||
"type": "object",
|
||||
"description": "Configuration of IP Source Guard (IPSG) on a physical interface in a Layer 2 switch.",
|
||||
@@ -1345,6 +1379,33 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"arp-inspect": {
|
||||
"type": "object",
|
||||
"description": "Global configuration for ARP Inspection on the switch.",
|
||||
"properties": {
|
||||
"ip-arp-inspect": {
|
||||
"type": "boolean",
|
||||
"description": "Enable or disable ARP Inspection globally.",
|
||||
"default": false
|
||||
},
|
||||
"validate-dst-mac": {
|
||||
"type": "boolean",
|
||||
"description": "Validate that the destination MAC address in the Ethernet header matches the target MAC address in the ARP body for ARP responses."
|
||||
},
|
||||
"validate-ip": {
|
||||
"type": "boolean",
|
||||
"description": "Validate ARP packets for unexpected or invalid IP addresses, such as 0.0.0.0, 255.255.255.255, and IP multicast addresses."
|
||||
},
|
||||
"validate-allow-zeros": {
|
||||
"type": "boolean",
|
||||
"description": "Allow ARP packets where the sender IP address is 0.0.0.0."
|
||||
},
|
||||
"validate-src-mac": {
|
||||
"type": "boolean",
|
||||
"description": "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."
|
||||
}
|
||||
}
|
||||
},
|
||||
"ip-source-guard": {
|
||||
"type": "object",
|
||||
"description": "Configuration for IP Source Guard global static bindings in a Layer 2 switch.",
|
||||
@@ -1742,6 +1803,13 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"dns": {
|
||||
"description": "Define a global list of dns servers.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1812,7 +1880,17 @@
|
||||
"id": {
|
||||
"description": "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.",
|
||||
"type": "integer",
|
||||
"maximum": 4050
|
||||
"maximum": 4094
|
||||
},
|
||||
"range-start": {
|
||||
"decription": "Start vlan-id of the specified range",
|
||||
"type": "integer",
|
||||
"maximum": 4094
|
||||
},
|
||||
"range-end": {
|
||||
"decription": "End vlan-id of the specified range",
|
||||
"type": "integer",
|
||||
"maximum": 4094
|
||||
},
|
||||
"proto": {
|
||||
"decription": "The L2 vlan tag that shall be added (1q,1ad)",
|
||||
@@ -2150,6 +2228,26 @@
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
},
|
||||
"ip-arp-inspect-vlan": {
|
||||
"type": "object",
|
||||
"description": "Configuration for ARP Inspection on specific VLANs in the switch.",
|
||||
"properties": {
|
||||
"vlan-enable": {
|
||||
"type": "boolean",
|
||||
"description": "Enable or disable ARP Inspection for a specified VLAN."
|
||||
},
|
||||
"vlan-acl-rule": {
|
||||
"type": "string",
|
||||
"description": "Specifies an ARP ACL to apply to one or more VLANs.",
|
||||
"maxLength": 32,
|
||||
"minLength": 1
|
||||
},
|
||||
"vlan-acl-nodhcp-bindings": {
|
||||
"type": "boolean",
|
||||
"description": "Validate ARP packets against only the specified ACL without checking address bindings in the DHCP snooping database."
|
||||
}
|
||||
}
|
||||
},
|
||||
"dhcp": {
|
||||
"description": "This section describes the DHCP server configuration",
|
||||
"type": "object",
|
||||
|
||||
@@ -529,6 +529,34 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"ip-arp-inspect-port": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"rate-limit-pps": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"trusted": {
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
},
|
||||
"rate-limit-port": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"ingress-kbps": {
|
||||
"type": "integer",
|
||||
"minimum": 64,
|
||||
"maximum": 1000000000
|
||||
},
|
||||
"egress-kbps": {
|
||||
"type": "integer",
|
||||
"minimum": 64,
|
||||
"maximum": 1000000000
|
||||
}
|
||||
}
|
||||
},
|
||||
"ip-source-guard-port": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -643,6 +671,27 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"switch.arp-inspect": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"ip-arp-inspect": {
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
},
|
||||
"validate-dst-mac": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"validate-ip": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"validate-allow-zeros": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"validate-src-mac": {
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
},
|
||||
"switch.ip-source-guard": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -1504,6 +1553,9 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"arp-inspect": {
|
||||
"$ref": "#/$defs/switch.arp-inspect"
|
||||
},
|
||||
"ip-source-guard": {
|
||||
"$ref": "#/$defs/switch.ip-source-guard"
|
||||
},
|
||||
@@ -1512,6 +1564,12 @@
|
||||
},
|
||||
"acl": {
|
||||
"$ref": "#/$defs/switch.acl"
|
||||
},
|
||||
"dns": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1520,7 +1578,17 @@
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"maximum": 4050
|
||||
"maximum": 4094
|
||||
},
|
||||
"range-start": {
|
||||
"decription": "Start vlan-id of the specified range",
|
||||
"type": "integer",
|
||||
"maximum": 4094
|
||||
},
|
||||
"range-end": {
|
||||
"decription": "End vlan-id of the specified range",
|
||||
"type": "integer",
|
||||
"maximum": 4094
|
||||
},
|
||||
"proto": {
|
||||
"decription": "The L2 vlan tag that shall be added (1q,1ad)",
|
||||
@@ -1609,6 +1677,22 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"interface.ipv4.arp-inspect": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"vlan-enable": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"vlan-acl-rule": {
|
||||
"type": "string",
|
||||
"maxLength": 32,
|
||||
"minLength": 1
|
||||
},
|
||||
"vlan-acl-nodhcp-bindings": {
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
},
|
||||
"interface.ipv4.dhcp": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -1913,6 +1997,9 @@
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
},
|
||||
"ip-arp-inspect-vlan": {
|
||||
"$ref": "#/$defs/interface.ipv4.arp-inspect"
|
||||
},
|
||||
"dhcp": {
|
||||
"$ref": "#/$defs/interface.ipv4.dhcp"
|
||||
},
|
||||
|
||||
@@ -623,6 +623,40 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"ip-arp-inspect-port": {
|
||||
"type": "object",
|
||||
"description": "Configuration for ARP Inspection on specific interfaces or ports in the switch.",
|
||||
"properties": {
|
||||
"rate-limit-pps": {
|
||||
"type": "integer",
|
||||
"description": "Sets a rate limit (packets per second) for the ARP packets received on a port. Ensures that the port does not process ARP packets beyond the configured limit.",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"trusted": {
|
||||
"type": "boolean",
|
||||
"description": "Configures the port as trusted, exempting it from ARP Inspection. Trusted ports bypass ARP validation checks."
|
||||
}
|
||||
}
|
||||
},
|
||||
"rate-limit-port": {
|
||||
"type": "object",
|
||||
"description": "Configuration for ingress and egress rate limiting on a specific port (in kbps)",
|
||||
"properties": {
|
||||
"ingress-kbps": {
|
||||
"type": "integer",
|
||||
"description": "Sets the maximum allowed ingress (input) traffic rate for the port, in kilobits per second (kbps).",
|
||||
"minimum": 64,
|
||||
"maximum": 1000000000
|
||||
},
|
||||
"egress-kbps": {
|
||||
"type": "integer",
|
||||
"description": "Sets the maximum allowed egress (output) traffic rate for the port, in kilobits per second (kbps).",
|
||||
"minimum": 64,
|
||||
"maximum": 1000000000
|
||||
}
|
||||
}
|
||||
},
|
||||
"ip-source-guard-port": {
|
||||
"type": "object",
|
||||
"description": "Configuration of IP Source Guard (IPSG) on a physical interface in a Layer 2 switch.",
|
||||
@@ -756,6 +790,33 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"switch.arp-inspect": {
|
||||
"type": "object",
|
||||
"description": "Global configuration for ARP Inspection on the switch.",
|
||||
"properties": {
|
||||
"ip-arp-inspect": {
|
||||
"type": "boolean",
|
||||
"description": "Enable or disable ARP Inspection globally.",
|
||||
"default": false
|
||||
},
|
||||
"validate-dst-mac": {
|
||||
"type": "boolean",
|
||||
"description": "Validate that the destination MAC address in the Ethernet header matches the target MAC address in the ARP body for ARP responses."
|
||||
},
|
||||
"validate-ip": {
|
||||
"type": "boolean",
|
||||
"description": "Validate ARP packets for unexpected or invalid IP addresses, such as 0.0.0.0, 255.255.255.255, and IP multicast addresses."
|
||||
},
|
||||
"validate-allow-zeros": {
|
||||
"type": "boolean",
|
||||
"description": "Allow ARP packets where the sender IP address is 0.0.0.0."
|
||||
},
|
||||
"validate-src-mac": {
|
||||
"type": "boolean",
|
||||
"description": "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."
|
||||
}
|
||||
}
|
||||
},
|
||||
"switch.ip-source-guard": {
|
||||
"type": "object",
|
||||
"description": "Configuration for IP Source Guard global static bindings in a Layer 2 switch.",
|
||||
@@ -1776,6 +1837,9 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"arp-inspect": {
|
||||
"$ref": "#/$defs/switch.arp-inspect"
|
||||
},
|
||||
"ip-source-guard": {
|
||||
"$ref": "#/$defs/switch.ip-source-guard"
|
||||
},
|
||||
@@ -1784,6 +1848,13 @@
|
||||
},
|
||||
"acl": {
|
||||
"$ref": "#/$defs/switch.acl"
|
||||
},
|
||||
"dns": {
|
||||
"description": "Define a global list of dns servers.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1794,7 +1865,17 @@
|
||||
"id": {
|
||||
"description": "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.",
|
||||
"type": "integer",
|
||||
"maximum": 4050
|
||||
"maximum": 4094
|
||||
},
|
||||
"range-start": {
|
||||
"decription": "Start vlan-id of the specified range",
|
||||
"type": "integer",
|
||||
"maximum": 4094
|
||||
},
|
||||
"range-end": {
|
||||
"decription": "End vlan-id of the specified range",
|
||||
"type": "integer",
|
||||
"maximum": 4094
|
||||
},
|
||||
"proto": {
|
||||
"decription": "The L2 vlan tag that shall be added (1q,1ad)",
|
||||
@@ -1895,6 +1976,26 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"interface.ipv4.arp-inspect": {
|
||||
"type": "object",
|
||||
"description": "Configuration for ARP Inspection on specific VLANs in the switch.",
|
||||
"properties": {
|
||||
"vlan-enable": {
|
||||
"type": "boolean",
|
||||
"description": "Enable or disable ARP Inspection for a specified VLAN."
|
||||
},
|
||||
"vlan-acl-rule": {
|
||||
"type": "string",
|
||||
"description": "Specifies an ARP ACL to apply to one or more VLANs.",
|
||||
"maxLength": 32,
|
||||
"minLength": 1
|
||||
},
|
||||
"vlan-acl-nodhcp-bindings": {
|
||||
"type": "boolean",
|
||||
"description": "Validate ARP packets against only the specified ACL without checking address bindings in the DHCP snooping database."
|
||||
}
|
||||
}
|
||||
},
|
||||
"interface.ipv4.dhcp": {
|
||||
"description": "This section describes the DHCP server configuration",
|
||||
"type": "object",
|
||||
@@ -2246,6 +2347,9 @@
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
},
|
||||
"ip-arp-inspect-vlan": {
|
||||
"$ref": "#/$defs/interface.ipv4.arp-inspect"
|
||||
},
|
||||
"dhcp": {
|
||||
"$ref": "#/$defs/interface.ipv4.dhcp"
|
||||
},
|
||||
|
||||
@@ -86,6 +86,44 @@
|
||||
"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.",
|
||||
@@ -120,6 +158,104 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"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": [
|
||||
"\u00cbthernet1"
|
||||
]
|
||||
},
|
||||
"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."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"$defs": {
|
||||
@@ -486,6 +622,11 @@
|
||||
"type": "string",
|
||||
"description": "The administrative name of this logical interface. This field is freetext"
|
||||
},
|
||||
"vlan_id": {
|
||||
"description": "VLAN-ID of the logical interface",
|
||||
"type": "integer",
|
||||
"maximum": 4094
|
||||
},
|
||||
"ntp_server": {
|
||||
"type": "string",
|
||||
"description": "The upstream NTP server being used by this interface."
|
||||
@@ -1116,6 +1257,100 @@
|
||||
"type": "number"
|
||||
}
|
||||
}
|
||||
},
|
||||
"loop-detect-protocol": {
|
||||
"description": "Status and protocol information for loop detection or prevention mechanisms active on this interface. Includes STP/xSTP/MSTP, Loopback Detection (LBD), etc.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"stp": {
|
||||
"description": "Spanning Tree Protocol (IEEE 802.1D/RSTP/MSTP) state on the port.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"protocol": {
|
||||
"type": "string",
|
||||
"description": "Variant of STP running (e.g., STP, RSTP, MSTP, RPVST+).",
|
||||
"examples": [
|
||||
"RSTP",
|
||||
"MSTP"
|
||||
]
|
||||
},
|
||||
"state": {
|
||||
"type": "string",
|
||||
"description": "STP state of the port.",
|
||||
"enum": [
|
||||
"disabled",
|
||||
"blocking",
|
||||
"listening",
|
||||
"learning",
|
||||
"forwarding"
|
||||
]
|
||||
},
|
||||
"role": {
|
||||
"type": "string",
|
||||
"description": "Role of the port in STP topology.",
|
||||
"enum": [
|
||||
"root",
|
||||
"designated",
|
||||
"alternate",
|
||||
"backup",
|
||||
"disabled"
|
||||
]
|
||||
},
|
||||
"bridge-id": {
|
||||
"type": "string",
|
||||
"description": "STP Bridge ID"
|
||||
},
|
||||
"root-bridge-id": {
|
||||
"type": "string",
|
||||
"description": "STP Root Bridge ID for the instance."
|
||||
},
|
||||
"oper-edge-port": {
|
||||
"type": "boolean",
|
||||
"description": "Whether the port is operating as an edge port (no BPDU expected)."
|
||||
},
|
||||
"cost": {
|
||||
"type": "integer",
|
||||
"description": "Operational path cost of the port."
|
||||
},
|
||||
"designated-cost": {
|
||||
"type": "integer",
|
||||
"description": "Cost advertised by the designated port."
|
||||
},
|
||||
"transitions": {
|
||||
"type": "integer",
|
||||
"description": "Number of STP state transitions (forwarding/discarding) on this port."
|
||||
}
|
||||
}
|
||||
},
|
||||
"lbd": {
|
||||
"description": "Loopback Detection (LBD) status on this port.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean",
|
||||
"description": "Whether LBD is enabled on this port."
|
||||
},
|
||||
"state": {
|
||||
"type": "string",
|
||||
"description": "Current loop detection status.",
|
||||
"enum": [
|
||||
"no_loop",
|
||||
"loop_detected",
|
||||
"disabled"
|
||||
]
|
||||
},
|
||||
"action": {
|
||||
"type": "string",
|
||||
"description": "Action taken when loop is detected (e.g., block, shutdown).",
|
||||
"enum": [
|
||||
"none",
|
||||
"block",
|
||||
"shutdown"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user