Datasets:
dataunitylab
/
json-schema-descriptions

Dataset card Data Studio Files Community
1
schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
ifstate.conf.schema.json
kind
qdisk type
{"const": "mq"}
ifstate.conf.schema.json
children
list child qdiscs for each device TX queue
{"type": "array", "items": {}}
ifstate.conf.schema.json
items
child qdiscs for the nth device TX queue
{}
ifstate.conf.schema.json
tc-cake
[cake](https://man7.org/linux/man-pages/man8/tc-cake.8.html) - common applications kept enhanced (CAKE)
{"required": ["kind"], "properties": {"kind": {"const": "cake"}, "handle": {}, "ack_filter": {"type": ["boolean", "string"], "enum": ["aggressive", true, false]}, "atm_mode": {"type": ["boolean", "string"], "enum": ["ptm", true, false]}, "autorate": {"type": "boolean"}, "diffserv_mode": {"type": "string", "enum": ["diffserv3", "diffserv4", "diffserv8", "besteffort", "precedence"]}, "ingress": {"type": "boolean"}, "overhead": {"type": "integer", "minimum": -64, "maximum": 256}, "flow_mode": {"type": "string", "enum": ["flowblind", "srchost", "dsthost", "hosts", "flows", "dual-srchost", "dual-dsthost", "triple-isolated"]}, "fwmark": {"type": "integer", "minimum": 0}, "memlimit": {"type": "integer", "minimum": 0}, "mpu": {"type": "integer", "minimum": 0, "maximum": 256}, "nat": {"type": "boolean"}, "raw": {"type": "boolean"}, "rtt": {"oneOf": [{"type": "string", "enum": ["datacentre", "lan", "metro", "regional", "internet", "oceanic", "satellite", "interplanetary"]}, {"type": "integer", "minimum": 1}]}, "split_gso": {"type": "boolean"}, "target": {"type": "integer", "minimum": 1}, "wash": {"type": "boolean"}}}
ifstate.conf.schema.json
kind
qdisk type
{"const": "cake"}
ifstate.conf.schema.json
handle
unique id
{}
ifstate.conf.schema.json
ack_filter
ACKnowledge filter
{"type": ["boolean", "string"], "enum": ["aggressive", true, false]}
ifstate.conf.schema.json
atm_mode
ATM mode
{"type": ["boolean", "string"], "enum": ["ptm", true, false]}
ifstate.conf.schema.json
autorate
autorate-ingress
{"type": "boolean"}
ifstate.conf.schema.json
diffserv_mode
diffserv mode
{"type": "string", "enum": ["diffserv3", "diffserv4", "diffserv8", "besteffort", "precedence"]}
ifstate.conf.schema.json
ingress
ingress
{"type": "boolean"}
ifstate.conf.schema.json
overhead
overhead
{"type": "integer", "minimum": -64, "maximum": 256}
ifstate.conf.schema.json
flow_mode
flow mode
{"type": "string", "enum": ["flowblind", "srchost", "dsthost", "hosts", "flows", "dual-srchost", "dual-dsthost", "triple-isolated"]}
ifstate.conf.schema.json
fwmark
fwmark
{"type": "integer", "minimum": 0}
ifstate.conf.schema.json
memlimit
memlimit
{"type": "integer", "minimum": 0}
ifstate.conf.schema.json
mpu
MPU
{"type": "integer", "minimum": 0, "maximum": 256}
ifstate.conf.schema.json
nat
NAT
{"type": "boolean"}
ifstate.conf.schema.json
raw
RAW
{"type": "boolean"}
ifstate.conf.schema.json
rtt
well-known RTT
{"type": "string", "enum": ["datacentre", "lan", "metro", "regional", "internet", "oceanic", "satellite", "interplanetary"]}
ifstate.conf.schema.json
rtt
manually specify an RTT (us)
{"type": "integer", "minimum": 1}
ifstate.conf.schema.json
split_gso
split GSO
{"type": "boolean"}
ifstate.conf.schema.json
target
target
{"type": "integer", "minimum": 1}
ifstate.conf.schema.json
wash
wash
{"type": "boolean"}
ifstate.conf.schema.json
iface-tc_action
traffic control filter action
{"type": "array", "items": {"type": "object", "required": ["kind"], "properties": {"kind": {"const": "mirred"}}, "oneOf": [{"additionalProperties": false, "required": ["direction", "action", "dev"], "properties": {"kind": {"const": "mirred"}, "direction": {"type": "string", "enum": ["ingress", "egress"]}, "action": {"type": "string", "enum": ["mirror", "redirect"]}, "dev": {}, "index": {"type": "integer", "minimum": 0, "maximum": 4294967295}}}]}}
ifstate.conf.schema.json
items
[mirred](https://man7.org/linux/man-pages/man8/tc-mirred.8.html) - mirror/redirect action
{"additionalProperties": false, "required": ["direction", "action", "dev"], "properties": {"kind": {"const": "mirred"}, "direction": {"type": "string", "enum": ["ingress", "egress"]}, "action": {"type": "string", "enum": ["mirror", "redirect"]}, "dev": {}, "index": {"type": "integer", "minimum": 0, "maximum": 4294967295}}}
ifstate.conf.schema.json
direction
packet direction
{"type": "string", "enum": ["ingress", "egress"]}
ifstate.conf.schema.json
action
copy (`mirror`) or move (`redirect`) packets to the destination interface
{"type": "string", "enum": ["mirror", "redirect"]}
ifstate.conf.schema.json
dev
destination interface where packets are redirected or mirrored to
{}
ifstate.conf.schema.json
index
unique action ID
{"type": "integer", "minimum": 0, "maximum": 4294967295}
ifstate.conf.schema.json
mode
force attach mode of the XDP program (`auto`: let the kernel choose, `xdp`: run inside driver, `xdpgeneric`: driver-independent before SKB allocation, `xdpoffload`: offload to SmartNIC co-processor)
{"type": "string", "enum": ["auto", "xdp", "xdpgeneric", "xdpoffload"], "default": "auto"}
ifstate.conf.schema.json
mode
allowed attach modes of the XDP program (`xdp`: run inside driver, `xdpgeneric`: driver-independent before SKB allocation, `xdpoffload`: offload to SmartNIC co-processor)
{"type": "array", "items": {"type": "string", "enum": ["xdp", "xdpgeneric", "xdpoffload"]}}
ifstate.conf.schema.json
options
global configuration settings
{"type": "object", "additionalProperties": false, "properties": {"sysctl": {"type": "object", "properties": {"all": {}, "default": {}}}}}
ifstate.conf.schema.json
all
overrides [per interface sysctl settings](https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt) in `/proc/sys/net/ipv*/conf/all/`
{}
ifstate.conf.schema.json
default
default [per interface sysctl settings](https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt) in `/proc/sys/net/ipv*/conf/default/`
{}
ifstate.conf.schema.json
ignore
ignore patterns to skip interface, ip address or routing objects
{"type": "object", "additionalProperties": false, "properties": {"ipaddr_builtin": {}, "ipaddr": {}, "ipaddr_dynamic": {"type": "boolean", "default": true}, "ifname_builtin": {}, "ifname": {}, "routes_builtin": {}, "routes": {}, "rules_builtin": {}, "rules": {}}}
ifstate.conf.schema.json
ipaddr_dynamic
ignore dynamic assigned ip addresses
{"type": "boolean", "default": true}
ifstate.conf.schema.json
bpf
load and pin eBPF programs (i.e. for XDP)
{"type": "object", "patternProperties": {"": {"type": "object", "additionalProperties": false, "required": ["object", "section"], "properties": {"object": {"type": "string"}, "section": {"type": "string"}}}}}
ifstate.conf.schema.json
BPF program
{"type": "object", "additionalProperties": false, "required": ["object", "section"], "properties": {"object": {"type": "string"}, "section": {"type": "string"}}}
ifstate.conf.schema.json
object
BPF ELF file to load
{"type": "string"}
ifstate.conf.schema.json
section
BPF program's section name
{"type": "string"}
ifstate.conf.schema.json
cshaper
cshaper templates
{"type": "object", "patternProperties": {"": {"type": "object", "additionalProperties": false, "required": ["egress_qdisc", "ingress_qdisc", "ingress_ifname"], "properties": {"egress_qdisc": {}, "ingress_qdisc": {}, "ingress_ifname": {"type": "object", "additionalProperties": false, "required": ["search", "replace"], "properties": {"search": {"type": "string"}, "replace": {"type": "string"}}}}}}, "required": ["default"]}
ifstate.conf.schema.json
cshaper profile
{"type": "object", "additionalProperties": false, "required": ["egress_qdisc", "ingress_qdisc", "ingress_ifname"], "properties": {"egress_qdisc": {}, "ingress_qdisc": {}, "ingress_ifname": {"type": "object", "additionalProperties": false, "required": ["search", "replace"], "properties": {"search": {"type": "string"}, "replace": {"type": "string"}}}}}
ifstate.conf.schema.json
ingress_ifname
build a ifb ifname using a regex on the ifname
{"type": "object", "additionalProperties": false, "required": ["search", "replace"], "properties": {"search": {"type": "string"}, "replace": {"type": "string"}}}
ifstate.conf.schema.json
search
pattern to search
{"type": "string"}
ifstate.conf.schema.json
replace
replace pattern by string
{"type": "string"}
ifstate.conf.schema.json
interfaces
list of interface settings (link settings and ip addresses)
{"type": "array", "items": {"type": "object", "required": ["name"], "additionalProperties": false, "properties": {"name": {}, "addresses": {"type": "array", "items": {"type": "string", "examples": ["192.0.2.1", "192.168.0.1/24", "2001:db8::1/64"]}}, "brport": {"type": "object", "additionalProperties": false, "properties": {"priority": {"type": "integer", "minimum": 0, "maximum": 63}, "cost": {"minimum": 1, "maximum": 65535}, "guard": {"type": "boolean"}, "mode": {"type": "boolean"}, "fast_leave": {"type": "boolean"}, "protect": {"type": "boolean"}, "learning": {"type": "boolean"}, "unicast_flood": {"type": "boolean"}, "bcast_flood": {"type": "boolean"}, "mcast_flood": {"type": "boolean"}, "mcast_to_ucast": {"type": "boolean"}, "proxyarp": {"type": "boolean"}, "proxyarp_wifi": {"type": "boolean"}, "neigh_suppress": {"type": "boolean"}, "vlan_tunnel": {"type": "boolean"}, "backup_port": {}, "isolated": {"type": "boolean"}}}, "vrrp": {"type": "object", "required": ["name", "type", "states"], "additionalProperties": false, "properties": {"name": {"type": "string"}, "type": {"type": "string", "enum": ["instance", "group"]}, "states": {"type": "array", "items": [{"type": "string", "enum": ["unknown", "fault", "backup", "master"]}]}}}, "link": {"type": "object", "oneOf": [{"required": ["kind"], "additionalProperties": false, "properties": {"kind": {"const": "ifb"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "properties": {"kind": {"const": "ip6tnl"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "properties": {"kind": {"const": "ipoib"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "properties": {"kind": {"const": "ipvlan"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "properties": {"kind": {"const": "macvlan"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "properties": {"kind": {"const": "macvtap"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "properties": {"kind": {"const": "team"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind", "tun_type"], "additionalProperties": false, "properties": {"kind": {"const": "tun"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "tun_type": {"default": "tap", "enum": [1, "tun", 2, "tap"]}, "tun_pi": {"type": ["boolean", "integer"], "default": false, "enum": [0, false, 1, true]}, "tun_persist": {"type": ["boolean", "integer"], "default": false, "enum": [0, false, 1, true]}, "tun_vnet_hdr": {"default": false, "enum": [0, false, 1, true]}, "tun_multi_queue": {"type": ["boolean", "integer"], "default": false, "enum": [0, false, 1, true]}, "tun_owner": {"type": ["integer", "string"]}, "tun_group": {"type": ["integer", "string"]}}}, {"required": ["kind"], "properties": {"kind": {"const": "vrf"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "properties": {"kind": {"const": "vti"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "properties": {"kind": {"const": "vti6"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "additionalProperties": false, "properties": {"kind": {"const": "bond"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "bond_mode": {"enum": [0, "balance-rr", 1, "active-backup", 2, "balance-xor", 3, "broadcast", 4, "802.3ad", 5, "balance-tlb", 6, "balance-alb"], "default": "balance-rr"}, "bond_miimon": {"type": "integer", "minimum": 0, "default": 0}, "bond_updelay": {"type": "integer", "minimum": 0, "default": 0}, "bond_downdelay": {"type": "integer", "minimum": 0, "default": 0}, "bond_use_carrier": {"enum": [0, 1], "default": 1}, "bond_arp_interval": {"type": "integer", "minimum": 0, "default": 0}, "bond_arp_validate": {"enum": [0, "none", 1, "active", 2, "backup", 3, "all", 4, "filter", 5, "filter_active", 6, "filter_backup"], "default": "none"}, "bond_arp_all_targets": {"enum": [0, "any", 1, "all"], "default": "any"}, "bond_primary_reselect": {"enum": [0, "always", 1, "better", 2, "failure"], "default": "always"}, "bond_fail_over_mac": {"enum": [0, "none", 1, "active", 2, "follow"], "default": "none"}, "bond_xmit_hash_policy": {"enum": [0, "layer2", 1, "layer3+4", 2, "layer2+3", 3, "encap2+3", 4, "encap3+4", 5, "vlan+srcmac"], "default": "layer2"}, "bond_resend_igmp": {"type": "integer", "minimum": 0, "maximum": 255, "default": 1}, "bond_num_peer_notif": {"type": "integer", "minimum": 0, "default": 1}, "bond_all_slaves_active": {"enum": [0, 1], "default": 1}, "bond_min_links": {"type": "integer", "minimum": 0, "default": 0}, "bond_lp_interval": {"type": "integer", "minimum": 0, "maximum": 2147483647, "default": 1}, "bond_packets_per_slave": {"type": "integer", "minimum": 0, "maximum": 65535, "default": 1}, "bond_ad_lacp_rate": {"enum": [0, "slow", 1, "fast"], "default": "slow"}, "bond_ad_select": {"enum": [0, "stable", 1, "bandwidth", 2, "count"], "default": "stable"}, "bond_tlb_dynamic_lb": {"enum": [0, 1], "default": 1}}}, {"required": ["kind"], "properties": {"kind": {"const": "bridge"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "br_ageing_time": {"type": "integer", "minimum": 0, "default": 30000}, "br_vlan_protocol": {"enum": [33024, "802.1q", 34984, "802.1ad"], "default": "802.1q"}}}, {"required": ["kind"], "additionalProperties": false, "properties": {"kind": {"type": "string", "enum": ["physical"]}, "address": {}, "group": {}, "permaddr": {}, "businfo": {"type": "string", "maxLength": 32}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "additionalProperties": false, "properties": {"kind": {"type": "string", "enum": ["dummy"]}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind", "peer"], "additionalProperties": false, "properties": {"kind": {"type": "string", "enum": ["veth", "vxcan"]}, "address": {}, "group": {}, "peer": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind", "link", "vlan_id"], "additionalProperties": false, "properties": {"kind": {"const": "vlan"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "link": {}, "vlan_id": {"type": ["integer"], "minimum": 0, "maximum": 4094}, "vlan_protocol": {"enum": [33024, "802.1q", 34984, "802.1ad"], "default": "802.1q"}}}, {"required": ["kind", "vxlan_id", "vxlan_link"], "additionalProperties": false, "properties": {"kind": {"const": "vxlan"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "vxlan_id": {"type": ["integer"], "minimum": 0, "maximum": 16777215}, "vxlan_link": {}}}, {"required": ["kind", "ipip_remote", "ipip_local"], "additionalProperties": false, "properties": {"kind": {"const": "ipip"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "ipip_remote": {}, "ipip_local": {}}}, {"required": ["kind", "sit_remote", "sit_local"], "additionalProperties": false, "properties": {"kind": {"const": "sit"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "sit_remote": {}, "sit_local": {}}}, {"required": ["kind", "gre_remote", "gre_local"], "additionalProperties": false, "properties": {"kind": {"type": "string", "enum": ["gre", "gretap"]}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "gre_remote": {}, "gre_local": {}, "gre_link": {}}}, {"required": ["kind", "ip6gre_remote", "ip6gre_local"], "additionalProperties": false, "properties": {"kind": {"type": "string", "enum": ["ip6gre", "ip6gretap"]}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "ip6gre_remote": {}, "ip6gre_local": {}, "ip6gre_link": {}}}, {"additionalProperties": false, "required": ["kind", "geneve_id", "geneve_remote"], "properties": {"kind": {"const": "geneve"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "geneve_id": {"type": ["integer"], "minimum": 0, "maximum": 16777215}, "geneve_remote": {}}}, {"additionalProperties": false, "required": ["kind", "geneve_id", "geneve_remote6"], "properties": {"kind": {"const": "geneve"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "geneve_id": {"type": ["integer"], "minimum": 0, "maximum": 16777215}, "geneve_remote6": {}}}, {"required": ["kind"], "additionalProperties": false, "properties": {"kind": {"const": "wireguard"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind", "xfrm_link"], "additionalProperties": false, "properties": {"kind": {"const": "xfrm"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "xfrm_link": {}, "xfrm_if_id": {"type": ["integer"], "minimum": 0, "maximum": 4294967295, "default": 0}}}]}, "neighbours": {"type": "array", "items": {"type": "object", "required": ["dst"], "additionalProperties": false, "properties": {"dst": {"type": "string", "format": "ipv4"}, "lladdr": {"default": null}}}}, "sysctl": {}, "ethtool": {"type": "object", "additionalProperties": false, "properties": {"pause": {"type": "object", "additionalProperties": false, "properties": {"autoneg": {}, "rx": {}, "tx": {}}}, "coalesce": {"type": "object", "additionalProperties": false, "properties": {"adaptive-rx": {}, "adaptive-tx": {}, "rx-usecs": {"type": "integer"}, "rx-frames": {"type": "integer"}, "rx-usecs-irq": {"type": "integer"}, "rx-frames-irq": {"type": "integer"}, "tx-usecs": {"type": "integer"}, "tx-frames": {"type": "integer"}, "tx-usecs-irq": {"type": "integer"}, "tx-frames-irq": {"type": "integer"}, "stats-block-usecs": {"type": "integer"}, "pkt-rate-low": {"type": "integer"}, "rx-usecs-low": {"type": "integer"}, "rx-frames-low": {"type": "integer"}, "tx-usecs-low": {"type": "integer"}, "tx-frames-low": {"type": "integer"}, "pkt-rate-high": {"type": "integer"}, "rx-usecs-high": {"type": "integer"}, "rx-frames-high": {"type": "integer"}, "tx-usecs-high": {"type": "integer"}, "tx-frames-high": {"type": "integer"}, "sample-interval": {"type": "integer"}}}, "ring": {"type": "object", "additionalProperties": false, "properties": {"rx": {"type": "integer"}, "rx-mmini": {"type": "integer"}, "rx-jumbo": {"type": "integer"}, "tx": {"type": "integer"}}}, "features": {"type": "object", "additionalProperties": false, "properties": {"rx": {}, "tx": {}, "sg": {}, "tso": {}, "ufo": {}, "gso": {}, "gro": {}, "lro": {}, "rxvlan": {}, "txvlan": {}, "ntuple": {}, "rxhash": {}}}, "change": {"type": "object", "additionalProperties": false, "properties": {"speed": {"type": "integer"}, "duplex": {"type": "string", "enum": ["half", "full"]}, "port": {"type": "string", "enum": ["tp", "aui", "bnc", "mii"]}, "mdix": {"type": ["boolean", "string"], "enum": ["auto", "on", "off", true, false]}, "autoneg": {}, "advertise": {"type": "integer"}, "phyad": {"type": "integer"}, "xcvr": {"type": "string", "enum": ["internal", "external"]}, "wol": {"type": "string", "pattern": "^[pumbagsfd]+$"}, "sopass": {"type": "string", "pattern": "^[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}$"}, "msglvl": {"oneOf": [{"type": "integer"}, {"type": "array", "items": [{"type": "string", "enum": ["drv", "probe", "link", "timer", "ifdown", "ifup", "rx_err", "tx_err", "tx_queued", "intr", "tx_done", "rx_status", "pktdata", "hw", "wol"]}, {}]}]}}}, "channels": {"type": "object", "additionalProperties": false, "properties": {"rx": {"type": "integer"}, "tx": {"type": "integer"}, "other": {"type": "integer"}, "combined": {"type": "integer"}}}, "eee": {"type": "object", "additionalProperties": false, "properties": {"eee": {}, "tx-lpi": {}, "advertise": {"type": "integer"}, "tx-timer": {"type": "integer"}}}, "phy-tunable": {"type": "object", "additionalProperties": false, "properties": {"downshift": {"oneOf": [{}, {"type": "array", "minItems": 3, "maxItems": 3, "items": [{}, {"type": "string", "enum": ["count"]}, {"type": "integer"}]}]}, "fast-link-down": {"oneOf": [{}, {"type": "array", "minItems": 3, "maxItems": 3, "items": [{}, {"type": "string", "enum": ["msec"]}, {"type": "integer"}]}]}, "energy-detect-power-down": {"oneOf": [{}, {"type": "array", "minItems": 3, "maxItems": 3, "items": [{}, {"type": "string", "enum": ["msec"]}, {"type": "integer"}]}]}}}, "priv-flags": {"type": "object"}, "fec": {"type": "object", "additionalProperties": false, "properties": {"encoding": {"type": ["string", "array"], "enum": ["auto", "off", "RS", "BaseR", "LLRS"], "items": {"type": "string", "enum": ["auto", "RS", "BaseR", "LLRS"]}}}}}}, "cshaper": {"type": "object", "additionalProperties": false, "properties": {"ingress": {"type": "string", "default": "unlimited"}, "egress": {"type": "string", "default": "unlimited"}, "profile": {"type": "string", "default": "default"}}}, "tc": {"type": "object", "additionalProperties": false, "properties": {"ingress": {"type": "boolean"}, "qdisc": {}, "filter": {"type": "array", "items": {"type": "object", "required": ["kind"], "properties": {"kind": {"type": "string", "enum": ["basic", "flow", "fw", "matchall"]}}, "oneOf": [{"additionalProperties": false, "properties": {"kind": {"type": "string", "enum": ["basic"]}, "protocol": {}, "prio": {}, "action": {}, "match": {"type": "object"}}}, {"properties": {"kind": {"type": "string", "enum": ["flow"]}, "protocol": {}, "prio": {}, "action": {}, "baseclass": {"type": "integer", "minimum": 0, "maximum": 65535, "default": 1}, "divisor": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "or": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "and": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "xor": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "rshift": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "addend": {"type": "integer", "minimum": 0, "maximum": 4294967295}}, "oneOf": [{"required": ["kind", "mode", "key"], "properties": {"mode": {"type": "string", "enum": ["map"]}, "key": {"type": "string", "enum": ["src", "dst", "proto", "proto-src", "proto-dst", "iif", "priority", "mark", "nfct", "nfct-src", "nfct-dst", "nfct-proto-src", "nfct-proto-dst", "rt-classid", "sk-uid", "sk-gid", "vlan-tag", "rxhash"]}}}, {"required": ["kind", "mode", "keys"], "properties": {"mode": {"type": "string", "enum": ["hash"]}, "keys": {"type": "array", "items": {"type": "string", "enum": ["src", "dst", "proto", "proto-src", "proto-dst", "iif", "priority", "mark", "nfct", "nfct-src", "nfct-dst", "nfct-proto-src", "nfct-proto-dst", "rt-classid", "sk-uid", "sk-gid", "vlan-tag", "rxhash"]}}, "perturb": {"type": "integer", "minimum": 0, "maximum": 294967295}}}]}, {"additionalProperties": false, "required": ["kind", "handle"], "properties": {"kind": {"type": "string", "enum": ["fw"]}, "protocol": {}, "prio": {}, "action": {}, "handle": {"type": "integer", "minimum": 0}}}, {"additionalProperties": false, "properties": {"kind": {"type": "string", "enum": ["matchall"]}, "parent": {}, "protocol": {}, "prio": {}, "action": {}, "classid": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "flags": {"type": "integer", "minimum": 0, "maximum": 4294967295}}}]}}}}, "wireguard": {"type": "object", "additionalProperties": false, "required": ["private_key"], "properties": {"private_key": {"type": "string"}, "listen_port": {"type": "integer", "minimum": 0, "maximum": 65535}, "fwmark": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "peers": {"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["public_key"], "properties": {"public_key": {"type": "string"}, "preshared_key": {"type": "string"}, "endpoint": {"type": "string"}, "persistent_keepalive_interval": {"type": "integer", "minimum": 0, "maximum": 65535}, "allowedips": {"type": "array", "items": {"type": "string"}}}}}}}, "xdp": {"oneOf": [{"type": "boolean", "enum": [false]}, {"type": "object", "additionalProperties": false, "required": ["pinned"], "properties": {"mode": {}, "pinned": {"type": "string", "format": "^/sys/fs/bfd/."}}}, {"type": "object", "additionalProperties": false, "required": ["bpf"], "properties": {"mode": {}, "bpf": {"type": "string"}}}]}}}}
ifstate.conf.schema.json
name
name of the interface
{}
ifstate.conf.schema.json
addresses
ip addresses of the interface
{"type": "array", "items": {"type": "string", "examples": ["192.0.2.1", "192.168.0.1/24", "2001:db8::1/64"]}}
ifstate.conf.schema.json
brport
settings for bridge ports
{"type": "object", "additionalProperties": false, "properties": {"priority": {"type": "integer", "minimum": 0, "maximum": 63}, "cost": {"minimum": 1, "maximum": 65535}, "guard": {"type": "boolean"}, "mode": {"type": "boolean"}, "fast_leave": {"type": "boolean"}, "protect": {"type": "boolean"}, "learning": {"type": "boolean"}, "unicast_flood": {"type": "boolean"}, "bcast_flood": {"type": "boolean"}, "mcast_flood": {"type": "boolean"}, "mcast_to_ucast": {"type": "boolean"}, "proxyarp": {"type": "boolean"}, "proxyarp_wifi": {"type": "boolean"}, "neigh_suppress": {"type": "boolean"}, "vlan_tunnel": {"type": "boolean"}, "backup_port": {}, "isolated": {"type": "boolean"}}}
ifstate.conf.schema.json
priority
set port priority
{"type": "integer", "minimum": 0, "maximum": 63}
ifstate.conf.schema.json
cost
set port cost
{"minimum": 1, "maximum": 65535}
ifstate.conf.schema.json
guard
filter BPDU packets
{"type": "boolean"}
ifstate.conf.schema.json
mode
enable hairpin mode
{"type": "boolean"}
ifstate.conf.schema.json
fast_leave
enable multicast fast leave
{"type": "boolean"}
ifstate.conf.schema.json
protect
prevent to become a root port
{"type": "boolean"}
ifstate.conf.schema.json
learning
allow MAC address learning
{"type": "boolean"}
ifstate.conf.schema.json
unicast_flood
flood unknown unicasts
{"type": "boolean"}
ifstate.conf.schema.json
bcast_flood
flood broadcasts
{"type": "boolean"}
ifstate.conf.schema.json
mcast_flood
flood multicasts
{"type": "boolean"}
ifstate.conf.schema.json
mcast_to_ucast
clone multicast packets into unicasts
{"type": "boolean"}
ifstate.conf.schema.json
proxyarp
enable proxy ARP
{"type": "boolean"}
ifstate.conf.schema.json
proxyarp_wifi
enable proxy ARP (IEEE 802.11 and Hotspot 2.0)
{"type": "boolean"}
ifstate.conf.schema.json
neigh_suppress
ARP and ND suppression
{"type": "boolean"}
ifstate.conf.schema.json
vlan_tunnel
VLAN to tunnel mapping
{"type": "boolean"}
ifstate.conf.schema.json
backup_port
backup bridge port on loss carrier
{}
ifstate.conf.schema.json
isolated
isolated port, can communicate only with non-isolated ports
{"type": "boolean"}
ifstate.conf.schema.json
vrrp
interface depending on vrrp status
{"type": "object", "required": ["name", "type", "states"], "additionalProperties": false, "properties": {"name": {"type": "string"}, "type": {"type": "string", "enum": ["instance", "group"]}, "states": {"type": "array", "items": [{"type": "string", "enum": ["unknown", "fault", "backup", "master"]}]}}}
ifstate.conf.schema.json
name
related vrrp INSTANCE or GROUP name
{"type": "string"}
ifstate.conf.schema.json
type
failover type
{"type": "string", "enum": ["instance", "group"]}
ifstate.conf.schema.json
states
states at which the interface should be configured
{"type": "array", "items": [{"type": "string", "enum": ["unknown", "fault", "backup", "master"]}]}
ifstate.conf.schema.json
link
link settings of the interface
{"type": "object", "oneOf": [{"required": ["kind"], "additionalProperties": false, "properties": {"kind": {"const": "ifb"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "properties": {"kind": {"const": "ip6tnl"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "properties": {"kind": {"const": "ipoib"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "properties": {"kind": {"const": "ipvlan"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "properties": {"kind": {"const": "macvlan"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "properties": {"kind": {"const": "macvtap"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "properties": {"kind": {"const": "team"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind", "tun_type"], "additionalProperties": false, "properties": {"kind": {"const": "tun"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "tun_type": {"default": "tap", "enum": [1, "tun", 2, "tap"]}, "tun_pi": {"type": ["boolean", "integer"], "default": false, "enum": [0, false, 1, true]}, "tun_persist": {"type": ["boolean", "integer"], "default": false, "enum": [0, false, 1, true]}, "tun_vnet_hdr": {"default": false, "enum": [0, false, 1, true]}, "tun_multi_queue": {"type": ["boolean", "integer"], "default": false, "enum": [0, false, 1, true]}, "tun_owner": {"type": ["integer", "string"]}, "tun_group": {"type": ["integer", "string"]}}}, {"required": ["kind"], "properties": {"kind": {"const": "vrf"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "properties": {"kind": {"const": "vti"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "properties": {"kind": {"const": "vti6"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "additionalProperties": false, "properties": {"kind": {"const": "bond"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "bond_mode": {"enum": [0, "balance-rr", 1, "active-backup", 2, "balance-xor", 3, "broadcast", 4, "802.3ad", 5, "balance-tlb", 6, "balance-alb"], "default": "balance-rr"}, "bond_miimon": {"type": "integer", "minimum": 0, "default": 0}, "bond_updelay": {"type": "integer", "minimum": 0, "default": 0}, "bond_downdelay": {"type": "integer", "minimum": 0, "default": 0}, "bond_use_carrier": {"enum": [0, 1], "default": 1}, "bond_arp_interval": {"type": "integer", "minimum": 0, "default": 0}, "bond_arp_validate": {"enum": [0, "none", 1, "active", 2, "backup", 3, "all", 4, "filter", 5, "filter_active", 6, "filter_backup"], "default": "none"}, "bond_arp_all_targets": {"enum": [0, "any", 1, "all"], "default": "any"}, "bond_primary_reselect": {"enum": [0, "always", 1, "better", 2, "failure"], "default": "always"}, "bond_fail_over_mac": {"enum": [0, "none", 1, "active", 2, "follow"], "default": "none"}, "bond_xmit_hash_policy": {"enum": [0, "layer2", 1, "layer3+4", 2, "layer2+3", 3, "encap2+3", 4, "encap3+4", 5, "vlan+srcmac"], "default": "layer2"}, "bond_resend_igmp": {"type": "integer", "minimum": 0, "maximum": 255, "default": 1}, "bond_num_peer_notif": {"type": "integer", "minimum": 0, "default": 1}, "bond_all_slaves_active": {"enum": [0, 1], "default": 1}, "bond_min_links": {"type": "integer", "minimum": 0, "default": 0}, "bond_lp_interval": {"type": "integer", "minimum": 0, "maximum": 2147483647, "default": 1}, "bond_packets_per_slave": {"type": "integer", "minimum": 0, "maximum": 65535, "default": 1}, "bond_ad_lacp_rate": {"enum": [0, "slow", 1, "fast"], "default": "slow"}, "bond_ad_select": {"enum": [0, "stable", 1, "bandwidth", 2, "count"], "default": "stable"}, "bond_tlb_dynamic_lb": {"enum": [0, 1], "default": 1}}}, {"required": ["kind"], "properties": {"kind": {"const": "bridge"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "br_ageing_time": {"type": "integer", "minimum": 0, "default": 30000}, "br_vlan_protocol": {"enum": [33024, "802.1q", 34984, "802.1ad"], "default": "802.1q"}}}, {"required": ["kind"], "additionalProperties": false, "properties": {"kind": {"type": "string", "enum": ["physical"]}, "address": {}, "group": {}, "permaddr": {}, "businfo": {"type": "string", "maxLength": 32}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind"], "additionalProperties": false, "properties": {"kind": {"type": "string", "enum": ["dummy"]}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind", "peer"], "additionalProperties": false, "properties": {"kind": {"type": "string", "enum": ["veth", "vxcan"]}, "address": {}, "group": {}, "peer": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind", "link", "vlan_id"], "additionalProperties": false, "properties": {"kind": {"const": "vlan"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "link": {}, "vlan_id": {"type": ["integer"], "minimum": 0, "maximum": 4094}, "vlan_protocol": {"enum": [33024, "802.1q", 34984, "802.1ad"], "default": "802.1q"}}}, {"required": ["kind", "vxlan_id", "vxlan_link"], "additionalProperties": false, "properties": {"kind": {"const": "vxlan"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "vxlan_id": {"type": ["integer"], "minimum": 0, "maximum": 16777215}, "vxlan_link": {}}}, {"required": ["kind", "ipip_remote", "ipip_local"], "additionalProperties": false, "properties": {"kind": {"const": "ipip"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "ipip_remote": {}, "ipip_local": {}}}, {"required": ["kind", "sit_remote", "sit_local"], "additionalProperties": false, "properties": {"kind": {"const": "sit"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "sit_remote": {}, "sit_local": {}}}, {"required": ["kind", "gre_remote", "gre_local"], "additionalProperties": false, "properties": {"kind": {"type": "string", "enum": ["gre", "gretap"]}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "gre_remote": {}, "gre_local": {}, "gre_link": {}}}, {"required": ["kind", "ip6gre_remote", "ip6gre_local"], "additionalProperties": false, "properties": {"kind": {"type": "string", "enum": ["ip6gre", "ip6gretap"]}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "ip6gre_remote": {}, "ip6gre_local": {}, "ip6gre_link": {}}}, {"additionalProperties": false, "required": ["kind", "geneve_id", "geneve_remote"], "properties": {"kind": {"const": "geneve"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "geneve_id": {"type": ["integer"], "minimum": 0, "maximum": 16777215}, "geneve_remote": {}}}, {"additionalProperties": false, "required": ["kind", "geneve_id", "geneve_remote6"], "properties": {"kind": {"const": "geneve"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "geneve_id": {"type": ["integer"], "minimum": 0, "maximum": 16777215}, "geneve_remote6": {}}}, {"required": ["kind"], "additionalProperties": false, "properties": {"kind": {"const": "wireguard"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}, {"required": ["kind", "xfrm_link"], "additionalProperties": false, "properties": {"kind": {"const": "xfrm"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "xfrm_link": {}, "xfrm_if_id": {"type": ["integer"], "minimum": 0, "maximum": 4294967295, "default": 0}}}]}
ifstate.conf.schema.json
link
Intermediate Functional Block device
{"required": ["kind"], "additionalProperties": false, "properties": {"kind": {"const": "ifb"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}
ifstate.conf.schema.json
kind
link type
{"const": "ifb"}
ifstate.conf.schema.json
link
Virtual tunnel interface IPv4|IPv6 over IPv6
{"required": ["kind"], "properties": {"kind": {"const": "ip6tnl"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}
ifstate.conf.schema.json
kind
link type
{"const": "ip6tnl"}
ifstate.conf.schema.json
link
IP over Infiniband device
{"required": ["kind"], "properties": {"kind": {"const": "ipoib"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}
ifstate.conf.schema.json
kind
link type
{"const": "ipoib"}
ifstate.conf.schema.json
link
Interface for L3 (IPv6/IPv4) based VLANs
{"required": ["kind"], "properties": {"kind": {"const": "ipvlan"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}
ifstate.conf.schema.json
kind
link type
{"const": "ipvlan"}
ifstate.conf.schema.json
link
Virtual interface base on link layer address (MAC)
{"required": ["kind"], "properties": {"kind": {"const": "macvlan"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}
ifstate.conf.schema.json
kind
link type
{"const": "macvlan"}
ifstate.conf.schema.json
link
Virtual interface based on link layer address (MAC) and TAP
{"required": ["kind"], "properties": {"kind": {"const": "macvtap"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}
ifstate.conf.schema.json
kind
link type
{"const": "macvtap"}
ifstate.conf.schema.json
link
Team network device
{"required": ["kind"], "properties": {"kind": {"const": "team"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}
ifstate.conf.schema.json
kind
link type
{"const": "team"}
ifstate.conf.schema.json
link
Virtual software device (TUN/TAP)
{"required": ["kind", "tun_type"], "additionalProperties": false, "properties": {"kind": {"const": "tun"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}, "tun_type": {"default": "tap", "enum": [1, "tun", 2, "tap"]}, "tun_pi": {"type": ["boolean", "integer"], "default": false, "enum": [0, false, 1, true]}, "tun_persist": {"type": ["boolean", "integer"], "default": false, "enum": [0, false, 1, true]}, "tun_vnet_hdr": {"default": false, "enum": [0, false, 1, true]}, "tun_multi_queue": {"type": ["boolean", "integer"], "default": false, "enum": [0, false, 1, true]}, "tun_owner": {"type": ["integer", "string"]}, "tun_group": {"type": ["integer", "string"]}}}
ifstate.conf.schema.json
kind
link type
{"const": "tun"}
ifstate.conf.schema.json
tun_type
device mode (Ethernet headers)
{"default": "tap", "enum": [1, "tun", 2, "tap"]}
ifstate.conf.schema.json
tun_pi
provide packet information
{"type": ["boolean", "integer"], "default": false, "enum": [0, false, 1, true]}
ifstate.conf.schema.json
tun_persist
persistent device; non-persistent devices cannot be created
{"type": ["boolean", "integer"], "default": false, "enum": [0, false, 1, true]}
ifstate.conf.schema.json
tun_vnet_hdr
prepend frames with struct virtio_net_hdr
{"default": false, "enum": [0, false, 1, true]}
ifstate.conf.schema.json
tun_multi_queue
enable multiqueue tuntap
{"type": ["boolean", "integer"], "default": false, "enum": [0, false, 1, true]}
ifstate.conf.schema.json
tun_owner
device owner
{"type": ["integer", "string"]}
ifstate.conf.schema.json
tun_group
device group
{"type": ["integer", "string"]}
ifstate.conf.schema.json
link
Virtual Routing and Forwarding device
{"required": ["kind"], "properties": {"kind": {"const": "vrf"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}
ifstate.conf.schema.json
kind
link type
{"const": "vrf"}
ifstate.conf.schema.json
link
Virtual tunnel interface over IPv4
{"required": ["kind"], "properties": {"kind": {"const": "vti"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}
ifstate.conf.schema.json
kind
link type
{"const": "vti"}
ifstate.conf.schema.json
link
Virtual tunnel interface over IPv6
{"required": ["kind"], "properties": {"kind": {"const": "vti6"}, "address": {}, "group": {}, "state": {}, "master": {}, "mtu": {}, "txqlen": {}, "ifalias": {}}}
ifstate.conf.schema.json
kind
link type
{"const": "vti6"}