ifstate.conf

Type: object

IfState 1.11.8 Configuration Schema

No Additional Properties

Type: array of object

default settings for configured interfaces

No Additional Items

Each item of this array must be:

Type: object

first matching entry will be used, settings will be overriden by explicit configured interface settings

No Additional Properties

Type: array of object

apply default settings for interfaces matching any list item (OR)

No Additional Items

Each item of this array must be:

Type: object

all conditions that must match (AND)

No Additional Properties

Type: string

regex to match interface name


Example:

^eth\d+$

Type: string

regex to match link type


Examples:

^physical$
^(physical|vlan)$

Type: boolean Default: false

implicit remove all ip addresses

Type: boolean Default: false

implicit remove all permanent fdb entries

Type: boolean Default: false

implicit remove all permanent ip neighbours

Type: boolean Default: false

implicit remove all tc qdiscs

Type: object

network driver and hardware settings via ethtool(8)

No Additional Properties

Type: object

pause parameters

No Additional Properties

Type: enum (of string or boolean)

enable pause autonegotiation

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable Rx pause

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable Tx pause

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: object

interrupt coalescing

No Additional Properties

Type: enum (of string or boolean)

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: object

rx/tx ring parameters

No Additional Properties

Type: integer

number of ring entries for the Rx ring

Type: integer

number of ring entries for the Rx Mini ring

Type: integer

number of ring entries for the Rx Jumbo ring

Type: integer

number of ring entries for the Tx ring

Type: object

offload parameters and other features

No Additional Properties

Type: enum (of string or boolean)

enable RX checksumming

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable TX checksumming

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable scatter-gather

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable TCP segmentation offload

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable UDP fragmentation offload

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable generic segmentation offload

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable generic receive offload

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable large receive offload

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable RX VLAN acceleration

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable TX VLAN acceleration

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable Rx ntuple filters and actions

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable receive hashing offload

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: object

device settings

No Additional Properties

Type: integer

speed in Mbps

Type: enum (of string)

full or half duplex mode

Must be one of:

  • "half"
  • "full"

Type: enum (of string)

device port selection

Must be one of:

  • "tp"
  • "aui"
  • "bnc"
  • "mii"

Type: enum (of string or boolean)

MDI-X mode for port

Must be one of:

  • "auto"
  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable autonegotation

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: integer

speed and duplex advertised by autonegotation

Type: integer

PHY address

Type: enum (of string)

transceiver type

Must be one of:

  • "internal"
  • "external"

Type: string

Wake-on-LAN options

Must match regular expression: ^[pumbagsfd]+$

Type: string

SecureOnâ„¢ password

Must match regular expression: ^[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}$


driver message flags

Type: integer

driver message flags by number

Type: array

driver message flags by name

No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string)

flag name

Must be one of:

  • "drv"
  • "probe"
  • "link"
  • "timer"
  • "ifdown"
  • "ifup"
  • "rx_err"
  • "tx_err"
  • "tx_queued"
  • "intr"
  • "tx_done"
  • "rx_status"
  • "pktdata"
  • "hw"
  • "wol"
Item at 2 must be:
Type: enum (of string or boolean)

enable flag

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: object

number of channels

No Additional Properties

Type: integer

number of channels with only receive queues

Type: integer

number of channels with only transmit queues

Type: integer

number of channels used only for other purposes

Type: integer

number of multi-purpose channels

Type: object

Energy-Efficient Ethernet (according to the IEEE 802.3az specifications)

No Additional Properties

Type: enum (of string or boolean)

enable EEE support

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

assert Tx LPI

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: integer

sets the speed for which EEE should be enabled (see also change.advertise)

Type: integer

amount of idle time prior asserting Tx LPI (in microseconds)

Type: object

PHY tunable parameters

No Additional Properties


enable downshift

Type: enum (of string or boolean)

enable downshift

Must be one of:

  • "on"
  • "off"
  • true
  • false
Type: array

Must contain a minimum of 3 items

Must contain a maximum of 3 items

No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string or boolean)

enable downshift

Must be one of:

  • "on"
  • "off"
  • true
  • false
Item at 2 must be:
Type: enum (of string)

REQUIRED

Must be one of:

  • "count"
Item at 3 must be:
Type: integer

PHY downshift re-tries count


enable Energy Detect Power Down (EDPD)

Type: enum (of string or boolean)

enable EDPD

Must be one of:

  • "on"
  • "off"
  • true
  • false
Type: array

Must contain a minimum of 3 items

Must contain a maximum of 3 items

No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string or boolean)

enable EDPD

Must be one of:

  • "on"
  • "off"
  • true
  • false
Item at 2 must be:
Type: enum (of string)

REQUIRED

Must be one of:

  • "msec"
Item at 3 must be:

Type: object

private flags

Type: object

Forward Error Correction

No Additional Properties

Type: enum (of string)

FEC encoding

Must be one of:

  • "auto"
  • "off"
  • "RS"
  • "BaseR"
  • "LLRS"

Type: object

global configuration settings

No Additional Properties

Type: object

global sysctl settings

No Additional Properties

Type: object

overrides per interface sysctl settings in /proc/sys/net/ipv*/conf/all/

No Additional Properties

Type: object

settings in /proc/sys/net/ipv4/<interface>/conf/

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: object

settings in /proc/sys/net/ipv6/<interface>/conf/

No Additional Properties

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: stringFormat: ipv6

Type: integer

Type: integer

Type: integer

Type: object

default per interface sysctl settings in /proc/sys/net/ipv*/conf/default/

No Additional Properties

Type: object

settings in /proc/sys/net/ipv4/<interface>/conf/

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: object

settings in /proc/sys/net/ipv6/<interface>/conf/

No Additional Properties

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: integer

Type: stringFormat: ipv6

Type: integer

Type: object

MPLS sysctl settings in /proc/sys/net/mpls/

No Additional Properties

Type: integer

number of entries in the platform label table

Value must be greater or equal to 0 and lesser or equal to 1048575

Type: integer

control whether TTL is propagated

Value must be greater or equal to 0 and lesser or equal to 1

Type: integer

default TTL value to use for MPLS packets

Value must be greater or equal to 1 and lesser or equal to 255

Type: object

ignore patterns to skip interface, ip address or routing objects

No Additional Properties

Type: array of string

list of ip address prefixes to be ignored

No Additional Items

Each item of this array must be:

Type: string

ip address with prefix length


Example:

fe80::/10

Type: array of string

list of ip address prefixes to be ignored

No Additional Items

Each item of this array must be:

Type: string

ip address with prefix length


Example:

fe80::/10

Type: boolean Default: true

ignore dynamic assigned ip addresses

Type: array of string

interface names matching this list of regex will be ignored

No Additional Items

Each item of this array must be:

Type: string

regex to match interface name


Examples:

^br-[\da-f]{12}
^docker\d+
^lo$
^ppp\d+$
^veth
^virbr\d+
^vrrp\d*\.\d+$

Type: array of string

interface names matching this list of regex will be ignored

No Additional Items

Each item of this array must be:

Type: string

regex to match interface name


Examples:

^br-[\da-f]{12}
^docker\d+
^lo$
^ppp\d+$
^veth
^virbr\d+
^vrrp\d*\.\d+$

Type: array of string

fdb entries matching this list of regex will be ignored

No Additional Items

Each item of this array must be:

Type: string

regex to match link-local addresses


Examples:

^33:33:
^01:00:5e:

Type: array of string

fdb entries matching this list of regex will be ignored

No Additional Items

Each item of this array must be:

Type: string

regex to match link-local addresses


Examples:

^33:33:
^01:00:5e:

Type: array of object

filter routes by options

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: integer or string

Type: integer or string Default: "boot"

Type: integer or string

Type: integer or string

Type: integer or string Default: "main"

Type: array of object

filter routes by options

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: integer or string

Type: integer or string Default: "boot"

Type: integer or string

Type: integer or string

Type: integer or string Default: "main"

Type: string

Type: string

Type: array of object

filter rules by options

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: enum (of string) Default: "to_tbl"

the type of this rule

Must be one of:

  • "to_tbl"
  • "blackhole"
  • "unreachable"
  • "prohibit"

Type: integer or string

Type: integer

the priority of this rule

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: string

select the source prefix to match

Type: string

select the destination prefix to match

Type: string

select the incoming device to match

Type: string

select the outgoing device to match

Type: integer or string Default: "unspec"

routing protocol number (/etc/iproute2/rt_protos)

Type: integer

select the fwmark value to match

Type: integer or string

select the ip protocol to match

Type: array of object

filter rules by options

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: enum (of string) Default: "to_tbl"

the type of this rule

Must be one of:

  • "to_tbl"
  • "blackhole"
  • "unreachable"
  • "prohibit"

Type: integer or string

Type: integer

the priority of this rule

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: string

select the source prefix to match

Type: string

select the destination prefix to match

Type: string

select the incoming device to match

Type: string

select the outgoing device to match

Type: integer or string Default: "unspec"

routing protocol number (/etc/iproute2/rt_protos)

Type: integer

select the fwmark value to match

Type: integer or string

select the ip protocol to match

Type: array of string

netns namespaces matching this list of regex will be ignored

No Additional Items

Each item of this array must be:

Type: string

regex to match interface name


Example:

^tenant-\d+

Type: object

load and pin eBPF programs (i.e. for XDP)

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:
Type: object

BPF program

No Additional Properties

Type: string

BPF ELF file to load

Type: string

BPF program's section name

Type: object

cshaper templates

The following properties are required:

  • default

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:
Type: object

cshaper profile

No Additional Properties

Type: object

cake - common applications kept enhanced (CAKE)

Type: const

qdisk type

Specific value: "cake"

Type: string

unique id

Type: enum (of string or boolean)

ACKnowledge filter

Must be one of:

  • "aggressive"
  • true
  • false

Type: enum (of string or boolean)

ATM mode

Must be one of:

  • "ptm"
  • true
  • false

Type: boolean

autorate-ingress

Type: enum (of string)

diffserv mode

Must be one of:

  • "diffserv3"
  • "diffserv4"
  • "diffserv8"
  • "besteffort"
  • "precedence"

Type: boolean

ingress

Type: integer

overhead

Value must be greater or equal to -64 and lesser or equal to 256

Type: enum (of string)

flow mode

Must be one of:

  • "flowblind"
  • "srchost"
  • "dsthost"
  • "hosts"
  • "flows"
  • "dual-srchost"
  • "dual-dsthost"
  • "triple-isolated"

Type: integer

fwmark

Value must be greater or equal to 0

Type: integer

memlimit

Value must be greater or equal to 0

Type: integer

MPU

Value must be greater or equal to 0 and lesser or equal to 256

Type: boolean

NAT

Type: boolean

RAW


Type: enum (of string)

well-known RTT

Must be one of:

  • "datacentre"
  • "lan"
  • "metro"
  • "regional"
  • "internet"
  • "oceanic"
  • "satellite"
  • "interplanetary"
Type: integer

manually specify an RTT (us)

Value must be greater or equal to 1

Type: boolean

split GSO

Type: integer

target

Value must be greater or equal to 1

Type: boolean

wash

Type: object

cake - common applications kept enhanced (CAKE)

Type: const

qdisk type

Specific value: "cake"

Type: string

unique id

Type: enum (of string or boolean)

ACKnowledge filter

Must be one of:

  • "aggressive"
  • true
  • false

Type: enum (of string or boolean)

ATM mode

Must be one of:

  • "ptm"
  • true
  • false

Type: boolean

autorate-ingress

Type: enum (of string)

diffserv mode

Must be one of:

  • "diffserv3"
  • "diffserv4"
  • "diffserv8"
  • "besteffort"
  • "precedence"

Type: boolean

ingress

Type: integer

overhead

Value must be greater or equal to -64 and lesser or equal to 256

Type: enum (of string)

flow mode

Must be one of:

  • "flowblind"
  • "srchost"
  • "dsthost"
  • "hosts"
  • "flows"
  • "dual-srchost"
  • "dual-dsthost"
  • "triple-isolated"

Type: integer

fwmark

Value must be greater or equal to 0

Type: integer

memlimit

Value must be greater or equal to 0

Type: integer

MPU

Value must be greater or equal to 0 and lesser or equal to 256

Type: boolean

NAT

Type: boolean

RAW


Type: enum (of string)

well-known RTT

Must be one of:

  • "datacentre"
  • "lan"
  • "metro"
  • "regional"
  • "internet"
  • "oceanic"
  • "satellite"
  • "interplanetary"
Type: integer

manually specify an RTT (us)

Value must be greater or equal to 1

Type: boolean

split GSO

Type: integer

target

Value must be greater or equal to 1

Type: boolean

wash

Type: object

build a ifb ifname using a regex on the ifname

No Additional Properties

Type: string

replace pattern by string

Type: array of object

list of interface settings (link settings and ip addresses)

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

name of the interface

Must match regular expression: ^[^/ ]{1,15}$

Type: array of string

ip addresses of the interface

No Additional Items

Each item of this array must be:

Type: string

Examples:

192.0.2.1
192.168.0.1/24
2001:db8::1/64

Type: object

settings for bridge ports

No Additional Properties

Type: integer

set port priority

Value must be greater or equal to 0 and lesser or equal to 63

Type: object

set port cost

Type: boolean

filter BPDU packets

Type: boolean

enable hairpin mode

Type: boolean

enable multicast fast leave

Type: boolean

prevent to become a root port

Type: boolean

allow MAC address learning

Type: boolean

flood unknown unicasts

Type: boolean

flood broadcasts

Type: boolean

flood multicasts

Type: boolean

clone multicast packets into unicasts

Type: boolean

enable proxy ARP

Type: boolean

enable proxy ARP (IEEE 802.11 and Hotspot 2.0)

Type: boolean

ARP and ND suppression

Type: boolean

VLAN to tunnel mapping

Type: integer or string

backup bridge port on loss carrier

Type: boolean

isolated port, can communicate only with non-isolated ports

Type: array of object

forwarding database for bridge interfaces, the entries are distinct by the lladdr property

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string Default: null

destination link layer address

Must match regular expression: ^([a-f0-9]{2}:){5}[a-f0-9]{2}$


ip address of the destination VXLAN tunnel endpoint

Type: objectFormat: ipv4
Type: objectFormat: ipv6

Type: integer

ecmp nexthop group for the VXLAN device driver

Value must be greater or equal to 1

Type: integer

destination port number to use to connect to the remote VXLAN tunnel endpoint

Value must be greater or equal to 0 and lesser or equal to 65535

Type: integer

virtual network identifier this entry belongs to

Value must be greater or equal to 0 and lesser or equal to 16777215

Type: array
No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string)

Must be one of:

  • "self"
  • "master"
  • "router"
  • "use"
  • "sticky"

Type: array
No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string)

Must be one of:

  • "permanent"
  • "noarp"

Type: object

configure depending on vrrp status

No Additional Properties

Type: string

related vrrp INSTANCE or GROUP name

Type: enum (of string)

failover type

Must be one of:

  • "instance"
  • "group"

Type: array

states at which the interface should be configured

No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string)

Must be one of:

  • "unknown"
  • "fault"
  • "backup"
  • "master"

Type: array of object

static ARP or NDISC cache entries

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: stringFormat: ipv4

protocol address of the neighbour

Type: string Default: null

link layer address of the neighbour

Must match regular expression: ^([a-f0-9]{2}:){5}[a-f0-9]{2}$

Type: object

interface sysctl settings

No Additional Properties

Type: object

settings in /proc/sys/net/ipv4/<interface>/conf/

Type: object

settings in /proc/sys/net/ipv6/<interface>/conf/

No Additional Properties

Type: stringFormat: ipv6

Type: object

MPLS interface sysctl settings in /proc/sys/net/mpls/<interface>/

No Additional Properties

Type: integer

control whether packets can be input on this interface

Value must be greater or equal to 0 and lesser or equal to 1

Type: object

network driver and hardware settings via ethtool(8)

No Additional Properties

Type: object

pause parameters

No Additional Properties

Type: enum (of string or boolean)

enable pause autonegotiation

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable Rx pause

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable Tx pause

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: object

interrupt coalescing

No Additional Properties

Type: enum (of string or boolean)

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: object

rx/tx ring parameters

No Additional Properties

Type: integer

number of ring entries for the Rx ring

Type: integer

number of ring entries for the Rx Mini ring

Type: integer

number of ring entries for the Rx Jumbo ring

Type: integer

number of ring entries for the Tx ring

Type: object

offload parameters and other features

No Additional Properties

Type: enum (of string or boolean)

enable RX checksumming

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable TX checksumming

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable scatter-gather

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable TCP segmentation offload

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable UDP fragmentation offload

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable generic segmentation offload

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable generic receive offload

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable large receive offload

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable RX VLAN acceleration

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable TX VLAN acceleration

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable Rx ntuple filters and actions

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable receive hashing offload

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: object

device settings

No Additional Properties

Type: integer

speed in Mbps

Type: enum (of string)

full or half duplex mode

Must be one of:

  • "half"
  • "full"

Type: enum (of string)

device port selection

Must be one of:

  • "tp"
  • "aui"
  • "bnc"
  • "mii"

Type: enum (of string or boolean)

MDI-X mode for port

Must be one of:

  • "auto"
  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable autonegotation

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: integer

speed and duplex advertised by autonegotation

Type: integer

PHY address

Type: enum (of string)

transceiver type

Must be one of:

  • "internal"
  • "external"

Type: string

Wake-on-LAN options

Must match regular expression: ^[pumbagsfd]+$

Type: string

SecureOnâ„¢ password

Must match regular expression: ^[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}$


driver message flags

Type: integer

driver message flags by number

Type: array

driver message flags by name

No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string)

flag name

Must be one of:

  • "drv"
  • "probe"
  • "link"
  • "timer"
  • "ifdown"
  • "ifup"
  • "rx_err"
  • "tx_err"
  • "tx_queued"
  • "intr"
  • "tx_done"
  • "rx_status"
  • "pktdata"
  • "hw"
  • "wol"
Item at 2 must be:
Type: enum (of string or boolean)

enable flag

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: object

number of channels

No Additional Properties

Type: integer

number of channels with only receive queues

Type: integer

number of channels with only transmit queues

Type: integer

number of channels used only for other purposes

Type: integer

number of multi-purpose channels

Type: object

Energy-Efficient Ethernet (according to the IEEE 802.3az specifications)

No Additional Properties

Type: enum (of string or boolean)

enable EEE support

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

assert Tx LPI

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: integer

sets the speed for which EEE should be enabled (see also change.advertise)

Type: integer

amount of idle time prior asserting Tx LPI (in microseconds)

Type: object

PHY tunable parameters

No Additional Properties


enable downshift

Type: enum (of string or boolean)

enable downshift

Must be one of:

  • "on"
  • "off"
  • true
  • false
Type: array

Must contain a minimum of 3 items

Must contain a maximum of 3 items

No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string or boolean)

enable downshift

Must be one of:

  • "on"
  • "off"
  • true
  • false
Item at 2 must be:
Type: enum (of string)

REQUIRED

Must be one of:

  • "count"
Item at 3 must be:
Type: integer

PHY downshift re-tries count


enable Energy Detect Power Down (EDPD)

Type: enum (of string or boolean)

enable EDPD

Must be one of:

  • "on"
  • "off"
  • true
  • false
Type: array

Must contain a minimum of 3 items

Must contain a maximum of 3 items

No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string or boolean)

enable EDPD

Must be one of:

  • "on"
  • "off"
  • true
  • false
Item at 2 must be:
Type: enum (of string)

REQUIRED

Must be one of:

  • "msec"
Item at 3 must be:

Type: object

private flags

Type: object

Forward Error Correction

No Additional Properties

Type: enum (of string)

FEC encoding

Must be one of:

  • "auto"
  • "off"
  • "RS"
  • "BaseR"
  • "LLRS"

Type: object

simple shaper setup based on the cake queue discipline; replaces any tc settings

No Additional Properties

Type: string Default: "unlimited"

target ingress bandwidth

Type: string Default: "unlimited"

target egress bandwidth

Type: string Default: "default"

cshaper profile

Type: object

settings for traffic control

No Additional Properties

Type: boolean

enable the ingress qdisc for policing and shaping in ingress

Type: object

root queueing disciplines

Type: object

generic classless qdisc

Type: enum (of string)

qdisk type

Must be one of:

  • "gred"
  • "hhf"
  • "mqprio"
  • "multiq"
  • "netem"
  • "pfifo_fast"
  • "pie"
  • "red"
  • "sfb"
  • "sfq"
  • "tbf"
Type: object

cake - common applications kept enhanced (CAKE)

Type: const

qdisk type

Specific value: "cake"

Type: string

unique id

Type: enum (of string or boolean)

ACKnowledge filter

Must be one of:

  • "aggressive"
  • true
  • false

Type: enum (of string or boolean)

ATM mode

Must be one of:

  • "ptm"
  • true
  • false

Type: boolean

autorate-ingress

Type: enum (of string)

diffserv mode

Must be one of:

  • "diffserv3"
  • "diffserv4"
  • "diffserv8"
  • "besteffort"
  • "precedence"

Type: boolean

ingress

Type: integer

overhead

Value must be greater or equal to -64 and lesser or equal to 256

Type: enum (of string)

flow mode

Must be one of:

  • "flowblind"
  • "srchost"
  • "dsthost"
  • "hosts"
  • "flows"
  • "dual-srchost"
  • "dual-dsthost"
  • "triple-isolated"

Type: integer

fwmark

Value must be greater or equal to 0

Type: integer

memlimit

Value must be greater or equal to 0

Type: integer

MPU

Value must be greater or equal to 0 and lesser or equal to 256


Type: enum (of string)

well-known RTT

Must be one of:

  • "datacentre"
  • "lan"
  • "metro"
  • "regional"
  • "internet"
  • "oceanic"
  • "satellite"
  • "interplanetary"
Type: integer

manually specify an RTT (us)

Value must be greater or equal to 1

Type: boolean

split GSO

Type: integer

target

Value must be greater or equal to 1

Type: object

choke - choose and keep scheduler

The following properties are required:

  • limit
  • min
  • max
  • avpkt
  • burst
  • probability

Type: const

qdisk type

Specific value: "choke"
Type: object

CoDel - Controlled-Delay Active Queue Management algorithm

Type: const

qdisk type

Specific value: "codel"
Type: object

bfifo - Byte limited First In, First Out queue; pfifo - Packet limited First In, First Out queue

No Additional Properties

Type: enum (of string)

qdisk type

Must be one of:

  • "bfifo"
  • "pfifo"

Type: number

queue size in bytes or packets

Type: object

fq - Fair Queue traffic policing

Type: const

qdisk type

Specific value: "fq"

Type: number

hard limit on the real queue size (number of packets)

Type: number

hard limit on the max number of packets per flow

Type: object

fq_codel - Fair Queuing (FQ) with Controlled Delay (CoDel)

Type: const

qdisk type

Specific value: "fq_codel"

Type: number

hard limit on the real queue size (number of packets)

Type: number

number of flows

Type: object

generic classful qdisc

Type: enum (of string)

qdisk type

Must be one of:

  • "atm"
  • "cbq"
  • "drr"
  • "dsmark"
  • "hfsc"
  • "htb"
  • "prio"
  • "qfq"
Type: object

classful multiqueue dummy scheduler

Type: const

qdisk type

Specific value: "mq"

Type: array

list child qdiscs for each device TX queue

No Additional Items

Each item of this array must be:

Type: object

child qdiscs for the nth device TX queue

Same definition as qdisc

Type: string

unique id

Type: array of object

filter used by qdiscs

No Additional Items

Each item of this array must be:


Type: object

basic - basic traffic control filter

No Additional Properties

Type: enum (of string)

Must be one of:

  • "basic"

Type: string or integer Default: 3

protocol selector

Type: integer

priority

Value must be greater or equal to 0 and lesser or equal to 65535

Type: array of object

traffic control filter action

No Additional Items

Each item of this array must be:

Type: object

mirred - mirror/redirect action

No Additional Properties

Type: enum (of string)

packet direction

Must be one of:

  • "ingress"
  • "egress"

Type: enum (of string)

copy (mirror) or move (redirect) packets to the destination interface

Must be one of:

  • "mirror"
  • "redirect"

Type: integer or string

destination interface where packets are redirected or mirrored to

Type: integer

unique action ID

Value must be greater or equal to 0 and lesser or equal to 4294967295


flow - flow based traffic control filter

Type: object

The following properties are required:

  • kind

Type: enum (of string)

filter mode

Must be one of:

  • "map"

Type: enum (of string)

map to class ID by key

Must be one of:

  • "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"
Type: object

The following properties are required:

  • kind

Type: enum (of string)

filter mode

Must be one of:

  • "hash"

Type: array of enum (of string)

hash over keys for class ID calculation

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

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

Type: integer

rehashing interval (in seconds)

Value must be greater or equal to 0 and lesser or equal to 294967295

Type: enum (of string)

Must be one of:

  • "flow"

Type: string or integer Default: 3

protocol selector

Type: integer

priority

Value must be greater or equal to 0 and lesser or equal to 65535

Type: array of object

traffic control filter action

No Additional Items

Each item of this array must be:

Type: object

mirred - mirror/redirect action

No Additional Properties

Type: enum (of string)

packet direction

Must be one of:

  • "ingress"
  • "egress"

Type: enum (of string)

copy (mirror) or move (redirect) packets to the destination interface

Must be one of:

  • "mirror"
  • "redirect"

Type: integer or string

destination interface where packets are redirected or mirrored to

Type: integer

unique action ID

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer Default: 1

offset for the class ID calculation

Value must be greater or equal to 0 and lesser or equal to 65535

Type: integer

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: object

fw - fwmark traffic control filter

No Additional Properties

Type: enum (of string)

Must be one of:

  • "fw"

Type: string or integer Default: 3

protocol selector

Type: integer

priority

Value must be greater or equal to 0 and lesser or equal to 65535

Type: array of object

traffic control filter action

No Additional Items

Each item of this array must be:

Type: object

mirred - mirror/redirect action

No Additional Properties

Type: enum (of string)

packet direction

Must be one of:

  • "ingress"
  • "egress"

Type: enum (of string)

copy (mirror) or move (redirect) packets to the destination interface

Must be one of:

  • "mirror"
  • "redirect"

Type: integer or string

destination interface where packets are redirected or mirrored to

Type: integer

unique action ID

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer

fwmark (iptables) to match

Value must be greater or equal to 0

Type: object

matchall - traffic control filter that matches every packet

No Additional Properties

Type: enum (of string)

Must be one of:

  • "matchall"

Type: string or integer Default: 3

protocol selector

Type: integer

priority

Value must be greater or equal to 0 and lesser or equal to 65535

Type: array of object

traffic control filter action

No Additional Items

Each item of this array must be:

Type: object

mirred - mirror/redirect action

No Additional Properties

Type: enum (of string)

packet direction

Must be one of:

  • "ingress"
  • "egress"

Type: enum (of string)

copy (mirror) or move (redirect) packets to the destination interface

Must be one of:

  • "mirror"
  • "redirect"

Type: integer or string

destination interface where packets are redirected or mirrored to

Type: integer

unique action ID

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer

push matching packets into class

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer

process flags (1: SKIPHW, 2: SKIPSW)

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: enum (of string)

filter type

Must be one of:

  • "basic"
  • "flow"
  • "fw"
  • "matchall"

Type: object

settings for WireGuard interfaces

No Additional Properties

Type: string

local private key (consider to use the !include tag to read the key from file)

Type: integer

port for listening

Value must be greater or equal to 0 and lesser or equal to 65535

Type: integer

fwmark for outgoing packets

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: array of object

list of peer definitions

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

the peer's public key

Type: string

preshared key for post-quantum resistance (consider to use the !include tag to read the key from file)

Type: string

initial endpoint IP or hostname

Type: integer

keepalive interval seconds

Value must be greater or equal to 0 and lesser or equal to 65535

Type: array of string

list of prefixes in CIDR notation

No Additional Items

Each item of this array must be:


settings for XDP ("eXpress Data Path") BPF program

Type: enum (of boolean)

remove attached XDP program

Must be one of:

  • false
Type: object

attach already pinned XDP program

No Additional Properties

Type: stringFormat: ^/sys/fs/bfd/.

path to already pinned XDP program

Type: object

BPF program from ifstate's bpf config section

No Additional Properties

Type: string

BPF program (key in bpf config section)

Type: object
No Additional Properties

Type: array of object
No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: enum (of string) Default: "unicast"

the type of this route

Must be one of:

  • "unicast"
  • "local"
  • "broadcast"
  • "anycast"
  • "multicast"
  • "blackhole"
  • "unreachable"
  • "prohibit"
  • "throw"
  • "nat"
  • "xresolve"

Type: integer or string

the output device name

Type: integer or string Default: "boot"

the routing protool identifier of this route

Type: integer or string

the realm to which this route is assigned

Type: integer or string

the scope of the destinations covered by the route prefix

Type: integer or string Default: "main"

the table to add this route to

Type: string

the destination prefix of the route


address of the nexthop router

Type: objectFormat: ipv4
Type: objectFormat: ipv6

Type: object

configure depending on vrrp status

No Additional Properties

Type: string

related vrrp INSTANCE or GROUP name

Type: enum (of string)

failover type

Must be one of:

  • "instance"
  • "group"

Type: array

states at which the interface should be configured

No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string)

Must be one of:

  • "unknown"
  • "fault"
  • "backup"
  • "master"


the source address to prefer

Type: objectFormat: ipv4
Type: objectFormat: ipv6

Type: integer Default: 0

preference of the route

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: array of object
No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

Type: object

Type: const
Specific value: "to_tbl"
Type: object

The following properties are required:

  • table
  • priority
Type: object

The following properties are required:

  • priority

Type: enum (of string) Default: "to_tbl"

the type of this rule

Must be one of:

  • "to_tbl"
  • "blackhole"
  • "unreachable"
  • "prohibit"

Type: integer or string

Type: integer

the priority of this rule

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: string

select the source prefix to match

Type: string

select the destination prefix to match

Type: string

select the incoming device to match

Type: string

select the outgoing device to match

Type: integer or string Default: "unspec"

routing protocol number (/etc/iproute2/rt_protos)

Type: integer

select the fwmark value to match

Type: integer or string

select the ip protocol to match

Type: object

configure depending on vrrp status

No Additional Properties

Type: string

related vrrp INSTANCE or GROUP name

Type: enum (of string)

failover type

Must be one of:

  • "instance"
  • "group"

Type: array

states at which the interface should be configured

No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string)

Must be one of:

  • "unknown"
  • "fault"
  • "backup"
  • "master"

Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: .+
Type: object
No Additional Properties

Type: object

load and pin eBPF programs (i.e. for XDP)

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:
Type: object

BPF program

No Additional Properties

Type: string

BPF ELF file to load

Type: string

BPF program's section name

Type: object

global configuration settings

No Additional Properties

Type: object

global sysctl settings

No Additional Properties

Type: object

overrides per interface sysctl settings in /proc/sys/net/ipv*/conf/all/

No Additional Properties

Type: object

settings in /proc/sys/net/ipv4/<interface>/conf/

Type: integer

Type: object

settings in /proc/sys/net/ipv6/<interface>/conf/

No Additional Properties

Type: integer

Type: stringFormat: ipv6

Type: object

default per interface sysctl settings in /proc/sys/net/ipv*/conf/default/

No Additional Properties

Type: object

settings in /proc/sys/net/ipv4/<interface>/conf/

Type: integer

Type: object

settings in /proc/sys/net/ipv6/<interface>/conf/

No Additional Properties

Type: integer

Type: stringFormat: ipv6

Type: object

MPLS sysctl settings in /proc/sys/net/mpls/

No Additional Properties

Type: integer

number of entries in the platform label table

Value must be greater or equal to 0 and lesser or equal to 1048575

Type: integer

control whether TTL is propagated

Value must be greater or equal to 0 and lesser or equal to 1

Type: integer

default TTL value to use for MPLS packets

Value must be greater or equal to 1 and lesser or equal to 255

Type: array of object

list of interface settings (link settings and ip addresses)

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

name of the interface

Must match regular expression: ^[^/ ]{1,15}$

Type: array of string

ip addresses of the interface

No Additional Items

Each item of this array must be:

Type: string

Examples:

192.0.2.1
192.168.0.1/24
2001:db8::1/64

Type: object

settings for bridge ports

No Additional Properties

Type: integer

set port priority

Value must be greater or equal to 0 and lesser or equal to 63

Type: object

set port cost

Type: boolean

filter BPDU packets

Type: boolean

enable hairpin mode

Type: boolean

enable multicast fast leave

Type: boolean

prevent to become a root port

Type: boolean

allow MAC address learning

Type: boolean

flood unknown unicasts

Type: boolean

flood broadcasts

Type: boolean

flood multicasts

Type: boolean

clone multicast packets into unicasts

Type: boolean

enable proxy ARP

Type: boolean

enable proxy ARP (IEEE 802.11 and Hotspot 2.0)

Type: boolean

ARP and ND suppression

Type: boolean

VLAN to tunnel mapping

Type: integer or string

backup bridge port on loss carrier

Type: boolean

isolated port, can communicate only with non-isolated ports

Type: array of object

forwarding database for bridge interfaces, the entries are distinct by the lladdr property

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string Default: null

destination link layer address

Must match regular expression: ^([a-f0-9]{2}:){5}[a-f0-9]{2}$


ip address of the destination VXLAN tunnel endpoint

Type: integer

ecmp nexthop group for the VXLAN device driver

Value must be greater or equal to 1

Type: integer

destination port number to use to connect to the remote VXLAN tunnel endpoint

Value must be greater or equal to 0 and lesser or equal to 65535

Type: integer

virtual network identifier this entry belongs to

Value must be greater or equal to 0 and lesser or equal to 16777215

Type: array
No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string)

Must be one of:

  • "self"
  • "master"
  • "router"
  • "use"
  • "sticky"

Type: array
No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string)

Must be one of:

  • "permanent"
  • "noarp"

Type: object

configure depending on vrrp status

No Additional Properties

Type: string

related vrrp INSTANCE or GROUP name

Type: enum (of string)

failover type

Must be one of:

  • "instance"
  • "group"

Type: array

states at which the interface should be configured

No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string)

Must be one of:

  • "unknown"
  • "fault"
  • "backup"
  • "master"

Type: array of object

static ARP or NDISC cache entries

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: stringFormat: ipv4

protocol address of the neighbour

Type: string Default: null

link layer address of the neighbour

Must match regular expression: ^([a-f0-9]{2}:){5}[a-f0-9]{2}$

Type: object

interface sysctl settings

No Additional Properties

Type: object

settings in /proc/sys/net/ipv4/<interface>/conf/

Type: object

settings in /proc/sys/net/ipv6/<interface>/conf/

No Additional Properties

Type: object

MPLS interface sysctl settings in /proc/sys/net/mpls/<interface>/

No Additional Properties

Type: integer

control whether packets can be input on this interface

Value must be greater or equal to 0 and lesser or equal to 1

Type: object

network driver and hardware settings via ethtool(8)

No Additional Properties

Type: object

pause parameters

No Additional Properties

Type: enum (of string or boolean)

enable pause autonegotiation

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable Rx pause

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable Tx pause

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: object

interrupt coalescing

No Additional Properties

Type: enum (of string or boolean)

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: object

rx/tx ring parameters

No Additional Properties

Type: integer

number of ring entries for the Rx ring

Type: integer

number of ring entries for the Rx Mini ring

Type: integer

number of ring entries for the Rx Jumbo ring

Type: integer

number of ring entries for the Tx ring

Type: object

offload parameters and other features

No Additional Properties

Type: enum (of string or boolean)

enable RX checksumming

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable TX checksumming

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable scatter-gather

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable TCP segmentation offload

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable UDP fragmentation offload

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable generic segmentation offload

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable generic receive offload

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable large receive offload

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable RX VLAN acceleration

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable TX VLAN acceleration

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable Rx ntuple filters and actions

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable receive hashing offload

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: object

device settings

No Additional Properties

Type: integer

speed in Mbps

Type: enum (of string)

full or half duplex mode

Must be one of:

  • "half"
  • "full"

Type: enum (of string)

device port selection

Must be one of:

  • "tp"
  • "aui"
  • "bnc"
  • "mii"

Type: enum (of string or boolean)

MDI-X mode for port

Must be one of:

  • "auto"
  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

enable autonegotation

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: integer

speed and duplex advertised by autonegotation

Type: integer

PHY address

Type: enum (of string)

transceiver type

Must be one of:

  • "internal"
  • "external"

Type: string

Wake-on-LAN options

Must match regular expression: ^[pumbagsfd]+$

Type: string

SecureOnâ„¢ password

Must match regular expression: ^[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}$


driver message flags

Type: integer

driver message flags by number

Type: array

driver message flags by name

No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string)

flag name

Must be one of:

  • "drv"
  • "probe"
  • "link"
  • "timer"
  • "ifdown"
  • "ifup"
  • "rx_err"
  • "tx_err"
  • "tx_queued"
  • "intr"
  • "tx_done"
  • "rx_status"
  • "pktdata"
  • "hw"
  • "wol"
Item at 2 must be:
Type: enum (of string or boolean)

enable flag

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: object

number of channels

No Additional Properties

Type: integer

number of channels with only receive queues

Type: integer

number of channels with only transmit queues

Type: integer

number of channels used only for other purposes

Type: integer

number of multi-purpose channels

Type: object

Energy-Efficient Ethernet (according to the IEEE 802.3az specifications)

No Additional Properties

Type: enum (of string or boolean)

enable EEE support

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: enum (of string or boolean)

assert Tx LPI

Must be one of:

  • "on"
  • "off"
  • true
  • false

Type: integer

sets the speed for which EEE should be enabled (see also change.advertise)

Type: integer

amount of idle time prior asserting Tx LPI (in microseconds)

Type: object

PHY tunable parameters

No Additional Properties


enable downshift

Type: enum (of string or boolean)

enable downshift

Must be one of:

  • "on"
  • "off"
  • true
  • false
Type: array

Must contain a minimum of 3 items

Must contain a maximum of 3 items

No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string or boolean)

enable downshift

Must be one of:

  • "on"
  • "off"
  • true
  • false
Item at 2 must be:
Type: enum (of string)

REQUIRED

Must be one of:

  • "count"
Item at 3 must be:


enable Energy Detect Power Down (EDPD)

Type: enum (of string or boolean)

enable EDPD

Must be one of:

  • "on"
  • "off"
  • true
  • false
Type: array

Must contain a minimum of 3 items

Must contain a maximum of 3 items

No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string or boolean)

enable EDPD

Must be one of:

  • "on"
  • "off"
  • true
  • false
Item at 2 must be:
Type: enum (of string)

REQUIRED

Must be one of:

  • "msec"
Item at 3 must be:

Type: object

private flags

Type: object

Forward Error Correction

No Additional Properties

Type: enum (of string)

FEC encoding

Must be one of:

  • "auto"
  • "off"
  • "RS"
  • "BaseR"
  • "LLRS"

Type: object

simple shaper setup based on the cake queue discipline; replaces any tc settings

No Additional Properties

Type: string Default: "unlimited"

target ingress bandwidth

Type: string Default: "unlimited"

target egress bandwidth

Type: string Default: "default"

cshaper profile

Type: object

settings for traffic control

No Additional Properties

Type: boolean

enable the ingress qdisc for policing and shaping in ingress

Type: object

root queueing disciplines

Type: object

generic classless qdisc

Type: enum (of string)

qdisk type

Must be one of:

  • "gred"
  • "hhf"
  • "mqprio"
  • "multiq"
  • "netem"
  • "pfifo_fast"
  • "pie"
  • "red"
  • "sfb"
  • "sfq"
  • "tbf"
Type: object

cake - common applications kept enhanced (CAKE)

Type: const

qdisk type

Specific value: "cake"

Type: enum (of string or boolean)

ACKnowledge filter

Must be one of:

  • "aggressive"
  • true
  • false

Type: enum (of string or boolean)

ATM mode

Must be one of:

  • "ptm"
  • true
  • false

Type: boolean

autorate-ingress

Type: enum (of string)

diffserv mode

Must be one of:

  • "diffserv3"
  • "diffserv4"
  • "diffserv8"
  • "besteffort"
  • "precedence"

Type: integer

overhead

Value must be greater or equal to -64 and lesser or equal to 256

Type: enum (of string)

flow mode

Must be one of:

  • "flowblind"
  • "srchost"
  • "dsthost"
  • "hosts"
  • "flows"
  • "dual-srchost"
  • "dual-dsthost"
  • "triple-isolated"

Type: integer

fwmark

Value must be greater or equal to 0

Type: integer

memlimit

Value must be greater or equal to 0

Type: integer

MPU

Value must be greater or equal to 0 and lesser or equal to 256


Type: enum (of string)

well-known RTT

Must be one of:

  • "datacentre"
  • "lan"
  • "metro"
  • "regional"
  • "internet"
  • "oceanic"
  • "satellite"
  • "interplanetary"
Type: integer

manually specify an RTT (us)

Value must be greater or equal to 1

Type: integer

target

Value must be greater or equal to 1

Type: object

choke - choose and keep scheduler

The following properties are required:

  • limit
  • min
  • max
  • avpkt
  • burst
  • probability

Type: const

qdisk type

Specific value: "choke"
Type: object

CoDel - Controlled-Delay Active Queue Management algorithm

Type: const

qdisk type

Specific value: "codel"
Type: object

bfifo - Byte limited First In, First Out queue; pfifo - Packet limited First In, First Out queue

No Additional Properties

Type: enum (of string)

qdisk type

Must be one of:

  • "bfifo"
  • "pfifo"

Type: number

queue size in bytes or packets

Type: object

fq - Fair Queue traffic policing

Type: const

qdisk type

Specific value: "fq"

Type: number

hard limit on the real queue size (number of packets)

Type: number

hard limit on the max number of packets per flow

Type: object

fq_codel - Fair Queuing (FQ) with Controlled Delay (CoDel)

Type: const

qdisk type

Specific value: "fq_codel"

Type: number

hard limit on the real queue size (number of packets)

Type: number

number of flows

Type: object

generic classful qdisc

Type: enum (of string)

qdisk type

Must be one of:

  • "atm"
  • "cbq"
  • "drr"
  • "dsmark"
  • "hfsc"
  • "htb"
  • "prio"
  • "qfq"
Type: object

classful multiqueue dummy scheduler

Type: const

qdisk type

Specific value: "mq"

Type: array

list child qdiscs for each device TX queue

No Additional Items

Each item of this array must be:

Type: object

child qdiscs for the nth device TX queue

Same definition as qdisc

Type: string

unique id

Type: array of object

filter used by qdiscs

No Additional Items

Each item of this array must be:


Type: object

basic - basic traffic control filter

No Additional Properties

Type: enum (of string)

Must be one of:

  • "basic"

Type: string or integer Default: 3

protocol selector

Type: integer

priority

Value must be greater or equal to 0 and lesser or equal to 65535

Type: array of object

traffic control filter action

No Additional Items

Each item of this array must be:

Type: object

mirred - mirror/redirect action

No Additional Properties

Type: enum (of string)

packet direction

Must be one of:

  • "ingress"
  • "egress"

Type: enum (of string)

copy (mirror) or move (redirect) packets to the destination interface

Must be one of:

  • "mirror"
  • "redirect"

Type: integer or string

destination interface where packets are redirected or mirrored to

Type: integer

unique action ID

Value must be greater or equal to 0 and lesser or equal to 4294967295


flow - flow based traffic control filter

Type: object

The following properties are required:

  • kind

Type: enum (of string)

filter mode

Must be one of:

  • "map"

Type: enum (of string)

map to class ID by key

Must be one of:

  • "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"
Type: object

The following properties are required:

  • kind

Type: enum (of string)

filter mode

Must be one of:

  • "hash"

Type: array of enum (of string)

hash over keys for class ID calculation

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

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

Type: integer

rehashing interval (in seconds)

Value must be greater or equal to 0 and lesser or equal to 294967295

Type: enum (of string)

Must be one of:

  • "flow"

Type: string or integer Default: 3

protocol selector

Type: integer

priority

Value must be greater or equal to 0 and lesser or equal to 65535

Type: array of object

traffic control filter action

No Additional Items

Each item of this array must be:

Type: object

mirred - mirror/redirect action

No Additional Properties

Type: enum (of string)

packet direction

Must be one of:

  • "ingress"
  • "egress"

Type: enum (of string)

copy (mirror) or move (redirect) packets to the destination interface

Must be one of:

  • "mirror"
  • "redirect"

Type: integer or string

destination interface where packets are redirected or mirrored to

Type: integer

unique action ID

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer Default: 1

offset for the class ID calculation

Value must be greater or equal to 0 and lesser or equal to 65535

Type: integer

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: object

fw - fwmark traffic control filter

No Additional Properties

Type: enum (of string)

Must be one of:

  • "fw"

Type: string or integer Default: 3

protocol selector

Type: integer

priority

Value must be greater or equal to 0 and lesser or equal to 65535

Type: array of object

traffic control filter action

No Additional Items

Each item of this array must be:

Type: object

mirred - mirror/redirect action

No Additional Properties

Type: enum (of string)

packet direction

Must be one of:

  • "ingress"
  • "egress"

Type: enum (of string)

copy (mirror) or move (redirect) packets to the destination interface

Must be one of:

  • "mirror"
  • "redirect"

Type: integer or string

destination interface where packets are redirected or mirrored to

Type: integer

unique action ID

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer

fwmark (iptables) to match

Value must be greater or equal to 0

Type: object

matchall - traffic control filter that matches every packet

No Additional Properties

Type: enum (of string)

Must be one of:

  • "matchall"

Type: string or integer Default: 3

protocol selector

Type: integer

priority

Value must be greater or equal to 0 and lesser or equal to 65535

Type: array of object

traffic control filter action

No Additional Items

Each item of this array must be:

Type: object

mirred - mirror/redirect action

No Additional Properties

Type: enum (of string)

packet direction

Must be one of:

  • "ingress"
  • "egress"

Type: enum (of string)

copy (mirror) or move (redirect) packets to the destination interface

Must be one of:

  • "mirror"
  • "redirect"

Type: integer or string

destination interface where packets are redirected or mirrored to

Type: integer

unique action ID

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer

push matching packets into class

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: integer

process flags (1: SKIPHW, 2: SKIPSW)

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: enum (of string)

filter type

Must be one of:

  • "basic"
  • "flow"
  • "fw"
  • "matchall"

Type: object

settings for WireGuard interfaces

No Additional Properties

Type: string

local private key (consider to use the !include tag to read the key from file)

Type: integer

port for listening

Value must be greater or equal to 0 and lesser or equal to 65535

Type: integer

fwmark for outgoing packets

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: array of object

list of peer definitions

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

preshared key for post-quantum resistance (consider to use the !include tag to read the key from file)

Type: string

initial endpoint IP or hostname

Type: integer

keepalive interval seconds

Value must be greater or equal to 0 and lesser or equal to 65535

Type: array of string

list of prefixes in CIDR notation

No Additional Items

Each item of this array must be:


settings for XDP ("eXpress Data Path") BPF program

Type: enum (of boolean)

remove attached XDP program

Must be one of:

  • false
Type: object

attach already pinned XDP program

No Additional Properties

Type: stringFormat: ^/sys/fs/bfd/.

path to already pinned XDP program

Type: object

BPF program from ifstate's bpf config section

No Additional Properties

Type: string

BPF program (key in bpf config section)

Type: object
No Additional Properties

Type: array of object
No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: enum (of string) Default: "unicast"

the type of this route

Must be one of:

  • "unicast"
  • "local"
  • "broadcast"
  • "anycast"
  • "multicast"
  • "blackhole"
  • "unreachable"
  • "prohibit"
  • "throw"
  • "nat"
  • "xresolve"

Type: integer or string

the output device name

Type: integer or string Default: "boot"

the routing protool identifier of this route

Type: integer or string

the realm to which this route is assigned

Type: integer or string

the scope of the destinations covered by the route prefix

Type: integer or string Default: "main"

the table to add this route to

Type: string

the destination prefix of the route


address of the nexthop router

Type: objectFormat: ipv4
Type: objectFormat: ipv6

Type: object

configure depending on vrrp status

No Additional Properties

Type: string

related vrrp INSTANCE or GROUP name

Type: enum (of string)

failover type

Must be one of:

  • "instance"
  • "group"

Type: array

states at which the interface should be configured

No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string)

Must be one of:

  • "unknown"
  • "fault"
  • "backup"
  • "master"


the source address to prefer

Type: objectFormat: ipv4
Type: objectFormat: ipv6

Type: integer Default: 0

preference of the route

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: array of object
No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

Type: object

Type: const
Specific value: "to_tbl"
Type: object

The following properties are required:

  • table
  • priority
Type: object

The following properties are required:

  • priority

Type: enum (of string) Default: "to_tbl"

the type of this rule

Must be one of:

  • "to_tbl"
  • "blackhole"
  • "unreachable"
  • "prohibit"

Type: integer or string

Type: integer

the priority of this rule

Value must be greater or equal to 0 and lesser or equal to 4294967295

Type: string

select the source prefix to match

Type: string

select the destination prefix to match

Type: string

select the incoming device to match

Type: string

select the outgoing device to match

Type: integer or string Default: "unspec"

routing protocol number (/etc/iproute2/rt_protos)

Type: integer

select the fwmark value to match

Type: integer or string

select the ip protocol to match

Type: object

configure depending on vrrp status

No Additional Properties

Type: string

related vrrp INSTANCE or GROUP name

Type: enum (of string)

failover type

Must be one of:

  • "instance"
  • "group"

Type: array

states at which the interface should be configured

No Additional Items

Tuple Validation

Item at 1 must be:
Type: enum (of string)

Must be one of:

  • "unknown"
  • "fault"
  • "backup"
  • "master"