| blob | 9b90109061c35bca42fa5950333345ea842e1f32 |
1 '\" te
2 .\" Copyright (c) 2009, 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
4 .\" See the License for the specific language governing permissions and limitations under the License. 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
5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH GATEWAYS 4 "May 20, 2009"
7 .SH NAME
8 gateways \- configuration file for /usr/sbin/in.routed IPv4 network routing
9 daemon
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fB/etc/gateways\fR
14 .fi
16 .SH DESCRIPTION
17 .sp
18 .LP
19 The \fB/etc/gateways\fR file is used by the routing daemon,
20 \fBin.routed\fR(1M). When the daemon starts, it reads \fB/etc/gateways\fR to
21 find such distant gateways that cannot be located using only information from a
22 routing socket, to discover if some of the local gateways are passive, and to
23 obtain other parameters.
24 .sp
25 .LP
26 The \fB/etc/gateways\fR file consists of a series of lines, each in one of the
27 two formats shown below or consisting of parameters described later. Blank
28 lines and lines starting with "\fB#\fR" are treated as comments.
29 .sp
30 .LP
31 One format specifies networks:
32 .sp
33 .in +2
34 .nf
35 net Nname[/mask] gateway Gname metric value <passive | active | external>
36 .fi
37 .in -2
39 .sp
40 .LP
41 The other format specifies hosts:
42 .sp
43 .in +2
44 .nf
45 host \fIHname\fR gateway \fIGname\fR metric \fIvalue\fR <passive | active | external>
46 .fi
47 .in -2
49 .sp
50 .LP
51 Host \fIhname\fR is equivalent to \fBnet \fInname\fR/32\fR.
52 .sp
53 .LP
54 The parameters in the lines shown above are described as follows:
55 .sp
56 .ne 2
57 .na
58 \fB\fINname\fR or \fIHname\fR\fR
59 .ad
60 .sp .6
61 .RS 4n
62 Name of the destination network or host. It can be a symbolic network name or
63 an Internet address specified in \fBdot\fR notation (see \fBinet\fR(3SOCKET)).
64 If it is a name, then it must either be defined in \fB/etc/networks\fR or
65 \fB/etc/hosts\fR, or a naming service must have been started before
66 \fBin.routed\fR(1M).
67 .RE
69 .sp
70 .ne 2
71 .na
72 \fB\fIMask\fR\fR
73 .ad
74 .sp .6
75 .RS 4n
76 An optional number between 1 and 32 indicating the netmask associated with
77 Nname.
78 .RE
80 .sp
81 .ne 2
82 .na
83 \fB\fIGname\fR\fR
84 .ad
85 .sp .6
86 .RS 4n
87 Name or address of the gateway to which RIP responses should be forwarded.
88 .RE
90 .sp
91 .ne 2
92 .na
93 \fB\fIValue\fR\fR
94 .ad
95 .sp .6
96 .RS 4n
97 The hop count to the destination host or network.
98 .RE
100 .sp
101 .ne 2
102 .na
103 \fB\fBpassive\fR | \fBactive\fR | \fBexternal\fR\fR
104 .ad
105 .sp .6
106 .RS 4n
107 One of these keywords must be present to indicate whether the gateway should be
108 treated as passive or active, or whether the gateway is external to the scope
109 of the RIP protocol. A passive gateway is not expected to exchange routing
110 information, while gateways marked active should be willing to exchange RIP
111 packets. See \fBin.routed\fR(1M) for further details.
112 .RE
114 .sp
115 .LP
116 After turning on debugging in \fBin.routed\fR with the \fB-t\fR option, you can
117 see that lines that follow the format described above create pseudo-interfaces.
118 To set parameters for remote or external interfaces, use a line starting with
119 \fBif=alias(\fIHname\fR)\fR, \fBif=remote(\fIHname\fR)\fR, and so forth.
120 .sp
121 .LP
122 For backward compatibility with the previous Solaris \fBin.routed\fR
123 implementation, three special keyword formats are accepted. If present, these
124 forms must each be on a separate line, and must not be combined on the same
125 line with any of the keywords listed elsewhere in this document. These three
126 forms are:
127 .sp
128 .ne 2
129 .na
130 \fB\fBnorip \fIifname\fR\fR\fR
131 .ad
132 .RS 19n
133 Disable all RIP processing on the specified interface.
134 .RE
136 .sp
137 .ne 2
138 .na
139 \fB\fBnoripin \fIifname\fR\fR\fR
140 .ad
141 .RS 19n
142 Disable the processing of received RIP responses on the specified interface.
143 .RE
145 .sp
146 .ne 2
147 .na
148 \fB\fBnoripout \fIifname\fR\fR\fR
149 .ad
150 .RS 19n
151 Disable RIP output on the specified interface.
152 .RE
154 .sp
155 .LP
156 Lines that start with neither \fBnet\fR nor \fBhost\fR must consist of one or
157 more of the following parameter settings, separated by commas or blanks:
158 .sp
159 .ne 2
160 .na
161 \fB\fB\fR\fBif=\fIifname\fR\fR\fR
162 .ad
163 .sp .6
164 .RS 4n
165 Indicates that the other parameters on the line apply only to the interface
166 name \fIifname\fR. If this parameter is not specified, then other parameters on
167 the line apply to all interfaces.
168 .RE
170 .sp
171 .ne 2
172 .na
173 \fB\fBsubnet=\fInname\fR[/\fImask\fR][,\fImetric\fR]\fR\fR
174 .ad
175 .sp .6
176 .RS 4n
177 Advertises a route to network nname with mask mask and the supplied metric
178 (default 1). This is useful for filling \fBholes\fR in CIDR allocations. This
179 parameter must appear by itself on a line. The network number must specify a
180 full, 32-bit value, as in \fB192.0.2.0\fR instead of \fB192.0.2\fR.
181 .RE
183 .sp
184 .ne 2
185 .na
186 \fB\fBripv1_mask=\fInname\fR/\fImask1\fR,\fImask2\fR\fR\fR
187 .ad
188 .sp .6
189 .RS 4n
190 Specifies that the netmask of the network of which \fInname\fR/\fImask1\fR is a
191 subnet should be \fImask2\fR. For example, \fBripv1_mask=192.0.2.16/28,27\fR
192 marks \fB192.0.2.16/28\fR as a subnet of \fB192.0.2.0/27\fR instead of
193 \fB192.0.2.0/24\fR. It is better to turn on RIPv2 instead of using this
194 facility. See the description of \fBripv2_out\fR, below.
195 .RE
197 .sp
198 .ne 2
199 .na
200 \fB\fBpasswd=\fIXXX\fR[|\fIKeyID\fR[\fIstart\fR|\fIstop\fR]]\fR\fR
201 .ad
202 .sp .6
203 .RS 4n
204 Specifies a RIPv2 cleartext password that will be included on all RIPv2
205 responses sent, and checked on all RIPv2 responses received. Any blanks, tab
206 characters, commas, or "\fB#\fR", "\fB|\fR", or NULL characters in the password
207 must be escaped with a backslash (\fB\e\fR). The common escape sequences
208 \fB\en\fR, \fB\er\fR, \fB\et\fR, \fB\eb\fR, and \fB\e\fIxxx\fR\fR have their
209 usual meanings. The \fIKeyID\fR must be unique but is ignored for cleartext
210 passwords. If present, \fIstart\fR and \fIstop\fR are timestamps in the form
211 year/month/day@hour:minute. They specify when the password is valid. The valid
212 password with the longest future is used on output packets, unless all
213 passwords have expired, in which case the password that expired most recently
214 is used. If no passwords are valid yet, no password is output. Incoming packets
215 can carry any password that is valid, will be valid within 24 hours, or that
216 was valid within 24 hours. To protect password secrecy, the passwd settings are
217 valid only in the \fB/etc/gateways\fR file and only when that file is readable
218 only by UID 0.
219 .RE
221 .sp
222 .ne 2
223 .na
224 \fB\fBmd5_passwd=\fR\fIXXX\fR|\fIKeyID\fR[\fIstart\fR|\fIstop\fR]\fR
225 .ad
226 .sp .6
227 .RS 4n
228 Specifies a RIPv2 MD5 password. Except that a KeyID is required, this keyword
229 is similar to \fBpasswd\fR (described above).
230 .RE
232 .sp
233 .ne 2
234 .na
235 \fB\fBno_ag\fR\fR
236 .ad
237 .sp .6
238 .RS 4n
239 Turns off aggregation of subnets in RIPv1 and RIPv2 responses.
240 .RE
242 .sp
243 .ne 2
244 .na
245 \fB\fBno_host\fR\fR
246 .ad
247 .sp .6
248 .RS 4n
249 Turns off acceptance of host routes.
250 .RE
252 .sp
253 .ne 2
254 .na
255 \fB\fBno_super_ag\fR\fR
256 .ad
257 .sp .6
258 .RS 4n
259 Turns off aggregation of networks into supernets in RIPv2 responses.
260 .RE
262 .sp
263 .ne 2
264 .na
265 \fB\fBpassive\fR\fR
266 .ad
267 .sp .6
268 .RS 4n
269 Marks the interface not to be advertised in updates sent over other interfaces,
270 and turns off all RIP and router discovery through the interface.
271 .RE
273 .sp
274 .ne 2
275 .na
276 \fB\fBno_rip\fR\fR
277 .ad
278 .sp .6
279 .RS 4n
280 Disables all RIP processing on the specified interface. If no interfaces are
281 allowed to process RIP packets, \fBin.routed\fR acts purely as a router
282 discovery daemon.
283 .sp
284 Note that turning off RIP without explicitly turning on router discovery
285 advertisements with \fBrdisc_adv\fR or \fB-s\fR causes \fBin.routed\fR to act
286 as a client router discovery daemon, which does not advertise.
287 .RE
289 .sp
290 .ne 2
291 .na
292 \fB\fBno_rip_mcast\fR\fR
293 .ad
294 .sp .6
295 .RS 4n
296 Causes RIPv2 packets to be broadcast instead of multicast.
297 .RE
299 .sp
300 .ne 2
301 .na
302 \fB\fBno_ripv1_in\fR\fR
303 .ad
304 .sp .6
305 .RS 4n
306 Causes RIPv1 received responses to be ignored.
307 .RE
309 .sp
310 .ne 2
311 .na
312 \fB\fBno_ripv2_in\fR\fR
313 .ad
314 .sp .6
315 .RS 4n
316 Causes RIPv2 received responses to be ignored.
317 .RE
319 .sp
320 .ne 2
321 .na
322 \fB\fBripv2_out\fR\fR
323 .ad
324 .sp .6
325 .RS 4n
326 Turns on RIPv2 output and causes RIPv2 advertisements to be multicast when
327 possible.
328 .RE
330 .sp
331 .ne 2
332 .na
333 \fB\fBripv2\fR\fR
334 .ad
335 .sp .6
336 .RS 4n
337 Equivalent to \fBno_ripv1_in\fR and \fBripv2_out\fR. This enables RIPv2 and
338 disables RIPv1.
339 .RE
341 .sp
342 .ne 2
343 .na
344 \fB\fBno_rdisc\fR\fR
345 .ad
346 .sp .6
347 .RS 4n
348 Disables the Internet Router Discovery Protocol.
349 .RE
351 .sp
352 .ne 2
353 .na
354 \fB\fBno_solicit\fR\fR
355 .ad
356 .sp .6
357 .RS 4n
358 Disables the transmission of Router Discovery Solicitations.
359 .RE
361 .sp
362 .ne 2
363 .na
364 \fB\fBsend_solicit\fR\fR
365 .ad
366 .sp .6
367 .RS 4n
368 Specifies that Router Discovery solicitations should be sent, even on
369 point-to-point links, which, by default, only listen to Router Discovery
370 messages.
371 .RE
373 .sp
374 .ne 2
375 .na
376 \fB\fBno_rdisc_adv\fR\fR
377 .ad
378 .sp .6
379 .RS 4n
380 Disables the transmission of Router Discovery Advertisements.
381 .RE
383 .sp
384 .ne 2
385 .na
386 \fB\fBrdisc_adv\fR\fR
387 .ad
388 .sp .6
389 .RS 4n
390 Specifies that Router Discovery Advertisements should be sent, even on
391 point-to-point links, which by default only listen to Router Discovery
392 messages.
393 .RE
395 .sp
396 .ne 2
397 .na
398 \fB\fBbcast_rdisc\fR\fR
399 .ad
400 .sp .6
401 .RS 4n
402 Specifies that Router Discovery packets should be broadcast instead of
403 multicast.
404 .RE
406 .sp
407 .ne 2
408 .na
409 \fB\fBrdisc_pref=\fIN\fR\fR\fR
410 .ad
411 .sp .6
412 .RS 4n
413 Sets the preference in Router Discovery Advertisements to the optionally signed
414 integer \fIN\fR. The default preference is 0. Default routes with higher or
415 less negative preferences are preferred by clients.
416 .RE
418 .sp
419 .ne 2
420 .na
421 \fB\fBrdisc_interval=\fIN\fR\fR\fR
422 .ad
423 .sp .6
424 .RS 4n
425 Sets the nominal interval with which Router Discovery Advertisements are
426 transmitted to \fIN\fR seconds and their lifetime to 3*\fIN\fR.
427 .RE
429 .sp
430 .ne 2
431 .na
432 \fB\fBfake_default=\fImetric\fR\fR\fR
433 .ad
434 .sp .6
435 .RS 4n
436 Has an identical effect to \fB-F\fR \fBnet\fR[/\fImask\fR][=\fImetric\fR] with
437 the network number and netmask coming from the specified interface.
438 .RE
440 .sp
441 .ne 2
442 .na
443 \fB\fBpm_rdisc\fR\fR
444 .ad
445 .sp .6
446 .RS 4n
447 Similar to \fBfake_default\fR. To prevent RIPv1 listeners from receiving RIPv2
448 routes when those routes are multicast, this feature causes a RIPv1 default
449 route to be broadcast to RIPv1 listeners. Unless modified with
450 \fBfake_default\fR, the default route is broadcast with a metric of 14. That
451 serves as a \fBpoor man's router discovery\fR protocol.
452 .RE
454 .sp
455 .ne 2
456 .na
457 \fB\fBtrust_gateway=\fIrtr_name\fR[|\fInet1\fR/\fImask1\fR|\fInet2\fR/\fImask2\
458 fR|...]\fR\fR
459 .ad
460 .sp .6
461 .RS 4n
462 Causes RIP packets from that router and other routers named in other
463 \fBtrust_gateway\fR keywords to be accepted, and packets from other routers to
464 be ignored. If networks are specified, then routes to other networks will be
465 ignored from that router.
466 .RE
468 .sp
469 .ne 2
470 .na
471 \fB\fBredirect_ok\fR\fR
472 .ad
473 .sp .6
474 .RS 4n
475 Causes RIP to allow ICMP Redirect messages when the system is acting as a
476 router and forwarding packets. Otherwise, ICMP Redirect messages are
477 overridden.
478 .RE
480 .sp
481 .ne 2
482 .na
483 \fB\fBrip_neighbor=\fIx.x.x.x\fR\fR\fR
484 .ad
485 .sp .6
486 .RS 4n
487 By default, RIPv1 advertisements over point-to-point links are sent to the
488 peer's address (255.255.255.255, if none is available), and RIPv2
489 advertisements are sent to either the RIP multicast address or the peer's
490 address if \fBno_rip_mcast\fR is set. This option overrides those defaults and
491 configures a specific address to use on the indicated interface. This can be
492 used to set a broadcast type advertisement on a point-to-point link.
493 .RE
495 .SH SEE ALSO
496 .sp
497 .LP
498 \fBin.routed\fR(1M), \fBroute\fR(1M), \fBrtquery\fR(1M), \fBinet\fR(3SOCKET),
499 .sp
500 .LP
501 \fIInternet Transport Protocols, XSIS 028112, Xerox System Integration
502 Standard\fR