1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)route.8 8.3 (Berkeley) 3/19/94
33 .\" $FreeBSD: src/sbin/route/route.8,v 1.17.2.7 2001/10/02 10:04:01 ru Exp $
40 .Nd manually manipulate the routing tables
51 is a utility used to manually manipulate the network
52 routing tables. It normally is not needed, as a
53 system routing table management daemon such as
55 should tend to this task.
59 utility supports a limited number of general options,
60 but a rich command language, enabling the user to specify
61 any arbitrary request that could be delivered via the
62 programmatic interface discussed in
65 The following options are available:
66 .Bl -tag -width indent
68 Bypass attempts to print host and network names symbolically
69 when reporting actions. (The process of translating between symbolic
70 names and numerical equivalents can be quite time consuming, and
71 may require correct operation of the network; thus it may be expedient
72 to forget this, especially when attempting to repair networking operations).
74 (verbose) Print additional details.
81 utility provides six commands:
83 .Bl -tag -width Fl -compact
89 Delete a specific route.
91 Change aspects of a route (such as its gateway).
93 Lookup and display the route for a destination.
95 Continuously report any changes to the routing information base,
96 routing lookup misses, or suspected network partitionings.
99 The monitor command has the syntax:
101 .Bd -ragged -offset indent -compact
107 The flush command has the syntax:
109 .Bd -ragged -offset indent -compact
118 command is specified,
120 will ``flush'' the routing tables of all gateway entries.
121 When the address family may is specified by any of the
128 modifiers, only routes having destinations with addresses in the
129 delineated family will be deleted.
131 The other commands have the following syntax:
133 .Bd -ragged -offset indent -compact
137 .Op Fl net No \&| Fl host
138 .Ar destination gateway
144 is the destination host or network,
146 is the next-hop intermediary via which packets should be routed.
147 Routes to a particular host may be distinguished from those to
148 a network by interpreting the Internet address specified as the
151 The optional modifiers
155 force the destination to be interpreted as a network or a host, respectively.
159 .Dq local address part
165 is the symbolic name of a network, then the route is
166 assumed to be to a network; otherwise, it is presumed to be a
170 could also be specified in the
171 .Ar net Ns / Ns Ar bits
177 .Fl host Li 128.0.0.32 ;
180 .Fl host Li 128.32.0.130 ;
184 .Fl net Li 128.32.130
190 .Fl net Li 192.168.64 Fl netmask Li 255.255.240.0 .
198 which is the default route.
200 If the destination is directly reachable
201 via an interface requiring
202 no intermediary system to act as a gateway, the
204 modifier should be specified;
205 the gateway given is the address of this host on the common network,
206 indicating the interface to be used for transmission.
207 Alternately, if the interface is point to point the name of the interface
208 itself may be given, in which case the route remains valid even
209 if the local or remote addresses change.
211 The optional modifiers
216 specify that all subsequent addresses are in the
222 or are specified as link-level addresses,
223 and the names must be numeric specifications rather than
229 to achieve the effect of an
232 redirect with the netmask option,
233 or to manually add subnet routes with
234 netmasks different from that of the implied network interface
235 (as would otherwise be communicated using the OSPF or ISIS routing protocols).
236 One specifies an additional ensuing address parameter
237 (to be interpreted as a network mask).
238 The implicit network mask generated in the AF_INET case
239 can be overridden by making sure this option follows the destination parameter.
246 is available instead of the
248 qualifier because non-continuous masks are not allowed in IPv6.
251 specifies network mask of
252 .Li ffff:ffff:0000:0000:0000:0000:0000:0000
254 The default value of prefixlen is 64 to get along with
255 the aggregatable address.
259 Note that the qualifier works only for
263 Routes have associated flags which influence operation of the protocols
264 when sending to destinations matched by the routes.
265 These flags may be set (or sometimes cleared)
266 by indicating the following corresponding modifiers:
268 -cloning RTF_CLONING - generates a new route on use
269 -xresolve RTF_XRESOLVE - emit mesg on use (for external lookup)
270 -iface ~RTF_GATEWAY - destination is directly reachable
271 -static RTF_STATIC - manually added route
272 -nostatic ~RTF_STATIC - pretend route added by kernel or daemon
273 -reject RTF_REJECT - emit an ICMP unreachable when matched
274 -blackhole RTF_BLACKHOLE - silently discard pkts (during updates)
275 -proto1 RTF_PROTO1 - set protocol specific routing flag #1
276 -proto2 RTF_PROTO2 - set protocol specific routing flag #2
277 -llinfo RTF_LLINFO - validly translates proto addr to link addr
280 The optional modifiers
290 provide initial values to quantities maintained in the routing entry
291 by transport level protocols, such as TCP or TP4.
292 These may be individually locked by preceding each such modifier to
296 meta-modifier, or one can
297 specify that all ensuing metrics may be locked by the
305 command where the destination and gateway are not sufficient to specify
308 case where several interfaces may have the
313 modifiers may be used to determine the interface or interface address.
317 modifier specifies that the
319 routing table entry is the
320 .Dq published (proxy-only)
322 entry, as reported by
325 All symbolic names specified for a
329 are looked up first as a host name using
330 .Xr gethostbyname 3 .
331 If this lookup fails,
333 is then used to interpret the name as that of a network.
336 uses a routing socket and the new message types
337 .Dv RTM_ADD , RTM_DELETE , RTM_GET ,
340 As such, only the super-user may modify
344 .It "add [host \&| network ] %s: gateway %s flags %x"
345 The specified route is being added to the tables. The
346 values printed are from the routing table entry supplied
350 If the gateway address used was not the primary address of the gateway
351 (the first one returned by
352 .Xr gethostbyname 3 ) ,
353 the gateway address is printed numerically as well as symbolically.
354 .It "delete [ host \&| network ] %s: gateway %s flags %x"
355 As above, but when deleting an entry.
359 command is specified, each routing table entry deleted
360 is indicated with a message of this form.
361 .It "Network is unreachable"
362 An attempt to add a route failed because the gateway listed was not
363 on a directly-connected network.
364 The next-hop gateway must be given.
366 A delete operation was attempted for an entry which
367 wasn't present in the tables.
368 .It "routing table overflow"
369 An add operation was attempted, but the system was
370 low on resources and was unable to allocate memory
371 to create the new entry.
372 .It "gateway uses the same route"
375 operation resulted in a route whose gateway uses the
376 same route as the one being changed.
377 The next-hop gateway should be reachable through a different route.
392 The first paragraph may have slightly exaggerated
projects / apple / network_cmds.git / blob