usr/src/man/man1m/arp.1m

   1 '\" te
   2 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH ARP 1M "Jan 5, 2009"
   8 .SH NAME
   9 arp \- address resolution display and control
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBarp\fR \fIhostname\fR
  14 .fi
  15
  16 .LP
  17 .nf
  18 \fBarp\fR \fB-a\fR [\fB-n\fR]
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBarp\fR \fB-d\fR \fIhostname\fR
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBarp\fR \fB-f\fR \fIfilename\fR
  29 .fi
  30
  31 .LP
  32 .nf
  33 \fBarp\fR \fB-s\fR \fIhostname\fR \fIether_address\fR [temp] [pub] [trail]
  34      [permanent]
  35 .fi
  36
  37 .SH DESCRIPTION
  38 .sp
  39 .LP
  40 The \fBarp\fR program displays and modifies the Internet-to-MAC address
  41 translation tables used by the address resolution protocol (see \fBarp\fR(7P)).
  42 .sp
  43 .LP
  44 With no flags, the program displays the current \fBARP\fR entry for
  45 \fIhostname\fR. The host may be specified by name or by number, using Internet
  46 dot notation.
  47 .sp
  48 .LP
  49 Options that modify the ARP translation tables (\fB-d\fR, \fB-f\fR, and
  50 \fB-s\fR) can be used only when the invoked command is granted the
  51 \fBsys_net_config\fR privilege. See \fBprivileges\fR(5).
  52 .SH OPTIONS
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fB-a\fR\fR
  57 .ad
  58 .RS 6n
  59 Display all of the current \fBARP\fR entries. The definition for the flags in
  60 the table are:
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBd\fR\fR
  65 .ad
  66 .RS 5n
  67 Unverified; this is a local IP address that is currently undergoing Duplicate
  68 Address Detection. ARP will not respond to requests for this address until
  69 Duplicate Address Detection completes.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBo\fR\fR
  76 .ad
  77 .RS 5n
  78 Old; this entry is aging away. If IP requests it again, a new ARP query will be
  79 generated. This state is used for detecting peer address changes.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBy\fR\fR
  86 .ad
  87 .RS 5n
  88 Delayed; periodic address defense and conflict detection was unable to send a
  89 packet due to internal network use limits for non-traffic-related messages (100
  90 packets per hour per interface). This occurs only on interfaces with very large
  91 numbers of aliases.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBA\fR\fR
  98 .ad
  99 .RS 5n
 100 Authority; this machine is authoritative for this IP address. ARP will not
 101 accept updates from other machines for this entry.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBL\fR\fR
 108 .ad
 109 .RS 5n
 110 Local; this is a local IP address configured on one of the machine's logical
 111 interfaces. ARP will defend this address if another node attempts to claim it.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBM\fR\fR
 118 .ad
 119 .RS 5n
 120 Mapping; only used for the multicast entry for \fB224.0.0.0\fR
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBP\fR\fR
 127 .ad
 128 .RS 5n
 129 Publish; includes IP address for the machine and the addresses that have
 130 explicitly been added by the \fB-s\fR option. ARP will respond to ARP requests
 131 for this address.
 132 .RE
 133
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fBS\fR\fR
 138 .ad
 139 .RS 5n
 140 Static; entry cannot be changed by learned information. This indicates that the
 141 \fBpermanent\fR flag was used when creating the entry.
 142 .RE
 143
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fBU\fR\fR
 148 .ad
 149 .RS 5n
 150 Unresolved; waiting for ARP response.
 151 .RE
 152
 153 You can use the \fB-n\fR option with the \fB-a\fR option to disable the
 154 automatic numeric IP address-to-name translation. Use \fBarp\fR \fB-an\fR or
 155 \fBarp\fR \fB-na\fR to display numeric IP addresses. The \fBarp\fR \fB-a\fR
 156 option is equivalent to:
 157 .sp
 158 .in +2
 159 .nf
 160 # \fBnetstat -p -f inet\fR
 161 .fi
 162 .in -2
 163 .sp
 164
 165 \&...and \fB-an\fR and \fB-na\fR are equivalent to:
 166 .sp
 167 .in +2
 168 .nf
 169 # \fBnetstat -pn -f inet\fR
 170 .fi
 171 .in -2
 172 .sp
 173
 174 .RE
 175
 176 .sp
 177 .ne 2
 178 .na
 179 \fB\fB-d\fR\fR
 180 .ad
 181 .RS 6n
 182 Delete an entry for the host called \fIhostname\fR.
 183 .sp
 184 Note that ARP entries for IPMP (IP Network Multipathing) data and test
 185 addresses are managed by the kernel and thus cannot be deleted.
 186 .RE
 187
 188 .sp
 189 .ne 2
 190 .na
 191 \fB\fB-f\fR\fR
 192 .ad
 193 .RS 6n
 194 Read the file named \fIfilename\fR and set multiple entries in the \fBARP\fR
 195 tables. Entries in the file should be of the form:
 196 .sp
 197 .in +2
 198 .nf
 199 \fIhostname\fR \fIMACaddress\fR [temp] [pub] [trail] [permanent]
 200 .fi
 201 .in -2
 202 .sp
 203
 204 See the \fB-s\fR option for argument definitions.
 205 .RE
 206
 207 .sp
 208 .ne 2
 209 .na
 210 \fB\fB-s\fR\fR
 211 .ad
 212 .RS 6n
 213 Create an \fBARP\fR entry for the host called \fIhostname\fR with the MAC
 214 address \fIMACaddress\fR. For example, an Ethernet address is given as six
 215 hexadecimal bytes separated by colons. The entry will not be subject to
 216 deletion by aging unless the word \fBtemp\fR is specified in the command. If
 217 the word \fBpub\fR is specified, the entry will be published, which means that
 218 this system will respond to ARP requests for \fIhostname\fR even though the
 219 \fIhostname\fR is not its own. The word \fBpermanent\fR indicates that the
 220 system will not accept MAC address changes for \fIhostname\fR from the network.
 221 .sp
 222 Solaris does not implement trailer encapsulation, and the word \fBtrail\fR is
 223 accepted on entries for compatibility only.
 224 .sp
 225 \fBarp\fR \fB-s\fR can be used for a limited form of proxy ARP when a host on
 226 one of the directly attached networks is not physically present on a subnet.
 227 Another machine can then be configured to respond to ARP requests using
 228 \fBarp\fR \fB-s\fR. This is useful in certain SLIP configurations.
 229 .sp
 230 Non-temporary proxy ARP entries for an IPMP (IP Network Multipathing) group are
 231 automatically managed by the kernel. Specifically, if the hardware address in
 232 an entry matches the hardware address of an IP interface in an IPMP group, and
 233 the IP address is not local to the system, this will be regarded as an IPMP
 234 proxy ARP entry. This entry will have its hardware address automatically
 235 adjusted in order to keep the IP address reachable so long as the IPMP group
 236 has not entirely failed.
 237 .sp
 238 ARP entries must be consistent across an IPMP group. Therefore, ARP entries
 239 cannot be associated with individual underlying IP interfaces in an IPMP group,
 240 and must instead be associated with the corresponding IPMP IP interface.
 241 .sp
 242 Note that ARP entries for IPMP data and test addresses are managed by the
 243 kernel and thus cannot be changed.
 244 .RE
 245
 246 .SH SEE ALSO
 247 .sp
 248 .LP
 249 \fBifconfig\fR(1M), \fBnetstat\fR(1M), \fBattributes\fR(5),
 250 \fBprivileges\fR(5), \fBarp\fR(7P)