ifstate.conf

Type: object

IfState Configuration Schema

root options
Type: object

global configuration settings

root options sysctl
Type: object

root options sysctl all
Type: object

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

root options sysctl all ipv4
Type: object

settings in /proc/sys/net/ipv4/*/conf/

root options sysctl all ipv4 accept_local
Type: integer

root options sysctl all ipv4 accept_redirects
Type: integer

root options sysctl all ipv4 arp_accept
Type: integer

root options sysctl all ipv4 arp_announce
Type: integer

root options sysctl all ipv4 arp_filter
Type: integer

root options sysctl all ipv4 arp_ignore
Type: integer

root options sysctl all ipv4 arp_notify
Type: integer

root options sysctl all ipv4 bc_forwarding
Type: integer

root options sysctl all ipv4 bootp_relay
Type: integer

root options sysctl all ipv4 disable_policy
Type: integer

root options sysctl all ipv4 disable_xfrm
Type: integer

root options sysctl all ipv4 forwarding
Type: integer

root options sysctl all ipv4 log_martians
Type: integer

root options sysctl all ipv4 mc_forwarding
Type: integer

root options sysctl all ipv4 medium_id
Type: integer

root options sysctl all ipv4 proxy_arp
Type: integer

root options sysctl all ipv4 proxy_arp_pvlan
Type: integer

root options sysctl all ipv4 route_localnet
Type: integer

root options sysctl all ipv4 rp_filter
Type: integer

root options sysctl all ipv4 secure_redirects
Type: integer

root options sysctl all ipv4 send_redirects
Type: integer

root options sysctl all ipv4 shared_media
Type: integer

root options sysctl all ipv4 src_valid_mark
Type: integer

root options sysctl all ipv4 tag
Type: integer

root options sysctl all ipv6
Type: object

settings in /proc/sys/net/ipv6/*/conf/

root options sysctl all ipv6 accept_dad
Type: integer

root options sysctl all ipv6 accept_ra
Type: integer

root options sysctl all ipv6 accept_ra_defrtr
Type: integer

root options sysctl all ipv6 accept_ra_mtu
Type: integer

root options sysctl all ipv6 accept_ra_pinfo
Type: integer

root options sysctl all ipv6 accept_redirects
Type: integer

root options sysctl all ipv6 addr_gen_mode
Type: integer

root options sysctl all ipv6 autoconf
Type: integer

root options sysctl all ipv6 dad_transmits
Type: integer

root options sysctl all ipv6 disable_ipv6
Type: integer

root options sysctl all ipv6 disable_policy
Type: integer

root options sysctl all ipv6 enhanced_dad
Type: integer

root options sysctl all ipv6 force_tllao
Type: integer

root options sysctl all ipv6 forwarding
Type: integer

root options sysctl all ipv6 hop_limit
Type: integer

root options sysctl all ipv6 max_addresses
Type: integer

root options sysctl all ipv6 mc_forwarding
Type: integer

root options sysctl all ipv6 mtu
Type: integer

root options sysctl all ipv6 ndisc_notify
Type: integer

root options sysctl all ipv6 ndisc_tclass
Type: integer

root options sysctl all ipv6 optimistic_dad
Type: integer

root options sysctl all ipv6 proxy_ndp
Type: integer

root options sysctl all ipv6 regen_max_retry
Type: integer

root options sysctl all ipv6 seg6_enabled
Type: integer

root options sysctl all ipv6 stable_secret
Type: stringFormat: ipv6

root options sysctl all ipv6 temp_valid_lft
Type: integer

root options sysctl all ipv6 use_optimistic
Type: integer

root options sysctl all ipv6 use_tempaddr
Type: integer

root options sysctl default
Type: object

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

root options sysctl default ipv4
Type: object

settings in /proc/sys/net/ipv4/*/conf/

root options sysctl default ipv4 accept_local
Type: integer

root options sysctl default ipv4 arp_accept
Type: integer

root options sysctl default ipv4 arp_announce
Type: integer

root options sysctl default ipv4 arp_filter
Type: integer

root options sysctl default ipv4 arp_ignore
Type: integer

root options sysctl default ipv4 arp_notify
Type: integer

root options sysctl default ipv4 bootp_relay
Type: integer

root options sysctl default ipv4 disable_xfrm
Type: integer

root options sysctl default ipv4 forwarding
Type: integer

root options sysctl default ipv4 log_martians
Type: integer

root options sysctl default ipv4 medium_id
Type: integer

root options sysctl default ipv4 proxy_arp
Type: integer

root options sysctl default ipv4 rp_filter
Type: integer

root options sysctl default ipv4 shared_media
Type: integer

root options sysctl default ipv4 tag
Type: integer

root options sysctl default ipv6
Type: object

settings in /proc/sys/net/ipv6/*/conf/

root options sysctl default ipv6 accept_dad
Type: integer

root options sysctl default ipv6 accept_ra
Type: integer

root options sysctl default ipv6 autoconf
Type: integer

root options sysctl default ipv6 disable_ipv6
Type: integer

root options sysctl default ipv6 enhanced_dad
Type: integer

root options sysctl default ipv6 force_tllao
Type: integer

root options sysctl default ipv6 forwarding
Type: integer

root options sysctl default ipv6 hop_limit
Type: integer

root options sysctl default ipv6 mtu
Type: integer

root options sysctl default ipv6 ndisc_notify
Type: integer

root options sysctl default ipv6 ndisc_tclass
Type: integer

root options sysctl default ipv6 proxy_ndp
Type: integer

root options sysctl default ipv6 seg6_enabled
Type: integer

root options sysctl default ipv6 stable_secret
Type: stringFormat: ipv6

root options sysctl default ipv6 use_tempaddr
Type: integer

root ignore
Type: object

ignore patterns to skip interface, ip address or routing objects

root ignore ipaddr
Type: array of string

list of ip address prefixes to be ignored

 No Additional Items

Each item of this array must be:

root ignore ipaddr ipaddr items
Type: string

ip address with prefix length
Example:

fe80::/10

root ignore ifname
Type: array of string

interface names matching this list of regex will be ignored

 No Additional Items

Each item of this array must be:

root ignore ifname ifname items
Type: string

regex to match interface name
Examples:

^docker\d+

^lo$

^ppp\d+$

^veth

root ignore routes
Type: object

filter routes by options

root ignore routes protos
Type: array of integer
No Additional Items

Each item of this array must be:

root ignore routes protos protos items
Type: integer

protocol number (/etc/iproute2/rt_protos)

root interfaces
Type: array of object

list of interface settings (link settings and ip addresses)

 No Additional Items

Each item of this array must be:

root interfaces interfaces items
Type: object

root interfaces interfaces items name
Type: string

name of the interface

root interfaces interfaces items addresses
Type: array of string

ip addresses of the interface

 No Additional Items

Each item of this array must be:

root interfaces interfaces items addresses addresses items
Type: string

Examples:

192.0.2.1

192.168.0.1/24

2001:db8::1/64

root interfaces interfaces items sysctl
Type: object

interface sysctl settings in /proc/sys/net/ipv*/conf/{IFACE}/

root interfaces interfaces items sysctl ipv4
Type: object

settings in /proc/sys/net/ipv4/*/conf/

root interfaces interfaces items sysctl ipv6
Type: object

settings in /proc/sys/net/ipv6/*/conf/

root interfaces interfaces items sysctl ipv6 stable_secret
Type: stringFormat: ipv6

root interfaces interfaces items ethtool
Type: object

network driver and hardware settings via ethtool(8)

root interfaces interfaces items ethtool pause
Type: object

pause parameters

root interfaces interfaces items ethtool pause autoneg
Type: enum (of string or boolean)

enable pause autonegotiation

Must be one of:

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

root interfaces interfaces items ethtool pause rx
Type: enum (of string or boolean)

enable Rx pause

Must be one of:

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

root interfaces interfaces items ethtool pause tx
Type: enum (of string or boolean)

enable Tx pause

Must be one of:

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

root interfaces interfaces items ethtool coalesce
Type: object

interrupt coalescing

root interfaces interfaces items ethtool coalesce adaptive-rx
Type: enum (of string or boolean)

Must be one of:

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

root interfaces interfaces items ethtool coalesce adaptive-tx
Type: enum (of string or boolean)

Must be one of:

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

root interfaces interfaces items ethtool ring
Type: object

rx/tx ring parameters

root interfaces interfaces items ethtool ring rx
Type: integer

number of ring entries for the Rx ring

root interfaces interfaces items ethtool ring rx-mmini
Type: integer

number of ring entries for the Rx Mini ring

root interfaces interfaces items ethtool ring rx-jumbo
Type: integer

number of ring entries for the Rx Jumbo ring

root interfaces interfaces items ethtool ring tx
Type: integer

number of ring entries for the Tx ring

root interfaces interfaces items ethtool features
Type: object

offload parameters and other features

root interfaces interfaces items ethtool features rx
Type: enum (of string or boolean)

enable RX checksumming

Must be one of:

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

root interfaces interfaces items ethtool features tx
Type: enum (of string or boolean)

enable TX checksumming

Must be one of:

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

root interfaces interfaces items ethtool features sg
Type: enum (of string or boolean)

enable scatter-gather

Must be one of:

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

root interfaces interfaces items ethtool features tso
Type: enum (of string or boolean)

enable TCP segmentation offload

Must be one of:

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

root interfaces interfaces items ethtool features ufo
Type: enum (of string or boolean)

enable UDP fragmentation offload

Must be one of:

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

root interfaces interfaces items ethtool features gso
Type: enum (of string or boolean)

enable generic segmentation offload

Must be one of:

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

root interfaces interfaces items ethtool features gro
Type: enum (of string or boolean)

enable generic receive offload

Must be one of:

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

root interfaces interfaces items ethtool features lro
Type: enum (of string or boolean)

enable large receive offload

Must be one of:

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

root interfaces interfaces items ethtool features rxvlan
Type: enum (of string or boolean)

enable RX VLAN acceleration

Must be one of:

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

root interfaces interfaces items ethtool features txvlan
Type: enum (of string or boolean)

enable TX VLAN acceleration

Must be one of:

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

root interfaces interfaces items ethtool features ntuple
Type: enum (of string or boolean)

enable Rx ntuple filters and actions

Must be one of:

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

root interfaces interfaces items ethtool features rxhash
Type: enum (of string or boolean)

enable receive hashing offload

Must be one of:

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

root interfaces interfaces items ethtool change
Type: object

device settings

root interfaces interfaces items ethtool change speed
Type: integer

speed in Mbps

root interfaces interfaces items ethtool change duplex
Type: enum (of string)

full or half duplex mode

Must be one of:

  • "half"
  • "full"

root interfaces interfaces items ethtool change port
Type: enum (of string)

device port selection

Must be one of:

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

root interfaces interfaces items ethtool change mdix
Type: enum (of string or boolean)

MDI-X mode for port

Must be one of:

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

root interfaces interfaces items ethtool change autoneg
Type: enum (of string or boolean)

enable autonegotation

Must be one of:

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

root interfaces interfaces items ethtool change advertise
Type: integer

speed and duplex advertised by autonegotation

root interfaces interfaces items ethtool change phyad
Type: integer

PHY address

root interfaces interfaces items ethtool change xcvr
Type: enum (of string)

transceiver type

Must be one of:

  • "internal"
  • "external"

root interfaces interfaces items ethtool change wol
Type: string

Wake-on-LAN options

Must match regular expression: ^[pumbagsfd]+$

root interfaces interfaces items ethtool change sopass
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}$

root interfaces interfaces items ethtool change msglvl

driver message flags

root interfaces interfaces items ethtool change msglvl oneOf item 0
Type: integer

driver message flags by number
root interfaces interfaces items ethtool change msglvl oneOf item 1
Type: array

driver message flags by name

 No Additional Items

Tuple Validation

Item at 1 must be:
root interfaces interfaces items ethtool change msglvl oneOf item 1 item 1 item 0
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:
root interfaces interfaces items ethtool change msglvl oneOf item 1 iface-ethtool_onoff
Type: enum (of string or boolean)

enable flag

Must be one of:

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

root interfaces interfaces items ethtool channels
Type: object

number of channels

root interfaces interfaces items ethtool channels rx
Type: integer

number of channels with only receive queues

root interfaces interfaces items ethtool channels tx
Type: integer

number of channels with only transmit queues

root interfaces interfaces items ethtool channels other
Type: integer

number of channels used only for other purposes

root interfaces interfaces items ethtool channels combined
Type: integer

number of multi-purpose channels

root interfaces interfaces items ethtool eee
Type: object

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

root interfaces interfaces items ethtool eee eee
Type: enum (of string or boolean)

enable EEE support

Must be one of:

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

root interfaces interfaces items ethtool eee tx-lpi
Type: enum (of string or boolean)

assert Tx LPI

Must be one of:

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

root interfaces interfaces items ethtool eee advertise
Type: integer

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

root interfaces interfaces items ethtool eee tx-timer
Type: integer

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

root interfaces interfaces items ethtool phy-tunable
Type: object

PHY tunable parameters

root interfaces interfaces items ethtool phy-tunable downshift

enable downshift

root interfaces interfaces items ethtool phy-tunable downshift oneOf iface-ethtool_onoff
Type: enum (of string or boolean)

enable downshift

Must be one of:

  • "on"
  • "off"
  • true
  • false
root interfaces interfaces items ethtool phy-tunable downshift oneOf item 1
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:
root interfaces interfaces items ethtool phy-tunable downshift oneOf item 1 iface-ethtool_onoff
Type: enum (of string or boolean)

enable downshift

Must be one of:

  • "on"
  • "off"
  • true
  • false
Item at 2 must be:
root interfaces interfaces items ethtool phy-tunable downshift oneOf item 1 item 1 item 1
Type: enum (of string)

REQUIRED

Must be one of:

  • "count"
Item at 3 must be:
root interfaces interfaces items ethtool phy-tunable downshift oneOf item 1 item 1 item 2
Type: integer

PHY downshift re-tries count

root interfaces interfaces items ethtool phy-tunable energy-detect-power-down

enable Energy Detect Power Down (EDPD)

root interfaces interfaces items ethtool phy-tunable energy-detect-power-down oneOf iface-ethtool_onoff
Type: enum (of string or boolean)

enable EDPD

Must be one of:

  • "on"
  • "off"
  • true
  • false
root interfaces interfaces items ethtool phy-tunable energy-detect-power-down oneOf item 1
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:
root interfaces interfaces items ethtool phy-tunable energy-detect-power-down oneOf item 1 iface-ethtool_onoff
Type: enum (of string or boolean)

enable EDPD

Must be one of:

  • "on"
  • "off"
  • true
  • false
Item at 2 must be:
root interfaces interfaces items ethtool phy-tunable energy-detect-power-down oneOf item 1 item 1 item 1
Type: enum (of string)

REQUIRED

Must be one of:

  • "msec"
Item at 3 must be:
root interfaces interfaces items ethtool phy-tunable energy-detect-power-down oneOf item 1 item 1 item 2
Type: integer

wake-up interval for Tx pulses

root interfaces interfaces items ethtool priv-flags
Type: object

private flags

root interfaces interfaces items ethtool fec
Type: object

Forward Error Correction

root interfaces interfaces items ethtool fec encoding
Type: enum (of string)

FEC encoding

Must be one of:

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

root routing
Type: object

root routing routes
Type: array of object
No Additional Items

Each item of this array must be:

root routing routes routes items
Type: object

root routing routes routes items dev
Type: integer or string

root routing routes routes items proto
Type: integer or string Default: "boot"

root routing routes routes items realm
Type: integer or string

root routing routes routes items scope
Type: integer or string

root routing routes routes items table
Type: integer or string Default: "main"

root routing routes routes items to
Type: string

root routing routes routes items via
Type: string

root routing rules
Type: array of object
No Additional Items

Each item of this array must be:

root routing rules rules items
Type: object

root routing rules rules items action
Type: enum (of string) Default: "to_tbl"

the type of this rule

Must be one of:

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

root routing rules rules items table
Type: integer or string

root routing rules rules items priority
Type: integer

the priority of this rule

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

root routing rules rules items from
Type: stringFormat: ipv4,ipv6

select the source prefix to match

root routing rules rules items to
Type: stringFormat: ipv4,ipv6

select the destination prefix to match

root routing rules rules items iif
Type: string

select the incoming device to match

root routing rules rules items oif
Type: string

select the outgoing device to match

root routing rules rules items proto
Type: integer or string Default: "unspec"

routing protocol number (/etc/iproute2/rt_protos)

root routing rules rules items fwmark
Type: integer

select the fwmark value to match

root routing rules rules items ipproto
Type: integer or string

select the ip protocol to match