Type: object

uCentral protocol (OpenLan) device and features capabilities schema

root serial
Type: string

Example:

"aabbccddeeff"

root firmware
Type: string

Platform revision
Example:

"Rel 1.6 build 5"

root version
Type: object

Switch version info, OLS release and schema.

root version switch
Type: object

the ols client version for this Switch
Example:

{
    "major": 3,
    "minor": 2,
    "patch": 0
}

root version switch major
Type: integer

root version switch minor
Type: integer

root version switch patch
Type: integer

root version schema
Type: object

the ols schema version used with the ols client.
Example:

{
    "major": 3,
    "minor": 2,
    "patch": 0
}

root version schema major
Type: integer

root version schema minor
Type: integer

root version schema patch
Type: integer

root platform
Type: enum (of string)

Must be one of:

  • "Switch"
  • "AP"

root model
Type: string

Device model

root hw-sku
Type: string

Stock keeping unit

root compatible
Type: string

Compatibility string, that defines the family of the device

root base-mac
Type: stringFormat: uc-mac

Switch MAC address
Example:

"aa:bb:cc:dd:ee:ff"

root port-list
Type: array of object

The list of physical network devices

 No Additional Items

Each item of this array must be:

root port-list port-list items
Type: object

root port-list port-list items name
Type: string

The logical name of the port that is used by the OS
Examples:

"Ethernet0"

"Ethernet1"

"Ethernet76"

root port-list port-list items front-panel-number
Type: integer

The identification number of the port as can be seen on the front-panel of the device

root port-capabilities
Type: object

Description of physical ports and their form-factors

root port-capabilities form-factors
Type: array of enum (of string)
No Additional Items

Each item of this array must be:

root port-capabilities form-factors form-factors items
Type: enum (of string)

Must be one of:

  • "RJ45"
  • "SFP"
  • "SFP+"
  • "SFP28"
  • "SFP-DD"
  • "QSFP"
  • "QSFP+"
  • "QSFP28"
  • "QSFP-DD"

root port-capabilities ports-list
Type: array of object
No Additional Items

Each item of this array must be:

root port-capabilities ports-list ports-list items
Type: object

root port-capabilities ports-list ports-list items type
Type: string

Example:

"RJ45"

root port-capabilities ports-list ports-list items ports
Type: array of string
No Additional Items

Each item of this array must be:

root port-capabilities ports-list ports-list items ports ports items
Type: string

Example:

"Ethernet1"

root poe-capabilities
Type: object

Description of physical ports and their PoE capabilities

root poe-capabilities supported-standards
Type: array of enum (of string)
No Additional Items

Each item of this array must be:

root poe-capabilities supported-standards supported-standards items
Type: enum (of string)

Must be one of:

  • ".3AF-POE"
  • ".3AT-POE+"
  • ".3BT-PoE++"
  • "PreStandard-Passive"

root poe-capabilities power-budget
Type: integer

Example:

2000

root poe-capabilities poe-ports
Type: array of object
No Additional Items

Each item of this array must be:

root poe-capabilities poe-ports poe-ports items
Type: object

root poe-capabilities poe-ports poe-ports items type
Type: string

Example:

".3AF-POE"

root poe-capabilities poe-ports poe-ports items ports
Type: array of string
No Additional Items

Each item of this array must be:

root poe-capabilities poe-ports poe-ports items ports ports items
Type: string

Example:

"Ethernet1"

root mclag-capabilities
Type: object

Capabilities of the MC-LAG (Multi-Chassis Link Aggregation) feature in the switch

root mclag-capabilities max-mclag-groups
Type: integer

Defines the maximum number of MC-LAG groups that can be configured on the switch.

root mclag-capabilities max-ports-per-mclag-group
Type: integer

Specifies the maximum number of physical ports that can be part of a single MC-LAG group.

root mclag-capabilities max-vlans-per-mclag-group
Type: integer

Indicates the maximum number of VLANs that can be supported within a single MC-LAG group.

root mclag-capabilities dual-active-detection
Type: enum (of string)

Describes the dual-active detection mechanism to prevent both switches from becoming active simultaneously.

Must be one of:

  • "ICCP"
  • "Backup-Link"
  • "None"

root mclag-capabilities failover-time-milliseconds
Type: integer

Specifies the time (in milliseconds) required for traffic to fail over to the secondary switch when there is a failure in the primary switch.

root mclag-capabilities vlan-synchronization
Type: boolean

Indicates whether VLAN synchronization across MC-LAG peers is supported and the number of VLANs that can be synchronized.

root mclag-capabilities max-mac-entries-per-mclag
Type: integer

Maximum number of MAC address entries that can be synchronized across MC-LAG peers.

root lldp-capabilities
Type: object

Description of LLDP capabilities across different switch models/vendors.

root lldp-capabilities supported-tlvs
Type: array of enum (of string)
No Additional Items

Each item of this array must be:

root lldp-capabilities supported-tlvs supported-tlvs items
Type: enum (of string)

Must be one of:

  • "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"

root lldp-capabilities max-neighbors
Type: integer

Maximum number of LLDP neighbors a switch can discover and maintain.
Examples:

64

128

256

root supported-features
Type: array of enum (of string)

List of all features supported by the device

 No Additional Items

Each item of this array must be:

root supported-features supported-features items
Type: enum (of string)

Must be one of:

  • "VLAN"
  • "VLAN-Voice"
  • "Jumbo-Frames"
  • "Link-Aggregation-LACP"
  • "Link-Aggregation-Static"
  • "Link-Aggregation-MCLAG"
  • "Port-Isolation"
  • "Spanning-Tree"
  • "Spanning-Tree-Rapid"
  • "Spanning-Tree-Per-VLAN"
  • "Spanning-Tree-Per-VLAN-Rapid"
  • "Spanning-Tree-MSTP"
  • "SVI-StaticIPv4"
  • "SVI-StaticIPv6"
  • "Interface-StaticIPv4"
  • "Interface-StaticIPv6"
  • "Routing-VRF"
  • "Routing-IPv4-Route-Blackhole"
  • "Routing-IPv4-Route-Unreachable"
  • "Routing-IPv4-Nexthop"
  • "Routing-IPv4-Broadcast"
  • "Routing-IPv4-Multicast-IGMP-Snooping"
  • "Routing-IPv4-Multicast-IGMP-Querier"
  • "Routing-IPv4-Multicast-IGMP-Static"
  • "Routing-IPv4-DHCP-Server"
  • "Routing-IPv4-DHCP-Relay"
  • "Routing-IPv4-DHCP-Snooping"
  • "Routing-IPv4-Port-Forward"
  • "Routing-IPv6-DHCP-Relay"
  • "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"
  • "Service-LLDP"
  • "Service-HTTP"
  • "Service-HTTPS"
  • "Service-GPS"
  • "Service-IGMP"
  • "Service-NTP"
  • "Service-NTP-Client"
  • "Service-MDNS"
  • "Service-QoS"
  • "Service-Syslog"
  • "Service-PAC"
  • "Service-Wireguard-Overlay"
  • "Service-Radius-Proxy"
  • "Service-Online-Check"
  • "Service-CaptivePortal"
  • "Service-PublicIpCheck"
  • "Tunneling-VxLAN"
  • "Tunneling-GRE"
  • "Tunneling-GRE6"
  • "Tunneling-L2TP"
  • "Tunneling-Mesh"