8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man1m / route.1m
blob60cbf3f1aeaac56cc125c152a9f99af2eb16e8c3
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.
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 ROUTE 1M "April 9, 2016"
7 .SH NAME
8 route \- manually manipulate the routing tables
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBroute\fR [\fB-fnvq\fR] \fIsub-command\fR [ [\fImodifiers\fR] \fIargs\fR]
13 .fi
15 .LP
16 .nf
17 \fBroute\fR [\fB-fnvq\fR] [\fB-p\fR [\fB-R\fR \fIroot-dir\fR]] add | delete [\fImodifiers\fR] \fIdestination\fR \fIgateway\fR
18      [\fIargs\fR]
19 .fi
21 .LP
22 .nf
23 \fBroute\fR [\fB-fnvq\fR] change | get [\fImodifiers\fR] \fIdestination\fR
24      [\fIgateway\fR [\fIargs\fR]]
25 .fi
27 .LP
28 .nf
29 \fBroute\fR [\fB-fn\fR] monitor [\fImodifiers\fR]
30 .fi
32 .LP
33 .nf
34 \fBroute\fR [\fB-fnvq\fR] flush [\fImodifiers\fR]
35 .fi
37 .LP
38 .nf
39 \fBroute\fR \fB-p\fR [\fB-R\fR \fIroot-dir\fR] show
40 .fi
42 .SH DESCRIPTION
43 .LP
44 \fBroute\fR manually manipulates the network routing tables. These tables are
45 normally maintained by the system routing daemon, such as \fBin.routed\fR(1M)
46 and \fBin.ripngd\fR(1M).
47 .sp
48 .LP
49 \fBroute\fR supports a limited number of general options, but a rich command
50 language. Users can specify an arbitrary request that can be delivered by means
51 of the programmatic interface discussed in \fBroute\fR(7P).
52 .sp
53 .LP
54 \fBroute\fR uses a routing socket and the new message types \fBRTM_ADD\fR,
55 \fBRTM_DELETE\fR, \fBRTM_GET\fR, and \fBRTM_CHANGE\fR. While only superusers
56 can modify routing tables, the \fBRTM_GET\fR operation is allowed for
57 non-privileged users.
58 .SH OPTIONS
59 .ne 2
60 .na
61 \fB\fB-f\fR\fR
62 .ad
63 .RS 15n
64 Flush the routing tables of all gateway entries. If you use the \fB-f\fR option
65 in conjunction with any of the \fBroute\fR subcommands, \fBroute\fR flushes
66 the gateways before performing the subcommand. Specify the table to flush by
67 placing the \fBinet\fR or \fBinet6\fR modifier immediately after the \fB-f\fR
68 option. If unspecified, flushing IPv4 (\fBinet\fR) routes is the default.
69 .RE
71 .sp
72 .ne 2
73 .na
74 \fB\fB-n\fR\fR
75 .ad
76 .RS 15n
77 Prevent attempts to print host and network names symbolically when reporting
78 actions. This option is useful when name servers are unavailable.
79 .RE
81 .sp
82 .ne 2
83 .na
84 \fB\fB-p\fR\fR
85 .ad
86 .RS 15n
87 Make changes to the network route tables persistent across system restarts. The
88 operation is applied to the network routing tables first and, if successful, is
89 then applied to the list of saved routes used at system startup. In determining
90 whether an operation was successful, a failure to add a route that already
91 exists or to delete a route that is not in the routing table is ignored.
92 Particular care should be taken when using host or network names in persistent
93 routes, as network-based name resolution services are not available at the time
94 routes are added at startup.
95 .RE
97 .sp
98 .ne 2
99 .na
100 \fB\fB-q\fR\fR
102 .RS 15n
103 Suppress all output.
107 .ne 2
109 \fB\fB-R\fR \fIroot-dir\fR\fR
111 .RS 15n
112 Specify an alternate root directory where \fBroute\fR applies changes. This
113 option is ignored unless used in conjunction with the \fB-p\fR option. When
114 \fB-R\fR is specified, route changes are applied only to the list of saved
115 routes to be used at startup, \fBnot\fR to the network routing tables. In
116 addition, certain checks, such as the existence of network interfaces used with
117 \fB-ifp\fR, are skipped. This can be useful from within JumpStart scripts,
118 where the root directory of the system being modified is in a location other
119 than \fB/\fR.
123 .ne 2
125 \fB\fB-v\fR\fR
127 .RS 15n
128 Print additional details in verbose mode.
131 .SS "Subcommands"
133 The following subcommands are supported:
135 .ne 2
137 \fB\fBadd\fR\fR
139 .RS 11n
140 Add a route.
144 .ne 2
146 \fB\fBchange\fR\fR
148 .RS 11n
149 Change aspects of a route (such as its gateway).
153 .ne 2
155 \fB\fBdelete\fR\fR
157 .RS 11n
158 Delete a specific route.
162 .ne 2
164 \fB\fBflush\fR\fR
166 .RS 11n
167 Remove all gateway entries from the routing table.
171 .ne 2
173 \fB\fBget\fR\fR
175 .RS 11n
176 Look up and display the route for a destination.
180 .ne 2
182 \fB\fBmonitor\fR\fR
184 .RS 11n
185 Continuously report any changes to the routing information base, routing lookup
186 misses, or suspected network partitionings.
190 .ne 2
192 \fB\fBshow\fR\fR
194 .RS 11n
195 Display the list of routes to be applied at system startup. Can be used only in
196 conjunction with the \fB-p\fR option.
201 The \fBadd\fR and \fBdelete\fR subcommands have the following syntax:
203 .in +2
205 route [ -fnvq ] cmd \fIdestination\fR \fIgateway\fR [metric/netmask]
207 .in -2
212 where \fIcmd\fR is \fBadd\fR or \fBdelete\fR, \fIdestination\fR is the
213 destination host or network, and \fIgateway\fR is the next-hop intermediary
214 through which packets should be routed. Modifiers described in \fBOPERANDS\fR
215 can be placed anywhere on the command line.
218 The \fBget\fR and \fBchange\fR subcommands have the following syntax:
220 .in +2
222 route [ -fnvq ] \fIcmd\fR \fIdestination\fR [\fIgateway\fR [metric/netmask]]
224 .in -2
229 where \fIcmd\fR is \fBget\fR or \fBchange\fR, \fIdestination\fR is the
230 destination host or network, and \fIgateway\fR is the next-hop intermediary
231 through which packets should be routed. Modifiers described in \fBOPERANDS\fR
232 can be placed anywhere on the command line.
235 The \fBmonitor\fR subcommand has the following syntax:
237 .in +2
239 route monitor [ -inet | -inet6 ]
241 .in -2
244 .SH OPERANDS
246 \fBroute\fR executes its subcommands on routes to destinations by way of
247 gateways.
248 .SS "Destinations and Gateways"
250 By default, destination and gateway addresses are interpreted as IPv4
251 addresses. All symbolic names are tried first as a host name, using
252 \fBgetipnodebyname\fR(3SOCKET). If this lookup fails in the AF_INET case,
253 \fBgetnetbyname\fR(3SOCKET) interprets the name as that of a network.
256 Including an optional modifier on the command line before the address changes
257 how the \fBroute\fR subcommand interprets it.
260 The following modifiers are supported:
262 .ne 2
264 \fB\fB-inet\fR\fR
266 .RS 10n
267 Force the address to be interpreted as an IPv4 address, that is, under the
268 \fBAF_INET\fR address family.
272 .ne 2
274 \fB\fB-inet6\fR\fR
276 .RS 10n
277 Force the address to be interpreted as an IPv6 address, that is, under the
278 \fBAF_INET6\fR address family.
283 For IPv4 addresses, routes to a particular host are by default distinguished
284 from those to a network by interpreting the Internet address specified as the
285 destination. If the destination has a \fBlocal address part\fR (that is, the
286 portion not covered by the netmask) of \fB0\fR, or if the destination is
287 resolved as the symbolic name of a network, then the route is assumed to be to
288 a network; otherwise, it is presumed to be a route to a host.
291 You can force this selection by using one of the following modifiers:
293 .ne 2
295 \fB\fB-host\fR\fR
297 .RS 9n
298 Force the destination to be interpreted as a host.
302 .ne 2
304 \fB\fB-net\fR\fR
306 .RS 9n
307 Force the destination to be interpreted as a network.
312 For example:
317 c c
318 l l .
319 Destination     Destination Equivalent
321 \fB128.32\fR    \fB-host\fR \fB128.0.0.32\fR
322 \fB128.32.130\fR        \fB-host\fR \fB128.32.0.130\fR
323 \fB-net\fR \fB128.32\fR \fB128.32.0.0\fR
324 \fB-net\fR \fB128.32.130\fR     \fB\fR\fB128.32.130.0\fR
329 Two modifiers avoid confusion between addresses and keywords (for example.,
330 \fBhost\fR used as a symbolic host name). You can distinguish a
331 \fIdestination\fR by preceding it with the \fB-dst\fR modifier. You can
332 distinguish a gateway address by using the \fB-gateway\fR modifier. If the
333 destination is directly reachable by way of an interface requiring no
334 intermediary IP router to act as a gateway, this can be indicated by using the
335 \fB-interface\fR or \fB-iface\fR modifier.
338 In the following example, the route does not refer to an external gateway
339 (router), but rather to one of the machine's interfaces. Packets with IP
340 destination addresses matching the destination and mask on such a route are
341 sent out on the interface identified by the gateway address. For interfaces
342 using the ARP protocol, this type of route is used to specify that all matching
343 destinations are local to the physical link. That is, a host could be
344 configured to ARP for all addresses, without regard to the configured interface
345 netmask, by adding a default route using this command. For example:
347 .in +2
349 example# route add default \fIhostname\fR -interface
351 .in -2
356 where gateway address \fIhostname\fR is the name or IP address associated with
357 the network interface over which all matching packets should be sent. On a host
358 with a single network interface, \fIhostname\fR is usually the same as the
359 \fInodename\fR returned by the \fBuname -n\fR command. See \fBuname\fR(1).
362 For backward compatibility with older systems, directly reachable routes can
363 also be specified by placing a \fB0\fR after the gateway address:
365 .in +2
367 example# route add default \fIhostname\fR 0
369 .in -2
374 This value was once a route metric, but this metric is no longer used. If the
375 value is specified as \fB0\fR, then the destination is directly reachable
376 (equivalent to specifying \fB-\fR\fBinterface\fR). If it is non-zero but cannot
377 be interpreted as a subnet mask, then a gateway is used (default).
380 With the \fBAF_INET\fR address family or an IPv4 address, a separate subnet
381 mask can be specified. This can be specified in one of the following ways:
382 .RS +4
384 .ie t \(bu
385 .el o
386 IP address following the gateway address . This is typically specified in
387 \fIdecimal dot\fR notation as for \fBinet_addr\fR(3SOCKET) rather than in
388 symbolic form.
390 .RS +4
392 .ie t \(bu
393 .el o
394 IP address following the \fB-netmask\fR qualifier.
396 .RS +4
398 .ie t \(bu
399 .el o
400 Slash character and a decimal length appended to the destination address.
404 If a subnet mask is not specified, the mask used is the subnet mask of the
405 output interface selected by the gateway address, if the classful network of
406 the destination is the same as the classful network of the interface.
407 Otherwise, the classful network mask for the destination address is used.
410 Each of the following examples creates an IPv4 route to the destination
411 \fB192.0.2.32\fR subnet with a subnet mask of \fB255.255.255.224\fR:
413 .in +2
415 example# route add 192.0.2.32/27 somegateway
416 example# route add 192.0.2.32 -netmask 255.255.255.224 somegateway
417 example# route add 192.0.2.32 somegateway 255.255.255.224
419 .in -2
424 For IPv6, only the slash format is accepted. The following example creates an
425 IPv6 route to the destination \fB33fe::\fR with a netmask of \fB16\fR one-bits
426 followed by 112 zero-bits.
428 .in +2
430 example# route add -inet6 3ffe::/16 somegateway
432 .in -2
437 In cases where the gateway does not uniquely identify the output interface (for
438 example, when several interfaces have the same address), you can use the
439 \fB-ifp\fR \fIifname\fR modifier to specify the interface by name.  For
440 example, \fB\fR\fB-ifp\fR \fBlo0\fR associates the route with the \fBlo0\fR
441 interface. If the named interface is an underlying interface in an IPMP (IP
442 multipathing) group, then requests to add a route will automatically be
443 translated to the corresponding IPMP IP interface, and requests to delete or
444 change a route on an underlying interface will fail.
445 .SS "Routing Flags"
447 Routes have associated flags that influence operation of the protocols when
448 sending to destinations matched by the routes. These flags can be set (and in
449 some cases cleared, indicated by \fB~\fR) by including the following modifiers
450 on the command line:
455 c c c
456 l l l .
457 Modifier        Flag    Description
459 \fB-interface\fR        \fB~RTF_GATEWAY\fR      Destination is directly reachable
460 \fB-iface\fR    \fB~RTF_GATEWAY\fR      Alias for interface modifier
461 \fB-static\fR   \fBRTF_STATIC\fR        Manually added route
462 \fB-nostatic\fR \fB~RTF_STATIC\fR       T{
463 Pretend route was added by kernel or routing daemon
465 \fB-reject\fR   \fBRTF_REJECT\fR        Emit an ICMP unreachable when matched
466 \fB-blackhole\fR        \fBRTF_BLACKHOLE\fR     Silently discard packets duing updates
467 \fB-proto1\fR   \fBRTF_PROTO1\fR        Set protocol specific routing flag #1
468 \fB-proto2\fR   \fBRTF_PROTO2\fR        Set protocol specific routing flag #2
469 \fB-private\fR  \fBRTF_PRIVATE\fR       Do not advertise this route
470 \fB-multirt\fR  \fBRTF_MULTIRT\fR       Creates the specified redundant route
471 \fB-setsrc\fR   \fBRTF_SETSRC\fR        Assigns the default source address
476 The optional modifiers \fB-rtt\fR, \fB-rttvar\fR, \fB-sendpipe\fR,
477 \fB-recvpipe\fR, \fB-mtu\fR, \fB-hopcount\fR, \fB-expire\fR, and
478 \fB-ssthresh\fR provide initial values to quantities maintained in the routing
479 entry by transport level protocols, such as \fBTCP\fR. These can be
480 individually locked either by preceding each modifier to be locked by the
481 \fB-lock\fR meta-modifier, or by specifying that all ensuing metrics can be
482 locked by the \fB-lockrest\fR meta-modifier.
485 Some transport layer protocols can support only some of these metrics. The
486 following optional modifiers are supported:
488 .ne 2
490 \fB\fB-expire\fR\fR
492 .RS 13n
493 Lifetime for the entry. This optional modifier is not currently supported.
497 .ne 2
499 \fB\fB-hopcount\fR\fR
501 .RS 13n
502 Maximum hop count. This optional modifier is not currently supported.
506 .ne 2
508 \fB\fB-mtu\fR\fR
510 .RS 13n
511 Maximum MTU in bytes.
515 .ne 2
517 \fB\fB-recvpipe\fR\fR
519 .RS 13n
520 Receive pipe size in bytes.
524 .ne 2
526 \fB\fB-rtt\fR\fR
528 .RS 13n
529 Round trip time in microseconds.
533 .ne 2
535 \fB\fB-rttvar\fR\fR
537 .RS 13n
538 Round trip time variance in microseconds.
542 .ne 2
544 \fB\fB-sendpipe\fR\fR
546 .RS 13n
547 Send pipe size in bytes.
551 .ne 2
553 \fB\fB-ssthresh\fR\fR
555 .RS 13n
556 Send pipe size threshold in bytes.
560 .ne 2
562 \fB\fB-secattr\fR\fR
564 .RS 13n
565 Security attributes of the route. This modifier is available only if the system
566 is configured with the Solaris Trusted Extensions feature.
568 The \fB-secattr\fR modifier has the following format:
570 .in +2
572 min_sl=\fIval\fR,max_sl=\fIval\fR,doi=\fIval\fR,cipso
574 .in -2
578 .in +2
580 sl=VAL,doi=VAL,cipso
582 .in -2
584 In the first form, above, the \fIval\fR for \fBmin_sl\fR and \fBmax_sl\fR is a
585 sensitivity label in either hex or string form. The \fIval\fR for \fBdoi\fR is
586 a non-negative integer. The route will apply only for packets with the same
587 domain of interpretation as defined by the \fBdoi\fR value and within the
588 accreditation range defined by the \fBmin_sl\fR and \fBmax_sl\fR values. The
589 \fBcipso\fR keyword is optional and set by default. Valid \fBmin_sl\fR,
590 \fBmax_sl\fR and \fBdoi\fR keyword/value pairs are mandatory. Note that if
591 \fIval\fR contains a space, it must be protected by double quotes.
593 The second form, above, is equivalent to specifying the first form with the
594 same \fBVAL\fR for \fBmin_sl\fR and \fBmax_sl\fR. The second form should be
595 used for the \fBget\fR command, because \fBget\fR uses only a single
596 sensitivity label.
599 .SS "Compatibility"
601 The modifiers \fBhost\fR and \fBnet\fR are taken to be equivalent to
602 \fB-\fR\fBhost\fR and \fB-net\fR\fB\fR. To specify a symbolic address that
603 matches one of these names, use the \fBdst\fR or \fBgateway\fR keyword to
604 distinguish it. For example: \fB\fR\fB-dst\fR \fBhost\fR
607 The following two flags are also accepted for compatibility with older systems,
608 but have no effect.
613 c c
614 l l .
615 Modifier        Flag
617 \fB-cloning\fR  RTF_CLONING
618 \fB-xresolve\fR RTF_XRESOLVE
623 The \fB\fR\fB-ifa\fR \fBhostname\fR modifier is also accepted, but has no
624 effect.
625 .SH FILES
626 .ne 2
628 \fB\fB/etc/defaultrouter\fR\fR
630 .RS 22n
631 List of default routers
635 .ne 2
637 \fB\fB/etc/hosts\fR\fR
639 .RS 22n
640 List of host names and net addresses
644 .ne 2
646 \fB\fB/etc/networks\fR\fR
648 .RS 22n
649 List of network names and addresses
652 .SH SEE ALSO
654 \fBuname\fR(1), \fBin.ripngd\fR(1M), \fBin.routed\fR(1M), \fBnetstat\fR(1M),
655 \fBrouted\fR(1M), \fBioctl\fR(2), \fBgetipnodebyname\fR(3SOCKET),
656 \fBgetnetbyname\fR(3SOCKET), \fBinet_addr\fR(3SOCKET), \fBdefaultrouter\fR(4),
657 \fBhosts\fR(4), \fBnetworks\fR(4), \fBattributes\fR(5), \fBARP\fR(7P),
658 \fBip\fR(7P), \fBroute\fR(7P), \fBrouting\fR(7P)
659 .SH DIAGNOSTICS
660 .ne 2
662 \fB\fBadd\fR [ \fBhost\fR\||\ \fBnetwork\|]\fR \fIdestination\fR:\fIgateway\fR
663 \fIflags\fR\fR
665 .sp .6
666 .RS 4n
667 The specified route is being added to the tables. The values printed are from
668 the routing table entry supplied in the \fBioctl\fR(2) call. If the gateway
669 address used was not the primary address of the gateway (the first one returned
670 by \fBgetipnodebyname\fR(3SOCKET)) the gateway address is printed numerically
671 as well as symbolically.
675 .ne 2
677 \fB\fBdelete\fR [ \fBhost\fR\||\ \fBnetwork\fR\|]
678 \fIdestination\fR:\fIgateway\fR \fIflags\fR\fR
682 \fB\fBchange\fR [ \fBhost\fR\||\ \fBnetwork\fR\|]
683 \fIdestination\fR:\fIgateway\fR \fIflags\fR\fR
685 .sp .6
686 .RS 4n
687 As \fBadd\fR, but when deleting or changing an entry.
691 .ne 2
693 \fB\fIdestination\fR \fBdone\fR\fR
695 .sp .6
696 .RS 4n
697 When the \fB-f\fR flag is specified, or the \fBflush\fR subcommand is used,
698 each routing table entry deleted is indicated with a message of this form.
702 .ne 2
704 \fB\fBNetwork is unreachable\fR\fR
706 .sp .6
707 .RS 4n
708 An attempt to add a route failed because the gateway listed was not on a
709 directly-connected network. Give the next-hop gateway instead.
713 .ne 2
715 \fB\fBnot in table\fR\fR
717 .sp .6
718 .RS 4n
719 A \fBdelete\fR operation was attempted for an entry that is not in the table.
723 .ne 2
725 \fB\fBentry exists\fR\fR
727 .sp .6
728 .RS 4n
729 An \fBadd\fR operation was attempted for a route that already exists in the
730 kernel.
734 .ne 2
736 \fB\fBrouting table overflow\fR\fR
738 .sp .6
739 .RS 4n
740 An operation was attempted, but the system was unable to allocate memory to
741 create the new entry.
745 .ne 2
747 \fB\fBinsufficient privileges\fR\fR
749 .sp .6
750 .RS 4n
751 An attempt to add, delete, change, or flush a route failed because the calling
752 process does not have appropriate privileges.
755 .SH NOTES
757 Specifying that destinations are local (with the \fB-interface\fRmodifier)
758 assumes that the routers implement \fBproxy ARP\fR, meaning that they respond
759 to ARP queries for all reachable destinations. Normally, using either router
760 discovery or RIP is more reliable and scalable than using proxy ARP. See
761 \fBin.routed\fR(1M) for information related to RIP.
764 Combining the all destinations are local route with subnet or network routes
765 can lead to unpredictable results. The search order as it relates to the all
766 destinations are local route are undefined and can vary from release to
767 release.