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