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": ["dif...
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": {"t...
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": 429496729...
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"], "...
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"}, "...
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, "propertie...
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": "boo...
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": {}, "sta...
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": fa...
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"}