sbin/route/route.8

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)route.8     8.3 (Berkeley) 3/19/94
  29 .\" $FreeBSD: src/sbin/route/route.8,v 1.17.2.9 2003/02/24 00:56:43 trhodes Exp $
  30 .\"
  31 .Dd June 8, 2001
  32 .Dt ROUTE 8
  33 .Os
  34 .Sh NAME
  35 .Nm route
  36 .Nd manually manipulate the routing tables
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl dnqtv
  40 .Op Fl c Ar cpu
  41 .Ar command
  42 .Oo
  43 .Op Ar modifiers
  44 .Ar args
  45 .Oc
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility is used to manually manipulate the network
  50 routing tables.  It normally is not needed, as a
  51 system routing table management daemon such as
  52 .Xr routed 8 ,
  53 should tend to this task.
  54 .Pp
  55 The
  56 .Nm
  57 utility supports a limited number of general options,
  58 but a rich command language, enabling the user to specify
  59 any arbitrary request that could be delivered via the
  60 programmatic interface discussed in
  61 .Xr route 4 .
  62 .Pp
  63 The following options are available:
  64 .Bl -tag -width indent
  65 .It Fl c Ar cpu
  66 On SMP systems the route table is replicated.  This option allows the
  67 route table for a specific cpu to be accessed and exists primarily
  68 for debugging purposes.
  69 .It Fl n
  70 Bypass attempts to print host and network names symbolically
  71 when reporting actions.  (The process of translating between symbolic
  72 names and numerical equivalents can be quite time consuming, and
  73 may require correct operation of the network; thus it may be expedient
  74 to forget this, especially when attempting to repair networking operations).
  75 .It Fl v
  76 (verbose) Print additional details.
  77 .It Fl q
  78 Suppress all output from the
  79 .Cm add , delete ,
  80 and
  81 .Cm flush
  82 commands.
  83 .It Fl w
  84 Print the full width of the data being represented even if it would overflow
  85 the column.
  86 .El
  87 .Pp
  88 The
  89 .Nm
  90 utility provides six commands:
  91 .Pp
  92 .Bl -tag -width Fl -compact
  93 .It Cm add
  94 Add a route.
  95 .It Cm flush
  96 Remove all routes.
  97 .It Cm delete
  98 Delete a specific route.
  99 .It Cm change
 100 Change aspects of a route (such as its gateway).
 101 .It Cm get
 102 Lookup and display the route for a destination.
 103 .It Cm show
 104 Print out the route table similar to "netstat \-r" (see
 105 .Xr netstat 1 ) .
 106 .It Cm monitor
 107 Continuously report any changes to the routing information base,
 108 routing lookup misses, or suspected network partitionings.
 109 .El
 110 .Pp
 111 The monitor command has the syntax:
 112 .Pp
 113 .Bd -ragged -offset indent -compact
 114 .Nm
 115 .Op Fl n
 116 .Cm monitor
 117 .Ed
 118 .Pp
 119 The flush command has the syntax:
 120 .Pp
 121 .Bd -ragged -offset indent -compact
 122 .Nm
 123 .Op Fl n
 124 .Cm flush
 125 .Op Ar family
 126 .Ed
 127 .Pp
 128 If the
 129 .Cm flush
 130 command is specified,
 131 .Nm
 132 will ``flush'' the routing tables of all gateway entries.
 133 When the address family may is specified by any of the
 134 .Fl osi ,
 135 .Fl xns ,
 136 .Fl inet6 ,
 137 or
 138 .Fl inet
 139 modifiers, only routes having destinations with addresses in the
 140 delineated family will be deleted.
 141 .Pp
 142 The other commands have the following syntax:
 143 .Pp
 144 .Bd -ragged -offset indent -compact
 145 .Nm
 146 .Op Fl n
 147 .Ar command
 148 .Op Fl net No \&| Fl host
 149 .Ar destination gateway
 150 .Op Ar netmask
 151 .Ed
 152 .Pp
 153 where
 154 .Ar destination
 155 is the destination host or network,
 156 .Ar gateway
 157 is the next-hop intermediary via which packets should be routed.
 158 Routes to a particular host may be distinguished from those to
 159 a network by interpreting the Internet address specified as the
 160 .Ar destination
 161 argument.
 162 The optional modifiers
 163 .Fl net
 164 and
 165 .Fl host
 166 force the destination to be interpreted as a network or a host, respectively.
 167 Otherwise, if the
 168 .Ar destination
 169 has a
 170 .Dq local address part
 171 of
 172 INADDR_ANY
 173 .Pq Li 0.0.0.0 ,
 174 or if the
 175 .Ar destination
 176 is the symbolic name of a network, then the route is
 177 assumed to be to a network; otherwise, it is presumed to be a
 178 route to a host.
 179 Optionally, the
 180 .Ar destination
 181 could also be specified in the
 182 .Ar net Ns / Ns Ar bits
 183 format.
 184 .Pp
 185 For example,
 186 .Li 128.32
 187 is interpreted as
 188 .Fl host Li 128.0.0.32 ;
 189 .Li 128.32.130
 190 is interpreted as
 191 .Fl host Li 128.32.0.130 ;
 192 .Fl net Li 128.32
 193 is interpreted as
 194 .Li 128.32.0.0;
 195 .Fl net Li 128.32.130
 196 is interpreted as
 197 .Li 128.32.130.0;
 198 and
 199 .Li 192.168.64/20
 200 is interpreted as
 201 .Fl net Li 192.168.64 Fl netmask Li 255.255.240.0 .
 202 .Pp
 203 A
 204 .Ar destination
 205 of
 206 .Ar default
 207 is a synonym for
 208 .Fl net Li 0.0.0.0 ,
 209 which is the default route.
 210 .Pp
 211 If the destination is directly reachable
 212 via an interface requiring
 213 no intermediary system to act as a gateway, the
 214 .Fl interface
 215 modifier should be specified;
 216 the gateway given is the address of this host on the common network,
 217 indicating the interface to be used for transmission.
 218 Alternately, if the interface is point to point the name of the interface
 219 itself may be given, in which case the route remains valid even
 220 if the local or remote addresses change.
 221 .Pp
 222 The optional modifiers
 223 .Fl mpls ,
 224 .Fl xns ,
 225 .Fl osi ,
 226 and
 227 .Fl link
 228 specify that all subsequent addresses are in the
 229 .Tn MPLS ,
 230 .Tn XNS ,
 231 or
 232 .Tn OSI
 233 address families,
 234 or are specified as link-level addresses,
 235 and the names must be numeric specifications rather than
 236 symbolic names.
 237 .Pp
 238 The optional
 239 .Fl netmask
 240 modifier is intended
 241 to achieve the effect of an
 242 .Tn OSI
 243 .Tn ESIS
 244 redirect with the netmask option,
 245 or to manually add subnet routes with
 246 netmasks different from that of the implied network interface
 247 (as would otherwise be communicated using the OSPF or ISIS routing protocols).
 248 One specifies an additional ensuing address parameter
 249 (to be interpreted as a network mask).
 250 The implicit network mask generated in the AF_INET case
 251 can be overridden by making sure this option follows the destination parameter.
 252 .Pp
 253 For
 254 .Dv AF_INET6 ,
 255 the
 256 .Fl prefixlen
 257 qualifier
 258 is available instead of the
 259 .Fl mask
 260 qualifier because non-continuous masks are not allowed in IPv6.
 261 For example,
 262 .Fl prefixlen Li 32
 263 specifies network mask of
 264 .Li ffff:ffff:0000:0000:0000:0000:0000:0000
 265 to be used.
 266 The default value of prefixlen is 64 to get along with
 267 the aggregatable address.
 268 But 0 is assumed if
 269 .Cm default
 270 is specified.
 271 Note that the qualifier works only for
 272 .Dv AF_INET6
 273 address family.
 274 .Pp
 275 Routes have associated flags which influence operation of the protocols
 276 when sending to destinations matched by the routes.
 277 These flags may be set (or sometimes cleared)
 278 by indicating the following corresponding modifiers:
 279 .Bd -literal
 280 -cloning   RTF_CLONING    - generates a new route on use
 281 -xresolve  RTF_XRESOLVE   - emit mesg on use (for external lookup)
 282 -iface    ~RTF_GATEWAY    - destination is directly reachable
 283 -static    RTF_STATIC     - manually added route
 284 -nostatic ~RTF_STATIC     - pretend route added by kernel or daemon
 285 -reject    RTF_REJECT     - emit an ICMP unreachable when matched
 286 -blackhole RTF_BLACKHOLE  - silently discard pkts (during updates)
 287 -proto1    RTF_PROTO1     - set protocol specific routing flag #1
 288 -proto2    RTF_PROTO2     - set protocol specific routing flag #2
 289 -llinfo    RTF_LLINFO     - validly translates proto addr to link addr
 290 .Ed
 291 .Pp
 292 The optional modifiers
 293 .Fl rtt ,
 294 .Fl rttvar ,
 295 .Fl sendpipe ,
 296 .Fl recvpipe ,
 297 .Fl mtu ,
 298 .Fl hopcount ,
 299 .Fl expire ,
 300 and
 301 .Fl ssthresh
 302 provide initial values to quantities maintained in the routing entry
 303 by transport level protocols, such as TCP or TP4.
 304 These may be individually locked by preceding each such modifier to
 305 be locked by
 306 the
 307 .Fl lock
 308 meta-modifier, or one can
 309 specify that all ensuing metrics may be locked by the
 310 .Fl lockrest
 311 meta-modifier.
 312 .Pp
 313 In a
 314 .Cm change
 315 or
 316 .Cm add
 317 command where the destination and gateway are not sufficient to specify
 318 the route (as in the
 319 .Tn ISO
 320 case where several interfaces may have the
 321 same address), the
 322 .Fl ifp
 323 or
 324 .Fl ifa
 325 modifiers may be used to determine the interface or interface address.
 326 .Pp
 327 The optional
 328 .Fl proxy
 329 modifier specifies that the
 330 .Dv RTF_LLINFO
 331 routing table entry is the
 332 .Dq published (proxy-only)
 333 .Tn ARP
 334 entry, as reported by
 335 .Xr arp 8 .
 336 .Pp
 337 All symbolic names specified for a
 338 .Ar destination
 339 or
 340 .Ar gateway
 341 are looked up first as a host name using
 342 .Xr gethostbyname 3 .
 343 If this lookup fails,
 344 .Xr getnetbyname 3
 345 is then used to interpret the name as that of a network.
 346 .Pp
 347 The optional
 348 .Fl push ,
 349 .Fl pop ,
 350 and
 351 .Fl swap
 352 modifiers may be used to specify the desired mpls label
 353 operations for the route. Each route may have up to 3
 354 label operations assigned to it. The label operations
 355 may be combined between them, but specifically the
 356 .Fl push
 357 and
 358 .Fl pop
 359 operations may be repeated if the intent is to push or pop
 360 more than one label at once. The
 361 .Fl swap
 362 operation always swaps the outer label and may not be
 363 repeated.
 364 Here are some MPLS route examples:
 365 .Pp
 366 Add an normal inet route, but push an mpls
 367 .Ar label
 368 to the packet:
 369 .Pp
 370 .Bd -ragged -offset indent -compact
 371 .Nm
 372 .Cm add
 373 .Ar destination gateway
 374 .Fl push
 375 .Ar label
 376 .Ed
 377 .Pp
 378 Add an normal inet route, but double-push an mpls
 379 .Ar inner-label
 380 and an
 381 .Ar outer-label
 382 to the packet:
 383 .Pp
 384 .Bd -ragged -offset indent -compact
 385 .Nm
 386 .Cm add
 387 .Ar destination gateway
 388 .Fl push
 389 .Ar inner-label
 390 .Fl push
 391 .Ar outer-label
 392 .Ed
 393 .Pp
 394 Add an mpls route for an
 395 .Ar incoming-label
 396 to be forwarded to
 397 .Ar gateway
 398 and swap that label with
 399 .Ar new-label :
 400 .Pp
 401 .Bd -ragged -offset indent -compact
 402 .Nm
 403 .Cm add
 404 .Fl mpls
 405 .Ar incoming-label
 406 .Fl inet
 407 .Ar gateway
 408 .Fl swap
 409 .Ar new-label
 410 .Ed
 411 .Pp
 412 The
 413 .Nm
 414 utility uses a routing socket and the new message types
 415 .Dv RTM_ADD , RTM_DELETE , RTM_GET ,
 416 and
 417 .Dv RTM_CHANGE .
 418 As such, only the super-user may modify
 419 the routing tables.
 420 .Sh EXIT STATUS
 421 .Ex -std
 422 .Sh DIAGNOSTICS
 423 .Bl -diag
 424 .It "add [host \&| network ] %s: gateway %s flags %x"
 425 The specified route is being added to the tables.  The
 426 values printed are from the routing table entry supplied
 427 in the
 428 .Xr ioctl 2
 429 call.
 430 If the gateway address used was not the primary address of the gateway
 431 (the first one returned by
 432 .Xr gethostbyname 3 ) ,
 433 the gateway address is printed numerically as well as symbolically.
 434 .It "delete [ host \&| network ] %s: gateway %s flags %x"
 435 As above, but when deleting an entry.
 436 .It "%s %s done"
 437 When the
 438 .Cm flush
 439 command is specified, each routing table entry deleted
 440 is indicated with a message of this form.
 441 .It "Network is unreachable"
 442 An attempt to add a route failed because the gateway listed was not
 443 on a directly-connected network.
 444 The next-hop gateway must be given.
 445 .It "not in table"
 446 A delete operation was attempted for an entry which
 447 wasn't present in the tables.
 448 .It "routing table overflow"
 449 An add operation was attempted, but the system was
 450 low on resources and was unable to allocate memory
 451 to create the new entry.
 452 .It "gateway uses the same route"
 453 A
 454 .Cm change
 455 operation resulted in a route whose gateway uses the
 456 same route as the one being changed.
 457 The next-hop gateway should be reachable through a different route.
 458 .El
 459 .Sh SEE ALSO
 460 .\".Xr esis 4 ,
 461 .Xr netintro 4 ,
 462 .Xr route 4 ,
 463 .Xr arp 8 ,
 464 .Xr IPXrouted 8 ,
 465 .Xr routed 8
 466 .\".Xr XNSrouted 8
 467 .Sh HISTORY
 468 The
 469 .Nm
 470 utility appeared in
 471 .Bx 4.2 .
 472 .Sh BUGS
 473 The first paragraph may have slightly exaggerated
 474 .Xr routed 8 Ns 's
 475 abilities.