Files
ols-ucentral-schema/schema/interface.yml
Mike Hansen 0ed83ba0a5 [OLS-545] Removal of AP specific schema elements from ols-ucentral-schema
Remove the AP specific elements of the schema (configuration), and state (reporting)
Remove the ucode files that are not used
Regenerate the json and documentation files to reflect schema and state changes

Signed-off-by: Mike Hansen <mike.hansen@netexperience.com>
2025-01-09 09:51:36 -05:00

79 lines
2.1 KiB
YAML

description:
This section describes the logical network interfaces of the device.
Interfaces as their primary have a role that is upstream, downstream,
guest, ....
type: object
properties:
name:
description:
This is a free text field, stating the administrative name of the
interface. It may contain spaces and special characters.
type: string
examples:
- LAN
role:
description:
The role defines if the interface is upstream or downstream facing.
type: string
enum:
- upstream
- downstream
isolate-hosts:
description:
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.
type: boolean
metric:
description:
The routing metric of this logical interface. Lower values have higher
priority.
type: integer
maximum: 4294967295
minimum: 0
mtu:
description:
The MTU of this logical interface.
type: integer
maximum: 1500
minimum: 1280
services:
description:
The services that shall be offered on this logical interface. These are
just strings such as "ssh", "lldp", "mdns"
type: array
items:
type: string
examples:
- ssh
- lldp
vlan-awareness:
description:
Setup additional VLANs inside the bridge
type: object
properties:
first:
type: integer
last:
type: integer
vlan:
$ref: "https://ucentral.io/schema/v1/interface/vlan/"
bridge:
$ref: "https://ucentral.io/schema/v1/interface/bridge/"
ethernet:
type: array
items:
$ref: "https://ucentral.io/schema/v1/interface/ethernet/"
ipv4:
$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-snoop-port:
$ref: "https://ucentral.io/schema/v1/interface/dhcp-snoop-port/"
broad-band:
$ref: "https://ucentral.io/schema/v1/interface/broad-band/"
tunnel:
$ref: "https://ucentral.io/schema/v1/interface/tunnel/"