blob: f9fff4843441cbde71bec0e9ec14a38facf63ab2 [file] [log] [blame] [view] [raw]
.\" $Id: arpsend.8,v 1.4.12.8 2005/10/17 11:42:41 igor Exp $
.TH arpsend 8 "10 Aug 2005" "OpenVZ" "Virtual Private Server"
.SH NAME
arpsend \- utility to send ARP requests.
.\" to detect or update neighbours ARP cashes with given IP.
.SH SYNOPSIS
arpsend < \fB-U\fR \fB-i\fR\ \fIsource_ip\fR |\ \fB-D\fR\
\fB-e\fR\ \fItarget_ip\fR [\fB-e\fR\ \fItarget_ip\fR]\ ... >
[\fB-c\fR \fIcount\fR] [\fB-w\fR \fItimeout\fR]
\fIinterface\fR
.SH DESCRIPTION
Utility \fBarpsend\fR sends ARP packets on device \fIinterface\fR to detect
or update neighbours' ARP caches with a given IP.
.SH COMMANDS
Run utility with one of the following commands:
.TP
\fB-D\fR
Send broadcast ARP request to detect neighbours with
\fItarget_ip\fR. You have to specify \fItarget_ip\fR (\fB-e\fR option).
.TP
\fB-U\fR
Send broadcast ARP request to update neighbours' ARP caches with
\fIsource_ip\fR. You have to specify \fIsource_ip\fR (\fB-i\fR option).
.SH OPTIONS
.TP
\fB-c\fR \fIcount\fR
Number of packets to send. Default is infinity.
.TP
\fB-w\fR \fIinterval\fR
Interval between packets, in seconds. Default is 1 second.
.TP
\fB-i\fR \fIsource_ip_address\fR
Set source IP address field in ARP packet.
.TP
\fB-e\fR \fItarget_ip_address\fR
Set target IP address field in ARP packet. Note that you can specify
\fB-e\fR option multiple times to detect many IP addresses in one utility call.
.SH DIAGNOSTICS
\fBarpsend\fR returns 0 upon successful execution. If something goes wrong, it
returns an appropriate error code.
.IP "1 EXC_USAGE"
Usage error
.IP "2 EXC_SYSTEM"
System error
.IP "3 EXC_RECV"
ARP reply was received
.SH EXAMPLES
To send request on interface \fIeth0\fR to detect any neighbour
computers with IP \fI192.168.10.200\fR:
.br
\f(CW arpsend -D -e 192.168.10.200 eth0\fR
.P
To send request on interface \fIeth0\fR to update neighbours'
ARP caches with IP \fI192.168.10.200\fR:
.br
\f(CW arpsend -U -i 192.168.10.200 eth0\fR
.SH NOTES
Interface you use have to be arpable and not be loopback (i.e.
\fB/sbin/ip link show \fIinterface\fR should show neither \fBNOARP\fR
not \fBLOOPBACK\fR flags in interface parameters).
.SH SEE ALSO
.BR vzctl (8),
.SH LICENSE
Copyright (C) 2000-2005, SWsoft. Licensed under QPL.