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