route(1M) TCP/IP R4.11 route(1M)
NAME
route - manipulate the routing tables
SYNOPSIS
route [ -C ] [ -n ] [ -q ] [ -v ] command [[ modifiers ] args ]
DESCRIPTION
Route is a program used to manually manipulate the network routing
tables. It normally is not needed, as the system routing table
management daemon, such as routed(8), should tend to this task.
Options supported by route :
-C Use the old route ioctl commands to add or delete routes
instead of the new route message interface.
-n Prevent attempts to print host and network names symbolically
when reporting actions.
-v (verbose) Print additional details.
-q Suppress all output.
Commands accepted by route :
add Add a route.
flush Remove all routes.
delete Delete a specific route.
change Change aspects of a route (such as its gateway).
get Lookup and display the route for a destination.
The flush command has the syntax
route [-n] flush [family]
Where the address family may be specified by any of the -inet
keywords.
The other commands have the following syntax:
route [-n] command [ -net | -host ] destination gateway
where destination is the destination host or network, gateway is the
next-hop gateway to which packets should be addressed. Routes to a
particular host are distinguished from those to a network by
interpreting the Internet address associated with destination. The
optional keywords -net and -host force the destination to be
interpreted as a network or a host, respectively. Otherwise, if the
has a ``local address part'' of INADDR_ANY , or if the destination is
the symbolic name of a network, then the route is assumed to be to a
network; otherwise, it is presumed to be a route to a host.
For example, 128.32 is interpreted as -host 128.0.0.32; 128.32.130 is
interpreted as -host 128.32.0.130; -net 128.32 is interpreted as
128.32.0.0; and -net 128.32.130 is interpreted as 128.32.130.0.
If the route is via an interface rather than via a gateway, the
-interface modifier should be specified; the gateway given is the
address of this host on the common network, indicating the interface
to be used for transmission.
The optional -netmask qualifier is intended to achieve the effect of
an OSI ESIS redirect with the netmask option. One specifies an
additional ensuing address parameter (to be interpreted as a network
mask). The implicit network mask generated in the inet case can be
overridden by making sure this option follows the destination
parameter.
The optional modifiers -rtt , -rttvar , -sendpipe , -recvpipe , -mtu
, -hopcount , -expire , and -ssthresh provide initial values to
metrics maintained in the routing entry. These may be individually
locked by preceding each such modifier to be locked by the -lock
meta-modifier, or one can specify that all ensuing metrics may be
locked by the -lockrest meta-modifier.
In a change or add command where the destination and gateway are not
sufficient to specify the route (as in the ISO case where several
interfaces may have the same address), the -ifp or -ifa modifiers may
be used to determine the interface or interface address.
All symbolic names specified for a destination or gateway are looked
up first as a host name using gethostbyname(3). If this lookup
fails, getnetbyname(3) is then used to interpret the name as that of
a network.
Route uses a raw socket and the new message types RTM_ADD,
RTM_DELETE, RTM_GET, and RTM_CHANGE which are passed in a SIOCMSGRT
ioctl. As such, only a user with appropriate privilege may modify
the routing tables. For systems supporting the DG/UX Capability
Option, appropriate privilege is defined as having one or more
specific capabilities enabled in the effective capability set of the
user. See cap_defaults(5) for the default capabilities for this
command.
On generic DG/UX systems, appropriate privilege means that your
process has an effective UID of root. See the
appropriate_privilege(5) man page for more information.
If the flush command is specified, route will ``flush'' the routing
tables of all gateway entries. One can choose to flush only those
routes whose destinations are of a given address family, by
specifying an optional keyword describing which address family.
DIAGNOSTICS
add [host | network ] %s: gateway %s flags %x The specified
route is being added to the tables. The values printed are
from the routing table entry supplied in the ioctl(2) call.
If the gateway address used was not the primary address of the
gateway (the first one returned by gethostbyname(3) ) , the
gateway address is printed numerically as well as
symbolically.
delete [ host | network ] %s: gateway %s flags %x As above,
but when deleting an entry.
%s %s done When the flush command is specified, each routing
table entry deleted is indicated with a message of this form.
Network is unreachable An attempt to add a route failed
because the gateway listed was not on a directly-connected
network. The next-hop gateway must be given.
not in table A delete operation was attempted for an entry
which wasn't present in the tables.
routing table overflow An add operation was attempted, but the
system was low on resources and was unable to allocate memory
to create the new entry.
SEE ALSO
routed(8)
cap_defaults(5)
HISTORY
Ported from BSD 4.3.R2.
To maintain backward compatibility with previous versions of route,
net and host can be used where -net and -host are given.
Licensed material--property of copyright holder(s)