mirror of
https://github.com/Telecominfraproject/ols-ucentral-schema.git
synced 2025-10-29 01:02:20 +00:00
377 lines
14 KiB
JSON
377 lines
14 KiB
JSON
{
|
|
"description": "uCentral protocol (OpenLan) device and features capabilities schema",
|
|
"type": "object",
|
|
"properties": {
|
|
"serial": {
|
|
"type": "string",
|
|
"examples": [
|
|
"aabbccddeeff"
|
|
]
|
|
},
|
|
"firmware": {
|
|
"type": "string",
|
|
"description": "Platform revision",
|
|
"examples": [
|
|
"Rel 1.6 build 5"
|
|
]
|
|
},
|
|
"version": {
|
|
"type": "object",
|
|
"description": "Switch version info, OLS release and schema.",
|
|
"properties": {
|
|
"switch": {
|
|
"type": "object",
|
|
"description": "the ols client version for this Switch",
|
|
"properties": {
|
|
"major": {
|
|
"type": "integer"
|
|
},
|
|
"minor": {
|
|
"type": "integer"
|
|
},
|
|
"patch": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"examples": [
|
|
{
|
|
"major": 3,
|
|
"minor": 2,
|
|
"patch": 0
|
|
}
|
|
]
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"description": "the ols schema version used with the ols client.",
|
|
"properties": {
|
|
"major": {
|
|
"type": "integer"
|
|
},
|
|
"minor": {
|
|
"type": "integer"
|
|
},
|
|
"patch": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"examples": [
|
|
{
|
|
"major": 3,
|
|
"minor": 2,
|
|
"patch": 0
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"platform": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Switch",
|
|
"AP"
|
|
]
|
|
},
|
|
"model": {
|
|
"type": "string",
|
|
"description": "Device model"
|
|
},
|
|
"hw-sku": {
|
|
"type": "string",
|
|
"description": "Stock keeping unit"
|
|
},
|
|
"compatible": {
|
|
"type": "string",
|
|
"description": "Compatibility string, that defines the family of the device"
|
|
},
|
|
"base-mac": {
|
|
"type": "string",
|
|
"description": "Switch MAC address",
|
|
"format": "uc-mac",
|
|
"examples": [
|
|
"aa:bb:cc:dd:ee:ff"
|
|
]
|
|
},
|
|
"port-list": {
|
|
"type": "array",
|
|
"description": "The list of physical network devices",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "The logical name of the port that is used by the OS",
|
|
"examples": [
|
|
"Ethernet0",
|
|
"Ethernet1",
|
|
"Ethernet76"
|
|
]
|
|
},
|
|
"front-panel-number": {
|
|
"type": "integer",
|
|
"description": "The identification number of the port as can be seen on the front-panel of the device"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"port-capabilities": {
|
|
"type": "object",
|
|
"description": "Description of physical ports and their form-factors",
|
|
"properties": {
|
|
"form-factors": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"RJ45",
|
|
"SFP",
|
|
"SFP+",
|
|
"SFP28",
|
|
"SFP-DD",
|
|
"QSFP",
|
|
"QSFP+",
|
|
"QSFP28",
|
|
"QSFP-DD"
|
|
]
|
|
}
|
|
},
|
|
"ports-list": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"examples": [
|
|
"RJ45"
|
|
]
|
|
},
|
|
"ports": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"examples": [
|
|
"Ethernet1"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"poe-capabilities": {
|
|
"type": "object",
|
|
"description": "Description of physical ports and their PoE capabilities",
|
|
"properties": {
|
|
"supported-standards": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
".3AF-POE",
|
|
".3AT-POE+",
|
|
".3BT-PoE++",
|
|
"PreStandard-Passive"
|
|
]
|
|
}
|
|
},
|
|
"power-budget": {
|
|
"type": "integer",
|
|
"examples": [
|
|
2000
|
|
]
|
|
},
|
|
"poe-ports": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"examples": [
|
|
".3AF-POE"
|
|
]
|
|
},
|
|
"budget-capacity": {
|
|
"type": "integer"
|
|
},
|
|
"ports": {
|
|
"type": "array",
|
|
"items": {
|
|
"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": "List of all features supported by the device",
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"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",
|
|
"BPDU-Guard",
|
|
"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",
|
|
"Storm-Control",
|
|
"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",
|
|
"Service-Global-DNS",
|
|
"Tunneling-VxLAN",
|
|
"Tunneling-GRE",
|
|
"Tunneling-GRE6",
|
|
"Tunneling-L2TP",
|
|
"Tunneling-Mesh"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"$defs": {}
|
|
} |