sysconfig/interfaces/ifcfg-description

   1
   2 DEVICE=<name>
   3
   4 [ BOOTPRIO=number ]
   5   ifcfg-* interfaces are configured in BOOTPRIO order starting
   6   from lowest value first. You need to set BOOTPRIO in _all_ your
   7   ifcfg* files because if you won't do that only these interfaces
   8   with BOOTPRIO variable will be configured. Use the same schema
   9   when setting variable for example BOOTPRIO=number
  10   or BOOTPRIO="number" because sorting is done by sort command.
  11
  12 [ BOOTPROTO={none|bootp|dhcp|pump} ]
  13   You can specify which dhcp client to use with the DHCP_CLIENT, if
  14   the DHCP_CLIENT is not specified we trying to launch in order :
  15   /sbin/dhcpcd
  16   /sbin/dhclient
  17   /sbin/dhcpxd
  18   /sbin/pump
  19   if you have a preferred client define the DHCP_CLIENT variable.
  20   You can also pass some options to dhcp client via DHCP_OPTIONS.
  21
  22 [ BOOTPROTO6={none|dhcp6|v4compat}
  23   dhcp6 isn't supported, yet.
  24   v4compat uses available IPv4 addresses (ie. from DHCPv4)
  25   and then convert them to IPv6 (IPv4-compatible) to use with
  26   automatic tunnels
  27
  28
  29 IPADDR="(IPv4 or IPv6 address)/prefix"
  30 IP_AOPTS="broadcast xxx etc" (by default broadcast is autocalculated)
  31 IP_ROPTS=""
  32 IP_LABEL=""
  33
  34 IPADDR1=
  35 IP_AOPTS1= options for ip addr add
  36 IP_ROPTS1= options for ip route add (currently used only for IP4_PRIM_IF)
  37 IP_LABEL1= IPv6 address label as per RFC 3484 (ip addrlabel ...)
  38
  39 IP4_PRIM_IF="1"         # number of primary IPv4 interface (IPADDRx)
  40 IP4_SRC_IF="1"          # number of IPv4 address for ip's ,,src'' parameter
  41 IP6_PRIM_IF=""          #
  42
  43 [ ONBOOT={no|yes} ]
  44 [ HOTPLUG={no|yes} ] - bring up from hotplug (udev for example) (default to no)
  45 [ MULTICAST={|no|yes} ] - for eth automatically set to yes
  46 [ ARP={no|yes} ]        - for eth automatically set to yes
  47 [ IPV6_DISABLE_AUTOCONF={yes|no} ] - disable IPv6 autoconfiguration
  48
  49 [ IPX=yes|no ]
  50 if      IPX=yes ; then
  51
  52         IPXNETNUM_{802_2,802_2TR,802_3,EtherII,SNAP}
  53         IPXPRIMARY_{802_2,802_2TR,802_3,EtherII,SNAP}=yes|no
  54         IPXACTIVE_{802_2,802_2TR,802_3,EtherII,SNAP}=yes|no
  55 fi
  56
  57 [ MTU= ]
  58 [ METRIC= ]
  59 [ PROXYARP={yes|no} ]
  60
  61 QDISC=[sfq|teql0|red|prio|...] (queueing discipline)
  62 QDISC_CLASS=[htb|cbq|none]     (use cbq|htb as class based discipline;
  63                                 if none specified and bandwidth_out present
  64                                 then tbf is used)
  65 BANDWIDTH_IN=[upstream limit in kilobites, supported on 2.4 only]
  66 BANDWIDTH_OUT=[downstream limit in kilobites]
  67
  68 VLAN_REORDER_HDR=[0|1]  When this is set, the VLAN device will move the
  69                         ethernet header around to make it look exactly like a
  70                         real ethernet device.  This may help programs such
  71                         as DHCPd which read the raw ethernet packet and
  72                         make assumptions about the location of bytes.
  73                         If you don't need it, don't turn it on, because there
  74                         will be at least a small performance degradation.
  75                         Default is ON.
  76
  77 [ VLAN_GVRP=yes|no ]    Enable GVRP.
  78
  79 [ DEFAULTHANDLING=yes|no ] (used in configuration for ATM interfaces,
  80                             obsolete variable)
  81 [ HANDLING=0|1|2|3 ] (0 is default; used ie. in ATM configuration, for
  82                       details see ifup script)
  83
  84 [ CHECK_LINK_WAIT_TIMEOUT=<wait max x sec for interface link up> ]
  85
  86 if      DEVICE=eth*; then
  87
  88         [ MEDIA={auto|10baseT|10base2|AUI} ]
  89         [ MACADDR=<hw address> ]
  90
  91         if macvlan
  92                 MACVLAN_DEV=<exitsting base interface eg. eth0>
  93                 MACVLAN_MACADDR=<desired hw address of new interface>
  94                 MACVLAN_MODE=<desired mode of new interface (private, vepa, bridge, passthru, source)>
  95         fi
  96
  97
  98         if      DEVICE=wireless interface (man iwconfig(8))
  99                 WLAN_UPEARLY=<yes>|<no> Up device before setting any WLAN parameters
 100                                         (needed for some drivers)
 101                 WLAN_ESSID=<ESSID or Network Name (Domain ID)>|any|off
 102                 WLAN_NWID=<Network ID (Domain ID)>|off
 103                 WLAN_FREQ=<frequency> (2.422G)
 104                 WLAN_CHANNEL=<channel number> (3)
 105                 WLAN_SENS=<the sensitivity threshold>
 106                 WLAN_MODE=ad-hoc|managed|master|repeater|secondary|auto
 107                 WLAN_AP=<Access Point address>|any|auto|off
 108                 WLAN_NICKNAME=<station nickname)
 109                 WLAN_BITRATE=<bitrate like 11M>|auto|fixed
 110                 WLAN_RTS_THRESHOLD=<rts/cts threshold>|auto|fixed|off
 111                 WLAN_FRAGMENTATION_THRESHOLD=<frag threshold>|auto|fixed|off
 112                 WLAN_KEY=XXXX-XXXX-XXXX-XXXX|XXXXXXXX|s:<ascii string>
 113                 if WLAN_KEY; then
 114                         WLAN_KEY_1=... <optional>
 115                         WLAN_KEY_2=... <optional>
 116                         WLAN_KEY_3=... <optional>
 117                         WLAN_KEY_4=... <optional>
 118                         WLAN_KEY_CURRENT=index <optional>
 119                 fi
 120                 WLAN_ENCRYPTION=on|off|open|restricted
 121                 WLAN_POWER=period <value>|timeout <value>|on|off|all|unicast|multicast
 122                 WLAN_TXPOWER=<power in dBm>|<power in mW>mW|auto|on|off
 123                 WLAN_RETRY=limit <value>|lifetime <value>
 124                 WLAN_COMMIT=yes|no (some cards require manual commit of changes)
 125                 if WLAN_WPA=yes; then
 126                         WLAN_WPA_WAIT_TIMEOUT=<wait max x sec for wpa_suplicant>
 127                         WLAN_WPA_DRIVER=<driver: see -D option of wpa_supplicant; default is wext>
 128                         WLAN_WPA_CONFIG=<path to wpa_supplicant config file>
 129                         WLAN_WPA_OPTIONS=[additional wpa_supplicant options]
 130                 fi
 131         fi
 132
 133 elif    DEVICE=ppp* || DEVICE=sl* ; then
 134
 135         PERSIST=yes|no
 136         MODEMPORT=<device, say /dev/modem>
 137         LINESPEED=<speed, say 115200>
 138         DEFABORT=yes|no
 139         DIRECT_CONNECT=yes|no (direct connection without chat/wvdial used for example
 140                                on SDI or leased lines)
 141
 142         if      DEVICE=ppp* ; then
 143
 144                 AUTH=yes|no
 145                 PEERDNS=yes|no
 146                 DEFROUTE=yes|no
 147                 ESCAPECHARS=yes|no
 148                 SYNC=yes|no (yes implies "sync" option)
 149                 HOLDOFF=30
 150                 HARDFLOWCTL=yes|no (yes implies "modem crtscts" options)
 151                 PPPOPTIONS=<arbitrary option string>
 152                 PAPNAME=<"name $PAPNAME" on pppd command line>
 153                 REMIP=<remote ip4 address, normally unspecified>
 154                 REMIP6=<remote ip6 address, normally unspecified>
 155                 MRU=
 156                 DISCONNECTTIMEOUT=<number of seconds, default currently 5>
 157                 RETRYTIMEOUT=<number of seconds, default currently 60>
 158                 INITSCRIPT=<modem command>
 159                 DATAFORCHAT=<list of variables>
 160                 <anything>=<anything> (for chat script)
 161                 IPV6_PPP=yes|no (use IPv6 for ppp ?)
 162                 if IPV6_PPP = yes ; then
 163                         IPV6_CP_USEV4=yes|no (use local IPv4 mapped addresses
 164                                               as IPv6 addresses)
 165                         IPV6_CP_PERSISTENT=yes|no (use EUI-48 addresses
 166                                                    as IPv6 addresses; not
 167                                                    supported on Linux, yet)
 168                         or by default use address specified by IP6_PRIM_IF
 169                         and REMIP6
 170                 fi
 171                 PPPOA=yes|no (generic PPP over ATM)
 172                 if PPPOA = yes ; then
 173                         PPPOA_VPI=<VPI number>
 174                         PPPOA_VCI=<VCI number>
 175                 fi
 176                 PPPOE_DEV=<ethX> (PPP over Ethernet device)
 177                 if PPPOE_DEV exists ; then
 178                         PPPOE_KERNEL=yes|no (use or not kernel space PPPoE support)
 179                         PPPOE_OPT=<options> (used only with userspace pppoe program)
 180                 fi
 181                 PPPOA_EAGLE=yes|no (eagle-usb support)
 182                 if PPPOA_EAGLE = yes ; then
 183                         PPPOA_OPT=<options> (used only with userspace pppoa program)
 184                 fi
 185                 PPPOA_SPEEDTOUCH=yes|no (speedtouch support)
 186                 if PPPOA_SPEEDTOUCH = yes ; then
 187                         PPPOA_KERNEL=yes|no (use or not kernel space PPPoA support)
 188                         PPPOA_VPI=<VPI number>
 189                         PPPOA_VCI=<VCI number>
 190                         PPPOA_OPT=<options> (used only with userspace pppoa program)
 191                 fi
 192                 UNIT=yes|no (pass unit option to pppd (depends on DEVICE name)
 193                              defaults to yes)
 194                 WVDIALSECT= (section in wvdial config maybe)
 195         fi
 196
 197         if      DEVICE=sl* ; then       (SLIP)
 198                 PROTOCOL=slip|cslip|adaptive
 199                 REMIP=<remote ip4 address>
 200                 REMIP6=<remote ip6 address, normally unspecified>
 201         fi
 202
 203 elif    DEVICE=br* ; then       /* Bridge */
 204
 205         BRIDGE_DEVS=<list of devices betwen which do bridging>
 206                     Note: separation configuration for devices in this list
 207                           should be avoided !
 208         AGEING=<ethernet (MAC) address ageing time in seconds>
 209         GCINT=<garbage collection interval time for the bridge in seconds>
 210
 211         SPANNING_TREE=yes|no (enable SPT - Spanning Tree Protocol)
 212         if      SPANNING_TREE=yes ; then
 213                         BRIDGEPRIO=<bridge's priority; 0-65535; less == better>
 214                         FD=<bridge forward delay time in seconds>
 215                         HELLO=<bridge hello time in seconds>
 216                         MAXAGE=<maximum message age in seconds>
 217                         PATHCOST_PORT=<port number>
 218                         PATHCOST=<cost of the port specified in PATHCOST_PORT>
 219                                 Note: both PATHCOST_PORT and PATHCOST must be
 220                                       specified to set cost of port
 221                         PORTPRIO_PORT=<port>
 222                         PORTPRIO=<port priority used by port selection algorithms;
 223                                   a number between 0 and 255>
 224                                 Note: see note above
 225         fi
 226 elif    DEVICE=irda* ; then     /* IrDA */
 227
 228         IRDAPORT=<device, say /dev/ttyS1>
 229         DONGLE=<driver, see README.irattach from irda-utils package>
 230         DISCOVERY=yes|no (starts discovery of remote IrDA devices)
 231 fi
 232
 233 # You can also run commands before/after a device has been brought up or down.
 234 # Just create functions run_up/run_pre_up/run_down/run_pre_down.
 235 run_pre_up()
 236 {
 237         echo "This will be executed before device is brought up!"
 238 }
 239
 240 run_up()
 241 {
 242         echo "This will be executed after device is brought up!"
 243 }
 244
 245 run_pre_down()
 246 {
 247         echo "This will be executed before device is brought down!"
 248 }
 249
 250 run_down()
 251 {
 252         echo "This will be executed after device is brought down!"
 253 }