6324 Add an `ndp' tool for manipulating the neighbors table
[illumos-gate.git] / usr / src / man / man1m / in.ndpd.1m
blob2ce26434056bbdbc6096a441a51f10892cbb8ea2
1 '\" te
2 .\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
3 .\" 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.
4 .\" 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.
5 .\" 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]
6 .TH IN.NDPD 1M "Sep 02, 2015"
7 .SH NAME
8 in.ndpd \- daemon for IPv6 autoconfiguration
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/usr/lib/inet/in.ndpd\fR [\fB-adt\fR] [\fB-f\fR \fIconfig_file\fR]
13 .fi
15 .SH DESCRIPTION
16 .LP
17 \fBin.ndpd\fR provides both the host and router autoconfiguration components of
18 Neighbor Discovery for IPv6 and Stateless and Stateful Address
19 Autoconfiguration for IPv6. In particular, \fBin.ndpd\fR implements:
20 .RS +4
21 .TP
22 .ie t \(bu
23 .el o
24 router discovery;
25 .RE
26 .RS +4
27 .TP
28 .ie t \(bu
29 .el o
30 prefix discovery;
31 .RE
32 .RS +4
33 .TP
34 .ie t \(bu
35 .el o
36 parameter discovery;
37 .RE
38 .RS +4
39 .TP
40 .ie t \(bu
41 .el o
42 invocation of stateful address autoconfiguration;
43 .RE
44 .RS +4
45 .TP
46 .ie t \(bu
47 .el o
48 stateless address autoconfiguration; and
49 .RE
50 .RS +4
51 .TP
52 .ie t \(bu
53 .el o
54 privacy extensions for stateless address autoconfiguration.
55 .RE
56 .sp
57 .LP
58 Other aspects of Neighbor Discovery are implemented by \fBip6\fR(7P),
59 including:
60 .RS +4
61 .TP
62 .ie t \(bu
63 .el o
64 address resolution;
65 .RE
66 .RS +4
67 .TP
68 .ie t \(bu
69 .el o
70 neighbor unreachability detection; and
71 .RE
72 .RS +4
73 .TP
74 .ie t \(bu
75 .el o
76 redirect.
77 .RE
78 .sp
79 .LP
80 The duplicate address detection function is implemented by the system kernel.
81 .sp
82 .LP
83 \fBin.ndpd\fR is managed by the service management facility (SMF), by means of
84 the service identifier:
85 .sp
86 .in +2
87 .nf
88 svc:/network/routing/ndp:default
89 .fi
90 .in -2
91 .sp
93 .sp
94 .LP
95 If the \fB/etc/inet/ndpd.conf\fR file does not exist or does not set the
96 variable \fBAdvSendAdvertisements\fR to true for a network interface, then
97 \fBin.ndpd\fR will make the node a host for that interface, that is, sending
98 router solicitation messages and then using router advertisement messages it
99 receives to autoconfigure the node. Note that \fBin.ndpd\fR only autoconfigures
100 the addresses of global or site-local scope from the prefix advertisement.
103 If \fBAdvSendAdvertisements\fR is set to true for an interface, then
104 \fBin.ndpd\fR will perform router functions on that interface, that is, sending
105 router advertisement messages to autoconfigure the attached hosts, but not use
106 any advertisements it receives for autoconfiguration. However, when sending
107 advertisements, \fBin.ndpd\fR will use the advertisements it sends itself to
108 autoconfigure its prefixes.
111 Stateless autoconfiguration requires no manual configuration of hosts, minimal
112 (if any) configuration of routers, and no additional servers. The stateless
113 mechanism enables a host to generate its own addresses and uses local
114 information as well as non-local information that is advertised by routers to
115 generate the addresses. \fBin.ndpd\fR will plumb logical interfaces for each of
116 these addresses.
119 Stateful autoconfiguration involves the \fBdhcpagent\fR(1M) daemon and the use
120 of the DHCPv6 protocol. The \fBdhcpagent\fR daemon is responsible for plumbing
121 the logical interfaces for the acquired addresses, maintaining the leases, and
122 handling duplicate addresses. \fBin.ndpd\fR starts the \fBdhcpagent\fR daemon
123 automatically and signals when DHCPv6 should be started. \fBin.ndpd\fR also
124 detects when \fBdhcpagent\fR configures the logical interfaces, and sets the
125 appropriate prefix length on each according to received Routing Advertisement
126 messages. \fBin.ndpd\fR will not stop \fBdhcpagent\fR; use \fBifconfig\fR(1M)
127 to control \fBdhcpagent\fR if necessary.
130 Temporary addresses that are autoconfigured for an interface can also be
131 implemented. A temporary address token is enabled for one or more interfaces on
132 a host. However, unlike standard, autoconfigured IPv6 addresses, a temporary
133 address consists of the site prefix and a randomly generated 64 bit number.
134 This random number becomes the interface ID segment of the IPv6 address. A
135 link-local address is not generated with the temporary address as the interface
139 If the kernel detects a duplicate temporary address, \fBin.ndpd\fR will
140 automatically choose another.
143 Routers advertise all prefixes that have been assigned on the link. IPv6 hosts
144 use Neighbor Discovery to obtain a subnet prefix from a local router. Hosts
145 automatically create IPv6 addresses by combining the subnet prefix with an
146 interface IDs that is generated from an interface's MAC address. In the absence
147 of routers, a host can generate only link-local addresses. Link-local addresses
148 can only be used for communication with nodes on the same link.
151 For information on how to enable IPv6 address autoconfiguration, see \fI\fR
152 .SH OPTIONS
154 Supported options and equivalent SMF service properties are listed below. SMF
155 service properties are set using a command of the form:
157 .in +2
159 # \fBrouteadm -m ndp:default \fIkey\fR=\fIvalue\fR\fR
161 .in -2
165 .ne 2
167 \fB\fB-a\fR\fR
169 .sp .6
170 .RS 4n
171 Turn off stateless and stateful address auto configuration. When set, the
172 daemon does not autoconfigure any addresses and does not renumber any
173 addresses. This option does the same thing as the following lines in
174 \fBndpd.conf\fR(4):
176 .in +2
178 ifdefault StatefulAddrConf off
179 ifdefault StatelessAddrConf off
181 .in -2
183 Use of this option is equivalent to setting the \fBstateless_addr_conf\fR
184 property to false.
188 .ne 2
190 \fB\fB-d\fR\fR
192 .sp .6
193 .RS 4n
194 Turn on large amounts of debugging output on \fBstdout\fR. When set, the
195 program runs in the foreground and stays attached to the controlling terminal.
196 Use of this option is equivalent to setting the \fBdebug\fR property to true.
200 .ne 2
202 \fB\fB-f\fR \ \fIconfig_file\fR\fR
204 .sp .6
205 .RS 4n
206 Use \fIconfig_file\fR for configuration information instead of the default
207 \fB/etc/inet/ndpd.conf\fR. Use of this option is equivalent to setting the
208 \fBconfig_file\fR property to the configuration file to be used.
212 .ne 2
214 \fB\fB-t\fR\fR
216 .sp .6
217 .RS 4n
218 Turn on tracing (printing) of all sent and received packets to\fBstdout\fR.
219 When set, the program runs in the foreground and stays attached to the
220 controlling terminal. As such, this option cannot be run under the SMF.
223 .SH FILES
224 .ne 2
226 \fB\fB/etc/inet/ndpd.conf\fR\fR
228 .RS 23n
229 Configuration file. This file is not necessary on a host, but it is required on
230 a router to enable \fBin.ndpd\fR to advertise autoconfiguration information to
231 the hosts.
234 .SH SEE ALSO
236 \fBdhcpagent\fR(1M), \fBifconfig\fR(1M), \fBndp\fR(1M), \fBrouteadm\fR(1M),
237 \fBsvcadm\fR(1M), \fBndpd.conf\fR(4), \fBattributes\fR(5), \fBsmf\fR(5),
238 \fBicmp6\fR(7P), \fBip6\fR(7P), \fBndp\fR(7P)
241 Narten, T., Nordmark, E., Simpson, W.\fIRFC 2461, Neighbor Discovery for IP
242 Version 6 (IPv6)\fR. The Internet Society. December 1998.
245 Thomson, S., Narten, T. \fIRFC 2462, IPv6 Stateless Address
246 Autoconfiguration\fR. The Internet Society. December 1998.
249 Narten, T., and Draves, R. RFC 3041, Privacy Extensions for Stateless Address
250 Autoconfiguration in IPv6. The Internet Society. January 2001.
251 .SH DIAGNOSTICS
253 Receipt of a \fBSIGHUP\fR signal will make \fBin.ndpd\fR restart and reread
254 \fB/etc/inet/ndpd.conf\fR.
255 .SH NOTES
257 The \fBin.ndpd\fR daemon service is managed by the service management facility,
258 \fBsmf\fR(5), under the service identifier:
260 .in +2
262 svc:/network/routing/ndp:default
264 .in -2
268 Administrative actions on this service, such as enabling, disabling, or
269 requesting restart, can be performed using \fBsvcadm\fR(1M) or
270 \fBrouteadm\fR(1M).