Manpages

NAME

route − manually manipulate the routing tables

SYNOPSIS

route [-fnvq] command [ [modifiers] args]

route [-fnvq] add | delete [modifiers] destination gateway [args]

route [-fnvq] change | get [modifiers] destination [ gateway [args]]

route [-n] monitor [modifiers]

route [-n] flush [modifiers]

DESCRIPTION

route manually manipulates the network routing tables. These tables are normally maintained by the system routing daemon, such as in.routed(1M) and in.ripngd(1M).

This utility supports a limited number of general options, but a rich command language. It enables the user to specify any arbitrary request that could be delivered by means of the programmatic interface discussed in route(7P).

route uses a routing socket and the new message types RTM_ADD, RTM_DELETE, RTM_GET, and RTM_CHANGE. As such, only the superuser may modify the routing tables.

OPTIONS

Commands
route executes one of four commands on a route to a destination. Two additional commands operate globally on all routing information. The six commands are:

change

Change aspects of a route (such as its gateway).

delete

Delete a specific route.

monitor

Continuously report any changes to the routing information base, routing lookup misses, or suspected network partitionings.

The add, delete, and change commands have the following syntax:

route [ -fnvq ] add | delete [ -net | -host ] destination gateway [args]

or

route [ -fnvq ] change | get [ -net | -host ] destination gateway [args]

where destination is the destination host or network, and gateway is the next-hop intermediary through which packets should be routed.

OPERANDS

route executes its commands on routes to destinations.

Destinations
By default, a destination is looked up under the AF_INET address family or as an IPv4 address. All symbolic names specified for a destination or gateway are looked up first as a host name, using getipnodebyname(3SOCKET). If this lookup fails in the AF_INET case, getnetbyname(3SOCKET) is used to interpret the name as that of a network.

An optional modifier may be included on the command line before a destination, to force how route interprets a destination:

-inet6

Forces the destination to be interpreted under the AF_INET6 address family or as an IPv6 address.

In the case of the AF_INET address family or an IPv4 address, routes to a particular host may be distinguished from those to a network by interpreting the Internet address specified as the destination. If the destination 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:

If the destination is directly reachable by way of an interface requiring no intermediary system to act as a gateway, this can be indicated by including one of two optional modifiers after the destination: The -interface modifier can be included or a metric of 0 can be specified. These modifiers are illustrated in the following alternative examples:

example% route add default hostname -interface
example% route add default hostname 0

hostname is the name or IP address associated with the network interface all packets should be sent over. On a host with a single network interface, hostname is normally the same as the nodename returned by uname -n (see uname(1)).

In the above examples, the route does not refer to a gateway, but rather to one of the machine’s interfaces. Destinations matching such a route are sent out on the interface identified by the gateway address. For interfaces using the ARP protocol, this type of route is used to specify all destinations are local. That is, a host should ARP for all addresses by adding a default route using one of the two commands listed above.

With the AF_INET address family or an IPv4 address, the optional -netmask qualifier is intended to manually add subnet routes with netmasks different from that of the implied network interface. The implicit network mask generated in the AF_INET case can be overridden by making sure this option, and an ensuing address parameter (to be interpreted as a network mask), follows the destination parameter.

Alternatively, the length of the netmask may be supplied by appending a slash character and the length immediately after the destination. For example:

example% route add 192.0.2.32/27 somegateway

will create an IPv4 route to the destination 192.0.2.32 with a netmask of 255.255.255.224, and

example% route add -inet6 3ffe::/16 somegateway

will create an IPv6 route to the destination 33fe:: with a netmask of 16 one-bits followed by 112 zero-bits.

Routing Flags
Routes have associated flags which influence operation of the protocols when sending to destinations matched by the routes. These flags may be set (or sometimes cleared) by including the following corresponding modifiers on the command line:

The optional modifiers -rtt, -rttvar, -sendpipe, -recvpipe, -mtu, -hopcount, -expire, and -ssthresh provide initial values to quantities maintained in the routing entry by transport level protocols, such as TCP. These may be individually locked either by preceding each modifier to be locked by the -lock meta-modifier, or by specifying that all ensuing metrics may be locked by the -lockrest meta-modifier.

The optional modifiers are defined as follows:

-expire

Lifetime for the entry. This optional modifier is not currently supported.

-hopcount

Maximum hop count. This optional modifier is not currently supported.

-recvpipe

Receive pipe size in bytes.

-rttvar

Round trip time variance in microseconds.

-sendpipe

Send pipe size in bytes.

-ssthresh

Send pipe size threshold in bytes.

Some transport layer protocols may support only some of these metrics.

In a change or add command where the destination and gateway are not sufficient to specify the route (for example, , when several interfaces have the same address), the -ifp or -ifa modifiers may be used to determine the interface or interface address.

FILES

/etc/defaultrouter

list of default routers

/etc/hosts

list of host names and net addresses

/etc/networks

list of network names and addresses

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

SEE ALSO

get(1), uname(1), in.rdisc(1M), netstat(1M), routed(1M), ioctl(2), getipnodebyname(3SOCKET), getnetbyname(3SOCKET), defaultrouter(4), hosts(4), networks(4), attributes(5), ARP(7P), ip(7P), route(7P), routing(7P)

DIAGNOSTICS

add [ host| network] destination:gateway flags

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 getipnodebyname(3SOCKET)) the gateway address is printed numerically as well as symbolically.

delete [ host| network] destination:gateway flags

As above, but when deleting an entry.

destination done

When the -f flag is specified, or in the flush command, 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. Give the next-hop gateway instead.

not in table

A delete operation was attempted for an entry that is not in the table.

routing table overflow

An add operation was attempted, but the system was unable to allocate memory to create the new entry.

NOTES

All destinations are local assumes that the routers implement the protocol, proxy arp. Normally, using router discovery (see in.rdisc(1M)) is more reliable than using proxy arp.

Combining the all destinations are local route with subnet or network routes can lead to unpredictable results: the search order as it relates to the all destinations are local route are undefined and may vary from release to release.