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 if      DEVICE=eth*; then
  85
  86         [ MEDIA={auto|10baseT|10base2|AUI} ]
  87         [ MACADDR=<hw address> ]
  88
  89         if macvlan
  90                 MACVLAN_DEV=<exitsting base interface eg. eth0>
  91                 MACVLAN_MACADDR=<desired hw address of new interface>
  92         fi
  93
  94
  95         if      DEVICE=wireless interface (man iwconfig(8))
  96                 WLAN_UPEARLY=<yes>|<no> Up device before setting any WLAN parameters
  97                                         (needed for some drivers)
  98                 WLAN_ESSID=<ESSID or Network Name (Domain ID)>|any|off
  99                 WLAN_NWID=<Network ID (Domain ID)>|off
 100                 WLAN_FREQ=<frequency> (2.422G)
 101                 WLAN_CHANNEL=<channel number> (3)
 102                 WLAN_SENS=<the sensitivity threshold>
 103                 WLAN_MODE=ad-hoc|managed|master|repeater|secondary|auto
 104                 WLAN_AP=<Access Point address>|any|auto|off
 105                 WLAN_NICKNAME=<station nickname)
 106                 WLAN_BITRATE=<bitrate like 11M>|auto|fixed
 107                 WLAN_RTS_THRESHOLD=<rts/cts threshold>|auto|fixed|off
 108                 WLAN_FRAGMENTATION_THRESHOLD=<frag threshold>|auto|fixed|off
 109                 WLAN_KEY=XXXX-XXXX-XXXX-XXXX|XXXXXXXX|s:<ascii string>
 110                 if WLAN_KEY; then
 111                         WLAN_KEY_1=... <optional>
 112                         WLAN_KEY_2=... <optional>
 113                         WLAN_KEY_3=... <optional>
 114                         WLAN_KEY_4=... <optional>
 115                         WLAN_KEY_CURRENT=index <optional>
 116                 fi
 117                 WLAN_ENCRYPTION=on|off|open|restricted
 118                 WLAN_POWER=period <value>|timeout <value>|on|off|all|unicast|multicast
 119                 WLAN_TXPOWER=<power in dBm>|<power in mW>mW|auto|on|off
 120                 WLAN_RETRY=limit <value>|lifetime <value>
 121                 WLAN_COMMIT=yes|no (some cards require manual commit of changes)
 122                 if WLAN_WPA=yes; then
 123                         WLAN_WPA_WAIT_TIMEOUT=<wait max x sec for wpa_suplicant>
 124                         WLAN_WPA_DRIVER=<driver: see -D option of wpa_supplicant; default is wext>
 125                         WLAN_WPA_CONFIG=<path to wpa_supplicant config file>
 126                         WLAN_WPA_OPTIONS=[additional wpa_supplicant options]
 127                 fi
 128         fi
 129
 130 elif    DEVICE=ppp* || DEVICE=sl* ; then
 131
 132         PERSIST=yes|no
 133         MODEMPORT=<device, say /dev/modem>
 134         LINESPEED=<speed, say 115200>
 135         DEFABORT=yes|no
 136         DIRECT_CONNECT=yes|no (direct connection without chat/wvdial used for example
 137                                on SDI or leased lines)
 138
 139         if      DEVICE=ppp* ; then
 140
 141                 AUTH=yes|no
 142                 PEERDNS=yes|no
 143                 DEFROUTE=yes|no
 144                 ESCAPECHARS=yes|no
 145                 SYNC=yes|no (yes implies "sync" option)
 146                 HOLDOFF=30
 147                 HARDFLOWCTL=yes|no (yes implies "modem crtscts" options)
 148                 PPPOPTIONS=<arbitrary option string>
 149                 PAPNAME=<"name $PAPNAME" on pppd command line>
 150                 REMIP=<remote ip4 address, normally unspecified>
 151                 REMIP6=<remote ip6 address, normally unspecified>
 152                 MRU=
 153                 DISCONNECTTIMEOUT=<number of seconds, default currently 5>
 154                 RETRYTIMEOUT=<number of seconds, default currently 60>
 155                 INITSCRIPT=<modem command>
 156                 DATAFORCHAT=<list of variables>
 157                 <anything>=<anything> (for chat script)
 158                 IPV6_PPP=yes|no (use IPv6 for ppp ?)
 159                 if IPV6_PPP = yes ; then
 160                         IPV6_CP_USEV4=yes|no (use local IPv4 mapped addresses
 161                                               as IPv6 addresses)
 162                         IPV6_CP_PERSISTENT=yes|no (use EUI-48 addresses
 163                                                    as IPv6 addresses; not
 164                                                    supported on Linux, yet)
 165                         or by default use address specified by IP6_PRIM_IF
 166                         and REMIP6
 167                 fi
 168                 PPPOA=yes|no (generic PPP over ATM)
 169                 if PPPOA = yes ; then
 170                         PPPOA_VPI=<VPI number>
 171                         PPPOA_VCI=<VCI number>
 172                 fi
 173                 PPPOE_DEV=<ethX> (PPP over Ethernet device)
 174                 if PPPOE_DEV exists ; then
 175                         PPPOE_KERNEL=yes|no (use or not kernel space PPPoE support)
 176                         PPPOE_OPT=<options> (used only with userspace pppoe program)
 177                 fi
 178                 PPPOA_EAGLE=yes|no (eagle-usb support)
 179                 if PPPOA_EAGLE = yes ; then
 180                         PPPOA_OPT=<options> (used only with userspace pppoa program)
 181                 fi
 182                 PPPOA_SPEEDTOUCH=yes|no (speedtouch support)
 183                 if PPPOA_SPEEDTOUCH = yes ; then
 184                         PPPOA_KERNEL=yes|no (use or not kernel space PPPoA support)
 185                         PPPOA_VPI=<VPI number>
 186                         PPPOA_VCI=<VCI number>
 187                         PPPOA_OPT=<options> (used only with userspace pppoa program)
 188                 fi
 189                 UNIT=yes|no (pass unit option to pppd (depends on DEVICE name)
 190                              defaults to yes)
 191                 WVDIALSECT= (section in wvdial config maybe)
 192         fi
 193
 194         if      DEVICE=sl* ; then       (SLIP)
 195                 PROTOCOL=slip|cslip|adaptive
 196                 REMIP=<remote ip4 address>
 197                 REMIP6=<remote ip6 address, normally unspecified>
 198         fi
 199
 200 elif    DEVICE=br* ; then       /* Bridge */
 201
 202         BRIDGE_DEVS=<list of devices betwen which do bridging>
 203                     Note: separation configuration for devices in this list
 204                           should be avoided !
 205         AGEING=<ethernet (MAC) address ageing time in seconds>
 206         GCINT=<garbage collection interval time for the bridge in seconds>
 207
 208         SPANNING_TREE=yes|no (enable SPT - Spanning Tree Protocol)
 209         if      SPANNING_TREE=yes ; then
 210                         BRIDGEPRIO=<bridge's priority; 0-65535; less == better>
 211                         FD=<bridge forward delay time in seconds>
 212                         HELLO=<bridge hello time in seconds>
 213                         MAXAGE=<maximum message age in seconds>
 214                         PATHCOST_PORT=<port number>
 215                         PATHCOST=<cost of the port specified in PATHCOST_PORT>
 216                                 Note: both PATHCOST_PORT and PATHCOST must be
 217                                       specified to set cost of port
 218                         PORTPRIO_PORT=<port>
 219                         PORTPRIO=<port priority used by port selection algorithms;
 220                                   a number between 0 and 255>
 221                                 Note: see note above
 222         fi
 223 elif    DEVICE=irda* ; then     /* IrDA */
 224
 225         IRDAPORT=<device, say /dev/ttyS1>
 226         DONGLE=<driver, see README.irattach from irda-utils package>
 227         DISCOVERY=yes|no (starts discovery of remote IrDA devices)
 228 fi
 229
 230 # You can also run some other programs *after* device has been brought up or down.
 231 # Just create functions run_up() and run_down().
 232 run_up()
 233 {
 234         echo "This will be executed after device is brought up!"
 235 }
 236
 237 run_down()
 238 {
 239         echo "This will be executed after device is brought down!"
 240 }