route.tproj/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. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)route.8     8.4 (Berkeley) 6/1/94
  33 .\"
  34 .Dd June 1, 1994
  35 .Dt ROUTE 8
  36 .Os BSD 4.4
  37 .Sh NAME
  38 .Nm route
  39 .Nd manually manipulate the routing tables.
  40 .Sh SYNOPSIS
  41 .Nm route
  42 .Op Fl nqv
  43 .Ar command
  44 .Oo
  45 .Op Ar modifiers
  46 .Ar args
  47 .Oc
  48 .Sh DESCRIPTION
  49 .Nm Route
  50 is a utility used to manually manipulate the network
  51 routing tables.  It normally is not needed, as a
  52 system routing table management daemon such as
  53 .Xr routed 8 ,
  54 should tend to this task.
  55 .Pp
  56 The
  57 .Nm route :
  58 utility supports a limited number of general options,
  59 but a rich command language, enabling the user to specify
  60 any arbitrary request that could be delivered via the
  61 programmatic interface discussed in
  62 .Xr route 4 .
  63 .Pp
  64 .Bl -tag -width Ds
  65 .It Fl n
  66 Bypasses attempts to print host and network names symbolically
  67 when reporting actions.  (The process of translating between symbolic
  68 names and numerical equivalents can be quite time consuming, and
  69 may require correct operation of the network; thus it may be expedient
  70 to forgo this, especially when attempting to repair networking operations),
  71 .It Fl v
  72 (verbose) Print additional details.
  73 .It Fl q
  74 Suppress all output.
  75 .El
  76 .Pp
  77 The
  78 .Nm route :
  79 utility provides six commands:
  80 .Pp
  81 .Bl -tag -width Fl -compact
  82 .It Cm add
  83 Add a route.
  84 .It Cm flush
  85 Remove all routes.
  86 .It Cm delete
  87 Delete a specific route.
  88 .It Cm change
  89 Change aspects of a route (such as its gateway).
  90 .It Cm get
  91 Lookup and display the route for a destination.
  92 .It Cm monitor
  93 Continuously report any changes to the routing information base,
  94 routing lookup misses, or suspected network partitionings.
  95 .El
  96 .Pp
  97 The monitor command has the syntax
  98 .Pp
  99 .Bd -filled -offset indent -compact
 100 .Nm route Op Fl n
 101 .Cm monitor
 102 .Ed
 103 .Pp
 104 The flush command has the syntax
 105 .Pp
 106 .Bd -filled -offset indent -compact
 107 .Nm route Op Fl n
 108 .Cm flush
 109 .Op Ar family
 110 .Ed
 111 .Pp
 112 If the
 113 .Cm flush
 114 command is specified,
 115 .Nm route
 116 will ``flush'' the routing tables of all gateway entries.
 117 When the address family may is specified by any of the
 118 .Fl osi ,
 119 .Fl xns ,
 120 or
 121 .Fl inet
 122 modifiers, only routes having destinations with addresses in the
 123 delineated family will be deleted.
 124 .Pp
 125 The other commands have the following syntax:
 126 .Pp
 127 .Bd -filled -offset indent -compact
 128 .Nm route Op Fl n
 129 .Ar command
 130 .Op Fl net No \&| Fl host
 131 .Ar destination gateway
 132 .Ed
 133 .Pp
 134 where
 135 .Ar destination
 136 is the destination host or network,
 137 .Ar gateway
 138 is the next-hop intermediary via which packets should be routed.
 139 Routes to a particular host may be distinguished from those to
 140 a network by interpreting the Internet address specified as the
 141 .Ar destination argument.
 142 The optional modifiers
 143 .Fl net
 144 and
 145 .Fl host
 146 force the destination to be interpreted as a network or a host, respectively.
 147 Otherwise, if the
 148 .Ar destination
 149 has a ``local address part'' of
 150 INADDR_ANY ,
 151 or if the
 152 .Ar destination
 153 is the symbolic name of a network, then the route is
 154 assumed to be to a network; otherwise, it is presumed to be a
 155 route to a host.
 156 .Pp
 157 For example,
 158 .Li 128.32
 159 is interpreted as
 160 .Fl host Li 128.0.0.32 ;
 161 .Li 128.32.130
 162 is interpreted as
 163 .Fl host Li 128.32.0.130 ;
 164 .Fl net Li 128.32
 165 is interpreted as
 166 .Li 128.32.0.0;
 167 and
 168 .Fl net Li 128.32.130
 169 is interpreted as
 170 .Li 128.32.130.0 .
 171 .Pp
 172 If the destination is directly reachable
 173 via an interface requiring
 174 no intermediary system to act as a gateway, the
 175 .Fl interface
 176 modifier should be specified;
 177 the gateway given is the address of this host on the common network,
 178 indicating the interface to be used for transmission.
 179 .Pp
 180 The optional modifiers
 181 .Fl xns ,
 182 .Fl osi ,
 183 and
 184 .Fl link
 185 specify that all subsequent addresses are in the
 186 .Tn XNS
 187 .Tn OSI
 188 address families,
 189 or are specified as link-level addresses,
 190 and the names must be numeric specifications rather than
 191 symbolic names.
 192 .Pp
 193 The optional
 194 .Fl netmask
 195 qualifier is intended
 196 to achieve the effect of an
 197 .Tn OSI
 198 .Tn ESIS
 199 redirect with the netmask option,
 200 or to manually add subnet routes with
 201 netmasks different from that of the implied network interface
 202 (as would otherwise be communicated using the OSPF or ISIS routing protocols).
 203 One specifies an additional ensuing address parameter
 204 (to be interpreted as a network mask).
 205 The implicit network mask generated in the AF_INET case
 206 can be overridden by making sure this option follows the destination parameter.
 207 .Pp
 208 Routes have associated flags which influence operation of the protocols
 209 when sending to destinations matched by the routes.
 210 These flags may be set (or sometimes cleared)
 211 by indicating the following corresponding modifiers:
 212 .Bd -literal
 213 -cloning   RTF_CLONING    - generates a new route on use
 214 -xresolve  RTF_XRESOLVE   - emit mesg on use (for external lookup)
 215 -iface    ~RTF_GATEWAY    - destination is directly reachable
 216 -static    RTF_STATIC     - manually added route
 217 -nostatic ~RTF_STATIC     - pretend route added by kernel or daemon
 218 -reject    RTF_REJECT     - emit an ICMP unreachable when matched
 219 -blackhole RTF_BLACKHOLE  - silently discard pkts (during updates)
 220 -proto1    RTF_PROTO1     - set protocol specific routing flag #1
 221 -proto2    RTF_PROTO2     - set protocol specific routing flag #2
 222 -llinfo    RTF_LLINFO     - validly translates proto addr to link addr
 223 .Ed
 224 .Pp
 225 The optional modifiers
 226 .Fl rtt ,
 227 .Fl rttvar ,
 228 .Fl sendpipe ,
 229 .Fl recvpipe ,
 230 .Fl mtu ,
 231 .Fl hopcount ,
 232 .Fl expire ,
 233 and
 234 .Fl ssthresh
 235 provide initial values to quantities maintained in the routing entry
 236 by transport level protocols, such as TCP or TP4.
 237 These may be individually locked by preceding each such modifier to
 238 be locked by
 239 the
 240 .Fl lock
 241 meta-modifier, or one can
 242 specify that all ensuing metrics may be locked by the
 243 .Fl lockrest
 244 meta-modifier.
 245 .Pp
 246 In a
 247 .Cm change
 248 or
 249 .Cm add
 250 command where the destination and gateway are not sufficient to specify
 251 the route (as in the
 252 .Tn ISO
 253 case where several interfaces may have the
 254 same address), the
 255 .Fl ifp
 256 or
 257 .Fl ifa
 258 modifiers may be used to determine the interface or interface address.
 259 .Pp
 260 All symbolic names specified for a
 261 .Ar destination
 262 or
 263 .Ar gateway
 264 are looked up first as a host name using
 265 .Xr gethostbyname 3 .
 266 If this lookup fails,
 267 .Xr getnetbyname 3
 268 is then used to interpret the name as that of a network.
 269 .Pp
 270 .Nm Route
 271 uses a routing socket and the new message types
 272 RTM_ADD,
 273 RTM_DELETE,
 274 RTM_GET,
 275 and
 276 RTM_CHANGE.
 277 As such, only the super-user may modify
 278 the routing tables.
 279 .ne 1i
 280 .Sh DIAGNOSTICS
 281 .Bl -tag -width Ds
 282 .It Sy "add [host \&| network ] %s: gateway %s flags %x"
 283 The specified route is being added to the tables.  The
 284 values printed are from the routing table entry supplied
 285 in the
 286 .Xr ioctl 2
 287 call.
 288 If the gateway address used was not the primary address of the gateway
 289 (the first one returned by
 290 .Xr gethostbyname 3 ) ,
 291 the gateway address is printed numerically as well as symbolically.
 292 .It Sy "delete [ host &| network ] %s: gateway %s flags %x"
 293 As above, but when deleting an entry.
 294 .It Sy "%s %s done"
 295 When the
 296 .Cm flush
 297 command is specified, each routing table entry deleted
 298 is indicated with a message of this form.
 299 .It Sy "Network is unreachable"
 300 An attempt to add a route failed because the gateway listed was not
 301 on a directly-connected network.
 302 The next-hop gateway must be given.
 303 .It Sy "not in table"
 304 A delete operation was attempted for an entry which
 305 wasn't present in the tables.
 306 .It Sy "routing table overflow"
 307 An add operation was attempted, but the system was
 308 low on resources and was unable to allocate memory
 309 to create the new entry.
 310 .El
 311 .Sh SEE ALSO
 312 .Xr netintro 4 ,
 313 .Xr route 4 ,
 314 .Xr esis 4 ,
 315 .Xr routed 8 ,
 316 .Xr XNSrouted 8
 317 .Sh HISTORY
 318 The
 319 .Nm
 320 command appeared in
 321 .Bx 4.2 .
 322 .Sh BUGS
 323 The first paragraph may have slightly exaggerated
 324 .Xr routed Ns 's
 325 abilities.