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