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 .\"
  30 .Dd June 16, 2023
  31 .Dt ROUTE 8
  32 .Os
  33 .Sh NAME
  34 .Nm route
  35 .Nd manually manipulate the routing tables
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl j Ar jail
  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 .It Fl j Ar jail
  95 Run inside a jail.
  96 .El
  97 .Pp
  98 The
  99 .Nm
 100 utility provides the following commands:
 101 .Pp
 102 .Bl -tag -width Fl -compact
 103 .It Cm add
 104 Add a route.
 105 .It Cm flush
 106 Remove all routes.
 107 .It Cm delete
 108 Delete a specific route.
 109 .It Cm del
 110 Another name for the
 111 .Cm delete
 112 command.
 113 .It Cm change
 114 Change aspects of a route (such as its gateway).
 115 .It Cm get
 116 Lookup and display the route for a destination.
 117 .It Cm monitor
 118 Continuously report any changes to the routing information base,
 119 routing lookup misses, or suspected network partitionings.
 120 .It Cm show
 121 Another name for the
 122 .Cm get
 123 command.
 124 .El
 125 .Pp
 126 The monitor command has the syntax:
 127 .Pp
 128 .Bd -ragged -offset indent -compact
 129 .Nm
 130 .Op Fl n
 131 .Cm monitor Op Fl fib Ar number
 132 .Ed
 133 .Pp
 134 The flush command has the syntax:
 135 .Pp
 136 .Bd -ragged -offset indent -compact
 137 .Nm
 138 .Op Fl n
 139 .Cm flush Oo Ar family Oc Op Fl fib Ar number
 140 .Ed
 141 .Pp
 142 If the
 143 .Cm flush
 144 command is specified,
 145 .Nm
 146 will ``flush'' the routing tables of all gateway entries.
 147 When the address family may is specified by any of the
 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
 268 .Fl netmask
 269 modifier is intended
 270 to achieve the effect of an OSI ESIS
 271 redirect with the netmask option,
 272 or to manually add subnet routes with
 273 netmasks different from that of the implied network interface
 274 (as would otherwise be communicated using the OSPF or ISIS routing protocols).
 275 One specifies an additional ensuing address parameter
 276 (to be interpreted as a network mask).
 277 The implicit network mask generated in the AF_INET case
 278 can be overridden by making sure this option follows the destination parameter.
 279 .Pp
 280 For
 281 .Dv AF_INET6 ,
 282 the
 283 .Fl prefixlen
 284 qualifier
 285 is available instead of the
 286 .Fl mask
 287 qualifier because non-continuous masks are not allowed in IPv6.
 288 For example,
 289 .Fl prefixlen Li 32
 290 specifies that a network mask of
 291 .Li ffff:ffff:0000:0000:0000:0000:0000:0000
 292 will be used.
 293 The default prefixlen is 64.
 294 However, it is assumed to be 0 if
 295 .Cm default
 296 is specified for
 297 .Ar destination .
 298 Note that the qualifier works only for
 299 .Dv AF_INET6
 300 address family.
 301 .Pp
 302 Routes have associated flags which influence operation of the protocols
 303 when sending to destinations matched by the routes.
 304 These flags may be set (or sometimes cleared)
 305 by indicating the following corresponding modifiers:
 306 .Bd -literal
 307 -xresolve  RTF_XRESOLVE   - emit mesg on use (for external lookup)
 308 -iface    ~RTF_GATEWAY    - destination is directly reachable
 309 -static    RTF_STATIC     - manually added route
 310 -nostatic ~RTF_STATIC     - pretend route added by kernel or daemon
 311 -reject    RTF_REJECT     - emit an ICMP unreachable when matched
 312 -blackhole RTF_BLACKHOLE  - silently discard pkts (during updates)
 313 -proto1    RTF_PROTO1     - set protocol specific routing flag #1
 314 -proto2    RTF_PROTO2     - set protocol specific routing flag #2
 315 .Ed
 316 .Pp
 317 The optional modifiers
 318 .Fl rtt ,
 319 .Fl rttvar ,
 320 .Fl sendpipe ,
 321 .Fl recvpipe ,
 322 .Fl mtu ,
 323 .Fl hopcount ,
 324 .Fl expire ,
 325 and
 326 .Fl ssthresh
 327 provide initial values to quantities maintained in the routing entry
 328 by transport level protocols, such as TCP or TP4.
 329 These may be individually locked by preceding each such modifier to
 330 be locked by
 331 the
 332 .Fl lock
 333 meta-modifier, or one can
 334 specify that all ensuing metrics may be locked by the
 335 .Fl lockrest
 336 meta-modifier.
 337 .Pp
 338 Note that
 339 .Fl expire
 340 accepts expiration time of the route as the number of seconds since the
 341 Epoch
 342 .Pq see Xr time 3 .
 343 When the first character of the number is
 344 .Dq +
 345 or
 346 .Dq - ,
 347 it is interpreted as a value relative to the current time.
 348 .Pp
 349 The optional modifier
 350 .Fl fib Ar number
 351 specifies that the command will be applied to a non-default FIB.
 352 The
 353 .Ar number
 354 must be smaller than the
 355 .Va net.fibs
 356 .Xr sysctl 8
 357 MIB.
 358 When this modifier is not specified,
 359 or a negative number is specified,
 360 the default FIB shown in the
 361 .Va net.my_fibnum
 362 .Xr sysctl 8
 363 MIB will be used.
 364 .Pp
 365 The
 366 .Ar number
 367 allows multiple FIBs by a comma-separeted list and/or range
 368 specification.
 369 The
 370 .Qq Fl fib Li 2,4,6
 371 means the FIB number 2, 4, and 6.
 372 The
 373 .Qq Fl fib Li 1,3-5,6
 374 means the 1, 3, 4, 5, and 6.
 375 .Pp
 376 In a
 377 .Cm change
 378 or
 379 .Cm add
 380 command where the destination and gateway are not sufficient to specify
 381 the route (as in the ISO case where several interfaces may have the
 382 same address), the
 383 .Fl ifp
 384 or
 385 .Fl ifa
 386 modifiers may be used to determine the interface or interface address.
 387 .Pp
 388 All symbolic names specified for a
 389 .Ar destination
 390 or
 391 .Ar gateway
 392 are looked up first as a host name using
 393 .Xr gethostbyname 3 .
 394 If this lookup fails,
 395 .Xr getnetbyname 3
 396 is then used to interpret the name as that of a network.
 397 .Pp
 398 The
 399 .Nm
 400 utility uses a routing socket and the new message types
 401 .Dv RTM_ADD , RTM_DELETE , RTM_GET ,
 402 and
 403 .Dv RTM_CHANGE .
 404 As such, only the super-user may modify
 405 the routing tables.
 406 .Pp
 407 .Fx provides support for scalable multipath routing.
 408 It is activated by default, but can be turned off by setting the
 409 .Va net.route.multipath
 410 .Xr sysctl 8
 411 MIB to 0.
 412 .Pp
 413 There are multiple route lookup algorithms available.
 414 They can be configured by setting
 415 .Va net.route.algo.inet.algo
 416 for IPv4 and
 417 .Va net.route.algo.inet6.algo
 418 for IPv6
 419 .Xr sysctl 8
 420 MIBs.
 421 .Pp
 422 A list of available algorithms can be obtained by accessing the
 423 following
 424 .Xr sysctl 8
 425 MIBs
 426 .Va net.route.algo.inet.algo_list
 427 for IPv4 and
 428 .Va net.route.algo.inet6.algo_list
 429 for IPv6.
 430 .Pp
 431 The following algorithms are available:
 432 .Bl -tag -width radix_lockless
 433 .It radix
 434 Base system radix backend.
 435 .It bsearch
 436 Lockless binary search in a special IP array, tailored for a small FIB
 437 with <16 routes.
 438 This algorithm is only available for IPv4.
 439 .It radix_lockless
 440 Lockless immutable radix, re-created on every rtable change,
 441 tailored for a small FIB with <1000 routes.
 442 .It dpdk_lpm
 443 DPDK DIR24-8-based lookups, lockless datastructure, optimized
 444 for large FIBs.
 445 DIR24-8 relies on a large flat lookup table (64 MB with IPv4) which is
 446 directly indexed by the more significant portion of the lookup key.
 447 In order to use the dpdk_lpm algorithm one or both of the
 448 following kernel modules must be loaded via
 449 .Xr loader.conf 5 :
 450 .Bl -tag -width dpdk_lpm6.ko -compact
 451 .It dpdk_lpm4.ko
 452 DPDK implementation for IPv4.
 453 .It dpdk_lpm6.ko
 454 DPDK implementation for IPv6.
 455 .El
 456 .It dxr
 457 IPv4 only, lockless, compressed lookup structure
 458 (below 2.5 Bytes per IPv4 prefix for large BGP FIBs)
 459 which easily fits into modern CPU cache hierarchies,
 460 lookup throughput scales linearly with CPU cores.
 461 Loadable as a kernel module at runtime or via
 462 .Xr loader.conf 5 :
 463 .Bl -tag -width fib_dxr.ko -compact
 464 .It fib_dxr.ko
 465 .El
 466 .El
 467 .Pp
 468 The algorithms are selected automatically based on the size of the routing
 469 table of the system.
 470 They can be changed, but not every algorithm performs best for every
 471 FIB size.
 472 .Sh EXIT STATUS
 473 .Ex -std
 474 .Sh EXAMPLES
 475 Add a default route to the network routing table.
 476 This will send all packets for destinations not available in the routing table
 477 to the default gateway at 192.168.1.1:
 478 .Pp
 479 .Dl route add -net 0.0.0.0/0 192.168.1.1
 480 .Pp
 481 A shorter version of adding a default route can also be written as:
 482 .Pp
 483 .Dl route add default 192.168.1.1
 484 .Pp
 485 Add a static route to the 172.16.10.0/24 network via the 172.16.1.1 gateway:
 486 .Pp
 487 .Dl route add -net 172.16.10.0/24 172.16.1.1
 488 .Pp
 489 Change the gateway of an already established static route in the routing table:
 490 .Pp
 491 .Dl route change -net 172.16.10.0/24 172.16.1.2
 492 .Pp
 493 Display the route for a destination network:
 494 .Pp
 495 .Dl route show 172.16.10.0
 496 .Pp
 497 Delete a static route from the routing table:
 498 .Pp
 499 .Dl route delete -net 172.16.10.0/24 172.16.1.2
 500 .Pp
 501 Remove all routes from the routing table:
 502 .Pp
 503 .Dl route flush
 504 .Pp
 505 The routing table can be listed with
 506 .Xr netstat 1 .
 507 .Sh DIAGNOSTICS
 508 .Bl -diag
 509 .It "add [host \&| network ] %s: gateway %s flags %x"
 510 The specified route is being added to the tables.
 511 The
 512 values printed are from the routing table entry supplied
 513 in the
 514 .Xr ioctl 2
 515 call.
 516 If the gateway address used was not the primary address of the gateway
 517 (the first one returned by
 518 .Xr gethostbyname 3 ) ,
 519 the gateway address is printed numerically as well as symbolically.
 520 .It "delete [ host \&| network ] %s: gateway %s flags %x"
 521 As above, but when deleting an entry.
 522 .It "%s %s done"
 523 When the
 524 .Cm flush
 525 command is specified, each routing table entry deleted
 526 is indicated with a message of this form.
 527 .It "Network is unreachable"
 528 An attempt to add a route failed because the gateway listed was not
 529 on a directly-connected network.
 530 The next-hop gateway must be given.
 531 .It "not in table"
 532 A delete operation was attempted for an entry which
 533 was not present in the tables.
 534 .It "routing table overflow"
 535 An add operation was attempted, but the system was
 536 low on resources and was unable to allocate memory
 537 to create the new entry.
 538 .It "gateway uses the same route"
 539 A
 540 .Cm change
 541 operation resulted in a route whose gateway uses the
 542 same route as the one being changed.
 543 The next-hop gateway should be reachable through a different route.
 544 .El
 545 .Sh SEE ALSO
 546 .Xr netstat 1 ,
 547 .Xr netintro 4 ,
 548 .Xr route 4 ,
 549 .Xr loader.conf 5 ,
 550 .Xr arp 8 ,
 551 .Xr routed 8
 552 .Sh HISTORY
 553 The
 554 .Nm
 555 utility appeared in
 556 .Bx 4.2 .
 557 .Sh BUGS
 558 The first paragraph may have slightly exaggerated
 559 .Xr routed 8 Ns 's
 560 abilities.
 561 .Pp
 562 Currently, routes with the
 563 .Dv RTF_BLACKHOLE
 564 flag set need to have the gateway set to an instance of the
 565 .Xr lo 4
 566 driver, using the
 567 .Fl iface
 568 option, for the flag to have any effect; unless IP fast forwarding
 569 is enabled, in which case the meaning of the flag will always
 570 be honored.