sysconfig/interfaces/ifcfg-description

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