admroute(1M) DG/UX 5.4R3.00 admroute(1M)
NAME
admroute - manage routing
SYNOPSIS
admroute -o add [ -k ] [ -t net | host ] [ -m metric ] [ -R rtt ] [
-V rttvar ] [ -M mtu ] [ -S cwthresh ] [ -N netmask ] [ -s
sendpipe ] [ -r recvpipe ] -g gateway destination
admroute -o modify [ -k ] [ -t net | host ] [ -d new-destination ] [
-G new-gateway ] [ -m metric ] [ -R rtt ] [ -V rttvar ] [
-M mtu ] [ -S cwthresh ] [ -N netmask ] [ -s sendpipe ] [
-r recvpipe ] -g gateway destination
admroute -o delete [ -k ] [ -t net | host ] -g gateway destination
admroute -o list [ -Ckqv ] [ all | destination ... ]
admroute -o search [ -k ] -g gateway destination
admroute -o start { static | gated }
admroute -o stop { static | gated }
admroute -o configure [ -i ] [ -I ] -c new-config-file routing-daemon
DESCRIPTION
admroute manages both the static and dynamic routing operations.
Static management involves managing the current and permanent routing
databases. The current routes are the routes in the network routing
table that are used by the kernel to make routing decisions. The
permanent routes are routes that are stored in /etc/tcpip.params and
installed as current routes when the network is started. When the
network is started, admroute manages the permanent routes, and
optionally the current routes. When the network is stopped, admroute
manages only the permanent routes.
Each static route consists of: type, destination, gateway, metric,
rtt, rttvar, mtu, cwthresh, netmask, sendpipe, and recvpipe.
Dynamic management involves starting, stopping, and configuring the
dynamic route management daemon (e.g. gated). With dynamic routing,
current routes are managed automatically by the route management
daemon. Permanent routes are specified in the routing-daemon
configuration file and are installed as current routes upon daemon
initialization.
Operations
add Add a new route to the permanent and/or current routing
database.
modify Change a route from the permanent and/or current routing
database. The destination type, destination, gateway,
Licensed material--property of copyright holder(s) 1
admroute(1M) DG/UX 5.4R3.00 admroute(1M)
metric, rtt, rttvar, mtu, cwthresh, netmask, sendpipe, and
recvpipe may all be changed.
delete Remove a route from the permanent and/or current routing
database.
list List one or more routes in the permanent or current routing
database. Information is listed about all routes to the
destinations; if no destinations are given or if
destination is all, information about all routes is listed.
If the Report the dynamic and static configuration of your
system. The dynamic configuration reports whether or not a
routing application (e.g. gated) is running which
dynamically manages your routes; the static configuration
lists the routes which are permanent on your system and so
are not managed by any routing application.
search Search for the destination/gateway combination in the
permanent or current routing database. If the route is
found, it is echoed to stdout with a single space delimiter
between each field. Otherwise, exit with an error code.
start Start static or dynamic routes. Starting static routes
means permanent routes which are stored in
/etc/tcpip.params are added to the kernel routing table;
starting dynamic routes means the routing daemon, gated, is
started to manage all routes.
stop Stop static or dynamic routes. Stop static routes means
permanent routes which are stored in /etc/tcpip.params are
removed from the kernel routing table; stopping dynamic
routes means the routing daemon, gated, is stopped.
configure Validate a configuration file for use with routing-daemon.
If no syntax errors exist, the new configuration file may
be installed for use by the routing daemon. Additionally,
the daemon may be signalled to immediately reinitialize
from the new configuration file.
Options
-C For the list operation, this option displays the current
routing configuration of the system.
-k Perform the requested operation on the current routes (i.e.
the routing table in the kernel). For the add, modify, and
delete operations, this option means the operation is
performed on current routes in addition to permanent
routes; for the list and search operations, this option
means the operation is performed on current routes instead
of permanent routes.
-t net | host
net | host is the type of destination for the route. When
the network is subnetted, this parameter is required to
Licensed material--property of copyright holder(s) 2
admroute(1M) DG/UX 5.4R3.00 admroute(1M)
distinguish a network address from a host address. If the
address is not on a subnetted network, then it can be
determined from the address whether it represents a host or
a network, and the parameter is not required.
-g gateway
gateway is the symbolic name or Internet address to route
packets through in order to reach the destination. If a
symbolic name is specified, then an entry will be added to
local hosts(4) database.
-m metric metric is the number of network hops to reach the gateway.
Currently, the only valid values are 0 and 1. A value of 0
indicates that the route goes through a local interface to
the directly-connected network. A value of 1 indicates
that the route goes through a gateway. The default is 1.
-R rtt rtt is the round trip time in microseconds that TCP should
use to initialize a new connection.
-V rttvar rttvar is the round trip variance in microseconds that TCP
should use to initialize a new connection.
-M mtu mtu is the Media Transfer Unit in bytes that TCP should use
for calculating the Maximum Segment Size for new
connections that use this route.
-S cwthresh
cwthresh is Congestion Window Threshold that TCP should use
initially for new connections. This value controls how
fast TCP will open the Send Congestion Window.
-N netmask
netmask is the mask that should be applied to the route
destination when doing a route lookup. This allows non-
local subnet routing.
-s sendpipe
sendpipe is the initial size for the TCP send buffer for
connections that use this route.
-r recvpipe
recvpipe is the initial size for the TCP receive buffer for
connections that use this route.
-d new-destination
new-destination is the symbolic name or Internet address
that will replace destination in the modify command. If a
symbolic name is specified, then an entry will be added to
the local hosts or networks(4) database.
-G new-gateway
new-gateway is the new name or Internet address that
replaces gateway. If a symbolic name is specified, then an
Licensed material--property of copyright holder(s) 3
admroute(1M) DG/UX 5.4R3.00 admroute(1M)
entry will be added to the local hosts database. Without
this option the gateway is not changed.
-q "Quiet." Produce an unformatted listing (i.e. no headers,
fields delimited by a single space).
-v "Verbose." Produce a formatted listing with headers and
aligned columns. This option is enabled by default.
-i "Install." If new-config-file contains no syntax errors,
this option will overwrite the standard routing-daemon
configuration file with new-config-file.
-I "Initialize." If new-config-file contains no syntax
errors, this option will signal routing-daemon and force it
to reinitialize from new-config-file.
admroute expects all Internet addresses to be of the form
a.b.c.d,
where a is a decimal number between 0 and 224, and b, c, and d are
decimal numbers between 0 and 255.
FILES
/etc/tcpip.params
TCP/IP parameters file contains the permanent routes
database.
/etc/gated.conf
Configuration file for the gated dynamic route management
daemon.
OUTPUT
The list and search operations write their output to stdout.
The verbose form of the list operation outputs information in aligned
columns with column headers.
If -q option is specified with the list operation, headers are
suppressed and each entry is printed on a separate line. The fields
within the entry are delimited by a single space, and are in the
following order:
type destination gateway metric
This format is also used by the search operation.
DIAGNOSTICS
Warnings
- The delete operation is requested, and destination/gateway does
not exist.
Errors
- The add operation is requested, and the destination/gateway
Licensed material--property of copyright holder(s) 4
admroute(1M) DG/UX 5.4R3.00 admroute(1M)
already exists.
- The modify operation is requested, and the new-destination/new-
gateway already exists.
- The modify or search operation is requested, and
destination/gateway does not exist.
- The destination, new-destination, gateway, or new-gateway
parameter is specified as an invalid Internet address.
- The destination, new-destination, gateway, or new-gateway is
specified as a symbolic name that cannot be resolved to a
Internet address by the hosts or networks database.
Exit Codes
0 The operation was successful.
1 The operation was unsuccessful.
2 The operation failed due to access restrictions.
3 There was an error in the command line.
4 A symbolic name could not be resolved, or an Invalid Internet
address was entered.
SEE ALSO
netstat(1M), route(1M), hosts(4), networks(4), tcpip.params(4M),
gated(1M), gated-config(4M).
NOTES
Only the system administrator may modify the routing daemons and
databases.
Licensed material--property of copyright holder(s) 5