1 IPADM(1M) Maintenance Commands IPADM(1M)
2
3 NAME
4 ipadm - configure IP and IPMP interfaces, addresses and protocols
5
6 SYNOPSIS
7 ipadm create-ip [-t] interface
8 ipadm delete-ip interface
9
10 ipadm create-ipmp [-t] ipmp-interface
11 ipadm delete-ipmp ipmp-interface
12 ipadm add-ipmp [-t] -i interface ... ipmp-interface
13 ipadm remove-ipmp [-t] -i interface ... ipmp-interface
14
15 ipadm disable-if -t interface
16 ipadm enable-if -t interface
17 ipadm show-if [[-p] -o field[,field]...] [interface]
18
19 ipadm set-ifprop [-t] -p prop=value[,value]... -m protocol interface
20 ipadm reset-ifprop [-t] -p prop -m protocol interface
21 ipadm show-ifprop [[-c] -o field[,value]...] [-p prop[,prop]...]
22 [-m protocol] [interface]
23
24 ipadm create-addr [-t] -T static [-d]
25 -a [local|remote=]addr[/prefixlen]... addrobj
26 ipadm create-addr [-t] -T dhcp [-1] [-h hostname] [-w {seconds|forever}]
27 addrobj
28 ipadm create-addr [-t] -T addrconf [-i interface-id]
29 [-p {stateful|stateless}={yes|no}]... addrobj
30 ipadm delete-addr [-r] addrobj
31 ipadm show-addr [[-p] -o field[,field]...] [addrobj]
32 ipadm refresh-addr [-i] addrobj
33 ipadm down-addr [-t] addrobj
34 ipadm up-addr [-t] addrobj
35 ipadm disable-addr [-t] addrobj
36 ipadm enable-addr [-t] addrobj
37
38 ipadm set-addrprop [-t] -p prop=value[,value]... addrobj
39 ipadm reset-addrprop [-t] -p prop addrobj
40 ipadm show-addrprop [[-c] -o field[,field]...] [-p prop[,prop]...]
41 [addrobj]
42
43 ipadm set-prop [-t] -p prop[+|-]=value[,value]... protocol
44 ipadm reset-prop [-t] -p prop protocol
45 ipadm show-prop [[-c] -o field[,field]...] [-p prop[,prop]...] [protocol]
46
47 DESCRIPTION
48 The ipadm command is a stable replacement for the ifconfig(1M) and
49 ndd(1M) commands. It is used to create IP interfaces and to configure IP
50 addresses on those interfaces. It is also used to get, set or reset
51 properties on interfaces, addresses and protocols.
52
53 For subcommands that take an addrobj, the addrobj specifies unique
54 address on the system. It is made up of two parts, delimited by a `/'.
55 The first part is the name of the interface and the second part is a
56 string up to 32 characters long. For example, "lo0/v4" is a loopback
57 interface addrobj name.
58
59 For subcommands that take a protocol, this can be one of the following
60 values: ip, ipv4, ipv6, icmp, tcp, sctp or udp.
61
62 SUBCOMMANDS
63 The following subcommands are supported:
64
65 ipadm create-ip [-t] interface
66 Create the IP interface that will handle both IPv4 and IPv6
67 packets. The interface will be enabled as part of the creation
68 process. The IPv4 interface will have the address 0.0.0.0. The
69 IPv6 interface will have the address ::.
70
71 -t,--temporary
72 Temporary, not persistent across reboots.
73
74 ipadm delete-ip interface
75 Permanently delete the specified IP interface.
76
77 ipadm create-ipmp [-t] ipmp-interface
78 Create the IPMP interface that will handle both IPv4 and IPv6
79 packets. The interface will be enabled as part of the creation
80 process. The IPv4 interface will have the address 0.0.0.0. The
81 IPv6 interface will have the adress ::.
82
83 -t,--temporary
84 Temporary, not persistent across reboots.
85
86 ipadm delete-ipmp ipmp-interface
87 Permanently delete the IPMP interface.
88
89 ipadm add-ipmp [-t] -i interface ... ipmp-interface
90 Add the IP interface(s) to the IPMP interface (group).
91
92 -i,--interface
93 Interface to be added to the IPMP interface (group). More than
94 one -i option can be specified.
95
96 -t,--temporary
97 Temporary, not persistent across reboots.
98
99 ipadm remove-ipmp [-t] -i interface ... ipmp-interface
100 Remove the IP interface(s) from the IPMP interface (group).
101
102 -i,--interface
103 Interface to be removed from the IPMP interface (group). More
104 than one -i option can be specified.
105
106 -t,--temporary
107 Temporary, not persistent across reboots.
108
109 ipadm disable-if -t interface
110 Disable the specified IP interface.
111
112 -t,--temporary
113 Temporary, not persistent across reboots.
114
115 ipadm enable-if -t interface
116 Enable the specified IP interface.
117
118 -t,--temporary
119 Temporary, not persistent across reboots.
120
121 ipadm show-if [[-p] -o field[,field]...] [interface]
122 Show the current IP interface configuration.
123
124 -o,--output
125 Select which fields will be shown. The field value can
126 be one of the following names:
127 ALL Display all fields.
128 IFNAME The name of the interface.
129 STATE The state can be one of the following values:
130 ok resources for the interface have
131 been allocated
132 offline the interface is offline
133 failed the interface's datalink is down
134 down the interface is down
135 disabled the interface is disabled
136 CURRENT A set of single character flags indicating
137 the following:
138 b broadcast (mutually exclusive with `p')
139 m multicast
140 p point-to-point (mutually exclusive with
141 `b')
142 v virtual interface
143 I IPMP
144 s IPMP standby
145 i IPMP inactive
146 V VRRP
147 a VRRP accept mode
148 4 IPv4
149 6 IPv6
150 PERSISTENT A set of single character flags showing what
151 configuration will be used the next time the
152 interface is enabled:
153 s IPMP standby
154 4 IPv4
155 6 IPv6
156
157 -p,--parsable
158 Print the output in parsable format.
159
160 ipadm set-ifprop [-t] -p prop=value[,value]... -m protocol interface
161 Set a property's value(s) on the specified IP interface.
162
163 -m,--module
164 Specify which protocol the setting applies to.
165
166 -p,--prop
167 Specify the property name and value(s). The property
168 name can be one of the following:
169 arp Address resolution protocol (on/off).
170 exchange_routes Exchange of routing data (on/off).
171 forwarding IP Forwarding (on/off)
172 metric Set the routing metric to the numeric
173 value. The value is treated as extra
174 hops to the destination.
175 mtu Set the maximum transmission unit to the
176 numeric value.
177 nud Neighbor unreachability detection
178 (on/off)
179 usesrc Indicates which interface to use for
180 source address selection. A value none
181 may also be used.
182
183 -t,--temporary
184 Temporary, not persistent across reboots.
185
186 ipadm reset-ifprop [-t] -p prop -m protocol interface
187 Reset the specified IP interface's property value to the default.
188
189 -m,--module
190 Specify which protocol the setting applies to.
191
192 -p,--prop
193 Specify the property name. See the ipadm set-ifprop
194 subcommand for the list of property names.
195
196 -t,--temporary
197 Temporary, not persistent across reboots.
198
199 ipadm show-ifprop [[-c] -o field[,value]...] [-p prop[,prop]...] [-m
200 protocol] [interface]
201 Display the property values for one or all of the IP interfaces.
202
203 -c,--parsable
204 Print the output in parsable format.
205
206 -m,--module
207 Specify which protocol to display.
208
209 -o,--output
210 Select which fields will be shown. The field value can
211 be one of the following names:
212 ALL Display all fields.
213 IFNAME The name of the interface.
214 PROPERTY The name of the property.
215 PROTO The name of the protocol.
216 PERM If the property is readable ("r") and/or
217 writable ("w").
218 CURRENT The value of the property.
219 PERSISTENT The persistent value of the property.
220 DEFAULT The default value of the property.
221 POSSIBLE The possible values for the property.
222
223 -p,--prop
224 Specify which properties to display. See the ipadm
225 set-ifprop subcommand for the list of property names.
226
227 ipadm create-addr [-t] -T static [-d] -a
228 [local|remote=]addr[/prefixlen]... addrobj
229 Create an address on the specified IP interface using static
230 configuration. The address will be enabled but can disabled
231 using the ipadm disable-addr subcommand. Note that addrconf
232 address configured on the interface is required to configure
233 static IPv6 address on the same interface. This takes the
234 following options:
235
236 -a,--address
237 Specify the address. The local or remote prefix can be
238 used for a point-to-point interface. In this case, both
239 addresses must be given. Otherwise, the equal sign ("=")
240 should be omitted and the address should be provided by
241 itself without second address.
242
243 -d,--down
244 The address is down.
245
246 -t,--temporary
247 Temporary, not persistent across reboots.
248
249 ipadm create-addr [-t] -T dhcp [-1] [-h hostname] [-w {seconds|forever}]
250 addrobj
251 Create an address on the specified IP interface using DHCP. This
252 takes the following options:
253
254 -1,--primary
255 Specify that the interface is primary. One effect will
256 be that nodename(4) will serve as -h,--reqhost if that
257 switch is not otherwise specified.
258
259 -h,--reqhost
260 Specify the host name to send to the DHCP server in order
261 to request an association of a Fully Qualified Domain
262 Name to the interface. An FQDN is determined from
263 hostname if it is "rooted" (ending in a '.'), or if it
264 consists of at least three DNS labels, or by appending to
265 hostname the DNS domain name value configured in
266 /etc/default/dhcpagent for dhcpagent(1m). N.b. that the
267 DHCP server implementation ultimately determines whether
268 and how the client-sent FQDN is used.
269
270 -t,--temporary
271 Temporary, not persistent across reboots.
272
273 -w,--wait
274 Specify the time, in seconds, that the command should
275 wait to obtain an address; or specify forever to wait
276 without interruption. The default value is 120.
277
278 ipadm create-addr [-t] -T addrconf [-i interface-id] [-p
279 {stateful|stateless}={yes|no}]... addrobj
280 Create an auto-configured address on the specified IP interface.
281 This takes the following options:
282
283 -i,--interface-id
284 Specify the interface ID to be used.
285
286 -p,--prop
287 Specify which method of auto-configuration should be
288 used.
289
290 -t,--temporary
291 Temporary, not persistent across reboots.
292
293 ipadm delete-addr [-r] addrobj
294 Delete the given address.
295
296 -r,--release
297 Indicate that the DHCP-assigned address should be
298 released.
299
300 ipadm show-addr [[-p] -o field[,field]...] [addrobj]
301 Show the current address properties.
302
303 -o,--output
304 Select which fields will be shown. The field value can
305 be one of the following names:
306 ALL Display all fields.
307 ADDROBJ The name of the address.
308 TYPE The type of the address
309 (static/dhcp/addrconf).
310 STATE The state of the address. It can be one of
311 the following values:
312 disabled see the ipadm disable-addr
313 subcommand
314 down see the ipadm down-addr
315 subcommand
316 duplicate the address is duplicate
317 inaccessible the interface for this address
318 has failed
319 ok the address is up
320 tentative duplicate address detection in
321 progress
322 CURRENT A set of single character flags indicating
323 the following:
324 U up
325 u unnumbered (matches another local address)
326 p private, not advertised to routing
327 t temporary IPv6 address
328 d deprecated (not used for outgoing packets)
329 PERSISTENT A set of single character flags showing the
330 configuration which will be used when the
331 address is enabled.
332 U up
333 p private, not advertised to routing
334 d deprecated (not used for outgoing packets)
335 ADDR The address.
336
337 -p,--parsable
338 Print the output in parsable format.
339
340 ipadm refresh-addr [-i] addrobj
341 Extend the lease for DHCP addresses. It also restarts duplicate
342 address detection for static addresses.
343
344 -i,--inform
345 Obtain network configuration from DHCP without taking a lease
346 on the address.
347
348 ipadm down-addr [-t] addrobj
349 Down the address. This will stop packets from being sent or
350 received.
351
352 -t,--temporary
353 Temporary, not persistent across reboots.
354
355 ipadm up-addr [-t] addrobj
356 Up the address. This will enable packets to be sent and
357 received.
358
359 -t,--temporary
360 Temporary, not persistent across reboots.
361
362 ipadm disable-addr [-t] addrobj
363 Disable the address.
364
365 -t,--temporary
366 Temporary, not persistent across reboots.
367
368 ipadm enable-addr [-t] addrobj
369 Enable the address.
370
371 -t,--temporary
372 Temporary, not persistent across reboots.
373
374 ipadm set-addrprop [-t] -p prop=value[,value]... addrobj
375 Set a property's value(s) on the addrobj.
376
377 -p,--prop
378 Specify the property name and value(s). The property
379 name can be one of the following:
380 broadcast The broadcast address (read-only).
381 deprecated The address should not be used to send
382 packets but can still receive packets
383 (on/off).
384 prefixlen The number of bits in the IPv4 netmask or
385 IPv6 prefix.
386 primary The DHCP primary interface flag (read-only).
387 private The address is not advertised to routing
388 (on/off).
389 reqhost The host name to send to the DHCP server in
390 order to request an association of the FQDN
391 to the interface. For a primary DHCP
392 interface, nodename(4) is sent if this
393 property is not defined. See the ipadm
394 create-addr -T dhcp subcommand for the
395 explanation of how an FQDN is determined.
396 transmit Packets can be transmitted (on/off).
397 zone The zone the addrobj is in (temporary-
398 only--use zonecfg(1M) to make persistent).
399
400 -t,--temporary
401 Temporary, not persistent across reboots.
402
403 ipadm reset-addrprop [-t] -p prop addrobj
404 Reset the addrobj's property value to the default.
405
406 -p,--prop
407 Specify the property name. See the ipadm set-addrprop
408 subcommand for the list of property names.
409
410 -t,--temporary
411 Temporary, not persistent across reboots.
412
413 ipadm show-addrprop [[-c] -o field[,field]...] [-p prop[,prop]...]
414 [addrobj]
415 Display the property values for one or all of the addrobjs.
416
417 -c,--parsable
418 Print the output in parsable format.
419
420 -o,--output
421 Select which fields will be shown. The field value can
422 be one of the following names:
423 ALL Display all fields.
424 ADDROBJ The name of the addrobj.
425 PROPERTY The name of the property.
426 PERM If the property is readable ("r") and/or
427 writable ("w").
428 CURRENT The value of the property.
429 PERSISTENT The persistent value of the property.
430 DEFAULT The default value of the property.
431 POSSIBLE The possible values for the property.
432
433 -p,--prop
434 Specify which properties to display. See the ipadm
435 set-addrprop subcommand for the list of property names.
436
437 ipadm set-prop [-t] -p prop[+|-]=value[,value]... protocol
438 Set a property's value(s) on the protocol.
439
440 -p,--prop
441 Specify the property name and value(s). The optional +|-
442 syntax can be used to add/remove values from the current
443 list of values on the property. The property name can be
444 one of the following:
445 ecn Explicit congestion control
446 (never/passive/active) (TCP).
447 extra_priv_ports Additional privileged ports
448 (SCTP/TCP/UDP).
449 forwarding Packet forwarding (on/off).
450 hoplimit The IPv6 hoplimit.
451 largest_anon_port Largest ephemeral port
452 (SCTP/TCP/UDP).
453 max_buf Maximum receive or send buffer
454 size (ICMP/SCTP/TCP/UDP). This
455 also sets the upper limit for the
456 recv_buf and send_buf properties.
457 recv_buf Default receive buffer size
458 (ICMP/SCTP/TCP/UDP). The maximum
459 value for this property is
460 controlled by the max_buf
461 property.
462 sack Selective acknowledgement
463 (active/passive/never) (TCP).
464 send_buf Default send buffer size
465 (ICMP/SCTP/TCP/UDP). The maximum
466 value for this property is
467 controlled by the max_buf
468 property.
469 smallest_anon_port Smallest ephemeral port
470 (SCTP/TCP/UDP).
471 smallest_nonpriv_port Smallest non-privileged port
472 (SCTP/TCP/UDP).
473 ttl The IPv4 time-to-live.
474
475 -t,--temporary
476 Temporary, not persistent across reboots.
477
478 ipadm reset-prop [-t] -p prop protocol
479 Reset a protocol's property value to the default.
480
481 -p,--prop
482 Specify the property name. See the ipadm set-prop
483 subcommand for the list of property names.
484
485 -t,--temporary
486 Temporary, not persistent across reboots.
487
488 ipadm show-prop [[-c] -o field[,field]...] [-p prop[,prop]...] [protocol]
489 Display the property values for one or all of the protocols.
490
491 -c,--parsable
492 Print the output in parsable format.
493
494 -o,--output
495 Select which fields will be shown. The field value can
496 be one of the following names:
497 ALL Display all fields.
498 PROTO The name of the protocol.
499 PROPERTY The name of the property.
500 PERM If the property is readable ("r") and/or
501 writable ("w").
502 CURRENT The value of the property.
503 PERSISTENT The persistent value of the property.
504 DEFAULT The default value of the property.
505 POSSIBLE The possible values for the property.
506
507 -p,--prop
508 Specify which properties to display. See the ipadm
509 set-prop subcommand for the list of property names.
510
511 SEE ALSO
512 arp(1M), cfgadm(1M), dhcpagent(1M), dladm(1M), if_mpadm(1M),
513 ifconfig(1M), ndd(1M), zonecfg(1M), nodename(4), nsswitch.conf(4),
514 dhcp(5)
515
516 illumos February 6, 2018 illumos