Compare commits

...

16 Commits

Author SHA1 Message Date
Binny
00403aa20a add 40g,50g, 200g port speeds 2024-12-27 18:17:03 +00:00
Olexandr, Mazur
3faa3421d3 Merge pull request #27 from Telecominfraproject/OLS-425_sprint6_schema
OLS-425 Sprint-6-Schema
2024-11-18 17:29:40 +02:00
Binny
7bffbb1cc9 OLS-425: second review comments 2024-11-18 14:44:13 +00:00
Binny
e96efa25ae OLS-425 second commit with review comments incorporated. 2024-11-12 19:40:43 +00:00
Binny
5622b66bb8 OLS-425 Sprint-6-Schema 2024-10-30 05:31:54 +00:00
Mike Hansen
5bc20c20b3 Merge pull request #26 from Telecominfraproject/OLS_390_Move_uplink_interface_definition_to_state.yml_Add_version_connect.capabilities
[OLS-390] Move uplink_interface definition to state.yml, add version …
2024-10-07 09:47:59 -04:00
Mike Hansen
9a7f469e61 [OLS-390] Move uplink_interface definition to state.yml, add version to connect.capabilities
Signed-off-by: Mike Hansen <mike.hansen@netexperience.com>
2024-10-04 12:00:20 -04:00
Binny
a8d8de9b4d Merge pull request #25 from Telecominfraproject/OLS_319_sprint4_schema
OLS-319 sprint4 schema
2024-09-23 21:28:22 +05:30
Binny
53c239b60d OLS-319 incorporated most review comments, revised files 2024-09-23 07:47:42 +00:00
Binny
9a994374b5 OLS-319 Schema changes for 3.2 Sprint-4 Features to private Branch - Edits 2024-09-19 16:54:23 +00:00
Binny
44ed03b3f7 OLS-319 Schema changes for 3.2 Sprint-4 Features to private Branch 2024-09-19 16:51:30 +00:00
Binny
a72be45c21 OLS-319 test commit schema to priv repo 2024-09-19 09:27:16 +00:00
Mike Hansen
7c62326155 change port mirror type to array
-- rebased and merge changes from https://github.com/Telecominfraproject/ols-ucentral-schema/pull/23 into main

Signed-off-by: Mike Hansen <mike.hansen@netexperience.com>
2024-09-09 10:08:22 -04:00
Mike Hansen
5291c3da99 Merge pull request #24 from Telecominfraproject/OLS-295_capabilities_add_lacp_linkAggregation_jumboFrames
[OLS-295] Add LACP, Link-Aggregation, and Jumbo-Frames to capabilities
2024-09-06 09:17:10 -04:00
Mike Hansen
1b12452eeb [OLS-295] Add LACP, Link-Aggregation, and Jumbo-Frames to capabilities
In ols-ucentral-schema->capabilities->connect.capabilities.yml->supported-features
Added enums for
  - Jumbo-Frames
  - LACP
  - Link-Aggregation

Regenerated json files.

Signed-off-by: Mike Hansen <mike.hansen@netexperience.com>
2024-09-04 14:50:31 -04:00
Mike Hansen
76504b1ad6 Merge pull request #20 from Telecominfraproject/link_aggregation
support link aggregation
2024-08-13 09:19:28 -04:00
15 changed files with 4066 additions and 42 deletions

View File

@@ -12,6 +12,21 @@ properties:
Platform revision
examples:
- Rel 1.6 build 5
version:
type: object
description:
The ols schema version to be used with this Switch
properties:
major:
type: integer
minor:
type: integer
patch:
type: integer
examples:
- 'major': 3
'minor': 2
'patch': 0
platform:
type: string
enum:
@@ -124,6 +139,72 @@ properties:
type: string
examples:
- Ethernet1
mclag-capabilities:
description: Capabilities of the MC-LAG (Multi-Chassis Link Aggregation) feature in the switch
type: object
properties:
max-mclag-groups:
description: Defines the maximum number of MC-LAG groups that can be configured on the switch.
type: integer
max-ports-per-mclag-group:
description: Specifies the maximum number of physical ports that can be part of a single MC-LAG group.
type: integer
max-vlans-per-mclag-group:
description: Indicates the maximum number of VLANs that can be supported within a single MC-LAG group.
type: integer
dual-active-detection:
description: Describes the dual-active detection mechanism to prevent both switches from becoming active simultaneously.
type: string
enum:
- ICCP
- Backup-Link
- None
failover-time-milliseconds:
description: 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: integer
vlan-synchronization:
description: Indicates whether VLAN synchronization across MC-LAG peers is supported and the number of VLANs that can be synchronized.
type: boolean
max-mac-entries-per-mclag:
description: Maximum number of MAC address entries that can be synchronized across MC-LAG peers.
type: integer
lldp-capabilities:
type: object
description:
Description of LLDP capabilities across different switch models/vendors.
properties:
supported-tlvs:
type: array
items:
type: string
enum:
- 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
max-neighbors:
type: integer
description: Maximum number of LLDP neighbors a switch can discover and maintain.
examples:
- 64
- 128
- 256
supported-features:
type: array
description:
@@ -133,6 +214,11 @@ properties:
enum:
# L2
- VLAN
- VLAN-Voice
- Jumbo-Frames
- Link-Aggregation-LACP
- Link-Aggregation-Static
- Link-Aggregation-MCLAG
- Port-Isolation
- Spanning-Tree
- Spanning-Tree-Rapid
@@ -160,16 +246,22 @@ properties:
- Routing-IPv6-DHCP-Stateful
- Routing-IPv6-DHCP-Stateless
- Routing-IPv6-Port-Forward
- Multicast-VLAN-Registration
# PoE
- PoE-Reset
# .1X
- Port-Access-Control
- PAC-Dynamic-Auth
- mac-address-bypass
# System
- System-PasswordChange
- System-SwUpdate
- System-SwUpdate-Partial
- Port-Mirroring
# Security
- MAC-ACL
- IP-ACL
- Guest-VLAN
# Services
- Service-SSH
- Service-RSSH
@@ -180,6 +272,7 @@ properties:
- Service-GPS
- Service-IGMP
- Service-NTP
- Service-NTP-Client
- Service-MDNS
- Service-QoS
- Service-Syslog

View File

@@ -18,6 +18,13 @@ properties:
- LAN*
- WAN*
- "*"
name:
description:
This is a free text field, stating the administrative name of the
port. It may contain spaces and special characters, not exceeding 64 characters.
type: string
examples:
- cloud_uplink_port
speed:
description:
The link speed that shall be forced.
@@ -30,7 +37,10 @@ properties:
- 5000
- 10000
- 25000
- 40000
- 50000
- 100000
- 200000
default: 1000
duplex:
description:
@@ -161,6 +171,12 @@ properties:
type: integer
minimum: 1
maximum: 4094
mac-address-bypass:
description: Enables bypass when a device does not support 802.1X authentication (e.g., printers, IP phones)
type: boolean
mac-address-bypass-timeout-minutes:
description: Defines the time period (in minutes) for which a MAC address is allowed access to the network without requiring reauthentication, after being authenticated or allowed via MAC Authentication Bypass (MAB).
type: integer
trunk-group:
description: Associates this port to a trunk or a port-channel.
type: integer
@@ -227,3 +243,128 @@ properties:
- short
- long
default: long
lldp-interface-config:
type: object
description: Configurations of LLDP on a specified interface.
properties:
lldp-admin-status:
type: string
description: Enables LLDP transmit, receive, or transmit and receive mode on the specified port.
enum:
- rx
- tx
- rx-tx
lldp-basic-tlv-mgmt-ip-v4:
type: boolean
description: Configures an LLDP-enabled port to advertise the management address for this device.
default: true
lldp-basic-tlv-mgmt-ip-v6:
type: boolean
description: Configures an LLDP-enabled port to advertise the management IPv6 address for this device, if available.
default: false
lldp-basic-tlv-port-descr:
type: boolean
description: Configures an LLDP-enabled port to advertise its port description.
default: true
lldp-basic-tlv-sys-capab:
type: boolean
description: Configures an LLDP-enabled port to advertise its system capabilities.
default: true
lldp-basic-tlv-sys-descr:
type: boolean
description: Configures an LLDP-enabled port to advertise the system description.
default: true
lldp-basic-tlv-sys-name:
type: boolean
description: Configures an LLDP-enabled port to advertise its system name.
default: true
lldp-dot1-tlv-proto-ident:
type: boolean
description: Configures an LLDP-enabled port to advertise the supported protocols.
default: true
lldp-dot1-tlv-proto-vid:
type: boolean
description: Configures an LLDP-enabled port to advertise port-based protocol-related VLAN information.
default: true
lldp-dot1-tlv-pvid:
type: boolean
description: Configures an LLDP-enabled port to advertise its default Native VLAN ID (PVID).
default: true
lldp-dot1-tlv-vlan-name:
type: boolean
description: Configures an LLDP-enabled port to advertise its VLAN name.
default: true
lldp-dot3-tlv-link-agg:
type: boolean
description: Configures an LLDP-enabled port to advertise its link aggregation capabilities.
default: true
lldp-dot3-tlv-mac-phy:
type: boolean
description: Configures an LLDP-enabled port to advertise its MAC and physical layer specifications.
default: true
lldp-dot3-tlv-max-frame:
type: boolean
description: Configures an LLDP-enabled port to advertise its maximum frame size.
default: true
lldp-dot3-tlv-poe:
type: boolean
description: Configures an LLDP-enabled port to advertise its Power-over-Ethernet capabilities.
default: true
lldp-med-location-civic-addr:
type: object
description: Configures an LLDP-MED-enabled port to advertise its location identification details.
properties:
lldp-med-location-civic-addr-admin-status:
type: boolean
description: Enables or disables the advertisement of this TLV.
default: false
lldp-med-location-civic-country-code:
type: string
description: Configure the two-letter ISO 3166 country code in capital ASCII letters.
lldp-med-location-civic-device-type:
type: integer
description: The type of device to which the location applies.
lldp-med-location-civic-ca:
description: The list of LLDP MED Location CA Types to advertise the physical location of the device, that is the city, street number, building and room information.
type: array
items:
type: object
properties:
lldp-med-location-civic-ca-type:
type: integer
description: A one-octet descriptor of the data civic address value.
maximum: 255
minimum: 0
lldp-med-location-civic-ca-value:
type: string
description: Description of a location.
maxLength: 32
minLength: 1
lldp-med-notification:
type: boolean
description: Enables the transmission of SNMP trap notifications about LLDP-MED changes.
default: false
lldp-med-tlv-ext-poe:
type: boolean
description: Configures an LLDP-MED-enabled port to advertise its extended Power over Ethernet configuration and usage information.
default: true
lldp-med-tlv-inventory:
type: boolean
description: Configures an LLDP-MED-enabled port to advertise its inventory identification details.
default: true
lldp-med-tlv-location:
type: boolean
description: Configures an LLDP-MED-enabled port to advertise its location identification details.
default: true
lldp-med-tlv-med-cap:
type: boolean
description: Configures an LLDP-MED-enabled port to advertise its Media Endpoint Device capabilities.
default: true
lldp-med-tlv-network-policy:
type: boolean
description: Configures an LLDP-MED-enabled port to advertise its network policy configuration.
default: true
lldp-notification:
type: boolean
description: Enables the transmission of SNMP trap notifications about LLDP changes.
default: false

33
schema/interface.acl.yml Normal file
View File

@@ -0,0 +1,33 @@
description: A collection of access control entries that define the rules for filtering traffic through a network interface.
type: array
items:
type: object
properties:
acl-inf-policy-preference:
description: Determines the priority of multiple ACL policies when more than one is applied to an interface, if any.
type: integer
minimum: 1
maximum: 64
default: 1
acl-inf-policy-ingress:
description: Specifies the ACL policy that is applied to incoming traffic on an interface.
type: string
maxLength: 32
minLength: 1
examples:
- blacklisted-macs
acl-inf-counters-ingress:
description: Tracks the number and type of packets that match the ingress ACL rules on an interface.
type: boolean
default: false
acl-inf-policy-egress:
description: Specifies the ACL policy that is applied to outgoing traffic from an interface.
type: string
maxLength: 32
minLength: 1
examples:
- blacklisted-macs
acl-inf-counters-egress:
description: Tracks the number and type of packets that match the egress ACL rules on an interface.
type: boolean
default: false

View File

@@ -0,0 +1,16 @@
description: "Configuration for DHCP Snooping on a port level on a switch"
type: object
properties:
dhcp-snoop-port-trust:
description: "This parameter designates a switch port as trusted for DHCP messages, meaning it can forward DHCP offers and acknowledgments, which is essential for connecting to legitimate DHCP servers"
type: boolean
default: false
dhcp-snoop-port-client-limit:
description: "It sets a limit on the number of DHCP clients that can be associated with a single port, helping to prevent a single port from exhausting the networks IP address pool"
type: integer
minimum: 1
dhcp-snoop-port-circuit-id:
description: "Specifies DHCP Option 82 circuit ID suboption information. Often including information like the interface number and VLAN ID, this can be useful for network management and troubleshooting"
type: string
minLength: 1
maxLength: 32

View File

@@ -150,6 +150,34 @@ properties:
format: ipv4
examples:
- 225.0.0.1
mvr:
type: object
description: MVR attributes on a given interface
properties:
mvr-intf-mvr-role:
type: string
description: Configure an interface as an MVR receiver or source port. A port which is not configured as an MVR receiver or source port can use IGMP snooping to join or leave multicast groups using the standard rules for multicast filtering.
enum:
- none
- source
- receiver
mvr-intf-immed-leave:
type: string
description: Switch to immediately remove an interface from a multicast stream as soon as it receives a leave message for that group. Applies to only receiver role ports.
enum:
- none
- by-host-ip
- by-group
default: by-group
mvr-intf-assoc-domain:
type: integer
description: Map the port to a specific domain.
maximum: 10
minimum: 1
required:
- mvr-intf-mvr-role
- mvr-intf-immed-leave
- mvr-intf-assoc-domain
send-hostname:
description:
include the devices hostname inside DHCP requests
@@ -168,6 +196,39 @@ properties:
examples:
- 8.8.8.8
- 4.4.4.4
dhcp-snoop-vlan-enable:
description: "Enables DHCP Snooping on a VLAN"
type: boolean
default: false
voice-vlan-intf-config:
description: "Configure the Voice VLAN feature at the interface level, allowing for VoIP traffic to be prioritized on this specific port."
type: object
properties:
voice-vlan-intf-mode:
description: "Specify the mode of placing this port on the voice VLAN."
type: string
default: "auto"
enum:
- none
- manual
- auto
voice-vlan-intf-priority:
description: "Define the Class of Service (CoS) priority for VoIP traffic passing through this port, ensuring higher priority over other traffic types."
type: integer
default: 6
minimum: 0
maximum: 6
voice-vlan-intf-detect-voice:
description: "Select the detection method for identifying VoIP traffic on this port, such as OUI-based detection or traffic pattern recognition."
type: string
default: "oui"
enum:
- oui
- lldp
voice-vlan-intf-security:
description: "Enable or configure security filtering for VoIP traffic on the interface to protect against unauthorized devices."
type: boolean
default: false
dhcp:
$ref: "https://ucentral.io/schema/v1/interface/ipv4/dhcp/"
dhcp-leases:

View File

@@ -68,6 +68,10 @@ properties:
$ref: "https://ucentral.io/schema/v1/interface/ipv4/"
ipv6:
$ref: "https://ucentral.io/schema/v1/interface/ipv6/"
acl:
$ref: "https://ucentral.io/schema/v1/interface/acl/"
dhcp-snooop-port:
$ref: "https://ucentral.io/schema/v1/interface/dhcp-snoop-port/"
broad-band:
$ref: "https://ucentral.io/schema/v1/interface/broad-band/"
ssids:

View File

@@ -5,18 +5,20 @@ properties:
port-mirror:
description:
Enable mirror of traffic from multiple minotor ports to a single analysis port.
type: object
properties:
monitor-ports:
description:
The list of ports that we want to mirror.
type: array
items:
type: array
items:
type: object
properties:
monitor-ports:
description:
The list of ports that we want to mirror.
type: array
items:
type: string
analysis-port:
description:
The port that mirror'ed packets should be sent to.
type: string
analysis-port:
description:
The port that mirror'ed packets should be sent to.
type: string
loop-detection:
description:
Enable loop detection on the L2 switches/bridge.
@@ -240,3 +242,468 @@ properties:
Enables Jumbo frames
type: boolean
default: false
dhcp-snooping:
description: DHCP Snooping configuration parameters
type: object
properties:
dhcp-snoop-enable:
description: "Enables DHCP Snooping on the network switch, which is a security feature that prevents unauthorized DHCP servers from offering IP addresses"
type: boolean
default: false
dhcp-snoop-rate-limit:
description: "Sets a limit on the number of DHCP packets per second that can be received on an untrusted interface to prevent DHCP flooding attacks"
type: integer
minimum: 1
maximum: 2048
dhcp-snoop-mac-verify:
description: "This option ensures that the MAC address in a DHCP request matches the source MAC address of the packet, providing an additional layer of security"
type: boolean
default: false
dhcp-snoop-inf-opt-82:
description: "This refers to the insertion of information option 82 in DHCP packets, which adds more details about the clients location and network information for tracking and control purposes"
type: boolean
default: false
dhcp-snoop-inf-opt-encode-subopt:
description: "This parameter allows for the encoding of sub-options within option 82 to further specify client information"
type: boolean
default: false
dhcp-snoop-inf-opt-remoteid:
description: "It specifies the remote ID sub-option in option 82, which typically includes information like the circuit ID or remote host identifier"
type: string
maxLength: 32
minLength: 1
dhcp-snoop-inf-opt-policy:
description: "This defines the policy for handling packets with option 82, determining whether they should be forwarded or dropped based on the configuration"
type: string
enum:
- drop
- keep
- replace
acl:
description: Contains all the access control rule definitions
type: array
items:
type: object
properties:
acl-type:
description: Type of the access control list
type: string
enum:
- ipv4
- ipv6
- ipv4Ext
- ipv6Ext
- mac
- arp
acl-name:
description: The identifier or name for the Access Control List
type: string
maxLength: 32
minLength: 1
acl-rule-action:
description: Defines whether to permit or deny traffic matching the rule
type: string
enum:
- permit
- deny
acl-source-macaddress:
description: Specifies the source MAC address to filter on
type: string
format: uc-mac
acl-source-macbitmask:
description: The mask applied to the source MAC address
type: string
format: uc-mac
acl-dest-macaddress:
description: Specifies the destination MAC address for the filter
type: string
format: uc-mac
acl-dest-macbitmask:
description: The mask applied to the destination MAC address
type: string
format: uc-mac
acl-packet-format:
description: Identifies the protocol encapsulated in the Ethernet frame by its EtherType
type: string
enum:
- any
- untagged-eth2
- untagged-802.3
- tagged-eth2
- tagged-802.3
acl-vlanid:
description: Specifies a VLAN ID to filter traffic from a specific VLAN
type: integer
minimum: 1
maximum: 4094
acl-vid-bitmask:
description: The mask applied to the VLAN ID
type: integer
minimum: 1
maximum: 4095
acl-ethertype:
description: Filters packets based on the custom EtherType field (HEX) in the Ethernet frame
type: string
default: "800"
acl-ethertype-bitmask:
description: The mask applied to the EtherType field
type: string
default: "FFFF"
acl-cos:
description: Filters based on the Class of Service (CoS) field in the frame
type: integer
minimum: 0
maximum: 7
acl-cos-bitmask:
description: The mask applied to the CoS field
type: integer
minimum: 0
maximum: 7
# IP-ACL (IPv4/IPv6) Parameters
acl-ipv4-source-address:
description: The IPv4 address of the source to filter on
type: string
format: ipv4
acl-ipv4-source-subnetmask:
description: The subnet mask applied to the source IPv4 address
type: string
format: ipv4
acl-ipv4-dest-address:
description: The IPv4 address of the destination to filter on
type: string
format: ipv4
acl-ipv4-dest-subnetmask:
description: The subnet mask applied to the destination IPv4 address
type: string
format: ipv4
acl-ipv6-source-address:
description: The IPv6 address of the source to filter on
type: string
format: ipv6
acl-ipv6-source-prefix-length:
description: Defines the length of the prefix used in filtering IPv6 source addresses
type: integer
minimum: 0
maximum: 128
acl-ipv6-dest-address:
description: The IPv6 address of the destination to filter on
type: string
format: ipv6
acl-ipv6-dest-prefix-length:
description: Defines the length of the prefix used in filtering IPv6 destination addresses
type: integer
minimum: 0
maximum: 128
acl-ip-proto:
description: Filters based on the IP protocol number
type: integer
minimum: 0
maximum: 255
acl-ipv6-next-header:
description: Specifies the next header type in IPv6 traffic, such as TCP, UDP, or ICMPv6
type: integer
minimum: 0
maximum: 255
acl-ipv6-flow-label:
description: Filters packets based on the IPv6 Flow Label field
type: integer
minimum: 0
maximum: 1048575
acl-ip-source-port:
description: Specifies the source port number for filtering
type: integer
minimum: 0
maximum: 65535
acl-ip-source-port-bitmask:
description: The mask applied to the source port number
type: integer
minimum: 0
maximum: 65535
acl-ip-dest-port:
description: Specifies the destination port number for filtering
type: integer
minimum: 0
maximum: 65535
acl-ip-dest-port-bitmask:
description: The mask applied to the destination port number
type: integer
minimum: 0
maximum: 65535
acl-ipv4-fragment-offset:
description: Filters based on IPv4 fragment offset for fragmented packets
type: integer
minimum: 0
maximum: 8191
acl-ipv6-fragment-offset:
description: Filters based on IPv6 fragment offset for fragmented packets
type: integer
minimum: 0
maximum: 8191
acl-ip-ttl:
description: Filters IPv4 traffic based on the TTL (Time to Live) value
type: integer
minimum: 0
maximum: 255
acl-ipv6-hop-limit:
description: Filters IPv6 traffic based on the hop limit value, equivalent to IPv4 TTL
type: integer
minimum: 0
maximum: 255
mvr-config:
description: This section defines the Multicast VLAN Registration (MVR) general configuration.
type: object
properties:
mvr-enable:
description: Enable/Disable MVR globally on the switch.
type: boolean
default: false
mvr-proxy-query-intvl:
description:
This command configures the interval (in seconds) at which the receiver port sends out general queries.
The maximum value is determined based on 12 hours as maximum interval, and minimum as 1 second as allowed value.
type: integer
default: 125
maximum: 43200
minimum: 1
mvr-proxy-switching:
description:
Enable the MVR proxy switching mode, where the source port acts as a host, and the receiver port
acts as an MVR router with querier service enabled.
type: boolean
default: false
mvr-robustness-val:
description:
Configure the expected packet loss, and thereby the number of times to generate report
and group-specific queries when changes are learned about downstream groups,
and the number of times group-specific queries are sent to downstream receiver ports.
Right configuration ensures that multicast group memberships are correctly maintained
even if some control messages are lost due to network issues.
type: integer
default: 2
maximum: 255
minimum: 1
mvr-source-port-mode:
description:
Configure the switch to forward only multicast streams that a source port has dynamically
joined or to forward all multicast groups.
type: string
default: forward
enum:
- dynamic
- forward
mvr-domain-config:
description: Configure the Multicast VLAN Registration (MVR) domains.
type: array
items:
type: object
properties:
mvr-domain-id:
description: Unique identifier for a Multicast Domain defined under the MVR.
type: integer
minimum: 1
maximum: 10
default: 1
mvr-domain-enable:
description: Enable/disable Multicast VLAN Registration (MVR) for a specific domain.
type: boolean
default: false
mvr-domain-vlan-id:
description:
Per domain Level Multicast VLAN ID. Specifies the VLAN through which MVR multicast data is received.
This is the VLAN to which all source ports must be assigned.
type: integer
minimum: 1
maximum: 4094
default: 1
mvr-domain-upstream-sip:
description: Configures the source IP address assigned to all MVR control packets sent upstream on all domains or on a specified domain.
type: string
format: ipv4
examples:
- 192.168.0.5
mvr-group-config:
type: array
description: List of MVR groups (or profiles) configuration.
items:
type: object
properties:
mvr-group-name:
type: string
description: The name of a MVR group that consists of one or more MVR group addresses
maxLength: 16
minLength: 1
mvr-group-range-start:
type: string
format: ipv4
description: Start IP address on the range of MVR group addresses that maps to a profile/MVR group
mvr-group-range-end:
type: string
format: ipv4
description: Statically configure all multicast group addresses that will join an MVR VLAN. Map a range of MVR group addresses to a profile
mvr-group-assoc-domain:
descpription: Map the MVR Group to a secific domain. There can be many profiles under a single domain
type: array
items:
type: integer
maximum: 10
minimum: 1
required:
- mvr-group-name
- mvr-group-range-start
- mvr-group-range-end
- mvr-group-assoc-domain
lldp-global-config:
type: object
description: Configuration options for LLDP on a global level in a OLS switch.
properties:
lldp-enable:
type: boolean
default: true
description: Enables or disables LLDP globally at a switch level.
lldp-holdtime-multiplier:
type: integer
description: 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.
default: 4
lldp-med-fast-start-count:
type: integer
description: Configures how many medFastStart packets are transmitted during the activation process of the LLDP-MED Fast Start mechanism.
default: 4
lldp-refresh-interval:
type: integer
description: Configures the periodic transmit interval for LLDP advertisements (in seconds).
default: 30
lldp-reinit-delay:
type: integer
description: Configures the delay (in seconds) before reinitializing after LLDP ports are disabled or the link goes down.
default: 2
lldp-tx-delay:
type: integer
description: Configures a delay (in seconds) between successive transmissions of advertisements initiated by a change in local LLDP state.
maximum: 8192
minimum: 1
lldp-notification-interval:
type: integer
description: Configures the interval (in seconds) for sending SNMP notifications about LLDP changes.
default: 5
mc-lag:
type: boolean
description: Enables MC-LAG or disables it.
default: false
mclag-config:
description: This section defines the MC-LAG configuration parameters for the switch.
type: object
properties:
mclag-domains:
description: List of MC-LAG domain configurations for the switch.
type: array
items:
type: object
properties:
mclag-domain:
description: Specifies the MC-LAG domain ID to identify the grouping of peer switches.
type: integer
minimum: 1
maximum: 1024
default: 1
peer-link:
description: Configures the peer-link, which could be a physical port or a trunk group that connects the two MC-LAG peer switches.
type: object
properties:
type:
description: Defines the type of peer-link, either 'port' or 'trunk-group'
type: string
enum:
- port
- trunk-group
default: trunk-group
value:
description: Specifies the port or trunk-group ID for the peer-link.
type: integer
minimum: 1
maximum: 64
mclag-group:
description: Configures the MC-LAG group, which binds the interfaces into a multi-chassis LAG.
type: object
properties:
group-id:
description: Defines the unique MC-LAG group identifier.
type: integer
minimum: 1
maximum: 128
members:
description: List of interfaces that participate in the MC-LAG group.
type: array
items:
type: string
description: Interface names that are part of the MC-LAG group.
examples:
- eth0
- eth1
lacp-config:
description: LACP configuration settings for the MC-LAG group.
type: object
properties:
lacp-enable:
description: Enables or disables LACP for the MC-LAG group.
type: boolean
default: true
lacp-role:
description: Configures the LACP role as 'actor' or 'partner'
type: string
enum:
- actor
- partner
default: actor
lacp-timeout:
description: Sets the LACP timeout as either 'short' or 'long'.
type: string
enum:
- short
- long
default: long
system-priority:
description: Specifies the system priority used by the switch for LACP negotiations.
type: integer
minimum: 1
maximum: 65535
default: 32768
dual-active-detection:
description: Enables dual-active detection to prevent split-brain scenarios in MC-LAG.
type: boolean
default: true
voice-vlan-config:
description: "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: object
properties:
voice-vlan-id:
description: "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."
type: integer
minimum: 1
maximum: 4094
voice-vlan-ageing-time:
description: "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."
type: integer
minimum: 5
maximum: 43200
default: 1440
voice-vlan-oui-config:
description: "Configures the Organizationally Unique Identifier (OUI) for identifying the voice devices (like IP phones)."
type: array
items:
type: object
properties:
voice-vlan-oui-mac:
description: "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: string
format: uc-mac
voice-vlan-oui-mask:
description: "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
format: uc-mac
voice-vlan-oui-description:
description: "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."
type: string
maxLength: 32
minLength: 1
examples:
- "A VoIP Phone"

View File

@@ -74,3 +74,118 @@ items:
type: array
items:
type: string
mvr:
type: object
description: MVR statistics on interface
properties:
mvr-intf-fwd-status:
description: Shows if MVR traffic is being forwarded or discarded.
type: boolean
mvr-intf-igmp-count-reports:
description: The number of IGMP membership reports received on this interface.
type: integer
mvr-intf-igmp-count-leave:
description: The number of leave messages received on this interface.
type: integer
mvr-intf-igmp-count-gquery:
description: The number of general query messages received on this interface.
type: integer
mvr-intf-igmp-count-gssquery:
description: The number of group specific or group-and-source specific query messages received on this interface.
type: integer
mvr-intf-igmp-count-drop:
description: The number of times a report, leave, or query was dropped.
type: integer
mvr-intf-igmp-count-joinsucc:
description: The number of times a multicast group was successfully joined.
type: integer
mvr-intf-igmp-count-actgroups:
description: The number of MVR groups active on this interface.
type: integer
acl-stats:
description: "Represents the overall statistics for ACLs on the OLS device."
type: object
properties:
acl-intf-stats:
description: "A list of ACL-related statistics, each corresponding to a specific interface or port."
type: array
items:
type: object
properties:
acl-intf-id:
description: "The identifier for the interface or port to which the ACL statistics apply."
type: string
acl-type:
description: "Type of the access control list."
type: string
enum:
- none
- ipv4
- ipv6
- ipv4Ext
- ipv6Ext
- mac
- arp
acl-rule-action:
description: "Indicates the action (permit or deny) taken when an ACL rule is matched."
type: string
enum:
- permit
- deny
acl-hit-count:
description: "The number of times an ACL rule has been matched by traffic."
type: number
acl-rule-resource-util:
description: "Shows the percentage of this user-configured ACL rule as a percentage of total ACL rules."
type: integer
minimum: 0
maximum: 100
acl-resource-stats:
description: "Represents the overall resource utilization statistics for ACLs."
type: object
properties:
acl-total-resource-util:
description: "Percentage of total ACL consumed resources amongst the resources available."
type: integer
minimum: 0
maximum: 100
dhcp-snoop-binding:
description: State message entry to show the binding table for DHCP Snooping
type: object
properties:
entries:
description: List of DHCP Snooping binding entries
type: array
items:
type: object
properties:
dhcp-snoop-bind-mac-address:
description: MAC address of the DHCP client in the DHCP Snooping binding table
type: string
format: uc-mac
dhcp-snoop-bind-ip-address:
description: IP address assigned to the MAC address in the DHCP Snooping binding table
type: string
format: ipv4
dhcp-snoop-bind-lease-seconds:
description: 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: integer
dhcp-snoop-bind-type:
description: Specifies the type of binding entry, such as dynamic or static, indicating how the IP address was assigned to the client
type: string
enum:
- dynamic
- static
dhcp-snoop-bind-vlan:
description: VLAN ID associated with the DHCP clients IP address, which helps in managing network segments
type: integer
minimum: 1
maximum: 4094
dhcp-snoop-bind-interf:
description: Identifies the interface through which the DHCP client is connected, aiding in network topology management
type: string
examples:
- "Ethernet1"
- "Unit-1/Port-2"
- "1-2"
- "Trunk 1"

View File

@@ -28,3 +28,105 @@ items:
type: string
description:
The physical network port that we see this neighbour on.
lldp-remote-port-info:
type: object
description: Provides information about the remote port, such as the interface name and its operational status on the neighboring device.
properties:
lldp-remote-port-id:
type: string
description: The identifier for the remote port connected to the local port, often displayed as a string or number representing the remote interface.
lldp-remote-port-id-type:
type: string
description: Specifies the type of identifier used for the remote port, such as MAC address, interface name, or ifIndex.
enum:
- MAC Address
- Interface Name
- ifIndex
lldp-remote-ttl:
type: integer
description: Shows the time-to-live (TTL) value for LLDP advertisements from the remote device. This is the duration (in seconds) the LLDP information remains valid before expiring."
lldp-remote-port-descr:
type: string
description: Provides a textual description of the remote port, typically describing the interface or its purpose.
example: "Ethernet Port on unit 1, port 2"
lldp-remote-port-max-mtu:
type: string
description: Displays the maximum transmission unit (MTU) size that the remote port supports, indicating the largest packet size the port can handle.
lldp-remote-sys-descr:
type: string
description: A textual description of the remote system, including the device model, software version, or any user-configured description.
example: "ECS4150-28P"
lldp-remote-sys-capab:
type: array
description: Indicates the system capabilities advertised by the remote device, such as whether it supports routing, switching, bridging, etc.
items:
type: string
example: ["Switch", "Bridge", "Routing"]
lldp-remote-enabled-capab:
type: array
description: Displays the capabilities that are actually enabled on the remote device, such as routing, switching, or bridging functionality.
items:
type: string
example: ["Switch", "Bridge", "Routing"]
lldp-remote-port-mgmt-address:
type: string
description: The management IP address of the remote device, used to access the device for administrative purposes.
example: "192.168.0.4"
lldp-remote-port-vlan-id:
type: integer
description: Shows the VLAN ID associated with the remote port, which could indicate the native VLAN or the port's trunk configuration.
lldp-remote-port-protocol-id:
type: string
description: Identifies any protocol-specific information (in HEX) advertised by the remote device, such as VLAN, Spanning Tree, or Link Aggregation protocol.
lldp-remote-port-mac-phy-status:
type: object
description: Displays the physical layer status of the remote port.
properties:
lldp-remote-port-aneg-suport:
type: boolean
description: Indicates whether the remote port supports auto-negotiation of link parameters like speed and duplex settings.
lldp-remote-port-aneg-enabled:
type: boolean
description: Shows whether auto-negotiation is enabled on the remote port.
lldp-remote-port-aneg-advertised-cap:
type: string
description: Lists the capabilities (in HEX) the remote port is advertising during auto-negotiation, such as supported speeds and duplex modes.
lldp-remote-port-mau-type:
type: integer
description: Displays the Media Access Unit (MAU) type, describing the port's physical characteristics (e.g., copper or fiber, 10/100/1000Base-T, etc.).
lldp-remote-port-power-info:
type: object
description: Provides detailed PoE information.
properties:
lldp-remote-port-power-class:
type: string
description: Indicates if the device is a PSE or a PD.
enum:
- pse
- pd
lldp-remote-port-power-mdi-support:
type: boolean
description: Indicates whether the remote device supports Media Dependent Interface (MDI) power supply, allowing power to be supplied through the Ethernet cable.
lldp-remote-port-power-mdi-enabled:
type: boolean
description: Shows whether MDI power is currently enabled on the remote port.
lldp-remote-port-power-pair-control:
type: boolean
description: Displays whether the remote device has control over which wire pairs in the Ethernet cable provide power (important for PoE).
lldp-remote-port-power-classification:
type: string
description: Displays the PoE class of the remote device, indicating its power consumption classification.
enum: ["Class-1", "Class-2", "Class-3", "Class-4","Class-5", "Class-6", "Class-7", "Class-8"]
lldp-remote-port-lag-info:
type: object
description: Provides information about the remote ports involvement in Link Aggregation Groups (LAG), if applicable.
properties:
lldp-remote-port-lag-support:
type: boolean
description: Indicates whether the remote port supports Link Aggregation (static or LACP).
lldp-remote-port-lag-enabled:
type: boolean
description: Shows whether Link Aggregation is enabled on the remote port.
lldp-remote-port-lag-port-id:
type: integer
description: Displays the identifier of the Link Aggregation Group (LAG) that the remote port belongs to.

View File

@@ -58,3 +58,7 @@ properties:
$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.

View File

@@ -15,6 +15,28 @@
"Rel 1.6 build 5"
]
},
"version": {
"type": "object",
"description": "The ols schema version to be used with this Switch",
"properties": {
"major": {
"type": "integer"
},
"minor": {
"type": "integer"
},
"patch": {
"type": "integer"
}
},
"examples": [
{
"major": 3,
"minor": 2,
"patch": 0
}
]
},
"platform": {
"type": "string",
"enum": [
@@ -160,6 +182,88 @@
}
}
},
"mclag-capabilities": {
"description": "Capabilities of the MC-LAG (Multi-Chassis Link Aggregation) feature in the switch",
"type": "object",
"properties": {
"max-mclag-groups": {
"description": "Defines the maximum number of MC-LAG groups that can be configured on the switch.",
"type": "integer"
},
"max-ports-per-mclag-group": {
"description": "Specifies the maximum number of physical ports that can be part of a single MC-LAG group.",
"type": "integer"
},
"max-vlans-per-mclag-group": {
"description": "Indicates the maximum number of VLANs that can be supported within a single MC-LAG group.",
"type": "integer"
},
"dual-active-detection": {
"description": "Describes the dual-active detection mechanism to prevent both switches from becoming active simultaneously.",
"type": "string",
"enum": [
"ICCP",
"Backup-Link",
"None"
]
},
"failover-time-milliseconds": {
"description": "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": "integer"
},
"vlan-synchronization": {
"description": "Indicates whether VLAN synchronization across MC-LAG peers is supported and the number of VLANs that can be synchronized.",
"type": "boolean"
},
"max-mac-entries-per-mclag": {
"description": "Maximum number of MAC address entries that can be synchronized across MC-LAG peers.",
"type": "integer"
}
}
},
"lldp-capabilities": {
"type": "object",
"description": "Description of LLDP capabilities across different switch models/vendors.",
"properties": {
"supported-tlvs": {
"type": "array",
"items": {
"type": "string",
"enum": [
"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"
]
}
},
"max-neighbors": {
"type": "integer",
"description": "Maximum number of LLDP neighbors a switch can discover and maintain.",
"examples": [
64,
128,
256
]
}
}
},
"supported-features": {
"type": "array",
"description": "List of all features supported by the device",
@@ -167,6 +271,11 @@
"type": "string",
"enum": [
"VLAN",
"VLAN-Voice",
"Jumbo-Frames",
"Link-Aggregation-LACP",
"Link-Aggregation-Static",
"Link-Aggregation-MCLAG",
"Port-Isolation",
"Spanning-Tree",
"Spanning-Tree-Rapid",
@@ -193,13 +302,18 @@
"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",
@@ -209,6 +323,7 @@
"Service-GPS",
"Service-IGMP",
"Service-NTP",
"Service-NTP-Client",
"Service-MDNS",
"Service-QoS",
"Service-Syslog",

View File

@@ -558,6 +558,13 @@
]
}
},
"name": {
"description": "This is a free text field, stating the administrative name of the port. It may contain spaces and special characters, not exceeding 64 characters.",
"type": "string",
"examples": [
"cloud_uplink_port"
]
},
"speed": {
"description": "The link speed that shall be forced.",
"type": "integer",
@@ -569,7 +576,10 @@
5000,
10000,
25000,
100000
40000,
50000,
100000,
200000
],
"default": 1000
},
@@ -683,6 +693,14 @@
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"mac-address-bypass": {
"description": "Enables bypass when a device does not support 802.1X authentication (e.g., printers, IP phones)",
"type": "boolean"
},
"mac-address-bypass-timeout-minutes": {
"description": "Defines the time period (in minutes) for which a MAC address is allowed access to the network without requiring reauthentication, after being authenticated or allowed via MAC Authentication Bypass (MAB).",
"type": "integer"
}
}
},
@@ -756,6 +774,166 @@
"default": "long"
}
}
},
"lldp-interface-config": {
"type": "object",
"description": "Configurations of LLDP on a specified interface.",
"properties": {
"lldp-admin-status": {
"type": "string",
"description": "Enables LLDP transmit, receive, or transmit and receive mode on the specified port.",
"enum": [
"rx",
"tx",
"rx-tx"
]
},
"lldp-basic-tlv-mgmt-ip-v4": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise the management address for this device.",
"default": true
},
"lldp-basic-tlv-mgmt-ip-v6": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise the management IPv6 address for this device, if available.",
"default": false
},
"lldp-basic-tlv-port-descr": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise its port description.",
"default": true
},
"lldp-basic-tlv-sys-capab": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise its system capabilities.",
"default": true
},
"lldp-basic-tlv-sys-descr": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise the system description.",
"default": true
},
"lldp-basic-tlv-sys-name": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise its system name.",
"default": true
},
"lldp-dot1-tlv-proto-ident": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise the supported protocols.",
"default": true
},
"lldp-dot1-tlv-proto-vid": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise port-based protocol-related VLAN information.",
"default": true
},
"lldp-dot1-tlv-pvid": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise its default Native VLAN ID (PVID).",
"default": true
},
"lldp-dot1-tlv-vlan-name": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise its VLAN name.",
"default": true
},
"lldp-dot3-tlv-link-agg": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise its link aggregation capabilities.",
"default": true
},
"lldp-dot3-tlv-mac-phy": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise its MAC and physical layer specifications.",
"default": true
},
"lldp-dot3-tlv-max-frame": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise its maximum frame size.",
"default": true
},
"lldp-dot3-tlv-poe": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise its Power-over-Ethernet capabilities.",
"default": true
},
"lldp-med-location-civic-addr": {
"type": "object",
"description": "Configures an LLDP-MED-enabled port to advertise its location identification details.",
"properties": {
"lldp-med-location-civic-addr-admin-status": {
"type": "boolean",
"description": "Enables or disables the advertisement of this TLV.",
"default": false
},
"lldp-med-location-civic-country-code": {
"type": "string",
"description": "Configure the two-letter ISO 3166 country code in capital ASCII letters."
},
"lldp-med-location-civic-device-type": {
"type": "integer",
"description": "The type of device to which the location applies."
},
"lldp-med-location-civic-ca": {
"description": "The list of LLDP MED Location CA Types to advertise the physical location of the device, that is the city, street number, building and room information.",
"type": "array",
"items": {
"type": "object",
"properties": {
"lldp-med-location-civic-ca-type": {
"type": "integer",
"description": "A one-octet descriptor of the data civic address value.",
"maximum": 255,
"minimum": 0
},
"lldp-med-location-civic-ca-value": {
"type": "string",
"description": "Description of a location.",
"maxLength": 32,
"minLength": 1
}
}
}
}
}
},
"lldp-med-notification": {
"type": "boolean",
"description": "Enables the transmission of SNMP trap notifications about LLDP-MED changes.",
"default": false
},
"lldp-med-tlv-ext-poe": {
"type": "boolean",
"description": "Configures an LLDP-MED-enabled port to advertise its extended Power over Ethernet configuration and usage information.",
"default": true
},
"lldp-med-tlv-inventory": {
"type": "boolean",
"description": "Configures an LLDP-MED-enabled port to advertise its inventory identification details.",
"default": true
},
"lldp-med-tlv-location": {
"type": "boolean",
"description": "Configures an LLDP-MED-enabled port to advertise its location identification details.",
"default": true
},
"lldp-med-tlv-med-cap": {
"type": "boolean",
"description": "Configures an LLDP-MED-enabled port to advertise its Media Endpoint Device capabilities.",
"default": true
},
"lldp-med-tlv-network-policy": {
"type": "boolean",
"description": "Configures an LLDP-MED-enabled port to advertise its network policy configuration.",
"default": true
},
"lldp-notification": {
"type": "boolean",
"description": "Enables the transmission of SNMP trap notifications about LLDP changes.",
"default": false
}
}
}
}
}
@@ -766,18 +944,21 @@
"properties": {
"port-mirror": {
"description": "Enable mirror of traffic from multiple minotor ports to a single analysis port.",
"type": "object",
"properties": {
"monitor-ports": {
"description": "The list of ports that we want to mirror.",
"type": "array",
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"monitor-ports": {
"description": "The list of ports that we want to mirror.",
"type": "array",
"items": {
"type": "string"
}
},
"analysis-port": {
"description": "The port that mirror'ed packets should be sent to.",
"type": "string"
}
},
"analysis-port": {
"description": "The port that mirror'ed packets should be sent to.",
"type": "string"
}
}
},
@@ -1009,10 +1190,583 @@
"src-mac"
],
"default": "src-dst-mac"
},
"jumbo-frames": {
"description": "Enables Jumbo frames",
"type": "boolean",
"default": false
},
"dhcp-snooping": {
"description": "DHCP Snooping configuration parameters",
"type": "object",
"properties": {
"dhcp-snoop-enable": {
"description": "Enables DHCP Snooping on the network switch, which is a security feature that prevents unauthorized DHCP servers from offering IP addresses",
"type": "boolean",
"default": false
},
"dhcp-snoop-rate-limit": {
"description": "Sets a limit on the number of DHCP packets per second that can be received on an untrusted interface to prevent DHCP flooding attacks",
"type": "integer",
"minimum": 1,
"maximum": 2048
},
"dhcp-snoop-mac-verify": {
"description": "This option ensures that the MAC address in a DHCP request matches the source MAC address of the packet, providing an additional layer of security",
"type": "boolean",
"default": false
},
"dhcp-snoop-inf-opt-82": {
"description": "This refers to the insertion of information option 82 in DHCP packets, which adds more details about the client\u2019s location and network information for tracking and control purposes",
"type": "boolean",
"default": false
},
"dhcp-snoop-inf-opt-encode-subopt": {
"description": "This parameter allows for the encoding of sub-options within option 82 to further specify client information",
"type": "boolean",
"default": false
},
"dhcp-snoop-inf-opt-remoteid": {
"description": "It specifies the remote ID sub-option in option 82, which typically includes information like the circuit ID or remote host identifier",
"type": "string",
"maxLength": 32,
"minLength": 1
},
"dhcp-snoop-inf-opt-policy": {
"description": "This defines the policy for handling packets with option 82, determining whether they should be forwarded or dropped based on the configuration",
"type": "string",
"enum": [
"drop",
"keep",
"replace"
]
}
}
},
"acl": {
"description": "Contains all the access control rule definitions",
"type": "array",
"items": {
"type": "object",
"properties": {
"acl-type": {
"description": "Type of the access control list",
"type": "string",
"enum": [
"ipv4",
"ipv6",
"ipv4Ext",
"ipv6Ext",
"mac",
"arp"
]
},
"acl-name": {
"description": "The identifier or name for the Access Control List",
"type": "string",
"maxLength": 32,
"minLength": 1
},
"acl-rule-action": {
"description": "Defines whether to permit or deny traffic matching the rule",
"type": "string",
"enum": [
"permit",
"deny"
]
},
"acl-source-macaddress": {
"description": "Specifies the source MAC address to filter on",
"type": "string",
"format": "uc-mac"
},
"acl-source-macbitmask": {
"description": "The mask applied to the source MAC address",
"type": "string",
"format": "uc-mac"
},
"acl-dest-macaddress": {
"description": "Specifies the destination MAC address for the filter",
"type": "string",
"format": "uc-mac"
},
"acl-dest-macbitmask": {
"description": "The mask applied to the destination MAC address",
"type": "string",
"format": "uc-mac"
},
"acl-packet-format": {
"description": "Identifies the protocol encapsulated in the Ethernet frame by its EtherType",
"type": "string",
"enum": [
"any",
"untagged-eth2",
"untagged-802.3",
"tagged-eth2",
"tagged-802.3"
]
},
"acl-vlanid": {
"description": "Specifies a VLAN ID to filter traffic from a specific VLAN",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"acl-vid-bitmask": {
"description": "The mask applied to the VLAN ID",
"type": "integer",
"minimum": 1,
"maximum": 4095
},
"acl-ethertype": {
"description": "Filters packets based on the custom EtherType field (HEX) in the Ethernet frame",
"type": "string",
"default": "800"
},
"acl-ethertype-bitmask": {
"description": "The mask applied to the EtherType field",
"type": "string",
"default": "FFFF"
},
"acl-cos": {
"description": "Filters based on the Class of Service (CoS) field in the frame",
"type": "integer",
"minimum": 0,
"maximum": 7
},
"acl-cos-bitmask": {
"description": "The mask applied to the CoS field",
"type": "integer",
"minimum": 0,
"maximum": 7
},
"acl-ipv4-source-address": {
"description": "The IPv4 address of the source to filter on",
"type": "string",
"format": "ipv4"
},
"acl-ipv4-source-subnetmask": {
"description": "The subnet mask applied to the source IPv4 address",
"type": "string",
"format": "ipv4"
},
"acl-ipv4-dest-address": {
"description": "The IPv4 address of the destination to filter on",
"type": "string",
"format": "ipv4"
},
"acl-ipv4-dest-subnetmask": {
"description": "The subnet mask applied to the destination IPv4 address",
"type": "string",
"format": "ipv4"
},
"acl-ipv6-source-address": {
"description": "The IPv6 address of the source to filter on",
"type": "string",
"format": "ipv6"
},
"acl-ipv6-source-prefix-length": {
"description": "Defines the length of the prefix used in filtering IPv6 source addresses",
"type": "integer",
"minimum": 0,
"maximum": 128
},
"acl-ipv6-dest-address": {
"description": "The IPv6 address of the destination to filter on",
"type": "string",
"format": "ipv6"
},
"acl-ipv6-dest-prefix-length": {
"description": "Defines the length of the prefix used in filtering IPv6 destination addresses",
"type": "integer",
"minimum": 0,
"maximum": 128
},
"acl-ip-proto": {
"description": "Filters based on the IP protocol number",
"type": "integer",
"minimum": 0,
"maximum": 255
},
"acl-ipv6-next-header": {
"description": "Specifies the next header type in IPv6 traffic, such as TCP, UDP, or ICMPv6",
"type": "integer",
"minimum": 0,
"maximum": 255
},
"acl-ipv6-flow-label": {
"description": "Filters packets based on the IPv6 Flow Label field",
"type": "integer",
"minimum": 0,
"maximum": 1048575
},
"acl-ip-source-port": {
"description": "Specifies the source port number for filtering",
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"acl-ip-source-port-bitmask": {
"description": "The mask applied to the source port number",
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"acl-ip-dest-port": {
"description": "Specifies the destination port number for filtering",
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"acl-ip-dest-port-bitmask": {
"description": "The mask applied to the destination port number",
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"acl-ipv4-fragment-offset": {
"description": "Filters based on IPv4 fragment offset for fragmented packets",
"type": "integer",
"minimum": 0,
"maximum": 8191
},
"acl-ipv6-fragment-offset": {
"description": "Filters based on IPv6 fragment offset for fragmented packets",
"type": "integer",
"minimum": 0,
"maximum": 8191
},
"acl-ip-ttl": {
"description": "Filters IPv4 traffic based on the TTL (Time to Live) value",
"type": "integer",
"minimum": 0,
"maximum": 255
},
"acl-ipv6-hop-limit": {
"description": "Filters IPv6 traffic based on the hop limit value, equivalent to IPv4 TTL",
"type": "integer",
"minimum": 0,
"maximum": 255
}
}
}
},
"mvr-config": {
"description": "This section defines the Multicast VLAN Registration (MVR) general configuration.",
"type": "object",
"properties": {
"mvr-enable": {
"description": "Enable/Disable MVR globally on the switch.",
"type": "boolean",
"default": false
},
"mvr-proxy-query-intvl": {
"description": "This command configures the interval (in seconds) at which the receiver port sends out general queries. The maximum value is determined based on 12 hours as maximum interval, and minimum as 1 second as allowed value.",
"type": "integer",
"default": 125,
"maximum": 43200,
"minimum": 1
},
"mvr-proxy-switching": {
"description": "Enable the MVR proxy switching mode, where the source port acts as a host, and the receiver port acts as an MVR router with querier service enabled.",
"type": "boolean",
"default": false
},
"mvr-robustness-val": {
"description": "Configure the expected packet loss, and thereby the number of times to generate report and group-specific queries when changes are learned about downstream groups, and the number of times group-specific queries are sent to downstream receiver ports. Right configuration ensures that multicast group memberships are correctly maintained even if some control messages are lost due to network issues.",
"type": "integer",
"default": 2,
"maximum": 255,
"minimum": 1
},
"mvr-source-port-mode": {
"description": "Configure the switch to forward only multicast streams that a source port has dynamically joined or to forward all multicast groups.",
"type": "string",
"default": "forward",
"enum": [
"dynamic",
"forward"
]
}
}
},
"mvr-domain-config": {
"description": "Configure the Multicast VLAN Registration (MVR) domains.",
"type": "array",
"items": {
"type": "object",
"properties": {
"mvr-domain-id": {
"description": "Unique identifier for a Multicast Domain defined under the MVR.",
"type": "integer",
"minimum": 1,
"maximum": 10,
"default": 1
},
"mvr-domain-enable": {
"description": "Enable/disable Multicast VLAN Registration (MVR) for a specific domain.",
"type": "boolean",
"default": false
},
"mvr-domain-vlan-id": {
"description": "Per domain Level Multicast VLAN ID. Specifies the VLAN through which MVR multicast data is received. This is the VLAN to which all source ports must be assigned.",
"type": "integer",
"minimum": 1,
"maximum": 4094,
"default": 1
},
"mvr-domain-upstream-sip": {
"description": "Configures the source IP address assigned to all MVR control packets sent upstream on all domains or on a specified domain.",
"type": "string",
"format": "ipv4",
"examples": [
"192.168.0.5"
]
}
}
}
},
"mvr-group-config": {
"type": "array",
"description": "List of MVR groups (or profiles) configuration.",
"items": {
"type": "object",
"properties": {
"mvr-group-name": {
"type": "string",
"description": "The name of a MVR group that consists of one or more MVR group addresses",
"maxLength": 16,
"minLength": 1
},
"mvr-group-range-start": {
"type": "string",
"format": "ipv4",
"description": "Start IP address on the range of MVR group addresses that maps to a profile/MVR group"
},
"mvr-group-range-end": {
"type": "string",
"format": "ipv4",
"description": "Statically configure all multicast group addresses that will join an MVR VLAN. Map a range of MVR group addresses to a profile"
},
"mvr-group-assoc-domain": {
"descpription": "Map the MVR Group to a secific domain. There can be many profiles under a single domain",
"type": "array",
"items": {
"type": "integer",
"maximum": 10,
"minimum": 1
}
}
},
"required": [
"mvr-group-name",
"mvr-group-range-start",
"mvr-group-range-end",
"mvr-group-assoc-domain"
]
}
},
"lldp-global-config": {
"type": "object",
"description": "Configuration options for LLDP on a global level in a OLS switch.",
"properties": {
"lldp-enable": {
"type": "boolean",
"default": true,
"description": "Enables or disables LLDP globally at a switch level."
},
"lldp-holdtime-multiplier": {
"type": "integer",
"description": "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.",
"default": 4
},
"lldp-med-fast-start-count": {
"type": "integer",
"description": "Configures how many medFastStart packets are transmitted during the activation process of the LLDP-MED Fast Start mechanism.",
"default": 4
},
"lldp-refresh-interval": {
"type": "integer",
"description": "Configures the periodic transmit interval for LLDP advertisements (in seconds).",
"default": 30
},
"lldp-reinit-delay": {
"type": "integer",
"description": "Configures the delay (in seconds) before reinitializing after LLDP ports are disabled or the link goes down.",
"default": 2
},
"lldp-tx-delay": {
"type": "integer",
"description": "Configures a delay (in seconds) between successive transmissions of advertisements initiated by a change in local LLDP state.",
"maximum": 8192,
"minimum": 1
},
"lldp-notification-interval": {
"type": "integer",
"description": "Configures the interval (in seconds) for sending SNMP notifications about LLDP changes.",
"default": 5
}
}
},
"mc-lag": {
"type": "boolean",
"description": "Enables MC-LAG or disables it.",
"default": false
},
"mclag-config": {
"description": "This section defines the MC-LAG configuration parameters for the switch.",
"type": "object",
"properties": {
"mclag-domains": {
"description": "List of MC-LAG domain configurations for the switch.",
"type": "array",
"items": {
"type": "object",
"properties": {
"mclag-domain": {
"description": "Specifies the MC-LAG domain ID to identify the grouping of peer switches.",
"type": "integer",
"minimum": 1,
"maximum": 1024,
"default": 1
},
"peer-link": {
"description": "Configures the peer-link, which could be a physical port or a trunk group that connects the two MC-LAG peer switches.",
"type": "object",
"properties": {
"type": {
"description": "Defines the type of peer-link, either 'port' or 'trunk-group'",
"type": "string",
"enum": [
"port",
"trunk-group"
],
"default": "trunk-group"
},
"value": {
"description": "Specifies the port or trunk-group ID for the peer-link.",
"type": "integer",
"minimum": 1,
"maximum": 64
}
}
},
"mclag-group": {
"description": "Configures the MC-LAG group, which binds the interfaces into a multi-chassis LAG.",
"type": "object",
"properties": {
"group-id": {
"description": "Defines the unique MC-LAG group identifier.",
"type": "integer",
"minimum": 1,
"maximum": 128
},
"members": {
"description": "List of interfaces that participate in the MC-LAG group.",
"type": "array",
"items": {
"type": "string",
"description": "Interface names that are part of the MC-LAG group.",
"examples": [
"eth0",
"eth1"
]
}
},
"lacp-config": {
"description": "LACP configuration settings for the MC-LAG group.",
"type": "object",
"properties": {
"lacp-enable": {
"description": "Enables or disables LACP for the MC-LAG group.",
"type": "boolean",
"default": true
},
"lacp-role": {
"description": "Configures the LACP role as 'actor' or 'partner'",
"type": "string",
"enum": [
"actor",
"partner"
],
"default": "actor"
},
"lacp-timeout": {
"description": "Sets the LACP timeout as either 'short' or 'long'.",
"type": "string",
"enum": [
"short",
"long"
],
"default": "long"
}
}
}
}
},
"system-priority": {
"description": "Specifies the system priority used by the switch for LACP negotiations.",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 32768
},
"dual-active-detection": {
"description": "Enables dual-active detection to prevent split-brain scenarios in MC-LAG.",
"type": "boolean",
"default": true
}
}
}
}
}
},
"voice-vlan-config": {
"description": "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": "object",
"properties": {
"voice-vlan-id": {
"description": "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.",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"voice-vlan-ageing-time": {
"description": "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.",
"type": "integer",
"minimum": 5,
"maximum": 43200,
"default": 1440
},
"voice-vlan-oui-config": {
"description": "Configures the Organizationally Unique Identifier (OUI) for identifying the voice devices (like IP phones).",
"type": "array",
"items": {
"type": "object",
"properties": {
"voice-vlan-oui-mac": {
"description": "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": "string",
"format": "uc-mac"
},
"voice-vlan-oui-mask": {
"description": "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",
"format": "uc-mac"
},
"voice-vlan-oui-description": {
"description": "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.",
"type": "string",
"maxLength": 32,
"minLength": 1,
"examples": [
"A VoIP Phone"
]
}
}
}
}
}
}
}
},
@@ -1581,6 +2335,42 @@
}
}
}
},
"mvr": {
"type": "object",
"description": "MVR attributes on a given interface",
"properties": {
"mvr-intf-mvr-role": {
"type": "string",
"description": "Configure an interface as an MVR receiver or source port. A port which is not configured as an MVR receiver or source port can use IGMP snooping to join or leave multicast groups using the standard rules for multicast filtering.",
"enum": [
"none",
"source",
"receiver"
]
},
"mvr-intf-immed-leave": {
"type": "string",
"description": "Switch to immediately remove an interface from a multicast stream as soon as it receives a leave message for that group. Applies to only receiver role ports.",
"enum": [
"none",
"by-host-ip",
"by-group"
],
"default": "by-group"
},
"mvr-intf-assoc-domain": {
"type": "integer",
"description": "Map the port to a specific domain.",
"maximum": 10,
"minimum": 1
}
},
"required": [
"mvr-intf-mvr-role",
"mvr-intf-immed-leave",
"mvr-intf-assoc-domain"
]
}
}
},
@@ -1604,6 +2394,48 @@
]
}
},
"dhcp-snoop-vlan-enable": {
"description": "Enables DHCP Snooping on a VLAN",
"type": "boolean",
"default": false
},
"voice-vlan-intf-config": {
"description": "Configure the Voice VLAN feature at the interface level, allowing for VoIP traffic to be prioritized on this specific port.",
"type": "object",
"properties": {
"voice-vlan-intf-mode": {
"description": "Specify the mode of placing this port on the voice VLAN.",
"type": "string",
"default": "auto",
"enum": [
"none",
"manual",
"auto"
]
},
"voice-vlan-intf-priority": {
"description": "Define the Class of Service (CoS) priority for VoIP traffic passing through this port, ensuring higher priority over other traffic types.",
"type": "integer",
"default": 6,
"minimum": 0,
"maximum": 6
},
"voice-vlan-intf-detect-voice": {
"description": "Select the detection method for identifying VoIP traffic on this port, such as OUI-based detection or traffic pattern recognition.",
"type": "string",
"default": "oui",
"enum": [
"oui",
"lldp"
]
},
"voice-vlan-intf-security": {
"description": "Enable or configure security filtering for VoIP traffic on the interface to protect against unauthorized devices.",
"type": "boolean",
"default": false
}
}
},
"dhcp": {
"description": "This section describes the DHCP server configuration",
"type": "object",
@@ -1902,6 +2734,72 @@
}
}
},
"acl": {
"description": "A collection of access control entries that define the rules for filtering traffic through a network interface.",
"type": "array",
"items": {
"type": "object",
"properties": {
"acl-inf-policy-preference": {
"description": "Determines the priority of multiple ACL policies when more than one is applied to an interface, if any.",
"type": "integer",
"minimum": 1,
"maximum": 64,
"default": 1
},
"acl-inf-policy-ingress": {
"description": "Specifies the ACL policy that is applied to incoming traffic on an interface.",
"type": "string",
"maxLength": 32,
"minLength": 1,
"examples": [
"blacklisted-macs"
]
},
"acl-inf-counters-ingress": {
"description": "Tracks the number and type of packets that match the ingress ACL rules on an interface.",
"type": "boolean",
"default": false
},
"acl-inf-policy-egress": {
"description": "Specifies the ACL policy that is applied to outgoing traffic from an interface.",
"type": "string",
"maxLength": 32,
"minLength": 1,
"examples": [
"blacklisted-macs"
]
},
"acl-inf-counters-egress": {
"description": "Tracks the number and type of packets that match the egress ACL rules on an interface.",
"type": "boolean",
"default": false
}
}
}
},
"dhcp-snooop-port": {
"description": "Configuration for DHCP Snooping on a port level on a switch",
"type": "object",
"properties": {
"dhcp-snoop-port-trust": {
"description": "This parameter designates a switch port as \u2018trusted\u2019 for DHCP messages, meaning it can forward DHCP offers and acknowledgments, which is essential for connecting to legitimate DHCP servers",
"type": "boolean",
"default": false
},
"dhcp-snoop-port-client-limit": {
"description": "It sets a limit on the number of DHCP clients that can be associated with a single port, helping to prevent a single port from exhausting the network\u2019s IP address pool",
"type": "integer",
"minimum": 1
},
"dhcp-snoop-port-circuit-id": {
"description": "Specifies DHCP Option 82 circuit ID suboption information. Often including information like the interface number and VLAN ID, this can be useful for network management and troubleshooting",
"type": "string",
"minLength": 1,
"maxLength": 32
}
}
},
"broad-band": {
"oneOf": [
{

View File

@@ -366,6 +366,12 @@
]
}
},
"name": {
"type": "string",
"examples": [
"cloud_uplink_port"
]
},
"speed": {
"type": "integer",
"enum": [
@@ -376,7 +382,10 @@
5000,
10000,
25000,
100000
40000,
50000,
100000,
200000
],
"default": 1000
},
@@ -475,6 +484,12 @@
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"mac-address-bypass": {
"type": "boolean"
},
"mac-address-bypass-timeout-minutes": {
"type": "integer"
}
}
},
@@ -538,6 +553,136 @@
"default": "long"
}
}
},
"lldp-interface-config": {
"type": "object",
"properties": {
"lldp-admin-status": {
"type": "string",
"enum": [
"rx",
"tx",
"rx-tx"
]
},
"lldp-basic-tlv-mgmt-ip-v4": {
"type": "boolean",
"default": true
},
"lldp-basic-tlv-mgmt-ip-v6": {
"type": "boolean",
"default": false
},
"lldp-basic-tlv-port-descr": {
"type": "boolean",
"default": true
},
"lldp-basic-tlv-sys-capab": {
"type": "boolean",
"default": true
},
"lldp-basic-tlv-sys-descr": {
"type": "boolean",
"default": true
},
"lldp-basic-tlv-sys-name": {
"type": "boolean",
"default": true
},
"lldp-dot1-tlv-proto-ident": {
"type": "boolean",
"default": true
},
"lldp-dot1-tlv-proto-vid": {
"type": "boolean",
"default": true
},
"lldp-dot1-tlv-pvid": {
"type": "boolean",
"default": true
},
"lldp-dot1-tlv-vlan-name": {
"type": "boolean",
"default": true
},
"lldp-dot3-tlv-link-agg": {
"type": "boolean",
"default": true
},
"lldp-dot3-tlv-mac-phy": {
"type": "boolean",
"default": true
},
"lldp-dot3-tlv-max-frame": {
"type": "boolean",
"default": true
},
"lldp-dot3-tlv-poe": {
"type": "boolean",
"default": true
},
"lldp-med-location-civic-addr": {
"type": "object",
"properties": {
"lldp-med-location-civic-addr-admin-status": {
"type": "boolean",
"default": false
},
"lldp-med-location-civic-country-code": {
"type": "string"
},
"lldp-med-location-civic-device-type": {
"type": "integer"
},
"lldp-med-location-civic-ca": {
"type": "array",
"items": {
"type": "object",
"properties": {
"lldp-med-location-civic-ca-type": {
"type": "integer",
"maximum": 255,
"minimum": 0
},
"lldp-med-location-civic-ca-value": {
"type": "string",
"maxLength": 32,
"minLength": 1
}
}
}
}
}
},
"lldp-med-notification": {
"type": "boolean",
"default": false
},
"lldp-med-tlv-ext-poe": {
"type": "boolean",
"default": true
},
"lldp-med-tlv-inventory": {
"type": "boolean",
"default": true
},
"lldp-med-tlv-location": {
"type": "boolean",
"default": true
},
"lldp-med-tlv-med-cap": {
"type": "boolean",
"default": true
},
"lldp-med-tlv-network-policy": {
"type": "boolean",
"default": true
},
"lldp-notification": {
"type": "boolean",
"default": false
}
}
}
}
},
@@ -545,16 +690,19 @@
"type": "object",
"properties": {
"port-mirror": {
"type": "object",
"properties": {
"monitor-ports": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"monitor-ports": {
"type": "array",
"items": {
"type": "string"
}
},
"analysis-port": {
"type": "string"
}
},
"analysis-port": {
"type": "string"
}
}
},
@@ -755,6 +903,489 @@
"jumbo-frames": {
"type": "boolean",
"default": false
},
"dhcp-snooping": {
"type": "object",
"properties": {
"dhcp-snoop-enable": {
"type": "boolean",
"default": false
},
"dhcp-snoop-rate-limit": {
"type": "integer",
"minimum": 1,
"maximum": 2048
},
"dhcp-snoop-mac-verify": {
"type": "boolean",
"default": false
},
"dhcp-snoop-inf-opt-82": {
"type": "boolean",
"default": false
},
"dhcp-snoop-inf-opt-encode-subopt": {
"type": "boolean",
"default": false
},
"dhcp-snoop-inf-opt-remoteid": {
"type": "string",
"maxLength": 32,
"minLength": 1
},
"dhcp-snoop-inf-opt-policy": {
"type": "string",
"enum": [
"drop",
"keep",
"replace"
]
}
}
},
"acl": {
"type": "array",
"items": {
"type": "object",
"properties": {
"acl-type": {
"type": "string",
"enum": [
"ipv4",
"ipv6",
"ipv4Ext",
"ipv6Ext",
"mac",
"arp"
]
},
"acl-name": {
"type": "string",
"maxLength": 32,
"minLength": 1
},
"acl-rule-action": {
"type": "string",
"enum": [
"permit",
"deny"
]
},
"acl-source-macaddress": {
"type": "string",
"format": "uc-mac"
},
"acl-source-macbitmask": {
"type": "string",
"format": "uc-mac"
},
"acl-dest-macaddress": {
"type": "string",
"format": "uc-mac"
},
"acl-dest-macbitmask": {
"type": "string",
"format": "uc-mac"
},
"acl-packet-format": {
"type": "string",
"enum": [
"any",
"untagged-eth2",
"untagged-802.3",
"tagged-eth2",
"tagged-802.3"
]
},
"acl-vlanid": {
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"acl-vid-bitmask": {
"type": "integer",
"minimum": 1,
"maximum": 4095
},
"acl-ethertype": {
"type": "string",
"default": "800"
},
"acl-ethertype-bitmask": {
"type": "string",
"default": "FFFF"
},
"acl-cos": {
"type": "integer",
"minimum": 0,
"maximum": 7
},
"acl-cos-bitmask": {
"type": "integer",
"minimum": 0,
"maximum": 7
},
"acl-ipv4-source-address": {
"type": "string",
"format": "ipv4"
},
"acl-ipv4-source-subnetmask": {
"type": "string",
"format": "ipv4"
},
"acl-ipv4-dest-address": {
"type": "string",
"format": "ipv4"
},
"acl-ipv4-dest-subnetmask": {
"type": "string",
"format": "ipv4"
},
"acl-ipv6-source-address": {
"type": "string",
"format": "ipv6"
},
"acl-ipv6-source-prefix-length": {
"type": "integer",
"minimum": 0,
"maximum": 128
},
"acl-ipv6-dest-address": {
"type": "string",
"format": "ipv6"
},
"acl-ipv6-dest-prefix-length": {
"type": "integer",
"minimum": 0,
"maximum": 128
},
"acl-ip-proto": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"acl-ipv6-next-header": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"acl-ipv6-flow-label": {
"type": "integer",
"minimum": 0,
"maximum": 1048575
},
"acl-ip-source-port": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"acl-ip-source-port-bitmask": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"acl-ip-dest-port": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"acl-ip-dest-port-bitmask": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"acl-ipv4-fragment-offset": {
"type": "integer",
"minimum": 0,
"maximum": 8191
},
"acl-ipv6-fragment-offset": {
"type": "integer",
"minimum": 0,
"maximum": 8191
},
"acl-ip-ttl": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"acl-ipv6-hop-limit": {
"type": "integer",
"minimum": 0,
"maximum": 255
}
}
}
},
"mvr-config": {
"type": "object",
"properties": {
"mvr-enable": {
"type": "boolean",
"default": false
},
"mvr-proxy-query-intvl": {
"type": "integer",
"default": 125,
"maximum": 43200,
"minimum": 1
},
"mvr-proxy-switching": {
"type": "boolean",
"default": false
},
"mvr-robustness-val": {
"type": "integer",
"default": 2,
"maximum": 255,
"minimum": 1
},
"mvr-source-port-mode": {
"type": "string",
"default": "forward",
"enum": [
"dynamic",
"forward"
]
}
}
},
"mvr-domain-config": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mvr-domain-id": {
"type": "integer",
"minimum": 1,
"maximum": 10,
"default": 1
},
"mvr-domain-enable": {
"type": "boolean",
"default": false
},
"mvr-domain-vlan-id": {
"type": "integer",
"minimum": 1,
"maximum": 4094,
"default": 1
},
"mvr-domain-upstream-sip": {
"type": "string",
"format": "ipv4",
"examples": [
"192.168.0.5"
]
}
}
}
},
"mvr-group-config": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mvr-group-name": {
"type": "string",
"maxLength": 16,
"minLength": 1
},
"mvr-group-range-start": {
"type": "string",
"format": "ipv4"
},
"mvr-group-range-end": {
"type": "string",
"format": "ipv4"
},
"mvr-group-assoc-domain": {
"descpription": "Map the MVR Group to a secific domain. There can be many profiles under a single domain",
"type": "array",
"items": {
"type": "integer",
"maximum": 10,
"minimum": 1
}
}
},
"required": [
"mvr-group-name",
"mvr-group-range-start",
"mvr-group-range-end",
"mvr-group-assoc-domain"
]
}
},
"lldp-global-config": {
"type": "object",
"properties": {
"lldp-enable": {
"type": "boolean",
"default": true
},
"lldp-holdtime-multiplier": {
"type": "integer",
"default": 4
},
"lldp-med-fast-start-count": {
"type": "integer",
"default": 4
},
"lldp-refresh-interval": {
"type": "integer",
"default": 30
},
"lldp-reinit-delay": {
"type": "integer",
"default": 2
},
"lldp-tx-delay": {
"type": "integer",
"maximum": 8192,
"minimum": 1
},
"lldp-notification-interval": {
"type": "integer",
"default": 5
}
}
},
"mc-lag": {
"type": "boolean",
"default": false
},
"mclag-config": {
"type": "object",
"properties": {
"mclag-domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mclag-domain": {
"type": "integer",
"minimum": 1,
"maximum": 1024,
"default": 1
},
"peer-link": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"port",
"trunk-group"
],
"default": "trunk-group"
},
"value": {
"type": "integer",
"minimum": 1,
"maximum": 64
}
}
},
"mclag-group": {
"type": "object",
"properties": {
"group-id": {
"type": "integer",
"minimum": 1,
"maximum": 128
},
"members": {
"type": "array",
"items": {
"type": "string",
"examples": [
"eth0",
"eth1"
]
}
},
"lacp-config": {
"type": "object",
"properties": {
"lacp-enable": {
"type": "boolean",
"default": true
},
"lacp-role": {
"type": "string",
"enum": [
"actor",
"partner"
],
"default": "actor"
},
"lacp-timeout": {
"type": "string",
"enum": [
"short",
"long"
],
"default": "long"
}
}
}
}
},
"system-priority": {
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 32768
},
"dual-active-detection": {
"type": "boolean",
"default": true
}
}
}
}
}
},
"voice-vlan-config": {
"type": "object",
"properties": {
"voice-vlan-id": {
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"voice-vlan-ageing-time": {
"type": "integer",
"minimum": 5,
"maximum": 43200,
"default": 1440
},
"voice-vlan-oui-config": {
"type": "array",
"items": {
"type": "object",
"properties": {
"voice-vlan-oui-mac": {
"type": "string",
"format": "uc-mac"
},
"voice-vlan-oui-mask": {
"type": "string",
"format": "uc-mac"
},
"voice-vlan-oui-description": {
"type": "string",
"maxLength": 32,
"minLength": 1,
"examples": [
"A VoIP Phone"
]
}
}
}
}
}
}
}
},
@@ -1302,6 +1933,38 @@
}
}
}
},
"mvr": {
"type": "object",
"properties": {
"mvr-intf-mvr-role": {
"type": "string",
"enum": [
"none",
"source",
"receiver"
]
},
"mvr-intf-immed-leave": {
"type": "string",
"enum": [
"none",
"by-host-ip",
"by-group"
],
"default": "by-group"
},
"mvr-intf-assoc-domain": {
"type": "integer",
"maximum": 10,
"minimum": 1
}
},
"required": [
"mvr-intf-mvr-role",
"mvr-intf-immed-leave",
"mvr-intf-assoc-domain"
]
}
}
},
@@ -1323,6 +1986,42 @@
]
}
},
"dhcp-snoop-vlan-enable": {
"type": "boolean",
"default": false
},
"voice-vlan-intf-config": {
"type": "object",
"properties": {
"voice-vlan-intf-mode": {
"type": "string",
"default": "auto",
"enum": [
"none",
"manual",
"auto"
]
},
"voice-vlan-intf-priority": {
"type": "integer",
"default": 6,
"minimum": 0,
"maximum": 6
},
"voice-vlan-intf-detect-voice": {
"type": "string",
"default": "oui",
"enum": [
"oui",
"lldp"
]
},
"voice-vlan-intf-security": {
"type": "boolean",
"default": false
}
}
},
"dhcp": {
"$ref": "#/$defs/interface.ipv4.dhcp"
},
@@ -1502,6 +2201,62 @@
}
}
},
"interface.acl": {
"type": "array",
"items": {
"type": "object",
"properties": {
"acl-inf-policy-preference": {
"type": "integer",
"minimum": 1,
"maximum": 64,
"default": 1
},
"acl-inf-policy-ingress": {
"type": "string",
"maxLength": 32,
"minLength": 1,
"examples": [
"blacklisted-macs"
]
},
"acl-inf-counters-ingress": {
"type": "boolean",
"default": false
},
"acl-inf-policy-egress": {
"type": "string",
"maxLength": 32,
"minLength": 1,
"examples": [
"blacklisted-macs"
]
},
"acl-inf-counters-egress": {
"type": "boolean",
"default": false
}
}
}
},
"interface.dhcp-snoop-port": {
"type": "object",
"properties": {
"dhcp-snoop-port-trust": {
"type": "boolean",
"default": false
},
"dhcp-snoop-port-client-limit": {
"type": "integer",
"minimum": 1
},
"dhcp-snoop-port-circuit-id": {
"type": "string",
"minLength": 1,
"maxLength": 32
}
}
},
"interface.broad-band.wwan": {
"type": "object",
"properties": {
@@ -2792,6 +3547,12 @@
"ipv6": {
"$ref": "#/$defs/interface.ipv6"
},
"acl": {
"$ref": "#/$defs/interface.acl"
},
"dhcp-snooop-port": {
"$ref": "#/$defs/interface.dhcp-snoop-port"
},
"broad-band": {
"$ref": "#/$defs/interface.broad-band"
},

View File

@@ -410,6 +410,13 @@
]
}
},
"name": {
"description": "This is a free text field, stating the administrative name of the port. It may contain spaces and special characters, not exceeding 64 characters.",
"type": "string",
"examples": [
"cloud_uplink_port"
]
},
"speed": {
"description": "The link speed that shall be forced.",
"type": "integer",
@@ -421,7 +428,10 @@
5000,
10000,
25000,
100000
40000,
50000,
100000,
200000
],
"default": 1000
},
@@ -535,6 +545,14 @@
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"mac-address-bypass": {
"description": "Enables bypass when a device does not support 802.1X authentication (e.g., printers, IP phones)",
"type": "boolean"
},
"mac-address-bypass-timeout-minutes": {
"description": "Defines the time period (in minutes) for which a MAC address is allowed access to the network without requiring reauthentication, after being authenticated or allowed via MAC Authentication Bypass (MAB).",
"type": "integer"
}
}
},
@@ -608,6 +626,166 @@
"default": "long"
}
}
},
"lldp-interface-config": {
"type": "object",
"description": "Configurations of LLDP on a specified interface.",
"properties": {
"lldp-admin-status": {
"type": "string",
"description": "Enables LLDP transmit, receive, or transmit and receive mode on the specified port.",
"enum": [
"rx",
"tx",
"rx-tx"
]
},
"lldp-basic-tlv-mgmt-ip-v4": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise the management address for this device.",
"default": true
},
"lldp-basic-tlv-mgmt-ip-v6": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise the management IPv6 address for this device, if available.",
"default": false
},
"lldp-basic-tlv-port-descr": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise its port description.",
"default": true
},
"lldp-basic-tlv-sys-capab": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise its system capabilities.",
"default": true
},
"lldp-basic-tlv-sys-descr": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise the system description.",
"default": true
},
"lldp-basic-tlv-sys-name": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise its system name.",
"default": true
},
"lldp-dot1-tlv-proto-ident": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise the supported protocols.",
"default": true
},
"lldp-dot1-tlv-proto-vid": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise port-based protocol-related VLAN information.",
"default": true
},
"lldp-dot1-tlv-pvid": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise its default Native VLAN ID (PVID).",
"default": true
},
"lldp-dot1-tlv-vlan-name": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise its VLAN name.",
"default": true
},
"lldp-dot3-tlv-link-agg": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise its link aggregation capabilities.",
"default": true
},
"lldp-dot3-tlv-mac-phy": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise its MAC and physical layer specifications.",
"default": true
},
"lldp-dot3-tlv-max-frame": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise its maximum frame size.",
"default": true
},
"lldp-dot3-tlv-poe": {
"type": "boolean",
"description": "Configures an LLDP-enabled port to advertise its Power-over-Ethernet capabilities.",
"default": true
},
"lldp-med-location-civic-addr": {
"type": "object",
"description": "Configures an LLDP-MED-enabled port to advertise its location identification details.",
"properties": {
"lldp-med-location-civic-addr-admin-status": {
"type": "boolean",
"description": "Enables or disables the advertisement of this TLV.",
"default": false
},
"lldp-med-location-civic-country-code": {
"type": "string",
"description": "Configure the two-letter ISO 3166 country code in capital ASCII letters."
},
"lldp-med-location-civic-device-type": {
"type": "integer",
"description": "The type of device to which the location applies."
},
"lldp-med-location-civic-ca": {
"description": "The list of LLDP MED Location CA Types to advertise the physical location of the device, that is the city, street number, building and room information.",
"type": "array",
"items": {
"type": "object",
"properties": {
"lldp-med-location-civic-ca-type": {
"type": "integer",
"description": "A one-octet descriptor of the data civic address value.",
"maximum": 255,
"minimum": 0
},
"lldp-med-location-civic-ca-value": {
"type": "string",
"description": "Description of a location.",
"maxLength": 32,
"minLength": 1
}
}
}
}
}
},
"lldp-med-notification": {
"type": "boolean",
"description": "Enables the transmission of SNMP trap notifications about LLDP-MED changes.",
"default": false
},
"lldp-med-tlv-ext-poe": {
"type": "boolean",
"description": "Configures an LLDP-MED-enabled port to advertise its extended Power over Ethernet configuration and usage information.",
"default": true
},
"lldp-med-tlv-inventory": {
"type": "boolean",
"description": "Configures an LLDP-MED-enabled port to advertise its inventory identification details.",
"default": true
},
"lldp-med-tlv-location": {
"type": "boolean",
"description": "Configures an LLDP-MED-enabled port to advertise its location identification details.",
"default": true
},
"lldp-med-tlv-med-cap": {
"type": "boolean",
"description": "Configures an LLDP-MED-enabled port to advertise its Media Endpoint Device capabilities.",
"default": true
},
"lldp-med-tlv-network-policy": {
"type": "boolean",
"description": "Configures an LLDP-MED-enabled port to advertise its network policy configuration.",
"default": true
},
"lldp-notification": {
"type": "boolean",
"description": "Enables the transmission of SNMP trap notifications about LLDP changes.",
"default": false
}
}
}
}
},
@@ -617,18 +795,21 @@
"properties": {
"port-mirror": {
"description": "Enable mirror of traffic from multiple minotor ports to a single analysis port.",
"type": "object",
"properties": {
"monitor-ports": {
"description": "The list of ports that we want to mirror.",
"type": "array",
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"monitor-ports": {
"description": "The list of ports that we want to mirror.",
"type": "array",
"items": {
"type": "string"
}
},
"analysis-port": {
"description": "The port that mirror'ed packets should be sent to.",
"type": "string"
}
},
"analysis-port": {
"description": "The port that mirror'ed packets should be sent to.",
"type": "string"
}
}
},
@@ -865,6 +1046,578 @@
"description": "Enables Jumbo frames",
"type": "boolean",
"default": false
},
"dhcp-snooping": {
"description": "DHCP Snooping configuration parameters",
"type": "object",
"properties": {
"dhcp-snoop-enable": {
"description": "Enables DHCP Snooping on the network switch, which is a security feature that prevents unauthorized DHCP servers from offering IP addresses",
"type": "boolean",
"default": false
},
"dhcp-snoop-rate-limit": {
"description": "Sets a limit on the number of DHCP packets per second that can be received on an untrusted interface to prevent DHCP flooding attacks",
"type": "integer",
"minimum": 1,
"maximum": 2048
},
"dhcp-snoop-mac-verify": {
"description": "This option ensures that the MAC address in a DHCP request matches the source MAC address of the packet, providing an additional layer of security",
"type": "boolean",
"default": false
},
"dhcp-snoop-inf-opt-82": {
"description": "This refers to the insertion of information option 82 in DHCP packets, which adds more details about the client\u2019s location and network information for tracking and control purposes",
"type": "boolean",
"default": false
},
"dhcp-snoop-inf-opt-encode-subopt": {
"description": "This parameter allows for the encoding of sub-options within option 82 to further specify client information",
"type": "boolean",
"default": false
},
"dhcp-snoop-inf-opt-remoteid": {
"description": "It specifies the remote ID sub-option in option 82, which typically includes information like the circuit ID or remote host identifier",
"type": "string",
"maxLength": 32,
"minLength": 1
},
"dhcp-snoop-inf-opt-policy": {
"description": "This defines the policy for handling packets with option 82, determining whether they should be forwarded or dropped based on the configuration",
"type": "string",
"enum": [
"drop",
"keep",
"replace"
]
}
}
},
"acl": {
"description": "Contains all the access control rule definitions",
"type": "array",
"items": {
"type": "object",
"properties": {
"acl-type": {
"description": "Type of the access control list",
"type": "string",
"enum": [
"ipv4",
"ipv6",
"ipv4Ext",
"ipv6Ext",
"mac",
"arp"
]
},
"acl-name": {
"description": "The identifier or name for the Access Control List",
"type": "string",
"maxLength": 32,
"minLength": 1
},
"acl-rule-action": {
"description": "Defines whether to permit or deny traffic matching the rule",
"type": "string",
"enum": [
"permit",
"deny"
]
},
"acl-source-macaddress": {
"description": "Specifies the source MAC address to filter on",
"type": "string",
"format": "uc-mac"
},
"acl-source-macbitmask": {
"description": "The mask applied to the source MAC address",
"type": "string",
"format": "uc-mac"
},
"acl-dest-macaddress": {
"description": "Specifies the destination MAC address for the filter",
"type": "string",
"format": "uc-mac"
},
"acl-dest-macbitmask": {
"description": "The mask applied to the destination MAC address",
"type": "string",
"format": "uc-mac"
},
"acl-packet-format": {
"description": "Identifies the protocol encapsulated in the Ethernet frame by its EtherType",
"type": "string",
"enum": [
"any",
"untagged-eth2",
"untagged-802.3",
"tagged-eth2",
"tagged-802.3"
]
},
"acl-vlanid": {
"description": "Specifies a VLAN ID to filter traffic from a specific VLAN",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"acl-vid-bitmask": {
"description": "The mask applied to the VLAN ID",
"type": "integer",
"minimum": 1,
"maximum": 4095
},
"acl-ethertype": {
"description": "Filters packets based on the custom EtherType field (HEX) in the Ethernet frame",
"type": "string",
"default": "800"
},
"acl-ethertype-bitmask": {
"description": "The mask applied to the EtherType field",
"type": "string",
"default": "FFFF"
},
"acl-cos": {
"description": "Filters based on the Class of Service (CoS) field in the frame",
"type": "integer",
"minimum": 0,
"maximum": 7
},
"acl-cos-bitmask": {
"description": "The mask applied to the CoS field",
"type": "integer",
"minimum": 0,
"maximum": 7
},
"acl-ipv4-source-address": {
"description": "The IPv4 address of the source to filter on",
"type": "string",
"format": "ipv4"
},
"acl-ipv4-source-subnetmask": {
"description": "The subnet mask applied to the source IPv4 address",
"type": "string",
"format": "ipv4"
},
"acl-ipv4-dest-address": {
"description": "The IPv4 address of the destination to filter on",
"type": "string",
"format": "ipv4"
},
"acl-ipv4-dest-subnetmask": {
"description": "The subnet mask applied to the destination IPv4 address",
"type": "string",
"format": "ipv4"
},
"acl-ipv6-source-address": {
"description": "The IPv6 address of the source to filter on",
"type": "string",
"format": "ipv6"
},
"acl-ipv6-source-prefix-length": {
"description": "Defines the length of the prefix used in filtering IPv6 source addresses",
"type": "integer",
"minimum": 0,
"maximum": 128
},
"acl-ipv6-dest-address": {
"description": "The IPv6 address of the destination to filter on",
"type": "string",
"format": "ipv6"
},
"acl-ipv6-dest-prefix-length": {
"description": "Defines the length of the prefix used in filtering IPv6 destination addresses",
"type": "integer",
"minimum": 0,
"maximum": 128
},
"acl-ip-proto": {
"description": "Filters based on the IP protocol number",
"type": "integer",
"minimum": 0,
"maximum": 255
},
"acl-ipv6-next-header": {
"description": "Specifies the next header type in IPv6 traffic, such as TCP, UDP, or ICMPv6",
"type": "integer",
"minimum": 0,
"maximum": 255
},
"acl-ipv6-flow-label": {
"description": "Filters packets based on the IPv6 Flow Label field",
"type": "integer",
"minimum": 0,
"maximum": 1048575
},
"acl-ip-source-port": {
"description": "Specifies the source port number for filtering",
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"acl-ip-source-port-bitmask": {
"description": "The mask applied to the source port number",
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"acl-ip-dest-port": {
"description": "Specifies the destination port number for filtering",
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"acl-ip-dest-port-bitmask": {
"description": "The mask applied to the destination port number",
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"acl-ipv4-fragment-offset": {
"description": "Filters based on IPv4 fragment offset for fragmented packets",
"type": "integer",
"minimum": 0,
"maximum": 8191
},
"acl-ipv6-fragment-offset": {
"description": "Filters based on IPv6 fragment offset for fragmented packets",
"type": "integer",
"minimum": 0,
"maximum": 8191
},
"acl-ip-ttl": {
"description": "Filters IPv4 traffic based on the TTL (Time to Live) value",
"type": "integer",
"minimum": 0,
"maximum": 255
},
"acl-ipv6-hop-limit": {
"description": "Filters IPv6 traffic based on the hop limit value, equivalent to IPv4 TTL",
"type": "integer",
"minimum": 0,
"maximum": 255
}
}
}
},
"mvr-config": {
"description": "This section defines the Multicast VLAN Registration (MVR) general configuration.",
"type": "object",
"properties": {
"mvr-enable": {
"description": "Enable/Disable MVR globally on the switch.",
"type": "boolean",
"default": false
},
"mvr-proxy-query-intvl": {
"description": "This command configures the interval (in seconds) at which the receiver port sends out general queries. The maximum value is determined based on 12 hours as maximum interval, and minimum as 1 second as allowed value.",
"type": "integer",
"default": 125,
"maximum": 43200,
"minimum": 1
},
"mvr-proxy-switching": {
"description": "Enable the MVR proxy switching mode, where the source port acts as a host, and the receiver port acts as an MVR router with querier service enabled.",
"type": "boolean",
"default": false
},
"mvr-robustness-val": {
"description": "Configure the expected packet loss, and thereby the number of times to generate report and group-specific queries when changes are learned about downstream groups, and the number of times group-specific queries are sent to downstream receiver ports. Right configuration ensures that multicast group memberships are correctly maintained even if some control messages are lost due to network issues.",
"type": "integer",
"default": 2,
"maximum": 255,
"minimum": 1
},
"mvr-source-port-mode": {
"description": "Configure the switch to forward only multicast streams that a source port has dynamically joined or to forward all multicast groups.",
"type": "string",
"default": "forward",
"enum": [
"dynamic",
"forward"
]
}
}
},
"mvr-domain-config": {
"description": "Configure the Multicast VLAN Registration (MVR) domains.",
"type": "array",
"items": {
"type": "object",
"properties": {
"mvr-domain-id": {
"description": "Unique identifier for a Multicast Domain defined under the MVR.",
"type": "integer",
"minimum": 1,
"maximum": 10,
"default": 1
},
"mvr-domain-enable": {
"description": "Enable/disable Multicast VLAN Registration (MVR) for a specific domain.",
"type": "boolean",
"default": false
},
"mvr-domain-vlan-id": {
"description": "Per domain Level Multicast VLAN ID. Specifies the VLAN through which MVR multicast data is received. This is the VLAN to which all source ports must be assigned.",
"type": "integer",
"minimum": 1,
"maximum": 4094,
"default": 1
},
"mvr-domain-upstream-sip": {
"description": "Configures the source IP address assigned to all MVR control packets sent upstream on all domains or on a specified domain.",
"type": "string",
"format": "ipv4",
"examples": [
"192.168.0.5"
]
}
}
}
},
"mvr-group-config": {
"type": "array",
"description": "List of MVR groups (or profiles) configuration.",
"items": {
"type": "object",
"properties": {
"mvr-group-name": {
"type": "string",
"description": "The name of a MVR group that consists of one or more MVR group addresses",
"maxLength": 16,
"minLength": 1
},
"mvr-group-range-start": {
"type": "string",
"format": "ipv4",
"description": "Start IP address on the range of MVR group addresses that maps to a profile/MVR group"
},
"mvr-group-range-end": {
"type": "string",
"format": "ipv4",
"description": "Statically configure all multicast group addresses that will join an MVR VLAN. Map a range of MVR group addresses to a profile"
},
"mvr-group-assoc-domain": {
"descpription": "Map the MVR Group to a secific domain. There can be many profiles under a single domain",
"type": "array",
"items": {
"type": "integer",
"maximum": 10,
"minimum": 1
}
}
},
"required": [
"mvr-group-name",
"mvr-group-range-start",
"mvr-group-range-end",
"mvr-group-assoc-domain"
]
}
},
"lldp-global-config": {
"type": "object",
"description": "Configuration options for LLDP on a global level in a OLS switch.",
"properties": {
"lldp-enable": {
"type": "boolean",
"default": true,
"description": "Enables or disables LLDP globally at a switch level."
},
"lldp-holdtime-multiplier": {
"type": "integer",
"description": "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.",
"default": 4
},
"lldp-med-fast-start-count": {
"type": "integer",
"description": "Configures how many medFastStart packets are transmitted during the activation process of the LLDP-MED Fast Start mechanism.",
"default": 4
},
"lldp-refresh-interval": {
"type": "integer",
"description": "Configures the periodic transmit interval for LLDP advertisements (in seconds).",
"default": 30
},
"lldp-reinit-delay": {
"type": "integer",
"description": "Configures the delay (in seconds) before reinitializing after LLDP ports are disabled or the link goes down.",
"default": 2
},
"lldp-tx-delay": {
"type": "integer",
"description": "Configures a delay (in seconds) between successive transmissions of advertisements initiated by a change in local LLDP state.",
"maximum": 8192,
"minimum": 1
},
"lldp-notification-interval": {
"type": "integer",
"description": "Configures the interval (in seconds) for sending SNMP notifications about LLDP changes.",
"default": 5
}
}
},
"mc-lag": {
"type": "boolean",
"description": "Enables MC-LAG or disables it.",
"default": false
},
"mclag-config": {
"description": "This section defines the MC-LAG configuration parameters for the switch.",
"type": "object",
"properties": {
"mclag-domains": {
"description": "List of MC-LAG domain configurations for the switch.",
"type": "array",
"items": {
"type": "object",
"properties": {
"mclag-domain": {
"description": "Specifies the MC-LAG domain ID to identify the grouping of peer switches.",
"type": "integer",
"minimum": 1,
"maximum": 1024,
"default": 1
},
"peer-link": {
"description": "Configures the peer-link, which could be a physical port or a trunk group that connects the two MC-LAG peer switches.",
"type": "object",
"properties": {
"type": {
"description": "Defines the type of peer-link, either 'port' or 'trunk-group'",
"type": "string",
"enum": [
"port",
"trunk-group"
],
"default": "trunk-group"
},
"value": {
"description": "Specifies the port or trunk-group ID for the peer-link.",
"type": "integer",
"minimum": 1,
"maximum": 64
}
}
},
"mclag-group": {
"description": "Configures the MC-LAG group, which binds the interfaces into a multi-chassis LAG.",
"type": "object",
"properties": {
"group-id": {
"description": "Defines the unique MC-LAG group identifier.",
"type": "integer",
"minimum": 1,
"maximum": 128
},
"members": {
"description": "List of interfaces that participate in the MC-LAG group.",
"type": "array",
"items": {
"type": "string",
"description": "Interface names that are part of the MC-LAG group.",
"examples": [
"eth0",
"eth1"
]
}
},
"lacp-config": {
"description": "LACP configuration settings for the MC-LAG group.",
"type": "object",
"properties": {
"lacp-enable": {
"description": "Enables or disables LACP for the MC-LAG group.",
"type": "boolean",
"default": true
},
"lacp-role": {
"description": "Configures the LACP role as 'actor' or 'partner'",
"type": "string",
"enum": [
"actor",
"partner"
],
"default": "actor"
},
"lacp-timeout": {
"description": "Sets the LACP timeout as either 'short' or 'long'.",
"type": "string",
"enum": [
"short",
"long"
],
"default": "long"
}
}
}
}
},
"system-priority": {
"description": "Specifies the system priority used by the switch for LACP negotiations.",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 32768
},
"dual-active-detection": {
"description": "Enables dual-active detection to prevent split-brain scenarios in MC-LAG.",
"type": "boolean",
"default": true
}
}
}
}
}
},
"voice-vlan-config": {
"description": "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": "object",
"properties": {
"voice-vlan-id": {
"description": "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.",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"voice-vlan-ageing-time": {
"description": "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.",
"type": "integer",
"minimum": 5,
"maximum": 43200,
"default": 1440
},
"voice-vlan-oui-config": {
"description": "Configures the Organizationally Unique Identifier (OUI) for identifying the voice devices (like IP phones).",
"type": "array",
"items": {
"type": "object",
"properties": {
"voice-vlan-oui-mac": {
"description": "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": "string",
"format": "uc-mac"
},
"voice-vlan-oui-mask": {
"description": "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",
"format": "uc-mac"
},
"voice-vlan-oui-description": {
"description": "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.",
"type": "string",
"maxLength": 32,
"minLength": 1,
"examples": [
"A VoIP Phone"
]
}
}
}
}
}
}
}
},
@@ -1490,6 +2243,42 @@
}
}
}
},
"mvr": {
"type": "object",
"description": "MVR attributes on a given interface",
"properties": {
"mvr-intf-mvr-role": {
"type": "string",
"description": "Configure an interface as an MVR receiver or source port. A port which is not configured as an MVR receiver or source port can use IGMP snooping to join or leave multicast groups using the standard rules for multicast filtering.",
"enum": [
"none",
"source",
"receiver"
]
},
"mvr-intf-immed-leave": {
"type": "string",
"description": "Switch to immediately remove an interface from a multicast stream as soon as it receives a leave message for that group. Applies to only receiver role ports.",
"enum": [
"none",
"by-host-ip",
"by-group"
],
"default": "by-group"
},
"mvr-intf-assoc-domain": {
"type": "integer",
"description": "Map the port to a specific domain.",
"maximum": 10,
"minimum": 1
}
},
"required": [
"mvr-intf-mvr-role",
"mvr-intf-immed-leave",
"mvr-intf-assoc-domain"
]
}
}
},
@@ -1513,6 +2302,48 @@
]
}
},
"dhcp-snoop-vlan-enable": {
"description": "Enables DHCP Snooping on a VLAN",
"type": "boolean",
"default": false
},
"voice-vlan-intf-config": {
"description": "Configure the Voice VLAN feature at the interface level, allowing for VoIP traffic to be prioritized on this specific port.",
"type": "object",
"properties": {
"voice-vlan-intf-mode": {
"description": "Specify the mode of placing this port on the voice VLAN.",
"type": "string",
"default": "auto",
"enum": [
"none",
"manual",
"auto"
]
},
"voice-vlan-intf-priority": {
"description": "Define the Class of Service (CoS) priority for VoIP traffic passing through this port, ensuring higher priority over other traffic types.",
"type": "integer",
"default": 6,
"minimum": 0,
"maximum": 6
},
"voice-vlan-intf-detect-voice": {
"description": "Select the detection method for identifying VoIP traffic on this port, such as OUI-based detection or traffic pattern recognition.",
"type": "string",
"default": "oui",
"enum": [
"oui",
"lldp"
]
},
"voice-vlan-intf-security": {
"description": "Enable or configure security filtering for VoIP traffic on the interface to protect against unauthorized devices.",
"type": "boolean",
"default": false
}
}
},
"dhcp": {
"$ref": "#/$defs/interface.ipv4.dhcp"
},
@@ -1712,6 +2543,72 @@
}
}
},
"interface.acl": {
"description": "A collection of access control entries that define the rules for filtering traffic through a network interface.",
"type": "array",
"items": {
"type": "object",
"properties": {
"acl-inf-policy-preference": {
"description": "Determines the priority of multiple ACL policies when more than one is applied to an interface, if any.",
"type": "integer",
"minimum": 1,
"maximum": 64,
"default": 1
},
"acl-inf-policy-ingress": {
"description": "Specifies the ACL policy that is applied to incoming traffic on an interface.",
"type": "string",
"maxLength": 32,
"minLength": 1,
"examples": [
"blacklisted-macs"
]
},
"acl-inf-counters-ingress": {
"description": "Tracks the number and type of packets that match the ingress ACL rules on an interface.",
"type": "boolean",
"default": false
},
"acl-inf-policy-egress": {
"description": "Specifies the ACL policy that is applied to outgoing traffic from an interface.",
"type": "string",
"maxLength": 32,
"minLength": 1,
"examples": [
"blacklisted-macs"
]
},
"acl-inf-counters-egress": {
"description": "Tracks the number and type of packets that match the egress ACL rules on an interface.",
"type": "boolean",
"default": false
}
}
}
},
"interface.dhcp-snoop-port": {
"description": "Configuration for DHCP Snooping on a port level on a switch",
"type": "object",
"properties": {
"dhcp-snoop-port-trust": {
"description": "This parameter designates a switch port as \u2018trusted\u2019 for DHCP messages, meaning it can forward DHCP offers and acknowledgments, which is essential for connecting to legitimate DHCP servers",
"type": "boolean",
"default": false
},
"dhcp-snoop-port-client-limit": {
"description": "It sets a limit on the number of DHCP clients that can be associated with a single port, helping to prevent a single port from exhausting the network\u2019s IP address pool",
"type": "integer",
"minimum": 1
},
"dhcp-snoop-port-circuit-id": {
"description": "Specifies DHCP Option 82 circuit ID suboption information. Often including information like the interface number and VLAN ID, this can be useful for network management and troubleshooting",
"type": "string",
"minLength": 1,
"maxLength": 32
}
}
},
"interface.broad-band.wwan": {
"description": "This Object defines the properties of a broad-band uplink.",
"type": "object",
@@ -3202,6 +4099,12 @@
"ipv6": {
"$ref": "#/$defs/interface.ipv6"
},
"acl": {
"$ref": "#/$defs/interface.acl"
},
"dhcp-snooop-port": {
"$ref": "#/$defs/interface.dhcp-snoop-port"
},
"broad-band": {
"$ref": "#/$defs/interface.broad-band"
},

View File

@@ -84,6 +84,10 @@
},
"lacp-trunks": {
"$ref": "#/$defs/lacp-trunks"
},
"uplink_interface": {
"type": "string",
"description": "Current interface that serves as the Uplink. Example Ethernet2."
}
},
"$defs": {
@@ -809,6 +813,159 @@
}
}
}
},
"mvr": {
"type": "object",
"description": "MVR statistics on interface",
"properties": {
"mvr-intf-fwd-status": {
"description": "Shows if MVR traffic is being forwarded or discarded.",
"type": "boolean"
},
"mvr-intf-igmp-count-reports": {
"description": "The number of IGMP membership reports received on this interface.",
"type": "integer"
},
"mvr-intf-igmp-count-leave": {
"description": "The number of leave messages received on this interface.",
"type": "integer"
},
"mvr-intf-igmp-count-gquery": {
"description": "The number of general query messages received on this interface.",
"type": "integer"
},
"mvr-intf-igmp-count-gssquery": {
"description": "The number of group specific or group-and-source specific query messages received on this interface.",
"type": "integer"
},
"mvr-intf-igmp-count-drop": {
"description": "The number of times a report, leave, or query was dropped.",
"type": "integer"
},
"mvr-intf-igmp-count-joinsucc": {
"description": "The number of times a multicast group was successfully joined.",
"type": "integer"
},
"mvr-intf-igmp-count-actgroups": {
"description": "The number of MVR groups active on this interface.",
"type": "integer"
}
}
},
"acl-stats": {
"description": "Represents the overall statistics for ACLs on the OLS device.",
"type": "object",
"properties": {
"acl-intf-stats": {
"description": "A list of ACL-related statistics, each corresponding to a specific interface or port.",
"type": "array",
"items": {
"type": "object",
"properties": {
"acl-intf-id": {
"description": "The identifier for the interface or port to which the ACL statistics apply.",
"type": "string"
},
"acl-type": {
"description": "Type of the access control list.",
"type": "string",
"enum": [
"none",
"ipv4",
"ipv6",
"ipv4Ext",
"ipv6Ext",
"mac",
"arp"
]
},
"acl-rule-action": {
"description": "Indicates the action (permit or deny) taken when an ACL rule is matched.",
"type": "string",
"enum": [
"permit",
"deny"
]
},
"acl-hit-count": {
"description": "The number of times an ACL rule has been matched by traffic.",
"type": "number"
},
"acl-rule-resource-util": {
"description": "Shows the percentage of this user-configured ACL rule as a percentage of total ACL rules.",
"type": "integer",
"minimum": 0,
"maximum": 100
}
}
}
}
}
},
"acl-resource-stats": {
"description": "Represents the overall resource utilization statistics for ACLs.",
"type": "object",
"properties": {
"acl-total-resource-util": {
"description": "Percentage of total ACL consumed resources amongst the resources available.",
"type": "integer",
"minimum": 0,
"maximum": 100
}
}
},
"dhcp-snoop-binding": {
"description": "State message entry to show the binding table for DHCP Snooping",
"type": "object",
"properties": {
"entries": {
"description": "List of DHCP Snooping binding entries",
"type": "array",
"items": {
"type": "object",
"properties": {
"dhcp-snoop-bind-mac-address": {
"description": "MAC address of the DHCP client in the DHCP Snooping binding table",
"type": "string",
"format": "uc-mac"
},
"dhcp-snoop-bind-ip-address": {
"description": "IP address assigned to the MAC address in the DHCP Snooping binding table",
"type": "string",
"format": "ipv4"
},
"dhcp-snoop-bind-lease-seconds": {
"description": "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": "integer"
},
"dhcp-snoop-bind-type": {
"description": "Specifies the type of binding entry, such as dynamic or static, indicating how the IP address was assigned to the client",
"type": "string",
"enum": [
"dynamic",
"static"
]
},
"dhcp-snoop-bind-vlan": {
"description": "VLAN ID associated with the DHCP client\u2019s IP address, which helps in managing network segments",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"dhcp-snoop-bind-interf": {
"description": "Identifies the interface through which the DHCP client is connected, aiding in network topology management",
"type": "string",
"examples": [
"Ethernet1",
"Unit-1/Port-2",
"1-2",
"Trunk 1"
]
}
}
}
}
}
}
}
}
@@ -844,6 +1001,160 @@
"port": {
"type": "string",
"description": "The physical network port that we see this neighbour on."
},
"lldp-remote-port-info": {
"type": "object",
"description": "Provides information about the remote port, such as the interface name and its operational status on the neighboring device.",
"properties": {
"lldp-remote-port-id": {
"type": "string",
"description": "The identifier for the remote port connected to the local port, often displayed as a string or number representing the remote interface."
},
"lldp-remote-port-id-type": {
"type": "string",
"description": "Specifies the type of identifier used for the remote port, such as MAC address, interface name, or ifIndex.",
"enum": [
"MAC Address",
"Interface Name",
"ifIndex"
]
},
"lldp-remote-ttl": {
"type": "integer",
"description": "Shows the time-to-live (TTL) value for LLDP advertisements from the remote device. This is the duration (in seconds) the LLDP information remains valid before expiring.\""
},
"lldp-remote-port-descr": {
"type": "string",
"description": "Provides a textual description of the remote port, typically describing the interface or its purpose.",
"example": "Ethernet Port on unit 1, port 2"
},
"lldp-remote-port-max-mtu": {
"type": "string",
"description": "Displays the maximum transmission unit (MTU) size that the remote port supports, indicating the largest packet size the port can handle."
},
"lldp-remote-sys-descr": {
"type": "string",
"description": "A textual description of the remote system, including the device model, software version, or any user-configured description.",
"example": "ECS4150-28P"
},
"lldp-remote-sys-capab": {
"type": "array",
"description": "Indicates the system capabilities advertised by the remote device, such as whether it supports routing, switching, bridging, etc.",
"items": {
"type": "string"
},
"example": [
"Switch",
"Bridge",
"Routing"
]
},
"lldp-remote-enabled-capab": {
"type": "array",
"description": "Displays the capabilities that are actually enabled on the remote device, such as routing, switching, or bridging functionality.",
"items": {
"type": "string"
},
"example": [
"Switch",
"Bridge",
"Routing"
]
},
"lldp-remote-port-mgmt-address": {
"type": "string",
"description": "The management IP address of the remote device, used to access the device for administrative purposes.",
"example": "192.168.0.4"
},
"lldp-remote-port-vlan-id": {
"type": "integer",
"description": "Shows the VLAN ID associated with the remote port, which could indicate the native VLAN or the port's trunk configuration."
},
"lldp-remote-port-protocol-id": {
"type": "string",
"description": "Identifies any protocol-specific information (in HEX) advertised by the remote device, such as VLAN, Spanning Tree, or Link Aggregation protocol."
},
"lldp-remote-port-mac-phy-status": {
"type": "object",
"description": "Displays the physical layer status of the remote port.",
"properties": {
"lldp-remote-port-aneg-suport": {
"type": "boolean",
"description": "Indicates whether the remote port supports auto-negotiation of link parameters like speed and duplex settings."
},
"lldp-remote-port-aneg-enabled": {
"type": "boolean",
"description": "Shows whether auto-negotiation is enabled on the remote port."
},
"lldp-remote-port-aneg-advertised-cap": {
"type": "string",
"description": "Lists the capabilities (in HEX) the remote port is advertising during auto-negotiation, such as supported speeds and duplex modes."
},
"lldp-remote-port-mau-type": {
"type": "integer",
"description": "Displays the Media Access Unit (MAU) type, describing the port's physical characteristics (e.g., copper or fiber, 10/100/1000Base-T, etc.)."
}
}
},
"lldp-remote-port-power-info": {
"type": "object",
"description": "Provides detailed PoE information.",
"properties": {
"lldp-remote-port-power-class": {
"type": "string",
"description": "Indicates if the device is a PSE or a PD.",
"enum": [
"pse",
"pd"
]
},
"lldp-remote-port-power-mdi-support": {
"type": "boolean",
"description": "Indicates whether the remote device supports Media Dependent Interface (MDI) power supply, allowing power to be supplied through the Ethernet cable."
},
"lldp-remote-port-power-mdi-enabled": {
"type": "boolean",
"description": "Shows whether MDI power is currently enabled on the remote port."
},
"lldp-remote-port-power-pair-control": {
"type": "boolean",
"description": "Displays whether the remote device has control over which wire pairs in the Ethernet cable provide power (important for PoE)."
},
"lldp-remote-port-power-classification": {
"type": "string",
"description": "Displays the PoE class of the remote device, indicating its power consumption classification.",
"enum": [
"Class-1",
"Class-2",
"Class-3",
"Class-4",
"Class-5",
"Class-6",
"Class-7",
"Class-8"
]
}
}
},
"lldp-remote-port-lag-info": {
"type": "object",
"description": "Provides information about the remote port\u2019s involvement in Link Aggregation Groups (LAG), if applicable.",
"properties": {
"lldp-remote-port-lag-support": {
"type": "boolean",
"description": "Indicates whether the remote port supports Link Aggregation (static or LACP)."
},
"lldp-remote-port-lag-enabled": {
"type": "boolean",
"description": "Shows whether Link Aggregation is enabled on the remote port."
},
"lldp-remote-port-lag-port-id": {
"type": "integer",
"description": "Displays the identifier of the Link Aggregation Group (LAG) that the remote port belongs to."
}
}
}
}
}
}
}