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
38 .Nd control/diagnose IPv6 neighbor discovery protocol
66 .Op Ar expressions ...
69 .Fl I Op Ar interface | Li delete
72 .Fl s Ar nodename etheraddr
79 utility manipulates the address mapping table
80 used by the Neighbor Discovery Protocol (NDP).
81 .Bl -tag -width indent
83 Dump the currently existing NDP entries.
84 The following information will be printed:
85 .Bl -tag -width "Neighbor"
87 IPv6 address of the neighbor.
89 Linklayer address of the neighbor.
92 when the address is not available.
94 Network interface associated with the neighbor cache entry.
96 The time until expiry of the entry.
97 The entry could become
99 in which case it will never expire.
101 State of the neighbor cache entry, as a single letter:
103 .Bl -tag -width indent -compact
119 Unknown state (should never happen).
122 Flags on the neighbor cache entry, in a single letter.
123 They are: Router, proxy neighbor advertisement
125 The field could be followed by a decimal number,
126 which means the number of NS probes the node has sent during the current state.
136 Erase all the NDP entries.
138 Delete specified NDP entry.
142 to be read and multiple entries to be set in the
146 in the file should be of the form
148 .Bd -ragged -offset indent -compact
149 .Ar hostname ether_addr
154 with argument meanings as given above.
155 Leading whitespace and empty lines are ignored.
158 character will mark the rest of the line as a comment.
160 Harmonize consistency between the routing table and the default router
161 list; install the top entry of the list into the kernel routing table.
163 Shows the default interface used as the default route when
164 there is no default router.
165 .It Fl I Ar interface
166 Specifies the default interface used as the default route when
167 there is no default router.
170 will be used as the default.
172 The current default interface will be deleted from the kernel.
173 .It Fl i Ar interface Op Ar expressions ...
174 View ND information for the specified interface.
175 If additional arguments
179 sets or clears the flags or variables for the interface as specified in
181 Each expression should be separated by white spaces or tab characters.
182 Possible expressions are as follows.
183 Some of the expressions can begin with the
186 which means the flag specified in the expression should be cleared.
193 .Bl -tag -width indent
195 Turn on or off NUD (Neighbor Unreachability Detection) on the
197 NUD is usually turned on by default.
199 Specify whether or not to accept Router Advertisement messages
203 .Va net.inet6.ip6.accept_rtadv
205 .It Ic auto_linklocal
206 Specify whether or not to perform automatic link-local address configuration
210 .Va net.inet6.ip6.auto_linklocal
212 .It Ic no_prefer_iface
213 The address on the outgoing interface is preferred by source addess
215 If this flag is set, stop treating the address on the
217 as special even when the
219 is outgoing interface.
220 The default value of this flag is off.
222 Disable IPv6 operation on the interface.
223 When disabled, the interface discards any IPv6 packets
224 received on or being sent to the interface.
225 In the sending case, an error of ENETDOWN will be returned to the
227 This flag is typically set automatically in the kernel as a result of
228 a certain failure of Duplicate Address Detection.
229 If the auto_linklocal per-interface flag is set, automatic link-local
230 address configuration is performed again when this flag is cleared.
231 .It Ic basereachable Ns Li = Ns Pq Ar number
232 Specify the BaseReachbleTimer on the interface in millisecond.
233 .It Ic retrans Ns Li = Ns Pq Ar number
234 Specify the RetransTimer on the interface in millisecond.
235 .It Ic curhlim Ns Li = Ns Pq Ar number
236 Specify the Cur Hop Limit on the interface.
239 Do not try to resolve numeric addresses to hostnames.
242 The following information will be printed:
243 .Bl -tag -width indent
245 The network interface associated with this prefix.
247 The status of the prefix, expressed by a combination of the following
250 .Bl -tag -width indent -compact
252 This prefix can be used for stateless address autoconfiguration.
254 This prefix can be used for on-link determination; that is, it can be
255 used to determine whether a given destination address is on-link.
257 There are no reachable routers advertising this prefix.
260 Valid lifetime; the length of time for which the prefix and a stateless
261 autoconfigured address generated from this prefix can be used for the
262 source or destination address of a packet.
264 Preferred lifetime; the length of time for which the prefix and a stateless
265 autoconfigured address generated from this prefix can be used by upper-layer
266 protocols unrestrictedly.
268 This is the remaining time that the prefix is in the valid state.
270 The number of kernel references held for this prefix.
273 Flush all the entries in the prefix list.
275 Show default router list.
277 Flush all the entries in the default router list.
279 Register an NDP entry for a node.
280 The entry will be permanent unless the word
282 is given in the command.
285 is given, this system will act as a proxy NDP server,
286 responding to requests for
288 even though the host address is not its own.
290 Print timestamp for each entry,
291 to make it possible to merge the output with
293 Most useful when used with
306 utility first appeared in the WIDE Hydrangea IPv6 protocol stack kit.
308 .Fl I Ar auto_linklocal
309 flag first appeared in