manually manipulate the routing
route is a utility used to manually view
and manipulate the network routing tables.
be used to modify nearly any aspect of the routing policy, except packet
forwarding, which can be manipulated through the
route utility supports a limited
number of general options, but a rich command language enables the user to
specify any arbitrary request that could be delivered via the programmatic
interface discussed in route(4).
The options are as follows:
- Run in debug-only mode, i.e., don't actually modify the routing table.
- Bypass attempts to print host and network names symbolically when reporting actions. (The process of translating between symbolic names and numerical equivalents can be quite time consuming, and may require correct operation of the network; thus it may be expedient to forgo this, especially when attempting to repair networking operations.)
- Suppress all output.
- Select an alternate routing table to modify or query. The default is to use the current routing table. The current routing table can be displayed with id(1).
- Write routing messages to a fake device (/dev/null) instead of a real routing socket to test route manipulation.
- (verbose) Print additional details.
route utility provides
the following simple commands:
- Execute a command forcing the process and its children to use the routing
table and appropriate routing domain as specified with the
- Delete all gateway entries from the routing table. When the address family
is specified by any one of the family modifiers
(listed below), only routes having destinations with addresses in the
delineated family will be deleted. Also, only routes matching a specific
interface or priority can be flushed by using the
get[modifier ...] address
- Extract a routing entry from the kernel. If
-gatewayis specified, only routes whose gateway are in the same address family as the destination are shown.
- Continuously report any changes to the routing information base, routing
lookup misses, or suspected network partitionings.
When the address family is specified by any one of the family modifiers (listed below), only routes having destinations with addresses in the delineated family will be shown. If the
-ifacemodifier is used, only interface specific messages (link state changes) are shown. If a routing table is supplied with
-T, only changes in that routing table will be displayed.
nameserverinterface [address ...]
- Broadcast a list of up to five nameserver address proposals.
unwind(8) will learn them and act according to unwind.conf(5).
resolvd(8) will replace all existing nameservers for the given interface in resolv.conf(5).
If no address argument is given, a request to remove the nameservers previously entered for the given interface is sent.
- Display the routing table.
-gatewayis specified, only routes whose gateway are in the same address family as the destination are shown.
-labelis specified, only routes with the specified label are shown.
-priorityis specified, only routes with the specified priority are shown. It may be specified by number or one of
bgp. If the priority is negative, then routes that do not match the numeric priority are shown.
Within the output of
show, the "Flags" column indicates what flags are set on the route. The mapping between letters and flags is:
Protocol specific routing flag #1. 2
Protocol specific routing flag #2. 3
Protocol specific routing flag #3. B
Just discard pkts (during updates). b
Correspond to a local broadcast address. C
Generate new routes on use. c
Cloned routes (generated from RTF_CLONING). D
Created dynamically (by redirect). G
Dest requires forwarding by intermediary. H
Host entry (net otherwise). h
Referenced by gateway route. L
Valid protocol to link address translation. l
Correspond to a local address. M
Modified dynamically (by redirect). m
Correspond to a multicast address. n
Interface route. P
Multipath route. R
Host or net unreachable. S
Manually added. T
MPLS route. U
- Set the preferred source address. If address is the
word "default", 0.0.0.0 or ::, source address will be chosen by
the kernel for the matching address family. When
address is omitted, preferred source address is
printed if set. If
-ifpis used, source will use IP assigned to interface. The preferred source will not be used when:
- destination is on-link
- source address is assigned to a disabled interface
The other commands relating to adding, changing, or deleting routes have the syntax:
add[modifier ...] destination gateway
change[modifier ...] destination gateway
ete] [modifier ...] destination gateway
destination is the destination host
or network; gateway is the next-hop intermediary via
which packets should be routed. Routes to a particular host may be
distinguished from those to a network by interpreting the Internet address
specified as the destination argument. The optional
cause the destination to be interpreted as a network or a host,
respectively. Otherwise, type is chosen based on the following rules:
The route is assumed to be to a network if any of the following apply to destination:
- it is the word "default", equivalent to 0/0
- it is an IPv4 address with less than 3 dots
- it is an IPv4 address with a “/XX” suffix (where XX is the number of bits in the network portion of the address and is less than 32)
- it is an IPv6 address with a “/XX” suffix (where XX is the number of bits in the network portion of the address and is less than 128)
- it is the symbolic name of a network.
If destination is a valid IP address or host name, it is presumed to be a route to a host.
192.168.1.1 is interpreted as
192.168.1 is interpreted as
192.168.2.0 will be interpreted as
192.168.2.0 since it
is a complete IP address with 3 dots. In this case the number of bits in the
network portion of the address must be explicitly listed, for example
192.168.2/24, or alternately
If the destination is directly reachable via an
interface requiring no intermediary system to act as a gateway, the
modifier should be specified; the gateway given is the address of this host
on the common network, indicating the interface to be used for
To allow addresses to be interpreted as belonging to a particular address family (as well as for use in the family arguments to some commands), the following modifiers may be used:
- Internet Protocol version 4 (IPv4) addresses (see ip(4))
- Internet Protocol version 6 (IPv6) addresses (see ip6(4))
- Hardware (link-level) addresses
- MPLS addresses
- Actual sockaddr data, in hexadecimal format
In the absence of modifiers, an address is assumed to be IPv4, unless containing a ‘:’ character, when it is treated as IPv6.
The optional modifier
-link specifies that
all subsequent addresses are specified as link-level addresses, and the
names must be numeric specifications rather than symbolic names.
qualifier is intended to manually add subnet routes with netmasks different
from that of the implied network interface (as would otherwise be
communicated using a routing protocol). One specifies an additional ensuing
address parameter (to be interpreted as a network mask). The implicit
network mask generated in the
AF_INET case can be
overridden by making sure this option follows the
is also available for a similar purpose, for IPv6/v4.
A specific routing priority can be specified with
qualifier. If no priority is specified, the kernel will set a priority
depending on the
RTF_STATIC flag to either
Note that priority 1 is reserved for kernel use.
modifier needs to be specified with the
to be able to enter multiple gateways for the same destination address
(multipath). When multiple routes exist for a destination, one route is
selected based on the source address of the packet. The
variables net.inet.ip.multipath and
net.inet6.ip6.multipath are used to control multipath
routing. If set to 1, multiple routes with the same priority are used
equally; if set to 0, the first route selected will be used for subsequent
packets to that destination regardless of source.
When inserting MPLS routes, particular modifiers
must be used. The
modifier needs to be specified in an ingress LSR to associate a particular
label to an IPv4/IPv6 route. The MPLS traffic
-out modifiers are intended to identify the
ingress label and, optionally, the outgoing one. Additionally, one of the
following operations must be used:
nexthop can be specified with the modifier
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 indicating the following corresponding modifiers:
||silently discard pkts (during updates)|
||generates a new route on use|
||destination is directly reachable|
||validly translates proto addr to link addr|
||multiple gateways for a destination exist|
||pretend route added by kernel or daemon|
||set protocol specific routing flag #1|
||set protocol specific routing flag #2|
||emit an ICMP unreachable when matched|
||manually added route|
The optional modifiers
-mtu provide initial values to quantities maintained
in the routing entry by transport level protocols, such as TCP (see
have the following meanings:
- Lifetime for route (e.g., if generated by a redirect).
- Maximum transmission unit (MTU) size for this path.
These may be individually locked by preceding each such
modifier to be locked by the
meta-modifier, or one can specify that all ensuing metrics may be locked by
add command where the destination and gateway are
not sufficient to specify the route, the
modifiers may be used to determine the interface name or interface
modifier specifies on route addition or modification that the route should
have the given label associated with it. Route labels can
be used to attach arbitrary information to a route.
All symbolic names specified for a destination or gateway are looked up using gethostbyname(3).
route uses a routing socket (see
and the message types
RTM_CHANGE. As such, only the superuser may modify
the routing tables.
- host and network name database
- default gateway address
Add a static inet(4) route to the 192.168.5.0/24 network via the 192.168.0.1 gateway:
# route add -inet 192.168.5.0/24 192.168.0.1
Amend the inet(4) route to the 192.168.5.0/24 network to use the 192.168.0.2 gateway:
# route change -inet 192.168.5.0/24 192.168.0.2
Delete the inet(4) route to the 192.168.5.0/24 network:
# route delete -inet 192.168.5.0/24
Add a static inet6(4) route to a host which is on the vio0 interface that is outside your prefix, and use that host as a default gateway, as used by some hosting providers:
# route add -inet6 2001:db8:efef::1 -cloning -link -iface vio0
# route add -inet6 default 2001:db8:efef::1
- %s: gateway %s flags %x
- The specified route is being added to or deleted from the tables. 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.
- %s %s done
- When the
flushcommand 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
deleteoperation was attempted for an entry which wasn't present in the tables.
- routing table overflow
addoperation was attempted, but the system was low on resources and was unable to allocate memory to create the new entry.
id(1), netstat(1), gethostbyname(3), netintro(4), route(4), rtable(4), tcp(4), hosts(5), mygate(5), resolv.conf(5), bgpd(8), ospfd(8), resolvd(8), ripd(8), sysctl(8)
route command appeared in
4.2BSD. IPv6 support was added by WIDE/KAME
-rttvar modifiers used to be used to initialize
various quantities in routing table entries. The routing system no longer
uses these values and the modifiers exist now only for compatibility with
other operating systems.
Some uses of the
-ifp modifiers with the
command will incorrectly fail with a “Network is unreachable”
message if there is no default route. See case
from sys/net/rtsock.c for details.