ifstate.conf

Type: object

IfState 1.11.0 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: 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)