NAME

/etc/net interface options

OPTIONS

Common options

TYPE

This option defines interface type. It is required, if interface type cannot be found from interface name and if DISABLED is not set.

DISABLED

Set to "yes" to ignore the interface. Note that setting DISABLED to "yes" in ifaces/default/options and having no "DISABLED=no" in interface-specific options file will effectively disable ALL interfaces.

BOOTPROTO

BOOTPROTO can be any of the following: static, dhcp, dhcp6, ipv4ll.

static use ipv4address/ipv6address. It has the same meaning as 'none' in initscripts/net-scripts sense. If you don't want to assign any address to an interface, but still keep it up and running, you can just use 'static' and have no ipv4address file.

dhcp run DHCP client

ipv4ll run IPv4LL client, currently avahi-autoipd

dhcp6 run DHCPv6 client

Additional feature is multi-method configurations (methods can be delimited by ' ', ',' or '-':

dhcp-static try DHCP, if it fails, configure IPv4 static address(es). Implies static for IPv6.

dhcp6-static try DHCPv6, if it fails, configure IPv6 static address(es). Implies static for IPv4.

dhcp-ipv4ll same, but fallback to IPv4LL

dhcp-ipv4ll-static try DHCP, fallback to IPv4LL (very unlikely to fail), fallback to static

/etc/net will try to configure interface at the first succeeding method. Note that etcnet will process routes and rules despite of BOOTPROTO.

ONBOOT

Defines if the interface will be automatically brought up during system startup or 'service network start' invocation.

USE_HOTPLUG

If set to yes, iface will be skipped during boot. Note that standard hotplug calls /sbin/ifup and /sbin/ifdown. This should be changed to /etc/net/scripts/ifup-removable and /etc/net/scripts/ifdown-removable respectively, if you wish to use etcnet from hotplug.

USE_PCMCIA

Same for pcmcia_cs

CONFIG_IPV4, CONFIG_IPV6, CONFIG_IPX

These boolean options define, if you want to perform configuration of particular protocol or not.

CONFIG_QOS

This boolean function enables Linux QoS configuration. This topic is explained in etcnet-qos manpage.

CONFIG_DOT1X

This boolean option enables wired 802.1x authentication.

CONFIG_WIRELESS

This boolean option enables wireless extensions configuration.

CONFIG_FW

This boolean option enables firewall configuration. This topic is explained in README.firewall file.

KEEP_UP

If set to yes, an interface will not be set DOWN while ifdown is invoked. This can be suitable for loopback interfaces.

KEEP_DOWN

If set to yes, an interface will not be set UP, but configured. You are unlikely to need this option enabled.

DONT_FLUSH

IPv4/IPv6. Don't flush existing addresses from interface before assigning new ones. Also don't flush addresses on deconfiguration.

IFUP_CHILDREN

If set to yes, this variable will cause ifup call for all child (having current interface in their REQUIRES list) after the current interface is set up.

IFUP_PARENTS

If set to yes, this variable will cause ifup call for all parent (listed in current REQUIRES list) before the current interface is set up. Note: this will not work for ifplugd-controlled interfaces.

IFDOWN_CHILDREN

If set to yes, this variable will cause ifdown call for all child (having current interface in their REQUIRES list) before the current interface is shut down.

IFDOWN_PARENTS

If set to yes, this variable will cause ifdown call for all parent (listed in current REQUIRES list) after the current interface is shut down. Note: this will not work for ifplugd-controlled interfaces.

Ethernet options

MODULE

Kernel module name (or quoted list of names), which must be loaded before interface initialisation.

USE_IFPLUGD

A special configuration method. The interface will be created, but no configuration will be done until cable is plugged in. When ifplugd detects cable presence on the interface, it will run ifup-ifplugd to finish configuration. Values: no: don't use this feature yes: manage ifplugd for each such interface auto: same as 'yes', if ifplugd is available and the card supports link detection

PERSISTENT_IFPLUGD

Two operational modes are possible with USE_IFPLUGD=auto: persistent ifplugd (ifplugd will be run once and then only suspended/resumed when needed) and temporary ifplugd (ifplugd will be killed at ifdown and started at ifup each time). Default mode is to keep persistent ifplugd process.

IFPLUGD_EXTRA_ARGS

/etc/net will construct ifplugd arg list automatically, but you can add extra args with this option.

LINKDETECT

LINKDETECT option allows to avoid DHCP/IPv4LL timeout, if ethernet cable is not plugged in during startup. This feature requires ifplugstatus and is off by default, because not all network cards report correct link status. Possible values are: yes/no/auto. link status, LINKDETECT feature will take effect.

LINKDELAY

Some Ethernet interface modules require significant time to negotiate link parameters upon loading. Once the initial negitiation is complete, they indicate further link state changes correctly. This option specifies maximum number of seconds allowed for a module to report link absence before giving up and deciding, that the link is really absent. If the module reports link before timeout expires, it will be seen without spending all the time waiting.

MACADDR_WAITTIME

Some network card modules create network device first, then perform some initialization and after some time fill in MAC address data. Hotplug starts working immediately after the interface is created. If this variable is set to non-zero, /etc/net will wait for specified amount of 0.1 sec times for MAC address to become not 00:00:00:00:00:00. WARNING: THIS IS EXPERIMENTAL FEATURE !!!

IWCONFIG

Optional path to iwconfig.

WPA_SUPPLICANT

Optional path to wpa_supplicant.

WPA_DRIVER

Optional WPA driver name to pass to wpa_supplicant.

DHCP_CLIENT

Full path to DHCP client. Currently dhclient and dhcpcd are recognized and command-line options list built appropriately.

DHCP_TIMEOUT

Optional DHCP client timeout in seconds.

DHCP_ARGS

Optional additional DHCP client arguments.

DHCP_HOSTNAME

Possible values: 'localhost' (compute a valid hostname and send it to DHCP server with -h option); 'NONE' (don't send anything); any other string (send the string as a hostname with -h).

IP tunnels options

TUNTYPE

IP tunnel type: 'ipip' (default), 'gre' or 'sit'.

TUNLOCAL

Local tunnel endpoint.

TUNREMOTE

Remote tunnel endpoint.

TUNOPTIONS

Append whatever you want (TTL, GRE keys etc). Don't set 'dev' here.

HOST

Optional host interface. If set, this name will be used for 'dev' option.

IPSec tunnels options

At least one of cipher or digest must be configured.

CIPHERFILE and DIGESTFILE are searched in iface dir. If CIPHER is defined, CIPHERFILE must be defined too, same for DIGEST and DIGESTFILE.

IPSECADM

(Optional) location of ipsecadm.

TUNLOCAL

Local endpoint.

TUNREMOTE

Remote endpoint.

TUNSPI

SPI must be defined for an IPSec tunnel. SPI is a hexadecimal number, values less than 0x2000 are reserved.

CIPHER

Cipher name.

CIPHERFILE

Dipher file name.

DIGEST

Digest name.

DIGESTFILE

Digest file name.

HOST

"ipsecadm --nextdev" argument

VLAN options

HOST

Required parent iface name.

VID

Required VLAN ID.

VLAN_REORDER_HDR

This option allows changing the REORDER_HDR flag for each VLAN interface. The flag can be either "yes" or "no" and its meaning is described in vconfig manpage.

VXLAN options

HOST

Required parent iface name.

VNI

Required VXLAN Network Identifer (or VXLAN Segment Identifier).

LOCAL

Required source IP address to use in outgoing packets.

REMOTE

Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database. This parameter cannot be specified with the group parameter.

GROUP

Specifies the multicast IP address to join. This parameter cannot be specified with the remote parameter.

DSTPORT

Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.

TTL

Specifies the TTL value to use in outgoing packets.

DVB options

DVBTYPE

This is a mandatory option. Currently supported values are: ss223 for SkyStar-2 rev. 2.3, ss226 for SkyStar-2 rev. 2.6, pentanet for Pent@NET, pentaval for Pent@VALUE

SkyStar-2 options

PID

SZAP

SZAP_ARGS

DVBNET

CHANNELS_CONF

For SkyStar cards you can override channels.conf location (default is channels.conf in the interface's configuration directory.

Pent@NET options

PENTANETT

pentanett location

PENTANET_CONF

Config file name.

Pent@VALUE options

PENTAVALT

pentavalt location

PENTAVAL_CONF

config file name

Bonding options

HOST

BONDMODE

Operation mode (optional). Possible values: 0 for round robin (default), 1 for active-backup, 2 for xor, 3 for broadcast, 4 for IEEE 802.3ad Dynamic link aggregation.

BONDOPTIONS

Additional options. This will have effect per interface. The list from modinfo bond is:
miimon:int: Link check interval in milliseconds
updelay:int: Delay before considering link up, in milliseconds
downdelay:int: Delay before considering link down, in milliseconds
use_carrier:int: Use netif_carrier_ok (vs MII ioctls) in miimon; 0 for off, 1 for on (default)
primary:string: Primary network device to use
lacp_rate:string: LACPDU tx rate to request from 802.3ad partner (slow/fast)
arp_interval:int: arp interval in milliseconds
arp_ip_target:string array (min = 1, max = 16): arp targets in n.n.n.n form

Bridge options

HOST

This variable must be defined for each bridge interface. This is a (quoted) space-separated list of slave ethernet interfaces combining the bridge. Don't forget to create configurations for the slave interfaces too.

BRIDGE_OPTIONS

Additional options. See ip-link(8) manpage for details.

PPP options

This section assumes knowledge of pppd(8) manpage.

PPPTYPE

PPP subtype. Valid types are: dialup, pptp, pppoe. pptp and pptp types will benefit from correctly set REQIURES and respectively HOST variables. dialup subtype will add 'modem' to pppd options list.

PPTP_SERVER

For "pptp" subtype you must specify hostname or IP address of PPtP server you connect to. Otherwise leave PPPTYPE=dialup.

HOST

pppoe client requires target interface name. You must specify it in the HOST variable, create-ppp will automatically construct correct pty option for pppd. This option is mandatory if PPPTYPE=pppoe.

PPPOE

Optional pppoe path.

PPPOE_EXTRA_OPTIONS

PPTP

Optional pptp-client path.

PPTP_EXTRA_OPTIONS

PPPD

pppd location, optional

PPPOPTIONS

Additional pppd args. Note that interface-specific options file will override PPPOPTIONS from options-ppp, not append. WARNING! NEVER set "persist maxfail 0" for an interface with ONBOOT=yes, otherwise your host risks hanging forever.

CHAT

chat location, optional

CHATOPTIONS

chat options (timeout, verbose mode etc)

PPPOPTIONSFILE

PPPINITCHAT

PPPCONNECTCHAT

PPPDISCONNECTCHAT

RESTORE_DEFAULTROUTE

pppd does not save default route for us. We could save and restore it with ip-up/ip-down, but this option will do the trick for us.

PPPTIMEOUT

Your PPP link will not hang for more seconds, than specified here. /etc/net will pass according lcp-echo-interval and lcp-echo-failure options to pppd, if this options is set.