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
141 .Ar destination gateway
147 is the destination host or network,
149 is the next-hop intermediary via which packets should be routed.
150 Routes to a particular host may be distinguished from those to
151 a network by interpreting the Internet address specified as the
154 The optional modifiers
158 force the destination to be interpreted as a network or a host, respectively.
162 .Dq local address part
168 is the symbolic name of a network, then the route is
169 assumed to be to a network; otherwise, it is presumed to be a
173 could also be specified in the
174 .Ar net Ns / Ns Ar bits
180 .Fl host Li 128.0.0.32 ;
183 .Fl host Li 128.32.0.130 ;
187 .Fl net Li 128.32.130
193 .Fl net Li 192.168.64 Fl netmask Li 255.255.240.0 .
201 which is the default route.
203 If the destination is directly reachable
204 via an interface requiring
205 no intermediary system to act as a gateway, the
207 modifier should be specified;
208 the gateway given is the address of this host on the common network,
209 indicating the interface to be used for transmission.
210 Alternately, if the interface is point to point the name of the interface
211 itself may be given, in which case the route remains valid even
212 if the local or remote addresses change.
216 modifier specifies the additional property of the route related to
217 the interface scope derived from interface
219 Such property allows for the presence of multiple route entries with
220 the same destination, where each route is associated with a unique
221 interface. This modifier is required in order to manipulate route
222 entries marked with the RTF_IFSCOPE flag.
224 The optional modifier
226 specify that all subsequent addresses
227 are specified as link-level addresses,
228 and the names must be numeric specifications rather than
234 to achieve the effect of an
237 redirect with the netmask option,
238 or to manually add subnet routes with
239 netmasks different from that of the implied network interface
240 (as would otherwise be communicated using the OSPF or ISIS routing protocols).
241 One specifies an additional ensuing address parameter
242 (to be interpreted as a network mask).
243 The implicit network mask generated in the AF_INET case
244 can be overridden by making sure this option follows the destination parameter.
251 is available instead of the
253 qualifier because non-continuous masks are not allowed in IPv6.
256 specifies network mask of
257 .Li ffff:ffff:0000:0000:0000:0000:0000:0000
259 The default value of prefixlen is 64 to get along with
260 the aggregatable address.
264 Note that the qualifier works only for
268 Routes have associated flags which influence operation of the protocols
269 when sending to destinations matched by the routes.
270 These flags may be set (or sometimes cleared)
271 by indicating the following corresponding modifiers:
273 -cloning RTF_CLONING - generates a new route on use
274 -xresolve RTF_XRESOLVE - emit mesg on use (for external lookup)
275 -iface ~RTF_GATEWAY - destination is directly reachable
276 -static RTF_STATIC - manually added route
277 -nostatic ~RTF_STATIC - pretend route added by kernel or daemon
278 -reject RTF_REJECT - emit an ICMP unreachable when matched
279 -blackhole RTF_BLACKHOLE - silently discard pkts (during updates)
280 -proto1 RTF_PROTO1 - set protocol specific routing flag #1
281 -proto2 RTF_PROTO2 - set protocol specific routing flag #2
282 -llinfo RTF_LLINFO - validly translates proto addr to link addr
285 The optional modifiers
295 provide initial values to quantities maintained in the routing entry
296 by transport level protocols, such as TCP or TP4.
297 These may be individually locked by preceding each such modifier to
301 meta-modifier, or one can
302 specify that all ensuing metrics may be locked by the
310 command where the destination and gateway are not sufficient to specify
313 case where several interfaces may have the
318 modifiers may be used to determine the interface or interface address.
322 modifier specifies that the
324 routing table entry is the
325 .Dq published (proxy-only)
327 entry, as reported by
330 All symbolic names specified for a
334 are looked up first as a host name using
335 .Xr gethostbyname 3 .
336 If this lookup fails,
338 is then used to interpret the name as that of a network.
341 uses a routing socket and the new message types
342 .Dv RTM_ADD , RTM_DELETE , RTM_GET ,
345 As such, only the super-user may modify
349 .It "add [host \&| network ] %s: gateway %s flags %x"
350 The specified route is being added to the tables. The
351 values printed are from the routing table entry supplied
355 If the gateway address used was not the primary address of the gateway
356 (the first one returned by
357 .Xr gethostbyname 3 ) ,
358 the gateway address is printed numerically as well as symbolically.
359 .It "delete [ host \&| network ] %s: gateway %s flags %x"
360 As above, but when deleting an entry.
364 command is specified, each routing table entry deleted
365 is indicated with a message of this form.
366 .It "Network is unreachable"
367 An attempt to add a route failed because the gateway listed was not
368 on a directly-connected network.
369 The next-hop gateway must be given.
371 A delete operation was attempted for an entry which
372 wasn't present in the tables.
373 .It "routing table overflow"
374 An add operation was attempted, but the system was
375 low on resources and was unable to allocate memory
376 to create the new entry.
377 .It "gateway uses the same route"
380 operation resulted in a route whose gateway uses the
381 same route as the one being changed.
382 The next-hop gateway should be reachable through a different route.
397 The first paragraph may have slightly exaggerated
projects / apple / network_cmds.git / blob