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$
  30 .\"
  31 .Dd May 8, 2014
  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 .Ar command
  41 .Oo
  42 .Op Ar modifiers
  43 .Ar args
  44 .Oc
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 utility is used to manually manipulate the network
  49 routing tables.
  50 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 4
  66 Specify
  67 .Cm inet
  68 address family as family hint for subcommands.
  69 .It Fl 6
  70 Specify
  71 .Cm inet
  72 address family as family hint for subcommands.
  73 .It Fl d
  74 Run in debug-only mode, i.e., do not actually modify the routing table.
  75 .It Fl n
  76 Bypass attempts to print host and network names symbolically
  77 when reporting actions.
  78 (The process of translating between symbolic
  79 names and numerical equivalents can be quite time consuming, and
  80 may require correct operation of the network; thus it may be expedient
  81 to forget this, especially when attempting to repair networking operations).
  82 .It Fl t
  83 Run in test-only mode.
  84 .Pa /dev/null
  85 is used instead of a socket.
  86 .It Fl v
  87 (verbose) Print additional details.
  88 .It Fl q
  89 Suppress all output from the
  90 .Cm add , change , delete ,
  91 and
  92 .Cm flush
  93 commands.
  94 .El
  95 .Pp
  96 The
  97 .Nm
  98 utility provides the following commands:
  99 .Pp
 100 .Bl -tag -width Fl -compact
 101 .It Cm add
 102 Add a route.
 103 .It Cm flush
 104 Remove all routes.
 105 .It Cm delete
 106 Delete a specific route.
 107 .It Cm del
 108 Another name for the
 109 .Cm delete
 110 command.
 111 .It Cm change
 112 Change aspects of a route (such as its gateway).
 113 .It Cm get
 114 Lookup and display the route for a destination.
 115 .It Cm monitor
 116 Continuously report any changes to the routing information base,
 117 routing lookup misses, or suspected network partitionings.
 118 .It Cm show
 119 Another name for the
 120 .Cm get
 121 command.
 122 .El
 123 .Pp
 124 The monitor command has the syntax:
 125 .Pp
 126 .Bd -ragged -offset indent -compact
 127 .Nm
 128 .Op Fl n
 129 .Cm monitor Op Fl fib Ar number
 130 .Ed
 131 .Pp
 132 The flush command has the syntax:
 133 .Pp
 134 .Bd -ragged -offset indent -compact
 135 .Nm
 136 .Oo Fl n Cm flush Oc Oo Ar family Oc Op Fl fib Ar number
 137 .Ed
 138 .Pp
 139 If the
 140 .Cm flush
 141 command is specified,
 142 .Nm
 143 will ``flush'' the routing tables of all gateway entries.
 144 When the address family may is specified by any of the
 145 .Fl osi ,
 146 .Fl xns ,
 147 .Fl atalk ,
 148 .Fl inet6 ,
 149 or
 150 .Fl inet
 151 modifiers, only routes having destinations with addresses in the
 152 delineated family will be deleted.
 153 Additionally,
 154 .Fl 4
 155 or
 156 .Fl 6
 157 can be used as aliases for
 158 .Fl inet
 159 and
 160 .Fl inet6
 161 modifiers.
 162 When a
 163 .Fl fib
 164 option is specified, the operation will be applied to
 165 the specified FIB
 166 .Pq routing table .
 167 .Pp
 168 The other commands have the following syntax:
 169 .Pp
 170 .Bd -ragged -offset indent -compact
 171 .Nm
 172 .Op Fl n
 173 .Ar command
 174 .Op Fl net No \&| Fl host
 175 .Ar destination gateway
 176 .Op Ar netmask
 177 .Op Fl fib Ar number
 178 .Ed
 179 .Pp
 180 where
 181 .Ar destination
 182 is the destination host or network,
 183 .Ar gateway
 184 is the next-hop intermediary via which packets should be routed.
 185 Routes to a particular host may be distinguished from those to
 186 a network by interpreting the Internet address specified as the
 187 .Ar destination
 188 argument.
 189 The optional modifiers
 190 .Fl net
 191 and
 192 .Fl host
 193 force the destination to be interpreted as a network or a host, respectively.
 194 Otherwise, if the
 195 .Ar destination
 196 has a
 197 .Dq local address part
 198 of
 199 INADDR_ANY
 200 .Pq Li 0.0.0.0 ,
 201 or if the
 202 .Ar destination
 203 is the symbolic name of a network, then the route is
 204 assumed to be to a network; otherwise, it is presumed to be a
 205 route to a host.
 206 Optionally, the
 207 .Ar destination
 208 could also be specified in the
 209 .Ar net Ns / Ns Ar bits
 210 format.
 211 .Pp
 212 For example,
 213 .Li 128.32
 214 is interpreted as
 215 .Fl host Li 128.0.0.32 ;
 216 .Li 128.32.130
 217 is interpreted as
 218 .Fl host Li 128.32.0.130 ;
 219 .Fl net Li 128.32
 220 is interpreted as
 221 .Li 128.32.0.0;
 222 .Fl net Li 128.32.130
 223 is interpreted as
 224 .Li 128.32.130.0;
 225 and
 226 .Li 192.168.64/20
 227 is interpreted as
 228 .Fl net Li 192.168.64 Fl netmask Li 255.255.240.0 .
 229 .Pp
 230 A
 231 .Ar destination
 232 of
 233 .Ar default
 234 is a synonym for the default route.
 235 For
 236 .Li IPv4
 237 it is
 238 .Fl net Fl inet Li 0.0.0.0 ,
 239 and for
 240 .Li IPv6
 241 it is
 242 .Fl net Fl inet6 Li :: .
 243 .Pp
 244 If the destination is directly reachable
 245 via an interface requiring
 246 no intermediary system to act as a gateway, the
 247 .Fl interface
 248 modifier should be specified;
 249 the gateway given is the address of this host on the common network,
 250 indicating the interface to be used for transmission.
 251 Alternately, if the interface is point to point the name of the interface
 252 itself may be given, in which case the route remains valid even
 253 if the local or remote addresses change.
 254 .Pp
 255 The optional modifiers
 256 .Fl xns ,
 257 .Fl osi ,
 258 .Fl atalk ,
 259 and
 260 .Fl link
 261 specify that all subsequent addresses are in the
 262 .Tn XNS ,
 263 .Tn OSI ,
 264 or
 265 .Tn AppleTalk
 266 address families,
 267 or are specified as link-level addresses,
 268 and the names must be numeric specifications rather than
 269 symbolic names.
 270 .Pp
 271 The optional
 272 .Fl netmask
 273 modifier is intended
 274 to achieve the effect of an
 275 .Tn OSI
 276 .Tn ESIS
 277 redirect with the netmask option,
 278 or to manually add subnet routes with
 279 netmasks different from that of the implied network interface
 280 (as would otherwise be communicated using the OSPF or ISIS routing protocols).
 281 One specifies an additional ensuing address parameter
 282 (to be interpreted as a network mask).
 283 The implicit network mask generated in the AF_INET case
 284 can be overridden by making sure this option follows the destination parameter.
 285 .Pp
 286 For
 287 .Dv AF_INET6 ,
 288 the
 289 .Fl prefixlen
 290 qualifier
 291 is available instead of the
 292 .Fl mask
 293 qualifier because non-continuous masks are not allowed in IPv6.
 294 For example,
 295 .Fl prefixlen Li 32
 296 specifies network mask of
 297 .Li ffff:ffff:0000:0000:0000:0000:0000:0000
 298 to be used.
 299 The default value of prefixlen is 64 to get along with
 300 the aggregatable address.
 301 But 0 is assumed if
 302 .Cm default
 303 is specified.
 304 Note that the qualifier works only for
 305 .Dv AF_INET6
 306 address family.
 307 .Pp
 308 Routes have associated flags which influence operation of the protocols
 309 when sending to destinations matched by the routes.
 310 These flags may be set (or sometimes cleared)
 311 by indicating the following corresponding modifiers:
 312 .Bd -literal
 313 -xresolve  RTF_XRESOLVE   - emit mesg on use (for external lookup)
 314 -iface    ~RTF_GATEWAY    - destination is directly reachable
 315 -static    RTF_STATIC     - manually added route
 316 -nostatic ~RTF_STATIC     - pretend route added by kernel or daemon
 317 -reject    RTF_REJECT     - emit an ICMP unreachable when matched
 318 -blackhole RTF_BLACKHOLE  - silently discard pkts (during updates)
 319 -proto1    RTF_PROTO1     - set protocol specific routing flag #1
 320 -proto2    RTF_PROTO2     - set protocol specific routing flag #2
 321 -proto3    RTF_PROTO3     - set protocol specific routing flag #3
 322 .Ed
 323 .Pp
 324 The optional modifiers
 325 .Fl rtt ,
 326 .Fl rttvar ,
 327 .Fl sendpipe ,
 328 .Fl recvpipe ,
 329 .Fl mtu ,
 330 .Fl hopcount ,
 331 .Fl expire ,
 332 and
 333 .Fl ssthresh
 334 provide initial values to quantities maintained in the routing entry
 335 by transport level protocols, such as TCP or TP4.
 336 These may be individually locked by preceding each such modifier to
 337 be locked by
 338 the
 339 .Fl lock
 340 meta-modifier, or one can
 341 specify that all ensuing metrics may be locked by the
 342 .Fl lockrest
 343 meta-modifier.
 344 .Pp
 345 Note that
 346 .Fl expire
 347 accepts expiration time of the route as the number of seconds since the
 348 Epoch
 349 .Pq see Xr time 3 .
 350 When the first character of the number is
 351 .Dq +
 352 or
 353 .Dq - ,
 354 it is interpreted as a value relative to the current time.
 355 .Pp
 356 The optional modifier
 357 .Fl fib Ar number
 358 specifies that the command will be applied to a non-default FIB.
 359 The
 360 .Ar number
 361 must be smaller than the
 362 .Va net.fibs
 363 .Xr sysctl 8
 364 MIB.
 365 When this modifier is not specified,
 366 or a negative number is specified,
 367 the default FIB shown in the
 368 .Va net.my_fibnum
 369 .Xr sysctl 8
 370 MIB will be used.
 371 .Pp
 372 The
 373 .Ar number
 374 allows multiple FIBs by a comma-separeted list and/or range
 375 specification.
 376 The
 377 .Qq Fl fib Li 2,4,6
 378 means the FIB number 2, 4, and 6.
 379 The
 380 .Qq Fl fib Li 1,3-5,6
 381 means the 1, 3, 4, 5, and 6.
 382 .Pp
 383 In a
 384 .Cm change
 385 or
 386 .Cm add
 387 command where the destination and gateway are not sufficient to specify
 388 the route (as in the
 389 .Tn ISO
 390 case where several interfaces may have the
 391 same address), the
 392 .Fl ifp
 393 or
 394 .Fl ifa
 395 modifiers may be used to determine the interface or interface address.
 396 .Pp
 397 All symbolic names specified for a
 398 .Ar destination
 399 or
 400 .Ar gateway
 401 are looked up first as a host name using
 402 .Xr gethostbyname 3 .
 403 If this lookup fails,
 404 .Xr getnetbyname 3
 405 is then used to interpret the name as that of a network.
 406 .Pp
 407 The
 408 .Nm
 409 utility uses a routing socket and the new message types
 410 .Dv RTM_ADD , RTM_DELETE , RTM_GET ,
 411 and
 412 .Dv RTM_CHANGE .
 413 As such, only the super-user may modify
 414 the routing tables.
 415 .Sh EXIT STATUS
 416 .Ex -std
 417 .Sh EXAMPLES
 418 Add a default route to the network routing table.
 419 This will send all packets for destinations not available in the routing table
 420 to the default gateway at 192.168.1.1:
 421 .Pp
 422 .Dl route add -net 0.0.0.0/0 192.168.1.1
 423 .Pp
 424 A shorter version of adding a default route can also be written as:
 425 .Pp
 426 .Dl route add default 192.168.1.1
 427 .Pp
 428 Add a static route to the 172.16.10.0/24 network via the 172.16.1.1 gateway:
 429 .Pp
 430 .Dl route add -net 172.16.10.0/24 172.16.1.1
 431 .Pp
 432 Change the gateway of an already established static route in the routing table:
 433 .Pp
 434 .Dl route change -net 172.16.10.0/24 172.16.1.2
 435 .Pp
 436 Display the route for a destination network:
 437 .Pp
 438 .Dl route show 172.16.10.0
 439 .Pp
 440 Delete a static route from the routing table:
 441 .Pp
 442 .Dl route delete -net 172.16.10.0/24 172.16.1.2
 443 .Pp
 444 Remove all routes from the routing table:
 445 .Pp
 446 .Dl route flush
 447 .Sh DIAGNOSTICS
 448 .Bl -diag
 449 .It "add [host \&| network ] %s: gateway %s flags %x"
 450 The specified route is being added to the tables.
 451 The
 452 values printed are from the routing table entry supplied
 453 in the
 454 .Xr ioctl 2
 455 call.
 456 If the gateway address used was not the primary address of the gateway
 457 (the first one returned by
 458 .Xr gethostbyname 3 ) ,
 459 the gateway address is printed numerically as well as symbolically.
 460 .It "delete [ host \&| network ] %s: gateway %s flags %x"
 461 As above, but when deleting an entry.
 462 .It "%s %s done"
 463 When the
 464 .Cm flush
 465 command is specified, each routing table entry deleted
 466 is indicated with a message of this form.
 467 .It "Network is unreachable"
 468 An attempt to add a route failed because the gateway listed was not
 469 on a directly-connected network.
 470 The next-hop gateway must be given.
 471 .It "not in table"
 472 A delete operation was attempted for an entry which
 473 was not present in the tables.
 474 .It "routing table overflow"
 475 An add operation was attempted, but the system was
 476 low on resources and was unable to allocate memory
 477 to create the new entry.
 478 .It "gateway uses the same route"
 479 A
 480 .Cm change
 481 operation resulted in a route whose gateway uses the
 482 same route as the one being changed.
 483 The next-hop gateway should be reachable through a different route.
 484 .El
 485 .Sh SEE ALSO
 486 .\".Xr esis 4 ,
 487 .Xr netintro 4 ,
 488 .Xr route 4 ,
 489 .Xr arp 8 ,
 490 .Xr IPXrouted 8 ,
 491 .Xr routed 8
 492 .\".Xr XNSrouted 8
 493 .Sh HISTORY
 494 The
 495 .Nm
 496 utility appeared in
 497 .Bx 4.2 .
 498 .Sh BUGS
 499 The first paragraph may have slightly exaggerated
 500 .Xr routed 8 Ns 's
 501 abilities.
 502 .Pp
 503 Currently, routes with the
 504 .Dv RTF_BLACKHOLE
 505 flag set need to have the gateway set to an instance of the
 506 .Xr lo 4
 507 driver, using the
 508 .Fl iface
 509 option, for the flag to have any effect; unless IP fast forwarding
 510 is enabled, in which case the meaning of the flag will always
 511 be honored.