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