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