[projects/rc-scripts.git] / sysconfig / interfaces / ifcfg-description

#	$Id: ifcfg-description,v 1.13 2001/05/15 16:03:43 baggins Exp $
DEVICE=<name>
[ BOOTMETHOD={none|bootp|dhcp|pump} ]
  You can specify which dhcp client to use with the DHCP_CLIENT, if
  the DHCP_CLIENT is not specified we trying to launch in order :
  /sbin/dhcpcd
  /sbin/dhclient
  /sbin/dhcpxd
  /sbin/pump
  if you have a preferred client define the DHCP_CLIENT variable.
  You can also pass some options to dhcl client via DHCP_OPTIONS.

[ BOOTMETHOD6={none|dhcp6|v4compat}
  dhcp6 method isn't supported, yet.
  v4compat uses available IPv4 addresses (ie. from DHCPv4)
  and then convert them to IPv6 (IPv4-compatible) to use with
  automatic tunnels


IPADDR="(IPv4 or IPv6 address)/prefix"
IP_AOPTS="broadcast xxx etc" (by default broadcast is autocalculated)
IP_ROPTS=""

IPADDR1=
IP_AOPTS1= options for ip addr add
IP_ROPTS1= options for ip route add (currently used only for IP4_PRIM_IF)

IP4_PRIM_IF="1"		# number of primary IPv4 interface (IPADDRx)
IP4_SRC_IF="1"		# number of IPv4 address for ip's ,,src'' parameter
IP6_PRIM_IF=""		# 
IP6_SRC_IF=""		# 

[ ONBOOT={no|yes} ]
[ MULTICAST={|no|yes} ]	- for eth automamaticly set to yes
[ ARP={no|yes} ]	- for eth automamaticly set to yes
[ IPV6_DISABLE_AUTOCONF={yes|no} ] - disable IPv6 autoconfiguration

[ IPX=yes|no ]
if	IPX=yes ; then

	IPXNETNUM_{802_2,802_2TR,802_3,EtherII,SNAP}
	IPXPRIMARY_{802_2,802_2TR,802_3,EtherII,SNAP}=yes|no
	IPXACTIVE_{802_2,802_2TR,802_3,EtherII,SNAP}=yes|no
fi

[ MTU= ]
[ METRIC= ]

[ QDISC= ]

[ DEFAULTHANDLING=yes|no ] (used in configuration for ATM interfaces,
			    obsolete variable)
[ HANDLING=0|1|2|3 ] (0 is default; used ie. in ATM configuration, for
		      details see ifup script)

if 	DEVICE=eth* ; then

	[ MEDIA={auto|10baseT|10base2|AUI} ]
	[ MAC=<hw addres> ]
	
elif	DEVICE=ppp* || DEVICE=sl* ; then
	
	PERSIST=yes|no
	MODEMPORT=<device, say /dev/modem>
	LINESPEED=<speed, say 115200>
	DEFABORT=yes|no 
	
	if	DEVICE=ppp* ; then
	
		AUTH=yes|no
		PEERDNS=yes|no
		DEFROUTE=yes|no
		ESCAPECHARS=yes|no
	  	HARDFLOWCTL=yes|no (yes imples "modem crtscts" options)
    	 	PPPOPTIONS=<arbitrary option string>
		PAPNAME=<"name $PAPNAME" on pppd command line>
		REMIP=<remote ip4 address, normally unspecified>
		REMIP6=<remote ip6 address, normally unspecified>
    		MRU=
    		DISCONNECTTIMEOUT=<number of seconds, default currently 5>
    		RETRYTIMEOUT=<number of seconds, default currently 60>
    		INITSCRIPT=<modem command>
    		DATAFORCHAT=<list of variables>
    		<anything>=<anything> (for chat script)
		IPV6_PPP=yes|no (use IPv6 for ppp ?)
		if IPV6_PPP = yes ; then
			IPV6_CP_USEV4=yes|no (use local IPv4 mapped addresses
					      as IPv6 addresses)
			IPV6_CP_PERSISTENT=yes|no (use EUI-48 addresses
						   as IPv6 addresses; not
						   supported on Linux, yet)
			or by default use address specified by IP6_PRIM_IF
			and REMIP6
		fi
	fi

	if	DEVICE=sl* ; then	(SLIP)
		DIRECT_CONNECT=yes|no (dirrect connection via slattach ?)
		PROTOCOL=slip|cslip|adaptive
		REMIP=<remote ip4 address>
		REMIP6=<remote ip6 address, normally unspecified>
	fi

elif	DEVICE=br* ; then	/* Bridge */

	BRIDGE_DEVS=<list of devices betwen which do bridging>
		    Note: separation configuration for devices in this list
		          should be avoided !
	AGEING=<ethernet (MAC) address ageing time in seconds>
	GCINT=<garbage collection interval time for the bridge in seconds>

	SPANNING_TREE=yes|no (enable SPT - Spanning Tree Protocol)
	if	SPANNING_TREE=yes ; then
			BRIDGEPRIO=<bridge's priority; 0-65535; less == better>
			FD=<bridge forward delay time in seconds>
			HELLO=<bridge hello time in seconds>
			MAXAGE=<maximum message age in seconds>
			PATHCOST_PORT=<port number>
			PATHCOST=<cost of the port specified in PATHCOST_PORT>
				Note: both PATHCOST_PORT and PATHCOST must be
				      specified to set cost of port
			PORTPRIO_PORT=<port>
			PORTPRIO=<port priority used by port selection algorithms;
			          a number between 0 and 255>
				Note: see note above
	fi
fi

# You can also run some other programs *after* uping od downing
# device. Just create functions run_up() and run_down()
run_up()
{
	echo "This will be executed after uping device !"
}

run_down()
{
	echo "This will be executed after downing device !"
}
Commit	Line	Data
de1fc6ce JR	1	# $Id: ifcfg-description,v 1.13 2001/05/15 16:03:43 baggins Exp $
	2	DEVICE=<name>
	3	[ BOOTMETHOD={none\|bootp\|dhcp\|pump} ]
	4	You can specify which dhcp client to use with the DHCP_CLIENT, if
	5	the DHCP_CLIENT is not specified we trying to launch in order :
	6	/sbin/dhcpcd
	7	/sbin/dhclient
	8	/sbin/dhcpxd
	9	/sbin/pump
	10	if you have a preferred client define the DHCP_CLIENT variable.
	11	You can also pass some options to dhcl client via DHCP_OPTIONS.
	12
	13	[ BOOTMETHOD6={none\|dhcp6\|v4compat}
	14	dhcp6 method isn't supported, yet.
	15	v4compat uses available IPv4 addresses (ie. from DHCPv4)
	16	and then convert them to IPv6 (IPv4-compatible) to use with
	17	automatic tunnels
	18
	19
	20	IPADDR="(IPv4 or IPv6 address)/prefix"
	21	IP_AOPTS="broadcast xxx etc" (by default broadcast is autocalculated)
	22	IP_ROPTS=""
	23
	24	IPADDR1=
	25	IP_AOPTS1= options for ip addr add
	26	IP_ROPTS1= options for ip route add (currently used only for IP4_PRIM_IF)
	27
	28	IP4_PRIM_IF="1" # number of primary IPv4 interface (IPADDRx)
	29	IP4_SRC_IF="1" # number of IPv4 address for ip's ,,src'' parameter
	30	IP6_PRIM_IF="" #
	31	IP6_SRC_IF="" #
	32
03f9cfee	33	[ ONBOOT={no\|yes} ]
de1fc6ce JR	34	[ MULTICAST={\|no\|yes} ] - for eth automamaticly set to yes
	35	[ ARP={no\|yes} ] - for eth automamaticly set to yes
	36	[ IPV6_DISABLE_AUTOCONF={yes\|no} ] - disable IPv6 autoconfiguration
	37
	38	[ IPX=yes\|no ]
	39	if IPX=yes ; then
	40
	41	IPXNETNUM_{802_2,802_2TR,802_3,EtherII,SNAP}
	42	IPXPRIMARY_{802_2,802_2TR,802_3,EtherII,SNAP}=yes\|no
	43	IPXACTIVE_{802_2,802_2TR,802_3,EtherII,SNAP}=yes\|no
	44	fi
	45
b2d62426 AM	46	[ MTU= ]
	47	[ METRIC= ]
	48
642c5ec3 JK	49	[ QDISC= ]
642c5ec3 JK	50
de1fc6ce JR	51	[ DEFAULTHANDLING=yes\|no ] (used in configuration for ATM interfaces,
	52	obsolete variable)
	53	[ HANDLING=0\|1\|2\|3 ] (0 is default; used ie. in ATM configuration, for
	54	details see ifup script)
	55
b2d62426 AM	56	if DEVICE=eth* ; then
	57
	58	[ MEDIA={auto\|10baseT\|10base2\|AUI} ]
	59	[ MAC=<hw addres> ]
	60
de1fc6ce	61	elif DEVICE=ppp* \|\| DEVICE=sl* ; then
b2d62426 AM	62
	63	PERSIST=yes\|no
	64	MODEMPORT=<device, say /dev/modem>
	65	LINESPEED=<speed, say 115200>
	66	DEFABORT=yes\|no
	67
	68	if DEVICE=ppp* ; then
	69
03f9cfee	70	AUTH=yes\|no
de1fc6ce	71	PEERDNS=yes\|no
b2d62426 AM	72	DEFROUTE=yes\|no
	73	ESCAPECHARS=yes\|no
	74	HARDFLOWCTL=yes\|no (yes imples "modem crtscts" options)
	75	PPPOPTIONS=<arbitrary option string>
	76	PAPNAME=<"name $PAPNAME" on pppd command line>
de1fc6ce JR	77	REMIP=<remote ip4 address, normally unspecified>
de1fc6ce JR	78	REMIP6=<remote ip6 address, normally unspecified>
b2d62426 AM	79	MRU=
	80	DISCONNECTTIMEOUT=<number of seconds, default currently 5>
	81	RETRYTIMEOUT=<number of seconds, default currently 60>
	82	INITSCRIPT=<modem command>
	83	DATAFORCHAT=<list of variables>
	84	<anything>=<anything> (for chat script)
de1fc6ce JR	85	IPV6_PPP=yes\|no (use IPv6 for ppp ?)
	86	if IPV6_PPP = yes ; then
	87	IPV6_CP_USEV4=yes\|no (use local IPv4 mapped addresses
	88	as IPv6 addresses)
	89	IPV6_CP_PERSISTENT=yes\|no (use EUI-48 addresses
	90	as IPv6 addresses; not
	91	supported on Linux, yet)
	92	or by default use address specified by IP6_PRIM_IF
	93	and REMIP6
	94	fi
	95	fi
b2d62426	96
de1fc6ce JR	97	if DEVICE=sl* ; then (SLIP)
	98	DIRECT_CONNECT=yes\|no (dirrect connection via slattach ?)
	99	PROTOCOL=slip\|cslip\|adaptive
	100	REMIP=<remote ip4 address>
	101	REMIP6=<remote ip6 address, normally unspecified>
	102	fi
	103
	104	elif DEVICE=br* ; then /* Bridge */
	105
	106	BRIDGE_DEVS=<list of devices betwen which do bridging>
	107	Note: separation configuration for devices in this list
	108	should be avoided !
	109	AGEING=<ethernet (MAC) address ageing time in seconds>
	110	GCINT=<garbage collection interval time for the bridge in seconds>
	111
	112	SPANNING_TREE=yes\|no (enable SPT - Spanning Tree Protocol)
	113	if SPANNING_TREE=yes ; then
	114	BRIDGEPRIO=<bridge's priority; 0-65535; less == better>
	115	FD=<bridge forward delay time in seconds>
	116	HELLO=<bridge hello time in seconds>
	117	MAXAGE=<maximum message age in seconds>
	118	PATHCOST_PORT=<port number>
	119	PATHCOST=<cost of the port specified in PATHCOST_PORT>
	120	Note: both PATHCOST_PORT and PATHCOST must be
	121	specified to set cost of port
	122	PORTPRIO_PORT=<port>
	123	PORTPRIO=<port priority used by port selection algorithms;
	124	a number between 0 and 255>
	125	Note: see note above
b2d62426 AM	126	fi
	127	fi
	128
201c98b9 AM	129	# You can also run some other programs after uping od downing
	130	# device. Just create functions run_up() and run_down()
	131	run_up()
	132	{
	133	echo "This will be executed after uping device !"
	134	}
	135
	136	run_down()
	137	{
	138	echo "This will be executed after downing device !"
	139	}