xref: /openbsd/usr.sbin/route6d/route6d.8 (revision cca36db2)
1.\"	$OpenBSD: route6d.8,v 1.21 2011/04/23 10:14:59 sobrado Exp $
2.\"	$KAME: route6d.8,v 1.11 2002/06/02 15:00:30 itojun Exp $
3.\"
4.\" Copyright (c) 1996 WIDE Project. All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modifications, are permitted provided that the above copyright notice
8.\" and this paragraph are duplicated in all such forms and that any
9.\" documentation, advertising materials, and other materials related to
10.\" such distribution and use acknowledge that the software was developed
11.\" by the WIDE Project, Japan. The name of the Project may not be used to
12.\" endorse or promote products derived from this software without
13.\" specific prior written permission. THIS SOFTWARE IS PROVIDED ``AS IS''
14.\" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
15.\" LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
16.\" A PARTICULAR PURPOSE.
17.\"
18.Dd $Mdocdate: April 23 2011 $
19.Dt ROUTE6D 8
20.Os
21.Sh NAME
22.Nm route6d
23.Nd RIP6 routing daemon
24.Sh SYNOPSIS
25.Bk -words
26.Nm route6d
27.Op Fl aDdhlnqSs
28.Sm off
29.Op Fl A No \~ Ar prefix No / Ar preflen , Ar if1 Op , Ar if2 , ...
30.Sm on
31.Sm off
32.Op Fl L No \~ Ar prefix No / Ar preflen , Ar if1 Op , Ar if2 , ...
33.Sm on
34.Sm off
35.Op Fl N No \~ Ar if1 Op , Ar if2 , ...
36.Sm on
37.Sm off
38.Op Fl O No \~ Ar prefix No / Ar preflen , Ar if1 Op , Ar if2 , ...
39.Sm on
40.Op Fl R Ar routelog
41.Sm off
42.Op Fl T No \~ Ar if1 Op , Ar if2 , ...
43.Sm on
44.Op Fl t Ar tag
45.Ek
46.Sh DESCRIPTION
47The
48.Nm
49utility is a routing daemon which supports RIP over IPv6.
50.Pp
51The options are as follows:
52.Bl -tag -width indent
53.It Xo Fl A
54.Sm off
55.Ar prefix No / Ar preflen
56.No , Ar if1
57.Op , Ar if2 , ...
58.Sm on
59.Xc
60This option is used for aggregating routes.
61.Ar prefix Ns / Ns Ar preflen
62specifies the prefix and the prefix length of the
63aggregated route.
64When advertising routes,
65.Nm
66filters specific routes covered by the aggregate
67and advertises the aggregated route
68.Ar prefix Ns / Ns Ar preflen
69to the interfaces specified in the comma-separated interface list
70.Sm off
71.Ar if1 Op , Ar if2 , ... .
72.Sm on
73.Nm
74creates a static route to
75.Ar prefix Ns / Ns Ar preflen ,
76with the
77.Dv RTF_REJECT
78flag set, into the kernel routing table.
79.It Fl a
80Enables aging of the statically defined routes.
81With this option, any
82statically defined routes will be removed unless corresponding updates
83arrive as if the routes are received at the startup of
84.Nm .
85.It Fl D
86Enables extensive output of debugging messages.
87This option also instructs
88.Nm
89to run in foreground mode
90.Pq i.e. it does not become a daemon process .
91.It Fl d
92Enables output of debugging messages.
93This option also instructs
94.Nm
95to run in foreground mode
96.Pq i.e. it does not become a daemon process .
97.It Fl h
98Disables split horizon processing.
99.It Xo Fl L
100.Sm off
101.Ar prefix No / Ar preflen
102.No , Ar if1
103.Op , Ar if2 , ...
104.Sm on
105.Xc
106Filter incoming routes from interfaces
107.Sm off
108.Ar if1 Op , Ar if2 , ... .
109.Sm on
110.Nm
111will accept incoming routes that are in
112.Ar prefix Ns / Ns Ar preflen .
113If multiple
114.Fl L
115options are specified, all routes that match any of the options are accepted.
116.Li ::/0
117is treated specially as the default route, not
118.Do
119any route that has longer prefix length than, or equal to, 0
120.Dc .
121For example, with
122.Dq -L 3ffe::/16,if1 -L ::/0,if1 ,
123.Nm
124will accept the default route and routes in the 3ffe::/16 address range,
125but no others.
126To accept any route, simply do not specify the
127.Fl L
128option.
129.It Fl l
130By default,
131.Nm
132will not exchange site local routes for safety reasons.
133This is because the semantics of site local address space are rather vague,
134as the specification is still being worked on,
135and there is no good way to define the site local boundary.
136With
137.Fl l ,
138.Nm
139will exchange site local routes as well.
140It must not be used on site boundary routers,
141since
142.Fl l
143assumes that all interfaces are in the same site.
144.It Xo
145.Fl N
146.Sm off
147.Ar if1
148.Op , Ar if2 , ...
149.Sm on
150.Xc
151Do not listen to, or advertise, route from/to interfaces specified by
152.Sm off
153.Ar if1 Op , Ar if2 , ... .
154.Sm on
155.It Fl n
156Do not update the kernel routing table.
157.It Xo Fl O
158.Sm off
159.Ar prefix No / Ar preflen
160.No , Ar if1
161.Op , Ar if2 , ...
162.Sm on
163.Xc
164Restrict route advertisement toward interfaces specified by
165.Sm off
166.Ar if1 Op , Ar if2 , ... .
167.Sm on
168With this option
169.Nm
170will only advertise routes that match
171.Ar prefix Ns / Ns Ar preflen .
172.It Fl q
173Makes
174.Nm
175use listen-only mode.
176No advertisement is sent.
177.It Fl R Ar routelog
178This option makes
179.Nm
180log route changes (add/delete) to the file
181.Ar routelog .
182.It Fl S
183This option is the same as
184.Fl s ,
185except that the split horizon rule does apply.
186.It Fl s
187Makes
188.Nm
189advertise the statically defined routes which exist in the kernel routing
190table when
191.Nm
192is invoked.
193Announcements obey the regular split horizon rule.
194.It Xo
195.Fl T
196.Sm off
197.Ar if1
198.Op , Ar if2 , ...
199.Sm on
200.Xc
201Advertise only the default route toward
202.Sm off
203.Ar if1 Op , Ar if2 , ... .
204.Sm on
205.It Fl t Ar tag
206Attach the route tag
207.Ar tag
208to originated route entries.
209.Ar tag
210can be decimal, octal prefixed by
211.Li 0 ,
212or hexadecimal prefixed by
213.Li 0x .
214.El
215.Pp
216Upon receipt of signal
217.Dv SIGINT
218or
219.Dv SIGUSR1 ,
220.Nm
221will dump the current internal state into
222.Pa /var/run/route6d_dump .
223.Sh FILES
224.Bl -tag -width /var/run/route6d_dump -compact
225.It Pa /var/run/route6d_dump
226Contains the internal state dumps created if
227.Nm
228receives a
229.Dv SIGINT
230or
231.Dv SIGUSR1
232signal.
233.El
234.Sh SEE ALSO
235.Xr ripd 8
236.Rs
237.%A G. Malkin
238.%A R. Minnear
239.%T RIPng for IPv6
240.%R RFC 2080
241.%D January 1997
242.Re
243.Sh NOTES
244.Nm
245uses the advanced IPv6 API,
246defined in RFC 2292,
247for communicating with peers using link-local addresses.
248.Pp
249Internally
250.Nm
251embeds interface identifiers into bits 32 to 63 of link-local addresses
252.Po
253.Li fe80::xx
254and
255.Li ff02::xx
256.Pc
257so they will be visible in the internal state dump file
258.Pq Pa /var/run/route6d_dump .
259.Pp
260Routing table manipulation differs from IPv6 implementation to implementation.
261Currently
262.Nm
263obeys the WIDE Hydrangea/KAME IPv6 kernel,
264and will not be able to run on other platforms.
265.Pp
266Currently,
267.Nm
268does not reduce the rate of the triggered updates when consecutive updates
269arrive.
270