System Administration Commands routeadm(1M)
NAME
routeadm - IP forwarding and routing configuration
SYNOPSIS
routeadm [-p [option]]
routeadm [-R root-dir] [-e option ...] [-d option...]
[-r option...] [-s var=value]
routeadm [-l fmri]
routeadm [-m fmri key=value [key=value]...]
routeadm [-u]
DESCRIPTION
The routeadm command is used to administer system-wide con-
figuration for IP forwarding and routing. IP forwarding is the passing of IP packets from one network to another; IP routing is the use of a routing protocol to determine routes. IP forwarding and routing functions are also represented as services within the service management facility (SMF), and can be administered by means of svcadm(1M) also, using the following fault management resource identifiers (FMRIs):svc:/network/ipv4-forwarding:default
svc:/network/ipv6-forwarding:default
svc:/network/routing/route:default svc:/network/routing/ripng:defaultSee EXAMPLES for relevant examples.
Note -
It is strongly encouraged to use ipadm(1M) to enable ordisable forwarding. Use of routeadm and the SMF service to
administer IP forwarding, for both IPv4 and IPv6, will be made obsolete in a future release, replaced by ipadm. See ipadm(1M) for further information.SunOS 5.11 Last change: 2 Mar 2010 1
System Administration Commands routeadm(1M)
In addition to enabling and disabling routing and forward-
ing, routeadm is used to interact with SMF-based routing
daemon services. Routing daemon services are identified bythe presence of a routeadm application property group, which
routeadm uses in administering the given service. Routing
daemon services can also specify properties relating to their operation in the routing application property group;these can be modified by means of routeadm -m. If an FMRI
for a service without such a property group is specified, an error is issued and the operation is not carried out. If a routing daemon has not been converted to SMF, the ipv4[or6]-routing-daemon, ipv4[or 6]-routing-daemon-args, and
ipv4[or 6]-routing-stop-cmd variables can be used to specify
the appropriate daemon for IPv4 or IPv6 routing. routeadm
will then run that daemon using thesvc:/network/routing/legacy-routing:ipv4[or 6] service as
appropriate. This conversion process occurs when you issuean enable (-e), disable (-d) or an update (-u) command.
The first usage, in the SYNOPSIS above, reports the current
configuration. OPTIONSThe following command-line options are supported:
-p [option]
Print the configuration in parseable format. If option is specified, only the configuration for the specified option or variable is displayed.-R root-dir
Specify an alternate root directory where routeadm
applies changes. This can be useful from withinJumpStart scripts, where the root directory of the sys-
tem being modified is mounted elsewhere.Note -
The root file system of any non-global zones must not
be referenced with the -R option. Doing so might dam-
age the global zone's file system, might compromise the security of the global zone, and might damage thenon-global zone's file system. See zones(5).
-e option...
Enable the specified option. The effect is to prepareSunOS 5.11 Last change: 2 Mar 2010 2
System Administration Commands routeadm(1M)
the associated services (svc:/network/ipv4-
forwarding:default in the case of ipv4-forwarding) for
enabling. By means of the routing-svcs variable, the
routing daemons are specified to be enabled on subse-
quent boot or when routeadm -u is run.
-d option...
Disable the specified option. The effect is to preparethe associated services (svc:/network/ipv4-
forwarding:default in the case of ipv4-forwarding) for
enabling. By means of the routing-svcs variable, the
routing daemons are specified to be disabled on subse-
quent boot or when routeadm -u is run.
-l fmri
List all properties in the routing application property group for the SMF routing daemon service.-m fmri key=value
Change property value of property key to value in rout-
ing application property group for the SMF routing dae-
mon service. For multi-valued properties, the property
name can be used multiple times in the modify operation, and each associated value will be added.-r option...
Revert the specified option to the system default. The system defaults are specified in the description of each option.-u
Apply the currently configured options to the runningsystem. These options might include enabling or disa-
bling IP forwarding and launching or killing routing daemons, if any are specified. It does not alter the state of the system for those settings that have been set to default. This option is meant to be used by administrators who do not want to reboot to apply theirchanges. In addition, this option upgrades non-SMF con-
figurations from the invocations of daemon stop com-
mands, which might include a set of arguments, to a sim-
ple enabling of the appropriate service.SunOS 5.11 Last change: 2 Mar 2010 3
System Administration Commands routeadm(1M)
-s key=value
Specify string values for specific variables in acomma-separated list with no intervening spaces. If
invalid options are specified, a warning message is displayed and the program exits. The following variables can be specified:routing-svcs=fmrilist
Specifies the routing daemon services to be enabled. Routing daemon services are determined to be IPv4 orIPv6 (and so enabled or disabled when routeadm -e/-d
ipv4(6)-routing is run) on the basis of property
values in the routeadm application property group.
Default: route:default ripng:defaultipv4-routing-daemon=
Specifies the routing daemon to be started whenipv4-routing is enabled. The routing daemon speci-
fied must be an executable binary or shell-script.
If the specified program maps to an SMF service, the service will be used, and daemon arguments to the program will be transferred to the properties of the service at enable time. Default: ""ipv4-routing-daemon-args=
Specifies the startup arguments to be passed to theipv4-routing-daemon when ipv4-routing is enabled.
Default: no argumentsipv4-routing-stop-cmd=
Specifies the command to be executed to stop therouting daemon when ipv4-routing is disabled.
mand> can be an executable binary or shell-script,
or a string that can be parsed by system(3C). Default: ""ipv6-routing-daemon=
Specifies the routing daemon to be started whenipv6-routing is enabled. The routing daemon speci-
fied must be an executable binary or shell-script.
If the specified program maps to an SMF service, the service will be used, and daemon arguments to theSunOS 5.11 Last change: 2 Mar 2010 4
System Administration Commands routeadm(1M)
program will be transferred to the properties of the service at enable time. Default: ""ipv6-routing-daemon-args=
Specifies the startup arguments to be passed to theipv6-routing-daemon when ipv6-routing is enabled.
Default: ""ipv6-routing-stop-cmd=
Specifies the command to be executed to stop therouting daemon when ipv6-routing is disabled.
mand> can be an executable binary or shell-script,
or a string that can be parsed by system(3C). Default: ""Multiple -e, -d, and -r options can be specified on the com-
mand line. Changes made by -e, -d, and -r are persistent,
but are not applied to the running system unless routeadm is
called later with the -u option.
Use the following options as arguments to the -e, -d, and -r
options (shown above as option...).ipv4-forwarding
Controls the global forwarding configuration for all IPv4 interfaces. The system default is disabled. Ifenabled, IP will forward IPv4 packets to and from inter-
faces when appropriate. If disabled, IP will not forward IPv4 packets to and from interfaces when appropriate.The SMF service associated with this configuration vari-
able is svc:/network/routing/ipv4-forwarding. This ser-
vice will be enabled or disabled as appropriate whenrouteadm is called with the u option. As an alternative,
you can use svcadm(1M). Services that require ipv4-
forwarding to be enabled should specify a dependency on this service.ipv4-routing
Determines whether an IPv4 routing daemon is run. The system default is enabled unless the /etc/defaultrouter file exists (see defaultrouter(4)), in which case theSunOS 5.11 Last change: 2 Mar 2010 5
System Administration Commands routeadm(1M)
default is disabled. The value of this option reflects the state of all IPv4 routing services, such that if anyIPv4 routing service is enabled, ipv4-routing is
enabled. This allows users to interact with routing ser-
vices using svcadm(1M), as well as through routeadm.
IPv4 routing services, specified by means of therouting-svcs variable, will be prepared for enable on
next boot when the user explicitly enables ipv4-routing.
The SMF routing daemon service for in.routed (svc:/network/routing/route:default) is specified by default.ipv6-forwarding
Controls the global forwarding configuration for all IPv6 interfaces. The system default is disabled. Ifenabled, IP will forward IPv6 packets to and from inter-
faces when appropriate. If disabled, IP will not forward IPv6 packets to and from interfaces when appropriate.The SMF service associated with this configuration vari-
able is svc:/network/routing/ipv6-forwarding. This ser-
vice will be enabled or disabled as appropriate whenrouteadm is called with the -u option, or svcadm(1M) is
used. Services that require ipv6-forwarding to be
enabled should specify a dependency on this service.ipv6-routing
Determines whether an IPv6 routing daemon is run. The system default is disabled. The value of this option reflects the state of all IPv6 routing services, suchthat, if any IPv6 routing service is enabled, ipv6-
routing is enabled. This allows users to interact with routing services via svcadm(1M) as well as throughrouteadm. IPv6 routing services, specified by means of
the routing-svcs variable, will be prepared for enable
on next boot when the user explicitly enables ipv6-
routing. The SMF routing daemon service for in.ripngd (svc:/network/routing/ripng:default) is specified by default. The forwarding and routing settings are related but not mutually dependent. For example, a router typically forwards IP packets and uses a routing protocol, but nothing wouldprevent an administrator from configuring a router that for-
wards packets and does not use a routing protocol. In that case, the administrator would enable forwarding, disable routing, and populate the router's routing table with staticSunOS 5.11 Last change: 2 Mar 2010 6
System Administration Commands routeadm(1M)
routes. The forwarding settings are global settings. Each interfacealso has an IFF_ROUTER forwarding flag that determines
whether packets can be forwarded to or from a particular interface. That flag can be independently controlled bymeans of ifconfig(1M)'s router option. When the global for-
warding setting is changed (that is, -u is issued to change
the value from enabled to disabled or vice-versa), all
interface flags in the system are changed simultaneously to reflect the new global policy. Interfaces configured bymeans of DHCP automatically have their interface-specific
IFF_ROUTER flag cleared.
When a new interface is plumbed by means of ifconfig, thevalue of the interface-specific forwarding flag is set
according to the current global forwarding value. Thus, the forwarding value forms the "default" for all new interfaces.EXAMPLES
Example 1 Enabling IPv4 ForwardingIPv4 forwarding is disabled by default. The following com-
mand enables IPv4 forwarding:example# routeadm -e ipv4-forwarding
Example 2 Apply Configured Settings to the Running System In the previous example, a system setting was changed, but will not take effect until the next reboot unless a command such as the following is used:example# routeadm -u
An alternative to the above two steps is to simply enable the equivalent SMF service:example# svcadm enable svc:/network/ipv4-forwarding
SunOS 5.11 Last change: 2 Mar 2010 7
System Administration Commands routeadm(1M)
...or, using the abbreviated FMRI:example# svcadm enable ipv4-forwarding
Example 3 Making a Setting Revert to its Default To make the setting changed in the first example revert to its default, enter the following:example# routeadm -r ipv4-forwarding
example# routeadm -u
Example 4 Starting in.routed with the -q Flag
Setting the -q flag is represented in the SMF service by
setting the quiet_mode property to true. The following
sequence of commands starts in.routed with the -q flag:
example# routeadm -m route:default quiet_mode=true
example# routeadm -e ipv4-routing -u
See in.routed(1M) for details of property names and how they relate to daemon behavior. EXIT STATUS The following exit values are returned: 0 Successful completion. !=0 An error occurred while obtaining or modifying the system configuration. FILES /etc/inet/routing.conf Parameters for IP forwarding and routing. (Not to be edited.)SunOS 5.11 Last change: 2 Mar 2010 8
System Administration Commands routeadm(1M)
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:____________________________________________________________
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
|_____________________________|_____________________________|
| Availability | SUNWcs ||_____________________________|_____________________________|
| Interface Stability | Committed ||_____________________________|_____________________________|
SEE ALSO
ifconfig(1M), in.routed(1M), ipadm(1M), svcadm(1M), gate-
ways(4), attributes(5), smf(5)SunOS 5.11 Last change: 2 Mar 2010 9