6324 Add an `ndp' tool for manipulating the neighbors table
[illumos-gate.git] / usr / src / man / man1m / in.ripngd.1m
blobdf3a10ace8dbae0ef172ede96a2aba4f3546045e
1 '\" te
2 .\" Copyright (C) 2006, 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.RIPNGD 1M "Jan 26, 2007"
7 .SH NAME
8 in.ripngd \- network routing daemon for IPv6
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/usr/sbin/in.ripngd\fR  [\fB-s\fR] [\fB-q\fR] [\fB-t\fR] [\fB-p\fR \fIn\fR] [\fB-P\fR] [\fB-v\fR ]
13  [\fIlogfile\fR]
14 .fi
16 .SH DESCRIPTION
17 .sp
18 .LP
19 \fBin.ripngd\fR is the IPv6 equivalent of \fBin.routed\fR(1M). It is invoked at
20 boot time to manage the network routing tables. The routing daemon uses the
21 Routing Information Protocol for IPv6.
22 .sp
23 .LP
24 \fBin.ripngd\fR is managed by the service management facility (SMF), by means
25 of the service identifier:
26 .sp
27 .in +2
28 .nf
29 svc:/network/routing/ripng:default
30 .fi
31 .in -2
32 .sp
34 .sp
35 .LP
36 In normal operation, \fBin.ripngd\fR listens on the \fBudp\fR(7P) socket port
37 521 for routing information packets. If the host is an internetwork router, it
38 periodically supplies copies of its routing tables to any directly connected
39 hosts and networks.
40 .sp
41 .LP
42 When \fBin.ripngd\fR is started, it uses the \fBSIOCGLIFCONF\fR \fBioctl\fR(2)
43 to find those directly connected IPv6 interfaces configured into the system and
44 marked "up"; the software loopback interface is ignored. If multiple interfaces
45 are present, it is assumed the host will forward packets between networks.
46 \fBin.ripngd\fR then multicasts a request packet on each IPv6 interface and
47 enters a loop, listening for request and response packets from other hosts.
48 .sp
49 .LP
50 When a request packet is received, \fBin.ripngd\fR formulates a reply based on
51 the information maintained in its internal tables. The response packet contains
52 a list of known routes. With each route is a number specifying the number of
53 bits in the prefix. The prefix is the number of bits in the high order part of
54 an address that indicate the subnet or network that the route describes. Each
55 route reported also has a "\fIhop count\fR" metric. A count of 16 or greater is
56 considered "infinity." The metric associated with each route returned provides
57 a metric relative to the sender.
58 .sp
59 .LP
60 The request packets received by \fBin.ripngd\fR are used to update the routing
61 tables if one of the following conditions is satisfied:
62 .RS +4
63 .TP
64 .ie t \(bu
65 .el o
66 No routing table entry exists for the destination network or host, and the
67 metric indicates the destination is "reachable", that is, the \fIhop count\fR
68 is not infinite.
69 .RE
70 .RS +4
71 .TP
72 .ie t \(bu
73 .el o
74 The source host of the packet is the same as the router in the existing routing
75 table entry. That is, updated information is being received from the very
76 internetwork router through which packets for the destination are being routed.
77 .RE
78 .RS +4
79 .TP
80 .ie t \(bu
81 .el o
82 The existing entry in the routing table has not been updated for a period of
83 time, defined to be 90 seconds, and the route is at least as cost-effective as
84 the current route.
85 .RE
86 .RS +4
87 .TP
88 .ie t \(bu
89 .el o
90 The new route describes a shorter route to the destination than the one
91 currently stored in the routing tables; this is determined by comparing the
92 metric of the new route against the one stored in the table.
93 .RE
94 .sp
95 .LP
96 When an update is applied, \fBin.ripngd\fR records the change in its internal
97 tables and generates a response packet to all directly connected hosts and
98 networks. To allow possible unstable situations to settle, \fBin.ripngd\fR
99 waits a short period of time (no more than 30 seconds) before modifying the
100 kernel's routing tables.
103 In addition to processing incoming packets, \fBin.ripngd\fR also periodically
104 checks the routing table entries. If an entry has not been updated for 3
105 minutes, the entry's metric is set to infinity and marked for deletion.
106 Deletions are delayed an additional 60 seconds to insure the invalidation is
107 propagated throughout the internet.
110 Hosts acting as internetwork routers gratuitously supply their routing tables
111 every 30 seconds to all directly connected hosts and networks.
112 .SH OPTIONS
115 \fB\fR\fBin.ripngd\fR supports the options listed below. Listed with the
116 options are the equivalent SMF property values. These are set for the
117 \fBripng:default\fR service with a command of the form:
119 .in +2
121 # \fBrouteadm -m ripng:default \fIkey\fR=\fIvalue\fR\fR
123 .in -2
127 .ne 2
129 \fB\fB-p\fR \fIn\fR\fR
131 .RS 8n
132 Send and receive the routing packets from other routers using the \fBUDP \fR
133 port number \fIn\fR. Use of this option is equivalent to setting the
134 \fBudp_port\fR property.
138 .ne 2
140 \fB\fB-P\fR\fR
142 .RS 8n
143 Do not use poison reverse. Use of this option is equivalent to setting the
144 \fBpoison_reverse\fR property to false.
148 .ne 2
150 \fB\fB-q\fR\fR
152 .RS 8n
153 Do not supply routing information. Use of this option is equivalent to setting
154 the \fBquiet_mode\fR property to true.
158 .ne 2
160 \fB\fB-s\fR\fR
162 .RS 8n
163 Force \fBin.ripngd\fR to supply routing information whether it is acting as an
164 internetwork router or not. Use of this option is equivalent to setting the
165 \fBsupply_routes\fR property to true.
169 .ne 2
171 \fB\fB-t\fR\fR
173 .RS 8n
174 Print all packets sent or received to standard output. \fBin.ripngd\fR will not
175 divorce itself from the controlling terminal. Accordingly, interrupts from the
176 keyboard will kill the process. Not supported by the \fBripng\fR service.
180 .ne 2
182 \fB\fB-v\fR\fR
184 .RS 8n
185 Print all changes made to the routing tables to standard output with a
186 timestamp. Use of this option is equivalent to setting the \fBverbose\fR
187 property to true.
189 Any other argument supplied to this option is interpreted as the name of the
190 file in which the actions of \fBin.ripngd\fR, as specified by this option or by
191 \fB-t\fR, should be logged instead of being sent to standard output.
193 The logfile can be specified for the \fBripng\fR service by means of the
194 \fBlog_file\fR property.
197 .SH SEE ALSO
200 \fBin.routed\fR(1M), \fBrouteadm\fR(1M), \fBsvcadm\fR(1M), \fBioctl\fR(2),
201 \fBattributes\fR(5), \fBsmf\fR(5), \fBudp\fR(7P)
204 G. Malkin, R. Minnear, \fIRFC 2080, RIPng for IPv6\fR, January 1997.
205 .SH NOTES
208 The kernel's routing tables may not correspond to those of \fBin.ripngd\fR for
209 short periods of time while processes that utilize existing routes exit; the
210 only remedy for this is to place the routing process in the kernel.
213 \fBin.ripngd\fR currently does not support all of the functionality of
214 \fBin.routed\fR(1M). Future releases may support more if appropriate.
217 \fBin.ripngd\fR initially obtains a routing table by examining the interfaces
218 configured on a machine. It then sends a request on all directly connected
219 networks for more routing information. \fBin.ripngd\fR does not recognize or
220 use any routing information already established on the machine prior to
221 startup. With the exception of interface changes, \fBin.ripngd\fR does not see
222 any routing table changes that have been done by other programs on the machine,
223 for example, routes added, deleted or flushed by means of the \fBroute\fR(1M)
224 command. Therefore, these types of changes should not be done while
225 \fBin.ripngd\fR is running. Rather, shut down \fBin.ripngd\fR, make the changes
226 required, and then restart \fBin.ripngd\fR.