| blob | f3ec1a3e1fad5b4988b437d5d48cb5c3834ff34e |
1 '\" te
2 .\" Copyright (C) 2004, 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 NDPD.CONF 4 "Jan 4, 2007"
7 .SH NAME
8 ndpd.conf \- configuration file for IPv6 router autoconfiguration
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/etc/inet/ndpd.conf\fR
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 The \fBndpd.conf\fR file contains configuration information for
19 \fBin.ndpd\fR(1M). On a host, this file does not need to exist or can be empty.
20 The file has one configuration entry per line; note that lines can be extended
21 with a backslash (\fB\e\fR) followed by a NEWLINE. There are four forms of
22 configuration entries which are identified by the first field on the line:
23 \fBifdefault\fR, \fBprefixdefault\fR, \fBif\fR, or \fBprefix\fR. The
24 \fBifdefault\fR and \fBif\fR entries set interface configuration variables. The
25 former establishes the routing behavior for all interfaces, the latter sets
26 per-interface parameters. Any \fBifdefault\fR entries must precede any \fBif\fR
27 entries in the file.
28 .sp
29 .LP
30 The \fBprefixdefault\fR and \fBprefix\fR entries control prefix configuration
31 variables. \fBprefixdefault\fR establishes the default behavior for all prefix
32 advertisements on all interfaces. The \fBprefix\fR keyword advertises
33 per-prefix information. Any \fBprefixdefault\fR entries must precede any
34 \fBprefix\fR entries in the file.
35 .sp
36 .LP
37 Each \fBifdefault\fR entry is composed of a single line of the form:
38 .sp
39 .in +2
40 .nf
41 ifdefault [ \fIif-variable-name\fR \fIvalue\fR ]*
42 .fi
43 .in -2
45 .sp
46 .LP
47 Each \fBif\fR entry is composed of a single line of the form:
48 .sp
49 .in +2
50 .nf
51 if \fIinterface\fR [ \fIif-variable-name\fR \fIvalue\fR ]*
52 .fi
53 .in -2
55 .sp
56 .LP
57 Each \fBprefixdefault\fR entry is composed of a single line of the form:
58 .sp
59 .in +2
60 .nf
61 prefixdefault [ \fIprefix-variable-name\fR \fIvalue\fR ]*
62 .fi
63 .in -2
65 .sp
66 .LP
67 Each prefix\fB\fR entry is composed of a single line of the form:
68 .sp
69 .in +2
70 .nf
71 prefix \fIprefix\fR/\fIprefix_length\fR \fIinterface\fR [ \fIprefix-variable-name\fR \fIvalue\fR ]*
72 .fi
73 .in -2
75 .sp
76 .LP
77 Fields are separated by either SPACE or TAB characters. A `\fB#\fR' (number
78 sign) indicates the beginning of a comment. Characters up to the end of the
79 line are not interpreted by routines that search this file.
80 .sp
81 .ne 2
82 .na
83 \fB\fB\fIinterface\fR\fR\fR
84 .ad
85 .RS 24n
86 The name of a network interface, for example, \fBeri0\fR.
87 .RE
89 .sp
90 .ne 2
91 .na
92 \fB\fB\fIprefix\fR\fR\fR
93 .ad
94 .RS 24n
95 An IPv6 address in standard hexadecimal notation, for example,
96 \fBfec0:0:0:1::0\fR.
97 .RE
99 .sp
100 .ne 2
101 .na
102 \fB\fB\fIprefix_length\fR\fR\fR
103 .ad
104 .RS 24n
105 A number between 0 and 128.
106 .RE
108 .sp
109 .ne 2
110 .na
111 \fB\fB\fIif-variable-name\fR\fR\fR
112 .ad
113 .RS 24n
114 An interface variable. Below is the list of interface variables applicable to
115 routers only along with their default values and units as discussed in \fIRFC
116 2461\fR and \fIRFC 2462\fR. The \fBTmp\fR* variables apply to hosts and
117 routers. The \fBTmp\fR* variables configure temporary address functionality as
118 defined in \fIRFC 3041\fR.
119 .sp
120 .in +2
121 .nf
122 Variable Name Default Unit
124 AdvSendAdvertisements false Boolean
125 DupAddrDetectTransmits 1 Counter
126 MaxRtrAdvInterval 600 Seconds
127 MinRtrAdvInterval 200 Seconds
128 AdvManagedFlag false Boolean
129 AdvOtherConfigFlag false Boolean
130 AdvLinkMTU 0 Bytes
131 AdvReachableTime 0 Milliseconds
132 AdvRetransTimer 0 Milliseconds
133 AdvCurHopLimit see below Counter
134 AdvDefaultLifetime 1800 Seconds
135 .fi
136 .in -2
137 .sp
139 These variables are described as follows:
140 .sp
141 .ne 2
142 .na
143 \fB\fBAdvSendAdvertisements\fR\fR
144 .ad
145 .RS 26n
146 Indicates whether the node should send out advertisements and respond to router
147 solicitations. You need to explicitly configure this value to turn on router
148 advertisement functions.
149 .RE
151 .sp
152 .ne 2
153 .na
154 \fB\fBDupAddrDetectTransmits\fR\fR
155 .ad
156 .RS 26n
157 Defines the number of consecutive Neighbor Solicitation messages that the
158 Neighbor Discovery protocol should send during Duplicate Address Detection of
159 the local node's address.
160 .RE
162 .sp
163 .ne 2
164 .na
165 \fB\fBMaxRtrAdvInterval\fR\fR
166 .ad
167 .RS 26n
168 Specifies the maximum time to wait between sending unsolicited multicast
169 advertisements.
170 .RE
172 .sp
173 .ne 2
174 .na
175 \fB\fBMinRtrAdvInterval\fR\fR
176 .ad
177 .RS 26n
178 Specifies the minimum amount of time to wait between sending unsolicited
179 multicast advertisements.
180 .RE
182 .sp
183 .ne 2
184 .na
185 \fB\fBAdvManagedFlag\fR\fR
186 .ad
187 .RS 26n
188 Indicates the value to be placed in the "Manage address configuration" flag in
189 the Router Advertisement. This flag causes hosts to run DHCPv6 to acquire
190 addresses and other configuration information. This flag causes hosts to run
191 DHCPv6 to acquire configuration information, but only if \fBAdvManagedFlag\fR
192 is not set.
193 .RE
195 .sp
196 .ne 2
197 .na
198 \fB\fBAdvOtherConfigFlag\fR\fR
199 .ad
200 .RS 26n
201 Indicates the value to be placed in the "Other stateful configuration"flag in
202 the Router Advertisement.
203 .RE
205 .sp
206 .ne 2
207 .na
208 \fB\fBAdvLinkMTU\fR\fR
209 .ad
210 .RS 26n
211 Specifies an MTU value to be sent by the router. The default of zero indicates
212 that the router does not specify MTU options.
213 .RE
215 .sp
216 .ne 2
217 .na
218 \fB\fBAdvReachableTime\fR\fR
219 .ad
220 .RS 26n
221 Specifies the value in the Reachable Time field in the advertisement messages
222 sent by the router.
223 .RE
225 .sp
226 .ne 2
227 .na
228 \fB\fBAdvRetransTimer\fR\fR
229 .ad
230 .RS 26n
231 Specifies the value in the Retrans Timer field in the advertisement messages
232 sent by the router.
233 .RE
235 .sp
236 .ne 2
237 .na
238 \fB\fBAdvCurHopLimit\fR\fR
239 .ad
240 .RS 26n
241 Specifies the value to be placed in the current hop limit field in the
242 advertisement messages sent by the router. The default is the current diameter
243 of the Internet.
244 .RE
246 .sp
247 .ne 2
248 .na
249 \fB\fBAdvDefaultLifetime\fR\fR
250 .ad
251 .RS 26n
252 Specifies the default lifetime of the router advertisements.
253 .RE
255 Listed below is the interface variable that applies to both hosts and routers.
256 .sp
257 .in +2
258 .nf
259 Variable Name Default Unit
261 StatefulAddrConf true Boolean
262 StatelessAddrConf true Boolean
263 TmpAddrsEnabled false Boolean
264 TmpValidLifetime 604800 Seconds
265 (1 week)
266 TmpPreferredLifetime 86400 Seconds
267 (1 day)
268 TmpRegenAdvance 5 Seconds
269 TmpMaxDesyncFactor 600 Seconds
270 .fi
271 .in -2
272 .sp
274 .sp
275 .ne 2
276 .na
277 \fB\fBStatefulAddrConf\fR\fR
278 .ad
279 .RS 24n
280 Controls whether the system configures its IPv6 addresses by means of the
281 Stateful Address Autoconfiguration mechanism, also known as DHCPv6, as
282 described in RFC 3315. If enabled (the default), hosts automatically run DHCPv6
283 based on the "managed" and "other" flags sent by routers. If disabled,
284 \fBin.ndpd\fR will not invoke DHCPv6 automatically. DHCPv6 can still be invoked
285 manually by using \fBifconfig\fR(1M), in which case \fBin.ndpd\fR automatically
286 sets the prefix length as needed.
287 .RE
289 .sp
290 .ne 2
291 .na
292 \fB\fBStatelessAddrConf\fR\fR
293 .ad
294 .RS 24n
295 Controls whether the system configures its IPv6 addresses by means of the
296 Stateless Address Autoconfiguration mechanism described in \fIRFC 2462\fR. If
297 enabled hosts (the default) autoconfigure addresses based on prefixes
298 advertised by routers, routers will only autoconfigure addresses based on the
299 prefixes they advertise themselves. In other words, even when enabled, routers
300 do not autoconfigure addresses based on prefixes that other routers advertise.
301 If you specify \fBfalse\fR for this variable, then the address must be
302 configured manually.
303 .RE
305 .sp
306 .ne 2
307 .na
308 \fB\fBTmpAddrsEnabled\fR\fR
309 .ad
310 .RS 24n
311 Indicates whether a temporary address should be created for all interfaces or
312 for a particular interface of a node.
313 .RE
315 .sp
316 .ne 2
317 .na
318 \fB\fBTmpValidLifetime\fR\fR
319 .ad
320 .RS 24n
321 Sets the valid lifetime for a temporary address.
322 .RE
324 .sp
325 .ne 2
326 .na
327 \fB\fBTmpPreferredLifetime\fR\fR
328 .ad
329 .RS 24n
330 Sets the preferred lifetime of a temporary address.
331 .RE
333 .sp
334 .ne 2
335 .na
336 \fB\fBTmpRegenAdvance\fR\fR
337 .ad
338 .RS 24n
339 Specifies the lead time in advance of address deprecation for generation of a
340 new temporary address.
341 .RE
343 .sp
344 .ne 2
345 .na
346 \fB\fBTmpMaxDesyncFactor\fR\fR
347 .ad
348 .RS 24n
349 Sets the upper bound on the DesyncFactor, which is a random value that is used
350 to shorten the preferred lifetime so that clients do not regenerate an address
351 at the same time.
352 .RE
354 .RE
356 .sp
357 .ne 2
358 .na
359 \fB\fIprefix-variable-name\fR\fR
360 .ad
361 .RS 24n
362 A prefix variable as discussed in \fIRFC 2461 \fR and \fIRFC 2462\fR. The
363 following lists the each interface variable and its default value and unit:
364 .sp
366 .sp
367 .TS
368 box;
369 c | c | c
370 l | l | l .
371 Variable Name Default Unit
372 _
373 AdvValidLifetime 2592000 Seconds
374 _
375 AdvOnLinkFlag true Boolean
376 _
377 AdvPreferredLifetime 604800 Seconds
378 _
379 AdvAutonomousFlag true Boolean
380 _
381 AdvValidExpiration not set Date/Time
382 _
383 AdvPreferredExpiration not set Date/TIme
384 .TE
386 These variables are described as follows:
387 .sp
388 .ne 2
389 .na
390 \fB\fBAdvValidLifetime\fR\fR
391 .ad
392 .RS 26n
393 Specifies the valid lifetime of the prefix that is being configured.
394 .RE
396 .sp
397 .ne 2
398 .na
399 \fB\fBAdvOnLinkFlag\fR\fR
400 .ad
401 .RS 26n
402 Specifies the value to be placed in the on-link flag ("L-bit") field in the
403 Prefix Information option.
404 .RE
406 .sp
407 .ne 2
408 .na
409 \fB\fBAdvPreferredLifetime\fR\fR
410 .ad
411 .RS 26n
412 Specifies the value to be placed in the Preferred Lifetime in the Prefix
413 Information option.
414 .RE
416 .sp
417 .ne 2
418 .na
419 \fB\fBAdvAutonomousFlag\fR\fR
420 .ad
421 .RS 26n
422 Specifies the value to be placed in the Autonomous Flag field in the Prefix
423 Information option.
424 .RE
426 .sp
427 .ne 2
428 .na
429 \fB\fBAdvValidExpiration\fR\fR
430 .ad
431 .RS 26n
432 Specifies the valid expiration date of the prefix.
433 .RE
435 .sp
436 .ne 2
437 .na
438 \fB\fBAdvPreferredExpiration\fR\fR
439 .ad
440 .RS 26n
441 Specifies the preferred expiration date of the prefix.
442 .RE
444 The \fBAdvValidExpiration\fR and \fBAdvPreferredExpiration\fR variables are
445 used to specify that the lifetime should be decremented in real time as
446 specified in \fIRFC 2461\fR. If an \fBExpiration\fR variable is set, it takes
447 precedence over the corresponding \fBAdvValidLifetime\fR or
448 \fBAdvPreferredLifetime\fR variable setting.
449 .RE
451 .sp
452 .ne 2
453 .na
454 \fB\fIvalue\fR\fR
455 .ad
456 .RS 24n
457 The value is a function of the unit. Boolean values are \fBtrue\fR,
458 \fBfalse\fR, \fBon\fR, \fBoff\fR, \fB1\fR, or \fB0\fR.
459 .sp
460 Values in seconds can have characters appended for day (\fBd\fR), hour
461 \fBh\fR), minute (\fBm\fR) and second (\fBs\fR). The default is seconds. For
462 example, \fB1h\fR means 1 hour. This is equivalent to the value \fB3600\fR.
463 .sp
464 Values in milliseconds can have characters appended for day (\fBd\fR),hour
465 (\fBh\fR), minute (\fBm\fR) second (\fBs\fR), and millisecond (\fBms\fR). The
466 default is milliseconds. For example, \fB1h\fR is equivalent to the value
467 \fB3600000\fR.
468 .sp
469 Date/time values are strings that use the recommended ISO date format described
470 as "\fB%Y-%m-%d %R\fR", which represents a 4 digit year, a dash character, a
471 numeric month, a dash character, and a numeric day of the month, followed by
472 one or more whitespace characters and finally a 24 hour clock with hours, a
473 colon, and minutes. For example, \fB1999-01-31 20:00\fR means 8pm January 31 in
474 1999. Since the date/time values contain a space, use single or double quotes
475 to declare the value. For example:
476 .sp
477 .in +2
478 .nf
479 prefixdefault AdvPreferredExpiration '1999-01-31 20:00'
480 .fi
481 .in -2
483 .RE
485 .SH EXAMPLES
486 .LP
487 \fBExample 1 \fRSending Router Advertisements for all Interfaces
488 .sp
489 .LP
490 The following example can be used to send router advertisements out to all
491 interfaces:
493 .sp
494 .in +2
495 .nf
496 # Send router advertisements out all interfaces
497 ifdefault AdvSendAdvertisements on
498 prefixdefault AdvOnLinkFlag on AdvAutonomousFlag on
500 # Advertise a (bogus) global prefix and a site
501 # local prefix on three interfaces using the default lifetimes
502 prefix 2:0:0:9255::0/64 eri0
503 prefix fec0:0:0:9255::0/64 eri0
505 prefix 2:0:0:9256::0/64 eri1
506 prefix fec0:0:0:9256::0/64 eri1
508 prefix 2:0:0:9259::0/64 eri2
509 prefix fec0:0:0:9259::0/64 eri2
510 .fi
511 .in -2
513 .SH ATTRIBUTES
514 .sp
515 .LP
516 See \fBattributes\fR(5) for descriptions of the following attributes:
517 .sp
519 .sp
520 .TS
521 box;
522 c | c
523 l | l .
524 ATTRIBUTE TYPE ATTRIBUTE VALUE
525 _
526 Interface Stability Committed
527 .TE
529 .SH SEE ALSO
530 .sp
531 .LP
532 \fBdhcpagent\fR(1M), \fBifconfig\fR(1M), \fBin.ndpd\fR(1M), \fBrouteadm\fR(1M),
533 \fBattributes\fR(5), \fBicmp6\fR(7P), \fBip6\fR(7P)
534 .sp
535 .LP
536 Narten, T., Nordmark, E., and Simpson, W. \fIRFC 2461, Neighbor Discovery for
537 IP Version 6 (IPv6)\fR. The Internet Society. December 1998.
538 .sp
539 .LP
540 Thomson, S., and Narten, T. \fIRFC 2462, IPv6 Stateless Address
541 Autoconfiguration\fR. The Internet Society. December 1998.
542 .sp
543 .LP
544 Narten, T., and Draves, R. \fIRFC 3041, Privacy Extensions for Stateless
545 Address Autoconfiguration in IPv6\fR. The Internet Society. January 2001.
546 .sp
547 .LP
548 Droms, R. \fIRFC 3315, Dynamic Host Configuration Protocol for IPv6
549 (DHCPv6)\fR. Cisco Systems. July 2003.
550 .sp
551 .LP
552 \fISystem Administration Guide: IP Services\fR