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
+++ new/usr/src/man/man1m/ipadm.1m
1 1 .\"
2 2 .\" This file and its contents are supplied under the terms of the
3 3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
4 4 .\" You may only use this file in accordance with the terms of version
5 5 .\" 1.0 of the CDDL.
6 6 .\"
7 7 .\" A full copy of the text of the CDDL should have accompanied this
8 8 .\" source. A copy of the CDDL is also available via the Internet at
9 9 .\" http://www.illumos.org/license/CDDL.
10 10 .\"
11 11 .\"
|
↓ open down ↓ |
11 lines elided |
↑ open up ↑ |
12 12 .\" Copyright (c) 2012, Joyent, Inc. All Rights Reserved
13 13 .\" Copyright (c) 2013 by Delphix. All rights reserved.
14 14 .\" Copyright 2018 Nexenta Systems, Inc.
15 15 .\" Copyright (c) 2016-2017, Chris Fraire <cfraire@me.com>.
16 16 .\"
17 17 .Dd February 6, 2018
18 18 .Dt IPADM 1M
19 19 .Os
20 20 .Sh NAME
21 21 .Nm ipadm
22 -.Nd configure IP interfaces, addresses and protocols
22 +.Nd configure IP and IPMP interfaces, addresses and protocols
23 23 .Sh SYNOPSIS
24 24 .Nm
25 -.Ic create-if
25 +.Ic create-ip
26 26 .Op Fl t
27 27 .Ar interface
28 28 .Nm
29 +.Ic delete-ip
30 +.Ar interface
31 +.Pp
32 +.Nm
33 +.Ic create-ipmp
34 +.Op Fl t
35 +.Ar ipmp-interface
36 +.Nm
37 +.Ic delete-ipmp
38 +.Ar ipmp-interface
39 +.Nm
40 +.Ic add-ipmp
41 +.Op Fl t
42 +.Fl i Ar interface No ...
43 +.Ar ipmp-interface
44 +.Nm
45 +.Ic remove-ipmp
46 +.Op Fl t
47 +.Fl i Ar interface No ...
48 +.Ar ipmp-interface
49 +.Pp
50 +.Nm
29 51 .Ic disable-if
30 52 .Fl t
31 53 .Ar interface
32 54 .Nm
33 55 .Ic enable-if
34 56 .Fl t
35 57 .Ar interface
36 58 .Nm
37 -.Ic delete-if
38 -.Ar interface
39 -.Nm
40 59 .Ic show-if
41 60 .Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
42 61 .Op Ar interface
62 +.Pp
43 63 .Nm
44 64 .Ic set-ifprop
45 65 .Op Fl t
46 66 .Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
47 67 .Fl m Ar protocol
48 68 .Ar interface
49 69 .Nm
50 70 .Ic reset-ifprop
51 71 .Op Fl t
52 72 .Fl p Ar prop
53 73 .Fl m Ar protocol
54 74 .Ar interface
55 75 .Nm
56 76 .Ic show-ifprop
57 77 .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar value Oc Ns ...
58 78 .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
59 79 .Op Fl m Ar protocol
60 80 .Op Ar interface
81 +.Pp
61 82 .Nm
62 83 .Ic create-addr
63 84 .Op Fl t
64 85 .Fl T Cm static
65 86 .Op Fl d
66 87 .Fl a Oo Cm local Ns | Ns Cm remote Ns = Oc Ns
67 88 .Ar addr Ns Oo / Ns Ar prefixlen Oc Ns ...
68 89 .Ar addrobj
69 90 .Nm
70 91 .Ic create-addr
71 92 .Op Fl t
72 93 .Fl T Cm dhcp
73 94 .Op Fl 1
74 95 .Op Fl h Ar hostname
75 96 .Op Fl w Bro Ar seconds Ns | Ns Cm forever Brc
|
↓ open down ↓ |
5 lines elided |
↑ open up ↑ |
76 97 .Ar addrobj
77 98 .Nm
78 99 .Ic create-addr
79 100 .Op Fl t
80 101 .Fl T Cm addrconf
81 102 .Op Fl i Ar interface-id
82 103 .Oo Fl p Bro Cm stateful Ns | Ns Cm stateless Brc Ns = Ns
83 104 .Bro Cm yes Ns | Ns Cm no Brc Oc Ns ...
84 105 .Ar addrobj
85 106 .Nm
107 +.Ic delete-addr
108 +.Op Fl r
109 +.Ar addrobj
110 +.Nm
111 +.Ic show-addr
112 +.Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
113 +.Op Ar addrobj
114 +.Nm
115 +.Ic refresh-addr
116 +.Op Fl i
117 +.Ar addrobj
118 +.Nm
86 119 .Ic down-addr
87 120 .Op Fl t
88 121 .Ar addrobj
89 122 .Nm
90 123 .Ic up-addr
91 124 .Op Fl t
92 125 .Ar addrobj
93 126 .Nm
94 127 .Ic disable-addr
95 128 .Op Fl t
96 129 .Ar addrobj
97 130 .Nm
98 131 .Ic enable-addr
99 132 .Op Fl t
100 133 .Ar addrobj
134 +.Pp
101 135 .Nm
102 -.Ic refresh-addr
103 -.Op Fl i
104 -.Ar addrobj
105 -.Nm
106 -.Ic delete-addr
107 -.Op Fl r
108 -.Ar addrobj
109 -.Nm
110 -.Ic show-addr
111 -.Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
112 -.Op Ar addrobj
113 -.Nm
114 136 .Ic set-addrprop
115 137 .Op Fl t
116 138 .Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
117 139 .Ar addrobj
118 140 .Nm
119 141 .Ic reset-addrprop
120 142 .Op Fl t
121 143 .Fl p Ar prop
122 144 .Ar addrobj
123 145 .Nm
124 146 .Ic show-addrprop
125 147 .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
126 148 .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
127 149 .Op Ar addrobj
150 +.Pp
128 151 .Nm
129 152 .Ic set-prop
130 153 .Op Fl t
131 154 .Fl p Ar prop Ns Oo Cm + Ns | Ns Cm - Oc Ns = Ns
132 155 .Ar value Ns Oo , Ns Ar value Oc Ns ...
133 156 .Ar protocol
134 157 .Nm
135 158 .Ic reset-prop
136 159 .Op Fl t
137 160 .Fl p Ar prop
138 161 .Ar protocol
139 162 .Nm
140 163 .Ic show-prop
141 164 .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
142 165 .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
143 166 .Op Ar protocol
144 167 .Sh DESCRIPTION
145 168 The
146 169 .Nm
147 170 command is a stable replacement for the
148 171 .Xr ifconfig 1M
149 172 and
150 173 .Xr ndd 1M
|
↓ open down ↓ |
13 lines elided |
↑ open up ↑ |
151 174 commands.
152 175 It is used to create IP interfaces and to configure IP addresses on those
153 176 interfaces.
154 177 It is also used to get, set or reset properties on interfaces, addresses and
155 178 protocols.
156 179 .Pp
157 180 For subcommands that take an
158 181 .Em addrobj ,
159 182 the
160 183 .Em addrobj
161 -specifies a unique address on the system.
184 +specifies unique address on the system.
162 185 It is made up of two parts, delimited by a
163 186 .Sq / .
164 187 The first part is the name of the interface and the second part is a string up
165 188 to 32 characters long.
166 189 For example,
167 190 .Qq lo0/v4
168 191 is a loopback interface
169 192 .Em addrobj
170 193 name.
171 194 .Pp
172 195 For subcommands that take a
173 196 .Em protocol ,
174 197 this can be one of the following values:
175 198 .Cm ip ,
176 199 .Cm ipv4 ,
177 200 .Cm ipv6 ,
178 201 .Cm icmp ,
179 202 .Cm tcp ,
180 203 .Cm sctp
181 204 or
182 -.Cm udp .
205 +.Cm udp.
183 206 .Sh SUBCOMMANDS
184 207 The following subcommands are supported:
185 208 .Bl -tag -width Ds
186 209 .It Xo
187 210 .Nm
188 -.Ic create-if
211 +.Ic create-ip
189 212 .Op Fl t
190 213 .Ar interface
191 214 .Xc
192 -Create an IP interface that will handle both IPv4 and IPv6 packets.
215 +Create the IP interface that will handle both IPv4 and IPv6 packets.
193 216 The interface will be enabled as part of the creation process.
194 217 The IPv4 interface will have the address 0.0.0.0.
195 218 The IPv6 interface will have the address ::.
196 219 .Bl -tag -width Ds
197 220 .It Fl t Ns \&, Ns Fl -temporary
198 221 Temporary, not persistent across reboots.
199 222 .El
200 223 .It Xo
201 224 .Nm
225 +.Ic delete-ip
226 +.Ar interface
227 +.Xc
228 +Permanently delete the specified IP interface.
229 +.It Xo
230 +.Nm
231 +.Ic create-ipmp
232 +.Op Fl t
233 +.Ar ipmp-interface
234 +.Xc
235 +Create the IPMP interface that will handle both IPv4 and IPv6 packets.
236 +The interface will be enabled as part of the creation process.
237 +The IPv4 interface will have the address 0.0.0.0.
238 +The IPv6 interface will have the adress ::.
239 +.Bl -tag -width Ds
240 +.It Fl t Ns \&, Ns Fl -temporary
241 +Temporary, not persistent across reboots.
242 +.El
243 +.It Xo
244 +.Nm
245 +.Ic delete-ipmp
246 +.Ar ipmp-interface
247 +.Xc
248 +Permanently delete the IPMP interface.
249 +.It Xo
250 +.Nm
251 +.Ic add-ipmp
252 +.Op Fl t
253 +.Fl i Ar interface No ...
254 +.Ar ipmp-interface
255 +.Xc
256 +Add the IP interface(s) to the IPMP interface (group).
257 +.Bl -tag -width ""
258 +.It Fl i Ns \&, Ns Fl -interface
259 +Interface to be added to the IPMP interface (group).
260 +More than one
261 +.Fl i
262 +option can be specified.
263 +.It Fl t Ns \&, Ns Fl -temporary
264 +Temporary, not persistent across reboots.
265 +.El
266 +.It Xo
267 +.Nm
268 +.Ic remove-ipmp
269 +.Op Fl t
270 +.Fl i Ar interface No ...
271 +.Ar ipmp-interface
272 +.Xc
273 +Remove the IP interface(s) from the IPMP interface (group).
274 +.Bl -tag -width ""
275 +.It Fl i Ns \&, Ns Fl -interface
276 +Interface to be removed from the IPMP interface (group).
277 +More than one
278 +.Fl i
279 +option can be specified.
280 +.It Fl t Ns \&, Ns Fl -temporary
281 +Temporary, not persistent across reboots.
282 +.El
283 +.It Xo
284 +.Nm
202 285 .Ic disable-if
203 286 .Fl t
204 287 .Ar interface
205 288 .Xc
206 289 Disable the specified IP interface.
207 290 .Bl -tag -width Ds
208 291 .It Fl t Ns \&, Ns Fl -temporary
209 292 Temporary, not persistent across reboots.
210 293 .El
211 294 .It Xo
212 295 .Nm
213 296 .Ic enable-if
|
↓ open down ↓ |
2 lines elided |
↑ open up ↑ |
214 297 .Fl t
215 298 .Ar interface
216 299 .Xc
217 300 Enable the specified IP interface.
218 301 .Bl -tag -width Ds
219 302 .It Fl t Ns \&, Ns Fl -temporary
220 303 Temporary, not persistent across reboots.
221 304 .El
222 305 .It Xo
223 306 .Nm
224 -.Ic delete-if
225 -.Ar interface
226 -.Xc
227 -Permanently delete the specified IP interface.
228 -.It Xo
229 -.Nm
230 307 .Ic show-if
231 308 .Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
232 309 .Op Ar interface
233 310 .Xc
234 311 Show the current IP interface configuration.
235 312 .Bl -tag -width Ds
236 313 .It Fl o Ns \&, Ns Fl -output
237 314 Select which fields will be shown.
238 315 The field value can be one of the following names:
239 316 .Bl -tag -compact -width "PERSISTENT"
240 317 .It Cm ALL
241 318 Display all fields.
242 319 .It Cm IFNAME
243 320 The name of the interface.
244 321 .It Cm STATE
245 322 The state can be one of the following values:
246 323 .Bl -tag -compact -width "disabled"
247 324 .It Sy ok
248 325 resources for the interface have been allocated
249 326 .It Sy offline
250 327 the interface is offline
251 328 .It Sy failed
252 329 the interface's datalink is down
253 330 .It Sy down
254 331 the interface is down
255 332 .It Sy disabled
256 333 the interface is disabled
257 334 .El
258 335 .It Cm CURRENT
259 336 A set of single character flags indicating the following:
260 337 .Bl -tag -compact -width "b"
261 338 .It Sy b
262 339 broadcast (mutually exclusive with
263 340 .Sq p )
264 341 .It Sy m
265 342 multicast
266 343 .It Sy p
267 344 point-to-point (mutually exclusive with
268 345 .Sq b )
269 346 .It Sy v
270 347 virtual interface
271 348 .It Sy I
272 349 IPMP
273 350 .It Sy s
274 351 IPMP standby
275 352 .It Sy i
276 353 IPMP inactive
277 354 .It Sy V
278 355 VRRP
279 356 .It Sy a
280 357 VRRP accept mode
281 358 .It Sy 4
282 359 IPv4
283 360 .It Sy 6
284 361 IPv6
285 362 .El
286 363 .It Cm PERSISTENT
287 364 A set of single character flags showing what configuration will be used the
288 365 next time the interface is enabled:
|
↓ open down ↓ |
49 lines elided |
↑ open up ↑ |
289 366 .Bl -tag -compact -width "s"
290 367 .It Sy s
291 368 IPMP standby
292 369 .It Sy 4
293 370 IPv4
294 371 .It Sy 6
295 372 IPv6
296 373 .El
297 374 .El
298 375 .It Fl p Ns \&, Ns Fl -parsable
299 -Print the output in a parsable format.
376 +Print the output in parsable format.
300 377 .El
301 378 .It Xo
302 379 .Nm
303 380 .Ic set-ifprop
304 381 .Op Fl t
305 382 .Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
306 383 .Fl m Ar protocol
307 384 .Ar interface
308 385 .Xc
309 386 Set a property's value(s) on the specified IP interface.
310 387 .Bl -tag -width Ds
311 388 .It Fl m Ns \&, Ns Fl -module
312 389 Specify which protocol the setting applies to.
313 390 .It Fl p Ns \&, Ns Fl -prop
314 391 Specify the property name and value(s).
315 392 The property name can be one of the following:
316 393 .Bl -tag -compact -width "exchange_routes"
317 394 .It Cm arp
318 395 Address resolution protocol
319 396 .Pq Cm on Ns / Ns Cm off .
320 397 .It Cm exchange_routes
321 398 Exchange of routing data
322 399 .Pq Cm on Ns / Ns Cm off .
323 400 .It Cm forwarding
324 401 IP Forwarding
325 402 .Pq Cm on Ns / Ns Cm off
326 403 .It Cm metric
327 404 Set the routing metric to the numeric value.
328 405 The value is treated as extra hops to the destination.
329 406 .It Cm mtu
330 407 Set the maximum transmission unit to the numeric value.
331 408 .It Cm nud
332 409 Neighbor unreachability detection
333 410 .Pq Cm on Ns / Ns Cm off
334 411 .It Cm usesrc
335 412 Indicates which interface to use for source address selection.
336 413 A value
337 414 .Cm none
338 415 may also be used.
339 416 .El
340 417 .It Fl t Ns \&, Ns Fl -temporary
341 418 Temporary, not persistent across reboots.
342 419 .El
343 420 .It Xo
344 421 .Nm
345 422 .Ic reset-ifprop
346 423 .Op Fl t
347 424 .Fl p Ar prop
348 425 .Fl m Ar protocol
349 426 .Ar interface
350 427 .Xc
351 428 Reset the specified IP interface's property value to the default.
352 429 .Bl -tag -width Ds
353 430 .It Fl m Ns \&, Ns Fl -module
354 431 Specify which protocol the setting applies to.
355 432 .It Fl p Ns \&, Ns Fl -prop
356 433 Specify the property name.
357 434 See the
358 435 .Nm ipadm Ic set-ifprop
359 436 subcommand for the list of property names.
360 437 .It Fl t Ns \&, Ns Fl -temporary
361 438 Temporary, not persistent across reboots.
362 439 .El
363 440 .It Xo
|
↓ open down ↓ |
54 lines elided |
↑ open up ↑ |
364 441 .Nm
365 442 .Ic show-ifprop
366 443 .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar value Oc Ns ...
367 444 .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
368 445 .Op Fl m Ar protocol
369 446 .Op Ar interface
370 447 .Xc
371 448 Display the property values for one or all of the IP interfaces.
372 449 .Bl -tag -width Ds
373 450 .It Fl c Ns \&, Ns Fl -parsable
374 -Print the output in a parsable format.
451 +Print the output in parsable format.
375 452 .It Fl m Ns \&, Ns Fl -module
376 453 Specify which protocol to display.
377 454 .It Fl o Ns \&, Ns Fl -output
378 455 Select which fields will be shown.
379 456 The field value can be one of the following names:
380 457 .Bl -tag -compact -width "PERSISTENT"
381 458 .It Cm ALL
382 459 Display all fields.
383 460 .It Cm IFNAME
384 461 The name of the interface.
385 462 .It Cm PROPERTY
386 463 The name of the property.
387 464 .It Cm PROTO
388 465 The name of the protocol.
389 466 .It Cm PERM
390 467 If the property is readable
391 468 .Pq Qq r
392 469 and/or writable
393 470 .Pq Qq w .
394 471 .It Cm CURRENT
395 472 The value of the property.
396 473 .It Cm PERSISTENT
397 474 The persistent value of the property.
398 475 .It Cm DEFAULT
399 476 The default value of the property.
400 477 .It Cm POSSIBLE
401 478 The possible values for the property.
402 479 .El
403 480 .It Fl p Ns \&, Ns Fl -prop
404 481 Specify which properties to display.
405 482 See the
406 483 .Nm ipadm Ic set-ifprop
407 484 subcommand for the list of property names.
408 485 .El
409 486 .It Xo
410 487 .Nm
411 488 .Ic create-addr
412 489 .Op Fl t
413 490 .Fl T Cm static
414 491 .Op Fl d
|
↓ open down ↓ |
30 lines elided |
↑ open up ↑ |
415 492 .Fl a Oo Cm local Ns | Ns Cm remote Ns = Oc Ns
416 493 .Ar addr Ns Oo / Ns Ar prefixlen Oc Ns ...
417 494 .Ar addrobj
418 495 .Xc
419 496 Create an address on the specified IP interface using static configuration.
420 497 The address will be enabled but can disabled using the
421 498 .Nm ipadm Ic disable-addr
422 499 subcommand.
423 500 Note that
424 501 .Cm addrconf
425 -address configured on an interface is required to configure
502 +address configured on the interface is required to configure
426 503 .Cm static
427 504 IPv6 address on the same interface.
428 505 This takes the following options:
429 506 .Bl -tag -width Ds
430 507 .It Fl a Ns \&, Ns Fl -address
431 508 Specify the address.
432 509 The
433 510 .Cm local
434 511 or
435 512 .Cm remote
436 513 prefix can be used for a point-to-point interface.
437 514 In this case, both addresses must be given.
438 515 Otherwise, the equal sign
439 516 .Pq Qq =
440 517 should be omitted and the address should be provided by itself without second
441 518 address.
442 519 .It Fl d Ns \&, Ns Fl -down
443 520 The address is down.
444 521 .It Fl t Ns \&, Ns Fl -temporary
445 522 Temporary, not persistent across reboots.
446 523 .El
447 524 .It Xo
448 525 .Nm
449 526 .Ic create-addr
450 527 .Op Fl t
451 528 .Fl T Cm dhcp
452 529 .Op Fl 1
453 530 .Op Fl h Ar hostname
454 531 .Op Fl w Bro Ar seconds Ns | Ns Cm forever Brc
455 532 .Ar addrobj
456 533 .Xc
457 534 Create an address on the specified IP interface using DHCP.
458 535 This takes the following options:
459 536 .Bl -tag -width Ds
460 537 .It Fl 1 Ns \&, Ns Fl -primary
461 538 Specify that the interface is primary.
462 539 One effect will be that
463 540 .Xr nodename 4
464 541 will serve as
465 542 .Fl h Ns \&, Ns Fl -reqhost
466 543 if that switch is not otherwise specified.
467 544 .It Fl h Ns \&, Ns Fl -reqhost
468 545 Specify the host name to send to the DHCP server in order to request an
469 546 association of a Fully Qualified Domain Name to the interface.
470 547 An FQDN is determined from
471 548 .Ar hostname
472 549 if it is "rooted" (ending in a '.'), or if it consists of at least three
473 550 DNS labels, or by appending to
474 551 .Ar hostname
475 552 the DNS domain name value configured in
476 553 .Pa /etc/default/dhcpagent
477 554 for
478 555 .Xr dhcpagent 1m .
479 556 N.b. that the DHCP server implementation ultimately determines whether and
480 557 how the client-sent FQDN is used.
481 558 .It Fl t Ns \&, Ns Fl -temporary
482 559 Temporary, not persistent across reboots.
483 560 .It Fl w Ns \&, Ns Fl -wait
484 561 Specify the time, in seconds, that the command should wait to obtain an
485 562 address; or specify
486 563 .Cm forever
487 564 to wait without interruption.
488 565 The default value is 120.
489 566 .El
490 567 .It Xo
491 568 .Nm
492 569 .Ic create-addr
493 570 .Op Fl t
494 571 .Fl T Cm addrconf
495 572 .Op Fl i Ar interface-id
496 573 .Oo Fl p Bro Cm stateful Ns | Ns Cm stateless Brc Ns = Ns
497 574 .Bro Cm yes Ns | Ns Cm no Brc Oc Ns ...
498 575 .Ar addrobj
499 576 .Xc
500 577 Create an auto-configured address on the specified IP interface.
501 578 This takes the following options:
|
↓ open down ↓ |
66 lines elided |
↑ open up ↑ |
502 579 .Bl -tag -width Ds
503 580 .It Fl i Ns \&, Ns Fl -interface-id
504 581 Specify the interface ID to be used.
505 582 .It Fl p Ns \&, Ns Fl -prop
506 583 Specify which method of auto-configuration should be used.
507 584 .It Fl t Ns \&, Ns Fl -temporary
508 585 Temporary, not persistent across reboots.
509 586 .El
510 587 .It Xo
511 588 .Nm
512 -.Ic down-addr
513 -.Op Fl t
514 -.Ar addrobj
515 -.Xc
516 -Down the address.
517 -This will stop packets from being sent or received.
518 -.Bl -tag -width Ds
519 -.It Fl t Ns \&, Ns Fl -temporary
520 -Temporary, not persistent across reboots.
521 -.El
522 -.It Xo
523 -.Nm
524 -.Ic up-addr
525 -.Op Fl t
526 -.Ar addrobj
527 -.Xc
528 -Up the address.
529 -This will enable packets to be sent and received.
530 -.Bl -tag -width Ds
531 -.It Fl t Ns \&, Ns Fl -temporary
532 -Temporary, not persistent across reboots.
533 -.El
534 -.It Xo
535 -.Nm
536 -.Ic disable-addr
537 -.Op Fl t
538 -.Ar addrobj
539 -.Xc
540 -Disable the address.
541 -.Bl -tag -width Ds
542 -.It Fl t Ns \&, Ns Fl -temporary
543 -Temporary, not persistent across reboots.
544 -.El
545 -.It Xo
546 -.Nm
547 -.Ic enable-addr
548 -.Op Fl t
549 -.Ar addrobj
550 -.Xc
551 -Enable the address.
552 -.Bl -tag -width Ds
553 -.It Fl t Ns \&, Ns Fl -temporary
554 -Temporary, not persistent across reboots.
555 -.El
556 -.It Xo
557 -.Nm
558 -.Ic refresh-addr
559 -.Op Fl i
560 -.Ar addrobj
561 -.Xc
562 -Extend the lease for
563 -.Sy DHCP
564 -addresses.
565 -It also restarts duplicate address detection for
566 -.Cm static
567 -addresses.
568 -.Bl -tag -width Ds
569 -.It Fl i Ns \&, Ns Fl -inform
570 -Obtain network configuration from DHCP without taking a lease on the address.
571 -.El
572 -.It Xo
573 -.Nm
574 589 .Ic delete-addr
575 590 .Op Fl r
576 591 .Ar addrobj
577 592 .Xc
578 593 Delete the given address.
579 594 .Bl -tag -width Ds
580 595 .It Fl r Ns \&, Ns Fl -release
581 596 Indicate that the DHCP-assigned address should be released.
582 597 .El
583 598 .It Xo
584 599 .Nm
585 600 .Ic show-addr
586 601 .Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
587 602 .Op Ar addrobj
588 603 .Xc
589 604 Show the current address properties.
590 605 .Bl -tag -width Ds
591 606 .It Fl o Ns \&, Ns Fl -output
592 607 Select which fields will be shown.
593 608 The field value can be one of the following names:
594 609 .Bl -tag -compact -width "PERSISTENT"
595 610 .It Cm ALL
596 611 Display all fields.
597 612 .It Cm ADDROBJ
598 613 The name of the address.
599 614 .It Cm TYPE
600 615 The type of the address
601 616 .Pq Sy static Ns / Ns Sy dhcp Ns / Ns Sy addrconf .
602 617 .It Cm STATE
603 618 The state of the address.
604 619 It can be one of the following values:
|
↓ open down ↓ |
21 lines elided |
↑ open up ↑ |
605 620 .Bl -tag -compact -width "inaccessible"
606 621 .It Sy disabled
607 622 see the
608 623 .Nm ipadm Ic disable-addr
609 624 subcommand
610 625 .It Sy down
611 626 see the
612 627 .Nm ipadm Ic down-addr
613 628 subcommand
614 629 .It Sy duplicate
615 -the address is a duplicate
630 +the address is duplicate
616 631 .It Sy inaccessible
617 632 the interface for this address has failed
618 633 .It Sy ok
619 634 the address is up
620 635 .It Sy tentative
621 636 duplicate address detection in progress
622 637 .El
623 638 .It Cm CURRENT
624 639 A set of single character flags indicating the following:
625 640 .Bl -tag -compact -width "U"
626 641 .It Sy U
627 642 up
628 643 .It Sy u
629 644 unnumbered
630 645 .Pq matches another local address
631 646 .It Sy p
632 647 private, not advertised to routing
633 648 .It Sy t
634 649 temporary IPv6 address
635 650 .It Sy d
636 651 deprecated
637 652 .Pq not used for outgoing packets
638 653 .El
639 654 .It Cm PERSISTENT
640 655 A set of single character flags showing the configuration which will be used
641 656 when the address is enabled.
642 657 .Bl -tag -compact -width "U"
643 658 .It Sy U
644 659 up
|
↓ open down ↓ |
19 lines elided |
↑ open up ↑ |
645 660 .It Sy p
646 661 private, not advertised to routing
647 662 .It Sy d
648 663 deprecated
649 664 .Pq not used for outgoing packets
650 665 .El
651 666 .It Cm ADDR
652 667 The address.
653 668 .El
654 669 .It Fl p Ns \&, Ns Fl -parsable
655 -Print the output in a parsable format.
670 +Print the output in parsable format.
656 671 .El
657 672 .It Xo
658 673 .Nm
674 +.Ic refresh-addr
675 +.Op Fl i
676 +.Ar addrobj
677 +.Xc
678 +Extend the lease for
679 +.Sy DHCP
680 +addresses.
681 +It also restarts duplicate address detection for
682 +.Cm static
683 +addresses.
684 +.Bl -tag -width ""
685 +.It Fl i Ns \&, Ns Fl -inform
686 +Obtain network configuration from DHCP without taking a lease on the address.
687 +.El
688 +.It Xo
689 +.Nm
690 +.Ic down-addr
691 +.Op Fl t
692 +.Ar addrobj
693 +.Xc
694 +Down the address.
695 +This will stop packets from being sent or received.
696 +.Bl -tag -width ""
697 +.It Fl t Ns \&, Ns Fl -temporary
698 +Temporary, not persistent across reboots.
699 +.El
700 +.It Xo
701 +.Nm
702 +.Ic up-addr
703 +.Op Fl t
704 +.Ar addrobj
705 +.Xc
706 +Up the address.
707 +This will enable packets to be sent and received.
708 +.Bl -tag -width ""
709 +.It Fl t Ns \&, Ns Fl -temporary
710 +Temporary, not persistent across reboots.
711 +.El
712 +.It Xo
713 +.Nm
714 +.Ic disable-addr
715 +.Op Fl t
716 +.Ar addrobj
717 +.Xc
718 +Disable the address.
719 +.Bl -tag -width ""
720 +.It Fl t Ns \&, Ns Fl -temporary
721 +Temporary, not persistent across reboots.
722 +.El
723 +.It Xo
724 +.Nm
725 +.Ic enable-addr
726 +.Op Fl t
727 +.Ar addrobj
728 +.Xc
729 +Enable the address.
730 +.Bl -tag -width ""
731 +.It Fl t Ns \&, Ns Fl -temporary
732 +Temporary, not persistent across reboots.
733 +.El
734 +.It Xo
735 +.Nm
659 736 .Ic set-addrprop
660 737 .Op Fl t
661 738 .Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
662 739 .Ar addrobj
663 740 .Xc
664 741 Set a property's value(s) on the addrobj.
665 742 .Bl -tag -width Ds
666 743 .It Fl p Ns \&, Ns Fl -prop
667 744 Specify the property name and value(s).
668 745 The property name can be one of the following:
669 746 .Bl -tag -compact -width "deprecated"
670 747 .It Cm broadcast
671 748 The broadcast address (read-only).
672 749 .It Cm deprecated
673 750 The address should not be used to send packets but can still receive packets
674 751 .Pq Cm on Ns / Ns Cm off .
675 752 .It Cm prefixlen
676 753 The number of bits in the IPv4 netmask or IPv6 prefix.
677 754 .It Cm primary
678 755 The DHCP primary interface flag (read-only).
679 756 .It Cm private
680 757 The address is not advertised to routing
681 758 .Pq Cm on Ns / Ns Cm off .
682 759 .It Cm reqhost
683 760 The host name to send to the DHCP server in order to request an association
684 761 of the FQDN to the interface.
685 762 For a primary DHCP interface,
686 763 .Xr nodename 4
687 764 is sent if this property is not defined.
688 765 See the
689 766 .Nm
690 767 .Ic create-addr
691 768 .Fl T Cm dhcp
692 769 subcommand for the explanation of how an FQDN is determined.
693 770 .It Cm transmit
694 771 Packets can be transmitted
695 772 .Pq Cm on Ns / Ns Cm off .
696 773 .It Cm zone
697 774 The zone the addrobj is in (temporary-only--use
698 775 .Xr zonecfg 1M
699 776 to make persistent).
700 777 .El
701 778 .It Fl t Ns \&, Ns Fl -temporary
702 779 Temporary, not persistent across reboots.
703 780 .El
704 781 .It Xo
705 782 .Nm
706 783 .Ic reset-addrprop
707 784 .Op Fl t
708 785 .Fl p Ar prop
709 786 .Ar addrobj
710 787 .Xc
711 788 Reset the addrobj's property value to the default.
712 789 .Bl -tag -width Ds
713 790 .It Fl p Ns \&, Ns Fl -prop
714 791 Specify the property name.
715 792 See the
716 793 .Nm ipadm Ic set-addrprop
717 794 subcommand for the list of property names.
718 795 .It Fl t Ns \&, Ns Fl -temporary
719 796 Temporary, not persistent across reboots.
720 797 .El
|
↓ open down ↓ |
52 lines elided |
↑ open up ↑ |
721 798 .It Xo
722 799 .Nm
723 800 .Ic show-addrprop
724 801 .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
725 802 .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
726 803 .Op Ar addrobj
727 804 .Xc
728 805 Display the property values for one or all of the addrobjs.
729 806 .Bl -tag -width Ds
730 807 .It Fl c Ns \&, Ns Fl -parsable
731 -Print the output in a parsable format.
808 +Print the output in parsable format.
732 809 .It Fl o Ns \&, Ns Fl -output
733 810 Select which fields will be shown.
734 811 The field value can be one of the following names:
735 812 .Bl -tag -compact -width "PERSISTENT"
736 813 .It Cm ALL
737 814 Display all fields.
738 815 .It Cm ADDROBJ
739 816 The name of the addrobj.
740 817 .It Cm PROPERTY
741 818 The name of the property.
742 819 .It Cm PERM
743 820 If the property is readable
744 821 .Pq Qq r
745 822 and/or writable
746 823 .Pq Qq w .
747 824 .It Cm CURRENT
748 825 The value of the property.
749 826 .It Cm PERSISTENT
750 827 The persistent value of the property.
751 828 .It Cm DEFAULT
752 829 The default value of the property.
|
↓ open down ↓ |
11 lines elided |
↑ open up ↑ |
753 830 .It Cm POSSIBLE
754 831 The possible values for the property.
755 832 .El
756 833 .It Fl p Ns \&, Ns Fl -prop
757 834 Specify which properties to display.
758 835 See the
759 836 .Nm ipadm Ic set-addrprop
760 837 subcommand for the list of property names.
761 838 .El
762 839 .It Xo
840 +.Nm
763 841 .Ic set-prop
764 842 .Op Fl t
765 843 .Fl p Ar prop Ns Oo Cm + Ns | Ns Cm - Oc Ns = Ns
766 844 .Ar value Ns Oo , Ns Ar value Oc Ns ...
767 845 .Ar protocol
768 846 .Xc
769 847 Set a property's value(s) on the protocol.
770 848 .Bl -tag -width Ds
771 849 .It Fl p Ns \&, Ns Fl -prop
772 850 Specify the property name and value(s).
773 851 The optional
774 852 .Sy + Ns | Ns Sy -
775 853 syntax can be used to add/remove values from the current list of values on the
776 854 property.
777 855 The property name can be one of the following:
778 856 .Bl -tag -compact -width "smallest_nonpriv_port"
779 857 .It Cm ecn
780 858 Explicit congestion control
781 859 .Pq Cm never Ns / Ns Cm passive Ns / Ns Cm active
782 860 .Pq TCP .
783 861 .It Cm extra_priv_ports
784 862 Additional privileged ports
785 863 .Pq SCTP/TCP/UDP .
786 864 .It Cm forwarding
787 865 Packet forwarding
788 866 .Pq Cm on Ns / Ns Cm off .
789 867 .It Cm hoplimit
790 868 The IPv6 hoplimit.
791 869 .It Cm largest_anon_port
792 870 Largest ephemeral port
793 871 .Pq SCTP/TCP/UDP .
794 872 .It Cm max_buf
795 873 Maximum receive or send buffer size
796 874 .Pq ICMP/SCTP/TCP/UDP .
797 875 This also sets the upper limit for the
798 876 .Cm recv_buf
799 877 and
800 878 .Cm send_buf
801 879 properties.
802 880 .It Cm recv_buf
803 881 Default receive buffer size
804 882 .Pq ICMP/SCTP/TCP/UDP .
805 883 The maximum value for this property is controlled by the
806 884 .Cm max_buf
807 885 property.
808 886 .It Cm sack
809 887 Selective acknowledgement
810 888 .Pq Cm active Ns / Ns Cm passive Ns / Ns Cm never
811 889 .Pq TCP .
812 890 .It Cm send_buf
813 891 Default send buffer size
814 892 .Pq ICMP/SCTP/TCP/UDP .
815 893 The maximum value for this property is controlled by the
816 894 .Cm max_buf
817 895 property.
818 896 .It Cm smallest_anon_port
819 897 Smallest ephemeral port
820 898 .Pq SCTP/TCP/UDP .
821 899 .It Cm smallest_nonpriv_port
822 900 Smallest non-privileged port
823 901 .Pq SCTP/TCP/UDP .
824 902 .It Cm ttl
825 903 The IPv4 time-to-live.
826 904 .El
827 905 .It Fl t Ns \&, Ns Fl -temporary
828 906 Temporary, not persistent across reboots.
829 907 .El
830 908 .It Xo
831 909 .Nm
832 910 .Ic reset-prop
833 911 .Op Fl t
834 912 .Fl p Ar prop
835 913 .Ar protocol
836 914 .Xc
837 915 Reset a protocol's property value to the default.
838 916 .Bl -tag -width Ds
839 917 .It Fl p Ns \&, Ns Fl -prop
840 918 Specify the property name.
841 919 See the
842 920 .Nm ipadm Ic set-prop
843 921 subcommand for the list of property names.
844 922 .It Fl t Ns \&, Ns Fl -temporary
845 923 Temporary, not persistent across reboots.
846 924 .El
|
↓ open down ↓ |
74 lines elided |
↑ open up ↑ |
847 925 .It Xo
848 926 .Nm
849 927 .Ic show-prop
850 928 .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
851 929 .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
852 930 .Op Ar protocol
853 931 .Xc
854 932 Display the property values for one or all of the protocols.
855 933 .Bl -tag -width Ds
856 934 .It Fl c Ns \&, Ns Fl -parsable
857 -Print the output in a parsable format.
935 +Print the output in parsable format.
858 936 .It Fl o Ns \&, Ns Fl -output
859 937 Select which fields will be shown.
860 938 The field value can be one of the following names:
861 939 .Bl -tag -compact -width "PERSISTENT"
862 940 .It Cm ALL
863 941 Display all fields.
864 942 .It Cm PROTO
865 943 The name of the protocol.
866 944 .It Cm PROPERTY
867 945 The name of the property.
868 946 .It Cm PERM
869 947 If the property is readable
870 948 .Pq Qq r
871 949 and/or writable
872 950 .Pq Qq w .
873 951 .It Cm CURRENT
874 952 The value of the property.
875 953 .It Cm PERSISTENT
876 954 The persistent value of the property.
877 955 .It Cm DEFAULT
878 956 The default value of the property.
879 957 .It Cm POSSIBLE
880 958 The possible values for the property.
881 959 .El
882 960 .It Fl p Ns \&, Ns Fl -prop
883 961 Specify which properties to display.
884 962 See the
885 963 .Nm ipadm Ic set-prop
886 964 subcommand for the list of property names.
887 965 .El
888 966 .El
889 967 .Sh SEE ALSO
890 968 .Xr arp 1M ,
891 969 .Xr cfgadm 1M ,
892 970 .Xr dhcpagent 1M ,
893 971 .Xr dladm 1M ,
894 972 .Xr if_mpadm 1M ,
895 973 .Xr ifconfig 1M ,
896 974 .Xr ndd 1M ,
897 975 .Xr zonecfg 1M ,
898 976 .Xr nodename 4 ,
899 977 .Xr nsswitch.conf 4 ,
900 978 .Xr dhcp 5
|
↓ open down ↓ |
33 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX