diff --git a/docs/ucentral-schema.html b/docs/ucentral-schema.html index 3da1332..e9a0ff0 100644 --- a/docs/ucentral-schema.html +++ b/docs/ucentral-schema.html @@ -39,10 +39,10 @@
List of MVR groups (or profiles) configuration.
No Additional ItemsThe name of a MVR group that consists of one or more MVR group addresses
Must be at least 1 characters long
Must be at most 16 characters long
Start IP address on the range of MVR group addresses that maps to a profile/MVR group
Statically configure all multicast group addresses that will join an MVR VLAN. Map a range of MVR group addresses to a profile
Value must be greater or equal to 1 and lesser or equal to 10
Configuration options for LLDP on a global level in a OLS switch.
Enables or disables LLDP globally at a switch level.
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.
Configures how many medFastStart packets are transmitted during the activation process of the LLDP-MED Fast Start mechanism.
Configures the periodic transmit interval for LLDP advertisements (in seconds).
Configures the delay (in seconds) before reinitializing after LLDP ports are disabled or the link goes down.
Configures a delay (in seconds) between successive transmissions of advertisements initiated by a change in local LLDP state.
Value must be greater or equal to 1 and lesser or equal to 8192
Configures the interval (in seconds) for sending SNMP notifications about LLDP changes.
Enables MC-LAG or disables it.
This section defines the MC-LAG configuration parameters for the switch.
List of MC-LAG domain configurations for the switch.
No Additional ItemsSpecifies the MC-LAG domain ID to identify the grouping of peer switches.
Value must be greater or equal to 1 and lesser or equal to 1024
Configures the peer-link, which could be a physical port or a trunk group that connects the two MC-LAG peer switches.
Defines the type of peer-link, either 'port' or 'trunk-group'
Specifies the port or trunk-group ID for the peer-link.
Value must be greater or equal to 1 and lesser or equal to 64
Configures the MC-LAG group, which binds the interfaces into a multi-chassis LAG.
Defines the unique MC-LAG group identifier.
Value must be greater or equal to 1 and lesser or equal to 128
List of interfaces that participate in the MC-LAG group.
No Additional ItemsInterface names that are part of the MC-LAG group.
"eth0"
"eth1"
LACP configuration settings for the MC-LAG group.
Enables or disables LACP for the MC-LAG group.
Configures the LACP role as 'actor' or 'partner'
Sets the LACP timeout as either 'short' or 'long'.
Specifies the system priority used by the switch for LACP negotiations.
Value must be greater or equal to 1 and lesser or equal to 65535
Enables dual-active detection to prevent split-brain scenarios in MC-LAG.
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.
Specifies the VLAN ID assigned to the Voice VLAN. This is the unique identifier for the VLAN that will be used for prioritizing voice traffic.
Value must be greater or equal to 1 and lesser or equal to 4094
Defines the time, in minutes, that a dynamic Voice VLAN entry remains in the VLAN after voice traffic is no longer detected. It helps manage resources by removing inactive voice devices from the VLAN after this time elapses.
Value must be greater or equal to 5 and lesser or equal to 43200
Configures the Organizationally Unique Identifier (OUI) for identifying the voice devices (like IP phones).
No Additional ItemsThe specific MAC address pattern that corresponds to voice devices, as determined by the OUI. It is used for identifying and classifying voice traffic.
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.
A descriptive label or comment for the OUI configuration. This can help administrators keep track of which OUI belongs to which type of voice device or vendor.
Must be at least 1 characters long
Must be at most 32 characters long
"A VoIP Phone"
-Global configuration for ARP Inspection on the switch.
Enable or disable ARP Inspection globally.
Validate that the destination MAC address in the Ethernet header matches the target MAC address in the ARP body for ARP responses.
Validate ARP packets for unexpected or invalid IP addresses, such as 0.0.0.0, 255.255.255.255, and IP multicast addresses.
Allow ARP packets where the sender IP address is 0.0.0.0.
Validate that the source MAC address in the Ethernet header matches the sender MAC address in the ARP body for both ARP requests and responses.
Configuration for IP Source Guard global static bindings in a Layer 2 switch.
List of static bindings for IP Source Guard.
No Additional ItemsSpecifies the mode for adding a static address to the Source Guard ACL or MAC address binding table. It determines whether the binding is based on MAC addresses or ACLs.
A valid unicast MAC address for binding to the Source Guard filtering table.
The VLAN ID associated with the static binding for Source Guard filtering. Must be a valid, configured VLAN on the switch.
A valid unicast IPv4 address to associate with the Source Guard filtering table.
The physical interface (e.g., ethernet0, ethernet1) where the Source Guard binding applies.
Configuration for enabling or disabling specific event categories and their sub-events.
Enable/Disable Port Status events.
Enable/Disable Port Status category.
Enable/Disable carrier down event.
Enable/Disable carrier up event.
Enable/Disable Module events.
Enable/Disable Module category.
Enable/Disable module plugout event.
Enable/Disable module plugin event.
Enable/Disable STP events.
Enable/Disable STP category.
Enable/Disable loop detected event.
Enable/Disable loop cleared event.
Enable/Disable state change event.
Enable/Disable RSTP events.
Enable/Disable RSTP category.
Enable/Disable loop detected event.
Enable/Disable loop cleared event.
Enable/Disable state change event.
Enable/Disable Firmware Upgrade events.
Enable/Disable Firmware Upgrade category.
Enable/Disable download start event.
Enable/Disable download in progress event.
Enable/Disable download failed event.
Enable/Disable validation start event.
Enable/Disable validation success event.
Enable/Disable validation failed event.
Enable/Disable firmware backup event.
Enable/Disable install start event.
Enable/Disable install failed event.
Enable/Disable reboot start event.
Enable/Disable upgrade success event.
Enable/Disable DHCP Snooping events.
Enable/Disable DHCP Snooping category.
Enable/Disable DHCP Snooping violation detected event.
Enable/Disable DHCP Snooping violation cleared event.
Contains all the access control rule definitions
All items must be unique
No Additional ItemsThe identifier or name for the Access Control List
Must be at least 1 characters long
Must be at most 32 characters long
Type of the access control list
access control rules under this ACL
Each additional property must conform to the following schema
Type: array of objectAll items must be unique
No Additional ItemsDefines whether to permit or deny traffic matching the rule
Specifies the source MAC address to filter on
The mask applied to the source MAC address
Specifies the destination MAC address for the filter
The mask applied to the destination MAC address
Identifies the protocol encapsulated in the Ethernet frame by its EtherType
Specifies a VLAN ID to filter traffic from a specific VLAN
Value must be greater or equal to 1 and lesser or equal to 4094
The mask applied to the VLAN ID
Value must be greater or equal to 1 and lesser or equal to 4095
Filters packets based on the custom EtherType field (HEX) in the Ethernet frame
The mask applied to the EtherType field
Filters based on the Class of Service (CoS) field in the frame
Value must be greater or equal to 0 and lesser or equal to 7
The mask applied to the CoS field
Value must be greater or equal to 0 and lesser or equal to 7
The IPv4 address of the source to filter on
The subnet mask applied to the source IPv4 address
The IPv4 address of the destination to filter on
The subnet mask applied to the destination IPv4 address
Filters based on the IP protocol number
Value must be greater or equal to 0 and lesser or equal to 255
This section describes the logical network interfaces of the device. Interfaces as their primary have a role that is upstream, downstream, guest, ....
This is a free text field, stating the administrative name of the interface. It may contain spaces and special characters.
"LAN"
+Global configuration for ARP Inspection on the switch.
Enable or disable ARP Inspection globally.
Validate that the destination MAC address in the Ethernet header matches the target MAC address in the ARP body for ARP responses.
Validate ARP packets for unexpected or invalid IP addresses, such as 0.0.0.0, 255.255.255.255, and IP multicast addresses.
Allow ARP packets where the sender IP address is 0.0.0.0.
Validate that the source MAC address in the Ethernet header matches the sender MAC address in the ARP body for both ARP requests and responses.
Configuration for IP Source Guard global static bindings in a Layer 2 switch.
List of static bindings for IP Source Guard.
No Additional ItemsSpecifies the mode for adding a static address to the Source Guard ACL or MAC address binding table. It determines whether the binding is based on MAC addresses or ACLs.
A valid unicast MAC address for binding to the Source Guard filtering table.
The VLAN ID associated with the static binding for Source Guard filtering. Must be a valid, configured VLAN on the switch.
A valid unicast IPv4 address to associate with the Source Guard filtering table.
The physical interface (e.g., ethernet0, ethernet1) where the Source Guard binding applies.
Configuration for enabling or disabling specific event categories and their sub-events.
Enable/Disable Port Status events.
Enable/Disable Port Status category.
Enable/Disable carrier down event.
Enable/Disable carrier up event.
Enable/Disable Module events.
Enable/Disable Module category.
Enable/Disable module plugout event.
Enable/Disable module plugin event.
Enable/Disable STP events.
Enable/Disable STP category.
Enable/Disable loop detected event.
Enable/Disable loop cleared event.
Enable/Disable state change event.
Enable/Disable RSTP events.
Enable/Disable RSTP category.
Enable/Disable loop detected event.
Enable/Disable loop cleared event.
Enable/Disable state change event.
Enable/Disable Firmware Upgrade events.
Enable/Disable Firmware Upgrade category.
Enable/Disable download start event.
Enable/Disable download in progress event.
Enable/Disable download failed event.
Enable/Disable validation start event.
Enable/Disable validation success event.
Enable/Disable validation failed event.
Enable/Disable firmware backup event.
Enable/Disable install start event.
Enable/Disable install failed event.
Enable/Disable reboot start event.
Enable/Disable upgrade success event.
Enable/Disable DHCP Snooping events.
Enable/Disable DHCP Snooping category.
Enable/Disable DHCP Snooping violation detected event.
Enable/Disable DHCP Snooping violation cleared event.
Contains all the access control rule definitions
All items must be unique
No Additional ItemsThe identifier or name for the Access Control List
Must be at least 1 characters long
Must be at most 32 characters long
Type of the access control list
access control rules under this ACL
Each additional property must conform to the following schema
Type: array of objectAll items must be unique
No Additional ItemsDefines whether to permit or deny traffic matching the rule
Specifies the source MAC address to filter on
The mask applied to the source MAC address
Specifies the destination MAC address for the filter
The mask applied to the destination MAC address
Identifies the protocol encapsulated in the Ethernet frame by its EtherType
Specifies a VLAN ID to filter traffic from a specific VLAN
Value must be greater or equal to 1 and lesser or equal to 4094
The mask applied to the VLAN ID
Value must be greater or equal to 1 and lesser or equal to 4095
Filters packets based on the custom EtherType field (HEX) in the Ethernet frame
The mask applied to the EtherType field
Filters based on the Class of Service (CoS) field in the frame
Value must be greater or equal to 0 and lesser or equal to 7
The mask applied to the CoS field
Value must be greater or equal to 0 and lesser or equal to 7
The IPv4 address of the source to filter on
The subnet mask applied to the source IPv4 address
The IPv4 address of the destination to filter on
The subnet mask applied to the destination IPv4 address
Filters based on the IP protocol number
Value must be greater or equal to 0 and lesser or equal to 255
Define a global list of dns servers.
No Additional ItemsThis section describes the logical network interfaces of the device. Interfaces as their primary have a role that is upstream, downstream, guest, ....
This is a free text field, stating the administrative name of the interface. It may contain spaces and special characters.
"LAN"
The role defines if the interface is upstream or downstream facing.
This option makes sure that any traffic leaving this interface is isolated and all local IP ranges are blocked. It essentially enforces "guest network" firewall settings.
The routing metric of this logical interface. Lower values have higher priority.
Value must be greater or equal to 0 and lesser or equal to 4294967295
The MTU of this logical interface.
Value must be greater or equal to 1280 and lesser or equal to 1500
The services that shall be offered on this logical interface. These are just strings such as "ssh", "lldp", "mdns"
No Additional Items"ssh"
"lldp"
-Setup additional VLANs inside the bridge
This section describes the vlan behaviour of a logical network interface.
This is the pvid of the vlan that shall be assigned to the interface. The individual physical network devices contained within the interface need to be told explicitly if egress traffic shall be tagged.
Value must be lesser or equal to 4050
This section describes the bridge behaviour of a logical network interface.
The MTU that shall be used by the network interface.
Value must be greater or equal to 256 and lesser or equal to 65535
1500
+Setup additional VLANs inside the bridge
This section describes the vlan behaviour of a logical network interface.
This is the pvid of the vlan that shall be assigned to the interface. The individual physical network devices contained within the interface need to be told explicitly if egress traffic shall be tagged.
Value must be lesser or equal to 4094
Value must be lesser or equal to 4094
Value must be lesser or equal to 4094
This section describes the bridge behaviour of a logical network interface.
The MTU that shall be used by the network interface.
Value must be greater or equal to 256 and lesser or equal to 65535
1500
The Transmit Queue Length is a TCP/IP stack network interface value that sets the number of packets allowed per kernel transmit queue of a network interface device.
5000
Isolates the bridge ports from each other.
This section defines the physical copper/fiber ports that are members of the interface. Network devices are referenced by their logical names.
The list of physical network devices that shall be added to the interface. The names are logical ones and wildcardable. "WAN" will use whatever the hardwares default upstream facing port is. "LANx" will use the "x'th" downstream facing ethernet port. LAN* will use all downstream ports.
No Additional Items"LAN1"
"LAN2"
@@ -114,4 +114,4 @@
"system.ntp.server",
"1.openwrt.pool.ntp.org"
]
-Additional Properties of any type are allowed.
Type: object