1 ROUTEADM(1M) Maintenance Commands ROUTEADM(1M)
2
3
4
5 NAME
6 routeadm - IP forwarding and routing configuration
7
8 SYNOPSIS
9 routeadm [-p [option]]
10
11
12 routeadm [-R root-dir] [-e option ...] [-d option...]
13 [-r option...] [-s var=value]
14
15
16 routeadm [-l fmri]
17
18
19 routeadm [-m fmri key=value [key=value]...]
20
21
22 routeadm [-u]
23
24
25 DESCRIPTION
26 The routeadm command is used to administer system-wide configuration
27 for IP forwarding and routing. IP forwarding is the passing of IP
28 packets from one network to another; IP routing is the use of a routing
29 protocol to determine routes.
30
31
32 IP forwarding and routing functions are also represented as services
33 within the service management facility (SMF), and can be administered
34 by means of svcadm(1M) also, using the following fault management
35 resource identifiers (FMRIs):
36
37 svc:/network/ipv4-forwarding:default
38 svc:/network/ipv6-forwarding:default
39 svc:/network/routing/route:default
40 svc:/network/routing/ripng:default
41
42
43
44 See EXAMPLES for relevant examples.
45
46
47 In addition to enabling and disabling routing and forwarding, routeadm
48 is used to interact with SMF-based routing daemon services. Routing
49 daemon services are identified by the presence of a routeadm
50 application property group, which routeadm uses in administering the
51 given service. Routing daemon services can also specify properties
52 relating to their operation in the routing application property group;
53 these can be modified by means of routeadm -m. If an FMRI for a service
54 without such a property group is specified, an error is issued and the
55 operation is not carried out. If a routing daemon has not been
56 converted to SMF, the ipv4[or 6]-routing-daemon, ipv4[or 6]-routing-
57 daemon-args, and ipv4[or 6]-routing-stop-cmd variables can be used to
58 specify the appropriate daemon for IPv4 or IPv6 routing. routeadm will
59 then run that daemon using the svc:/network/routing/legacy-
60 routing:ipv4[or 6] service as appropriate. This conversion process
61 occurs when you issue an enable (-e), disable (-d) or an update (-u)
62 command.
63
64
65 The first usage, in the SYNOPSIS above, reports the current
66 configuration.
67
68 OPTIONS
69 The following command-line options are supported:
70
71 -p [option]
72
73 Print the configuration in parsable format. If option is specified,
74 only the configuration for the specified option or variable is
75 displayed.
76
77
78 -R root-dir
79
80 Specify an alternate root directory where routeadm applies changes.
81
82 Note -
83
84 The root file system of any non-global zones must not be
85 referenced with the -R option. Doing so might damage the global
86 zone's file system, might compromise the security of the global
87 zone, and might damage the non-global zone's file system. See
88 zones(5).
89
90
91 -e option...
92
93 Enable the specified option. The effect is to prepare the
94 associated services (svc:/network/ipv4-forwarding:default in the
95 case of ipv4-forwarding) for enabling. By means of the routing-svcs
96 variable, the routing daemons are specified to be enabled on
97 subsequent boot or when routeadm -u is run.
98
99
100 -d option...
101
102 Disable the specified option. The effect is to prepare the
103 associated services (svc:/network/ipv4-forwarding:default in the
104 case of ipv4-forwarding) for enabling. By means of the routing-svcs
105 variable, the routing daemons are specified to be disabled on
106 subsequent boot or when routeadm -u is run.
107
108
109 -l fmri
110
111 List all properties in the routing application property group for
112 the SMF routing daemon service.
113
114
115 -m fmri key=value
116
117 Change property value of property key to value in routing
118 application property group for the SMF routing daemon service. For
119 multi-valued properties, the property name can be used multiple
120 times in the modify operation, and each associated value will be
121 added.
122
123
124 -r option...
125
126 Revert the specified option to the system default. The system
127 defaults are specified in the description of each option.
128
129
130 -u
131
132 Apply the currently configured options to the running system. These
133 options might include enabling or disabling IP forwarding and
134 launching or killing routing daemons, if any are specified. It does
135 not alter the state of the system for those settings that have been
136 set to default. This option is meant to be used by administrators
137 who do not want to reboot to apply their changes. In addition,
138 this option upgrades non-SMF configurations from the invocations of
139 daemon stop commands, which might include a set of arguments, to a
140 simple enabling of the appropriate service.
141
142
143 -s key=value
144
145 Specify string values for specific variables in a comma-separated
146 list with no intervening spaces. If invalid options are specified,
147 a warning message is displayed and the program exits. The following
148 variables can be specified:
149
150 routing-svcs=fmrilist
151
152 Specifies the routing daemon services to be enabled. Routing
153 daemon services are determined to be IPv4 or IPv6 (and so
154 enabled or disabled when routeadm -e/-d ipv4(6)-routing is run)
155 on the basis of property values in the routeadm application
156 property group. Default: route:default ripng:default
157
158
159 ipv4-routing-daemon=<full_path_to_routing_daemon>
160
161 Specifies the routing daemon to be started when ipv4-routing is
162 enabled. The routing daemon specified must be an executable
163 binary or shell-script. If the specified program maps to an SMF
164 service, the service will be used, and daemon arguments to the
165 program will be transferred to the properties of the service at
166 enable time. Default: ""
167
168
169 ipv4-routing-daemon-args=<args>
170
171 Specifies the startup arguments to be passed to the
172 ipv4-routing-daemon when ipv4-routing is enabled. Default: no
173 arguments
174
175
176 ipv4-routing-stop-cmd=<command>
177
178 Specifies the command to be executed to stop the routing daemon
179 when ipv4-routing is disabled. <command> can be an executable
180 binary or shell-script, or a string that can be parsed by
181 system(3C). Default: ""
182
183
184 ipv6-routing-daemon=<full_path_to_routing_daemon>
185
186 Specifies the routing daemon to be started when ipv6-routing is
187 enabled. The routing daemon specified must be an executable
188 binary or shell-script. If the specified program maps to an SMF
189 service, the service will be used, and daemon arguments to the
190 program will be transferred to the properties of the service at
191 enable time. Default: ""
192
193
194 ipv6-routing-daemon-args=<args>
195
196 Specifies the startup arguments to be passed to the
197 ipv6-routing-daemon when ipv6-routing is enabled. Default: ""
198
199
200 ipv6-routing-stop-cmd=<command>
201
202 Specifies the command to be executed to stop the routing daemon
203 when ipv6-routing is disabled. <command> can be an executable
204 binary or shell-script, or a string that can be parsed by
205 system(3C). Default: ""
206
207
208
209
210 Multiple -e, -d, and -r options can be specified on the command line.
211 Changes made by -e, -d, and -r are persistent, but are not applied to
212 the running system unless routeadm is called later with the -u option.
213
214
215 Use the following options as arguments to the -e, -d, and -r options
216 (shown above as option...).
217
218 ipv4-forwarding
219
220 Controls the global forwarding configuration for all IPv4
221 interfaces. The system default is disabled. If enabled, IP will
222 forward IPv4 packets to and from interfaces when appropriate. If
223 disabled, IP will not forward IPv4 packets to and from interfaces
224 when appropriate. The SMF service associated with this
225 configuration variable is svc:/network/routing/ipv4-forwarding.
226 This service will be enabled or disabled as appropriate when
227 routeadm is called with the u option. As an alternative, you can
228 use svcadm(1M). Services that require ipv4-forwarding to be enabled
229 should specify a dependency on this service.
230
231
232 ipv4-routing
233
234 Determines whether an IPv4 routing daemon is run. The system
235 default is enabled unless the /etc/defaultrouter file exists (see
236 defaultrouter(4)), in which case the default is disabled. The value
237 of this option reflects the state of all IPv4 routing services,
238 such that if any IPv4 routing service is enabled, ipv4-routing is
239 enabled. This allows users to interact with routing services using
240 svcadm(1M), as well as through routeadm. IPv4 routing services,
241 specified by means of the routing-svcs variable, will be prepared
242 for enable on next boot when the user explicitly enables
243 ipv4-routing. The SMF routing daemon service for in.routed
244 (svc:/network/routing/route:default) is specified by default.
245
246
247 ipv6-forwarding
248
249 Controls the global forwarding configuration for all IPv6
250 interfaces. The system default is disabled. If enabled, IP will
251 forward IPv6 packets to and from interfaces when appropriate. If
252 disabled, IP will not forward IPv6 packets to and from interfaces
253 when appropriate. The SMF service associated with this
254 configuration variable is svc:/network/routing/ipv6-forwarding.
255 This service will be enabled or disabled as appropriate when
256 routeadm is called with the -u option, or svcadm(1M) is used.
257 Services that require ipv6-forwarding to be enabled should specify
258 a dependency on this service.
259
260
261 ipv6-routing
262
263 Determines whether an IPv6 routing daemon is run. The system
264 default is disabled. The value of this option reflects the state of
265 all IPv6 routing services, such that, if any IPv6 routing service
266 is enabled, ipv6-routing is enabled. This allows users to interact
267 with routing services via svcadm(1M) as well as through routeadm.
268 IPv6 routing services, specified by means of the routing-svcs
269 variable, will be prepared for enable on next boot when the user
270 explicitly enables ipv6-routing. The SMF routing daemon service for
271 in.ripngd (svc:/network/routing/ripng:default) is specified by
272 default.
273
274
275
276 The forwarding and routing settings are related but not mutually
277 dependent. For example, a router typically forwards IP packets and uses
278 a routing protocol, but nothing would prevent an administrator from
279 configuring a router that forwards packets and does not use a routing
280 protocol. In that case, the administrator would enable forwarding,
281 disable routing, and populate the router's routing table with static
282 routes.
283
284
285 The forwarding settings are global settings. Each interface also has an
286 IFF_ROUTER forwarding flag that determines whether packets can be
287 forwarded to or from a particular interface. That flag can be
288 independently controlled by means of ifconfig(1M)'s router option. When
289 the global forwarding setting is changed (that is, -u is issued to
290 change the value from enabled to disabled or vice-versa), all interface
291 flags in the system are changed simultaneously to reflect the new
292 global policy. Interfaces configured by means of DHCP automatically
293 have their interface-specific IFF_ROUTER flag cleared.
294
295
296 When a new interface is plumbed by means of ifconfig, the value of the
297 interface-specific forwarding flag is set according to the current
298 global forwarding value. Thus, the forwarding value forms the "default"
299 for all new interfaces.
300
301 EXAMPLES
302 Example 1 Enabling IPv4 Forwarding
303
304
305 IPv4 forwarding is disabled by default. The following command enables
306 IPv4 forwarding:
307
308
309 example# routeadm -e ipv4-forwarding
310
311
312
313 Example 2 Apply Configured Settings to the Running System
314
315
316 In the previous example, a system setting was changed, but will not
317 take effect until the next reboot unless a command such as the
318 following is used:
319
320
321 example# routeadm -u
322
323
324
325
326 An alternative to the above two steps is to simply enable the
327 equivalent SMF service:
328
329
330 example# svcadm enable svc:/network/ipv4-forwarding
331
332
333
334
335 ...or, using the abbreviated FMRI:
336
337
338 example# svcadm enable ipv4-forwarding
339
340
341
342 Example 3 Making a Setting Revert to its Default
343
344
345 To make the setting changed in the first example revert to its default,
346 enter the following:
347
348
349 example# routeadm -r ipv4-forwarding
350 example# routeadm -u
351
352
353
354 Example 4 Starting in.routed with the -q Flag
355
356
357 Setting the -q flag is represented in the SMF service by setting the
358 quiet_mode property to true. The following sequence of commands starts
359 in.routed with the -q flag:
360
361
362 example# routeadm -m route:default quiet_mode=true
363 example# routeadm -e ipv4-routing -u
364
365
366
367
368 See in.routed(1M) for details of property names and how they relate to
369 daemon behavior.
370
371
372 EXIT STATUS
373 The following exit values are returned:
374
375 0
376 Successful completion.
377
378
379 !=0
380 An error occurred while obtaining or modifying the system
381 configuration.
382
383
384 FILES
385 /etc/inet/routing.conf
386 Parameters for IP forwarding and routing.
387 (Not to be edited.)
388
389
390 ATTRIBUTES
391 See attributes(5) for descriptions of the following attributes:
392
393
394
395
396 +--------------------+-----------------+
397 | ATTRIBUTE TYPE | ATTRIBUTE VALUE |
398 +--------------------+-----------------+
399 |Interface Stability | Stable |
400 +--------------------+-----------------+
401
402 SEE ALSO
403 ifconfig(1M), in.routed(1M), svcadm(1M), gateways(4), attributes(5),
404 smf(5)
405
406
407
408 May 13, 2017 ROUTEADM(1M)
|
1 ROUTEADM(1M) Maintenance Commands ROUTEADM(1M)
2
3 NAME
4 routeadm - IP forwarding and routing configuration
5
6 SYNOPSIS
7 routeadm [-p [option]]
8 routeadm [-R root-dir] [-e option ...] [-d option ...] [-r option ...]
9 [-s var=value]
10 routeadm -l fmri
11 routeadm -m fmri key=value [key=value]...
12 routeadm -u
13
14 DESCRIPTION
15 The routeadm command is used to administer system-wide configuration for
16 IP forwarding and routing. IP forwarding is the passing of IP packets
17 from one network to another; IP routing is the use of a routing protocol
18 to determine routes.
19
20 IP forwarding and routing functions are also represented as services
21 within the service management facility (SMF), and can be administered by
22 means of svcadm(1M) also, using the following fault management resource
23 identifiers (FMRIs):
24
25 svc:/network/ipv4-forwarding:default
26 svc:/network/ipv6-forwarding:default
27 svc:/network/routing/route:default
28 svc:/network/routing/ripng:default
29
30 See EXAMPLES for relevant examples.
31
32 In addition to enabling and disabling routing and forwarding, routeadm is
33 used to interact with SMF-based routing daemon services. Routing daemon
34 services are identified by the presence of a routeadm application
35 property group, which routeadm uses in administering the given service.
36 Routing daemon services can also specify properties relating to their
37 operation in the routing application property group; these can be
38 modified by means of routeadm -m. If an FMRI for a service without such
39 a property group is specified, an error is issued and the operation is
40 not carried out. If a routing daemon has not been converted to SMF, the
41 ipv4-routing-daemon, ipv6-routing-daemon, ipv4-routing-daemon-args,
42 ipv6-routing-daemon-args, and ipv4-routing-stop-cmd,
43 ipv6-routing-stop-cmd variables can be used to specify the appropriate
44 daemon for IPv4 or IPv6 routing. routeadm will then run that daemon
45 using the svc:/network/routing/legacy-routing:ipv4 or
46 svc:/network/routing/legacy-routing:ipv6 service as appropriate. This
47 conversion process occurs when you issue an enable (-e), disable (-d) or
48 an update (-u) command.
49
50 The first usage, in the SYNOPSIS above, reports the current
51 configuration.
52
53 OPTIONS
54 The following command-line options are supported:
55
56 -d option ...
57 Disable the specified option. The effect is to prepare the
58 associated services (svc:/network/ipv4-forwarding:default in the
59 case of ipv4-forwarding) for disabling. By means of the
60 routing-svcs variable, the routing daemons are specified to be
61 disabled on subsequent boot or when routeadm -u is run.
62
63 -e option ...
64 Enable the specified option. The effect is to prepare the
65 associated services (svc:/network/ipv4-forwarding:default in the
66 case of ipv4-forwarding) for enabling. By means of the
67 routing-svcs variable, the routing daemons are specified to be
68 enabled on subsequent boot or when routeadm -u is run.
69
70 -l fmri
71 List all properties in the routing application property group for
72 the SMF routing daemon service.
73
74 -m fmri key=value
75 Change property value of property key to value in routing
76 application property group for the SMF routing daemon service.
77 For multi-valued properties, the property name can be used
78 multiple times in the modify operation, and each associated value
79 will be added.
80
81 -p [option]
82 Print the configuration in parsable format. If option is
83 specified, only the configuration for the specified option or
84 variable is displayed.
85
86 -r option ...
87 Revert the specified option to the system default. The system
88 defaults are specified in the description of each option.
89
90 -R root-dir
91 Specify an alternate root directory where routeadm applies
92 changes.
93
94 Note: The root file system of any non-global zones must not be
95 referenced with the -R option. Doing so might damage the global
96 zone's file system, might compromise the security of the global
97 zone, and might damage the non-global zone's file system. See
98 zones(5).
99
100 -s key=value
101 Specify string values for specific variables in a comma-separated
102 list with no intervening spaces. If invalid options are
103 specified, a warning message is displayed and the program exits.
104 The following variables can be specified:
105
106 routing-svcs=fmrilist
107 Specifies the routing daemon services to be enabled.
108 Routing daemon services are determined to be IPv4 or IPv6
109 (and so enabled or disabled when routeadm -e/-d
110 ipv4(6)-routing is run) on the basis of property values
111 in the routeadm application property group. Default:
112 empty.
113
114 ipv4-routing-daemon=full_path_to_routing_daemon
115 Specifies the routing daemon to be started when
116 ipv4-routing is enabled. The routing daemon specified
117 must be an executable binary or shell-script. If the
118 specified program maps to an SMF service, the service
119 will be used, and daemon arguments to the program will be
120 transferred to the properties of the service at enable
121 time. Default: empty string.
122
123 ipv4-routing-daemon-args=args
124 Specifies the startup arguments to be passed to the
125 ipv4-routing-daemon when ipv4-routing is enabled.
126 Default: no arguments
127
128 ipv4-routing-stop-cmd=command
129 Specifies the command to be executed to stop the routing
130 daemon when ipv4-routing is disabled. command can be an
131 executable binary or shell-script, or a string that can
132 be parsed by system(3C). Default: empty string.
133
134 ipv6-routing-daemon=full_path_to_routing_daemon
135 Specifies the routing daemon to be started when
136 ipv6-routing is enabled. The routing daemon specified
137 must be an executable binary or shell-script. If the
138 specified program maps to an SMF service, the service
139 will be used, and daemon arguments to the program will be
140 transferred to the properties of the service at enable
141 time. Default: empty string.
142
143 ipv6-routing-daemon-args=args
144 Specifies the startup arguments to be passed to the
145 ipv6-routing-daemon when ipv6-routing is enabled.
146 Default: empty string.
147
148 ipv6-routing-stop-cmd=command
149 Specifies the command to be executed to stop the routing
150 daemon when ipv6-routing is disabled. command can be an
151 executable binary or shell-script, or a string that can
152 be parsed by system(3C). Default: empty string.
153
154 -u Apply the currently configured options to the running system.
155 These options might include enabling or disabling IP forwarding
156 and launching or killing routing daemons, if any are specified.
157 It does not alter the state of the system for those settings that
158 have been set to default. This option is meant to be used by
159 administrators who do not want to reboot to apply their changes.
160 In addition, this option upgrades non-SMF configurations from the
161 invocations of daemon stop commands, which might include a set of
162 arguments, to a simple enabling of the appropriate service.
163
164 Multiple -e, -d, and -r options can be specified on the command line.
165 Changes made by -e, -d, and -r are persistent, but are not applied to the
166 running system unless routeadm is called later with the -u option.
167
168 Use the following options as arguments to the -e, -d, and -r options
169 (shown above as option ...):
170
171 ipv4-forwarding
172 Controls the global forwarding configuration for all IPv4
173 interfaces. The system default is disabled. If enabled, IP will
174 forward IPv4 packets to and from interfaces when appropriate. If
175 disabled, IP will not forward IPv4 packets to and from interfaces
176 when appropriate. The SMF service associated with this
177 configuration variable is svc:/network/routing/ipv4-forwarding.
178 This service will be enabled or disabled as appropriate when
179 routeadm is called with the -u option. As an alternative, you
180 can use svcadm(1M). Services that require ipv4-forwarding to be
181 enabled should specify a dependency on this service.
182
183 ipv4-routing
184 Determines whether an IPv4 routing daemon is run. The system
185 default is disabled. The value of this option reflects the state
186 of all IPv4 routing services, such that if any IPv4 routing
187 service is enabled, ipv4-routing is enabled. This allows users
188 to interact with routing services using svcadm(1M), as well as
189 through routeadm. IPv4 routing services, specified by means of
190 the routing-svcs variable, will be prepared for enable on next
191 boot when the user explicitly enables ipv4-routing.
192
193 ipv6-forwarding
194 Controls the global forwarding configuration for all IPv6
195 interfaces. The system default is disabled. If enabled, IP will
196 forward IPv6 packets to and from interfaces when appropriate. If
197 disabled, IP will not forward IPv6 packets to and from interfaces
198 when appropriate. The SMF service associated with this
199 configuration variable is svc:/network/routing/ipv6-forwarding.
200 This service will be enabled or disabled as appropriate when
201 routeadm is called with the -u option, or svcadm(1M) is used.
202 Services that require ipv6-forwarding to be enabled should
203 specify a dependency on this service.
204
205 ipv6-routing
206 Determines whether an IPv6 routing daemon is run. The system
207 default is disabled. The value of this option reflects the state
208 of all IPv6 routing services, such that, if any IPv6 routing
209 service is enabled, ipv6-routing is enabled. This allows users
210 to interact with routing services via svcadm(1M) as well as
211 through routeadm. IPv6 routing services, specified by means of
212 the routing-svcs variable, will be prepared for enable on next
213 boot when the user explicitly enables ipv6-routing.
214
215 The forwarding and routing settings are related but not mutually
216 dependent. For example, a router typically forwards IP packets and uses
217 a routing protocol, but nothing would prevent an administrator from
218 configuring a router that forwards packets and does not use a routing
219 protocol. In that case, the administrator would enable forwarding,
220 disable routing, and populate the router's routing table with static
221 routes.
222
223 The forwarding settings are global settings. Each interface also has an
224 IFF_ROUTER forwarding flag that determines whether packets can be
225 forwarded to or from a particular interface. That flag can be
226 independently controlled by means of ifconfig(1M) router option. When
227 the global forwarding setting is changed (that is, -u is issued to change
228 the value from enabled to disabled or vice-versa), all interface flags in
229 the system are changed simultaneously to reflect the new global policy.
230 Interfaces configured by means of DHCP automatically have their
231 interface-specific IFF_ROUTER flag cleared.
232
233 When a new interface is plumbed by means of ifconfig, the value of the
234 interface-specific forwarding flag is set according to the current global
235 forwarding value. Thus, the forwarding value forms the "default" for all
236 new interfaces.
237
238 FILES
239 /etc/inet/routing.conf Parameters for IP forwarding and
240 routing. (Not to be edited.)
241
242 EXIT STATUS
243 The routeadm utility exits 0 on success, and >0 if an error occurs.
244
245 EXAMPLES
246 Example 1 Enabling IPv4 Forwarding
247 IPv4 forwarding is disabled by default. The following command
248 enables IPv4 forwarding:
249
250 # routeadm -e ipv4-forwarding
251
252 Example 2 Apply Configured Settings to the Running System
253 In the previous example, a system setting was changed, but will
254 not take effect until the next reboot unless a command such as
255 the following is used:
256
257 # routeadm -u
258
259 An alternative to the above two steps is to simply enable the
260 equivalent SMF service:
261
262 # svcadm enable svc:/network/ipv4-forwarding
263
264 ...or, using the abbreviated FMRI:
265
266 # svcadm enable ipv4-forwarding
267
268 Example 3 Making a Setting Revert to its Default
269 To make the setting changed in the first example revert to its
270 default, enter the following:
271
272 # routeadm -r ipv4-forwarding
273 # routeadm -u
274
275 Example 4 Starting in.routed with the -q Flag
276 Setting the -q flag is represented in the SMF service by setting
277 the quiet_mode property to true. The following sequence of
278 commands starts in.routed with the -q flag:
279
280 # routeadm -m route:default quiet_mode=true
281 # routeadm -e ipv4-routing -u
282
283 See in.routed(1M) for details of property names and how they
284 relate to daemon behavior.
285
286 INTERFACE STABILITY
287 Stable.
288
289 SEE ALSO
290 ifconfig(1M), in.routed(1M), svcadm(1M), gateways(4), attributes(5),
291 smf(5)
292
293 illumos July 4, 2018 illumos
|