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