[mirror_iproute2.git] / man / man8 / arpd.8

.TH ARPD 8 "28 June, 2007"

.SH NAME
arpd \- userspace arp daemon.

.SH SYNOPSIS
Usage: arpd [ -lkh? ] [ -a N ] [ -b dbase ] [ -B number ] [ -f file ] [-p interval ] [ -n time ] [ -R rate ] [ <INTERFACES> ]

.SH DESCRIPTION
The
.B arpd
daemon collects gratuitous ARP information, saving it on local disk and feeding it to the kernel on demand to avoid redundant broadcasting due to limited size of the kernel ARP cache.

.SH OPTIONS
.TP
-h -?
Print help
.TP
-l
Dump the arpd database to stdout and exit. The output consists of three columns: the interface index, the IP address of the interface, and the MAC address of the interface. Negative entries for dead hosts are also shown, in this case the MAC address is replaced by the word FAILED followed by a colon and the most recent time when the fact that the host is dead was proven.
.TP
-f <FILE>
Read and load an arpd database from FILE in a text format similar to that dumped by option -l. Exit after load, possibly listing resulting database, if option -l is also given. If FILE is -, stdin is read to get the ARP table.
.TP
-b <DATABASE>
the location of the database file. The default location is /var/lib/arpd/arpd.db
.TP
-a <NUMBER>
With this option, arpd not only passively listens for ARP packets on the interface, but also sends broadcast queries itself. NUMBER is the number of such queries to make before a destination is considered dead. When arpd is started as kernel helper (i.e. with app_solicit enabled in sysctl or even with option -k) without this option and still did not learn enough information, you can observe 1 second gaps in service. Not fatal, but not good.
.TP
-k
Suppress sending broadcast queries by the kernel. This option only makes sense together with option -a.
.TP
-n <TIME>
Specifies the timeout of the negative cache. When resolution fails, arpd suppresses further attempts to resolve for this period. This option only makes sense together with option '-k'. This timeout should not be too much longer than the boot time of a typical host not supporting gratuitous ARP. Default value is 60 seconds.
.TP
-p <TIME>
The time to wait in seconds between polling attempts to the kernel ARP table. TIME may be a floating point number. The default value is 30.
.TP
-R <RATE>
Maximal steady rate of broadcasts sent by arpd in packets per second. Default value is 1.
.TP
-B <NUMBER>
The number of broadcasts sent by arpd back to back. Default value is 3. Together with the -R option, this option ensures that the number of ARP queries that are broadcast does not exceed B+R*T over any interval of time T.
.P
<INTERFACES> is a list of names of networking interfaces to watch. If no interfaces are given, arpd monitors all the interfaces. In this case arpd does not adjust sysctl parameters, it is assumed that the user does this himself after arpd is started.
.P
.SH SIGNALS
.TP
When arpd receives a SIGINT or SIGTERM signal, it exits gracefully, syncing the database and restoring adjusted sysctl parameters. On a SIGHUP it syncs the database to disk. With SIGUSR1 it sends some statistics to syslog. The effect of any other signals is undefined. In particular, they may corrupt the database and leave the sysctl parameters in an unpredictable state.
.P
.SH NOTE
.TP
In order for arpd to be able to serve as ARP resolver, the kernel must be compiled with the option CONFIG_ARPD and, in the case when interface list in not given on command line, variable app_solicit on interfaces of interest should be in /proc/sys/net/ipv4/neigh/*. If this is not made arpd still collects gratuitous ARP information in its database.
.SH EXAMPLES
.TP
arpd -b /var/tmp/arpd.db
Start arpd to collect gratuitous ARP, but not messing with kernel functionality.
.TP
killall arpd ; arpd -l -b /var/tmp/arpd.db
Look at result after some time.
.TP
arpd -b /var/tmp/arpd.db -a 1 eth0 eth1
Enable kernel helper, leaving leading role to kernel.
.TP
arpd -b /var/tmp/arpd.db -a 3 -k eth0 eth1
Completely replace kernel resolution on interfaces eth0 and eth1. In this case the kernel still does unicast probing to validate entries, but all the broadcast activity is suppressed and made under authority of arpd.
.PP
This is the mode in which arpd normally is supposed to work. It is not the default to prevent occasional enabling of too aggressive a mode.
Commit	Line	Data
f7c3cefc AH	1	.TH ARPD 8 "28 June, 2007"
	2
	3	.SH NAME
	4	arpd \- userspace arp daemon.
	5
	6	.SH SYNOPSIS
49572501	7	Usage: arpd [ -lkh? ] [ -a N ] [ -b dbase ] [ -B number ] [ -f file ] [-p interval ] [ -n time ] [ -R rate ] [ <INTERFACES> ]
f7c3cefc AH	8
	9	.SH DESCRIPTION
	10	The
	11	.B arpd
49572501	12	daemon collects gratuitous ARP information, saving it on local disk and feeding it to the kernel on demand to avoid redundant broadcasting due to limited size of the kernel ARP cache.
f7c3cefc AH	13
	14	.SH OPTIONS
	15	.TP
	16	-h -?
	17	Print help
	18	.TP
	19	-l
49572501	20	Dump the arpd database to stdout and exit. The output consists of three columns: the interface index, the IP address of the interface, and the MAC address of the interface. Negative entries for dead hosts are also shown, in this case the MAC address is replaced by the word FAILED followed by a colon and the most recent time when the fact that the host is dead was proven.
f7c3cefc AH	21	.TP
f7c3cefc AH	22	-f <FILE>
49572501	23	Read and load an arpd database from FILE in a text format similar to that dumped by option -l. Exit after load, possibly listing resulting database, if option -l is also given. If FILE is -, stdin is read to get the ARP table.
f7c3cefc AH	24	.TP
f7c3cefc AH	25	-b <DATABASE>
49572501	26	the location of the database file. The default location is /var/lib/arpd/arpd.db
f7c3cefc AH	27	.TP
f7c3cefc AH	28	-a <NUMBER>
6274b0b7	29	With this option, arpd not only passively listens for ARP packets on the interface, but also sends broadcast queries itself. NUMBER is the number of such queries to make before a destination is considered dead. When arpd is started as kernel helper (i.e. with app_solicit enabled in sysctl or even with option -k) without this option and still did not learn enough information, you can observe 1 second gaps in service. Not fatal, but not good.
f7c3cefc AH	30	.TP
f7c3cefc AH	31	-k
49572501	32	Suppress sending broadcast queries by the kernel. This option only makes sense together with option -a.
f7c3cefc AH	33	.TP
f7c3cefc AH	34	-n <TIME>
49572501	35	Specifies the timeout of the negative cache. When resolution fails, arpd suppresses further attempts to resolve for this period. This option only makes sense together with option '-k'. This timeout should not be too much longer than the boot time of a typical host not supporting gratuitous ARP. Default value is 60 seconds.
f7c3cefc	36	.TP
0df7db3c	37	-p <TIME>
a89d5329	38	The time to wait in seconds between polling attempts to the kernel ARP table. TIME may be a floating point number. The default value is 30.
0df7db3c	39	.TP
281d7406	40	-R <RATE>
f7c3cefc AH	41	Maximal steady rate of broadcasts sent by arpd in packets per second. Default value is 1.
	42	.TP
	43	-B <NUMBER>
49572501	44	The number of broadcasts sent by arpd back to back. Default value is 3. Together with the -R option, this option ensures that the number of ARP queries that are broadcast does not exceed B+R*T over any interval of time T.
f7c3cefc	45	.P
49572501	46	<INTERFACES> is a list of names of networking interfaces to watch. If no interfaces are given, arpd monitors all the interfaces. In this case arpd does not adjust sysctl parameters, it is assumed that the user does this himself after arpd is started.
f7c3cefc	47	.P
49572501 KR	48	.SH SIGNALS
	49	.TP
	50	When arpd receives a SIGINT or SIGTERM signal, it exits gracefully, syncing the database and restoring adjusted sysctl parameters. On a SIGHUP it syncs the database to disk. With SIGUSR1 it sends some statistics to syslog. The effect of any other signals is undefined. In particular, they may corrupt the database and leave the sysctl parameters in an unpredictable state.
f7c3cefc	51	.P
49572501 KR	52	.SH NOTE
	53	.TP
	54	In order for arpd to be able to serve as ARP resolver, the kernel must be compiled with the option CONFIG_ARPD and, in the case when interface list in not given on command line, variable app_solicit on interfaces of interest should be in /proc/sys/net/ipv4/neigh/*. If this is not made arpd still collects gratuitous ARP information in its database.
f7c3cefc AH	55	.SH EXAMPLES
	56	.TP
	57	arpd -b /var/tmp/arpd.db
	58	Start arpd to collect gratuitous ARP, but not messing with kernel functionality.
	59	.TP
	60	killall arpd ; arpd -l -b /var/tmp/arpd.db
	61	Look at result after some time.
	62	.TP
	63	arpd -b /var/tmp/arpd.db -a 1 eth0 eth1
	64	Enable kernel helper, leaving leading role to kernel.
	65	.TP
	66	arpd -b /var/tmp/arpd.db -a 3 -k eth0 eth1
49572501	67	Completely replace kernel resolution on interfaces eth0 and eth1. In this case the kernel still does unicast probing to validate entries, but all the broadcast activity is suppressed and made under authority of arpd.
f7c3cefc	68	.PP
49572501	69	This is the mode in which arpd normally is supposed to work. It is not the default to prevent occasional enabling of too aggressive a mode.