1 .\" $KAME: ndp.8,v 1.28 2002/07/17 08:46:33 itojun Exp $
3 .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the project nor the names of its contributors
15 .\" may be used to endorse or promote products derived from this software
16 .\" without specific prior written permission.
18 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 .Nd control/diagnose IPv6 neighbor discovery protocol
64 .Op Ar expressions ...
67 .Fl I Op Ar interface | Li delete
70 .Fl s Ar nodename etheraddr
77 utility manipulates the address mapping table
78 used by the Neighbor Discovery Protocol (NDP).
79 .Bl -tag -width indent
81 Dump the currently existing NDP entries.
82 The following information will be printed:
83 .Bl -tag -width "Neighbor"
85 IPv6 address of the neighbor.
87 Linklayer address of the neighbor.
90 when the address is not available.
92 Network interface associated with the neighbor cache entry.
94 The time until expiry of the entry.
95 The entry could become
97 in which case it will never expire.
99 State of the neighbor cache entry, as a single letter:
101 .Bl -tag -width indent -compact
117 Unknown state (should never happen).
120 Flags on the neighbor cache entry, in a single letter.
121 They are: Router, proxy neighbor advertisement
123 The field could be followed by a decimal number,
124 which means the number of NS probes the node has sent during the current state.
134 Erase all the NDP entries.
136 Delete specified NDP entry.
140 to be read and multiple entries to be set in the
144 in the file should be of the form
146 .Bd -ragged -offset indent -compact
147 .Ar hostname ether_addr
152 with argument meanings as given above.
153 Leading whitespace and empty lines are ignored.
156 character will mark the rest of the line as a comment.
158 Harmonize consistency between the routing table and the default router
159 list; install the top entry of the list into the kernel routing table.
161 Shows the default interface used as the default route when
162 there is no default router.
163 .It Fl I Ar interface
164 Specifies the default interface used as the default route when
165 there is no default router.
168 will be used as the default.
170 The current default interface will be deleted from the kernel.
171 .It Fl i Ar interface Op Ar expressions ...
172 View ND information for the specified interface.
173 If additional arguments
177 sets or clears the flags or variables for the interface as specified in
179 Each expression should be separated by white spaces or tab characters.
180 Possible expressions are as follows.
181 Some of the expressions can begin with the
184 which means the flag specified in the expression should be cleared.
191 .Bl -tag -width indent
193 Turn on or off NUD (Neighbor Unreachability Detection) on the
195 NUD is usually turned on by default.
197 Specify whether or not to accept Router Advertisement messages
201 .Va net.inet6.ip6.accept_rtadv
203 .It Ic auto_linklocal
204 Specify whether or not to perform automatic link-local address configuration
208 .Va net.inet6.ip6.auto_linklocal
210 .It Ic no_prefer_iface
211 The address on the outgoing interface is preferred by source addess
213 If this flag is set, stop treating the address on the
215 as special even when the
217 is outgoing interface.
218 The default value of this flag is off.
220 Disable IPv6 operation on the interface.
221 When disabled, the interface discards any IPv6 packets
222 received on or being sent to the interface.
223 In the sending case, an error of ENETDOWN will be returned to the
225 This flag is typically set automatically in the kernel as a result of
226 a certain failure of Duplicate Address Detection.
227 If the auto_linklocal per-interface flag is set, automatic link-local
228 address configuration is performed again when this flag is cleared.
229 .It Ic basereachable Ns Li = Ns Pq Ar number
230 Specify the BaseReachbleTimer on the interface in millisecond.
231 .It Ic retrans Ns Li = Ns Pq Ar number
232 Specify the RetransTimer on the interface in millisecond.
233 .It Ic curhlim Ns Li = Ns Pq Ar number
234 Specify the Cur Hop Limit on the interface.
237 Do not try to resolve numeric addresses to hostnames.
240 The following information will be printed:
241 .Bl -tag -width indent
243 The network interface associated with this prefix.
245 The status of the prefix, expressed by a combination of the following
248 .Bl -tag -width indent -compact
250 This prefix can be used for stateless address autoconfiguration.
252 This prefix can be used for on-link determination; that is, it can be
253 used to determine whether a given destination address is on-link.
255 There are no reachable routers advertising this prefix.
258 Valid lifetime; the length of time for which the prefix and a stateless
259 autoconfigured address generated from this prefix can be used for the
260 source or destination address of a packet.
262 Preferred lifetime; the length of time for which the prefix and a stateless
263 autoconfigured address generated from this prefix can be used by upper-layer
264 protocols unrestrictedly.
266 This is the remaining time that the prefix is in the valid state.
268 The number of kernel references held for this prefix.
271 Flush all the entries in the prefix list.
273 Show default router list.
275 Flush all the entries in the default router list.
277 Register an NDP entry for a node.
278 The entry will be permanent unless the word
280 is given in the command.
283 is given, this system will act as a proxy NDP server,
284 responding to requests for
286 even though the host address is not its own.
288 Print timestamp for each entry,
289 to make it possible to merge the output with
291 Most useful when used with
304 utility first appeared in the WIDE Hydrangea IPv6 protocol stack kit.
306 .Fl I Ar auto_linklocal
307 flag first appeared in