1 '\" te
2 .\" Copyright (c) 2012, Joyent, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH IPADM 1M "May 14, 2012"
7 .SH NAME
8 ipadm \- configure IP network interfaces and protocol properties.
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBipadm\fR create-if [\fB-t\fR] \fIinterface\fR
13 .fi
14
15 .LP
16 .nf
17 \fBipadm\fR disable-if \fB-t\fR \fIinterface\fR
18 .fi
19
20 .LP
21 .nf
22 \fBipadm\fR enable-if \fB-t\fR \fIinterface\fR
23 .fi
24
25 .LP
26 .nf
27 \fBipadm\fR delete-if \fIinterface\fR
28 .fi
29
30 .LP
31 .nf
32 \fBipadm\fR show-if [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIinterface\fR]
33 .fi
34
35 .LP
36 .nf
37 \fBipadm\fR set-ifprop [\fB-t\fR] \fB-p\fR \fIprop\fR=<\fIvalue\fR[,...]> \fB-m\fR \fIprotocol\fR \fIinterface\fR
38 .fi
39
40 .LP
41 .nf
42 \fBipadm\fR reset-ifprop [\fB-t\fR] \fB-p\fR \fIprop\fR \fB-m\fR \fIprotocol\fR \fIinterface\fR
43 .fi
44
45 .LP
46 .nf
47 \fBipadm\fR show-ifprop [[\fB-c\fR]\fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR,...] [\fB-m\fR \fIprotocol\fR]
48 [\fIinterface\fR]
49 .fi
50
51 .LP
52 .nf
53 \fBipadm\fR create-addr [\fB-t\fR] \fB-T\fR static [\fB-d\fR]
54 \fB-a\fR {local|remote}=\fIaddr\fR[/\fIprefixlen\fR],... \fIaddrobj\fR
55 .fi
56
57 .LP
58 .nf
59 \fBipadm\fR create-addr [\fB-t\fR] \fB-T\fR dhcp [\fB-w\fR \fIseconds\fR | forever ] \fIaddrobj\fR
60 .fi
61
62 .LP
63 .nf
64 \fBipadm\fR create-addr [\fB-t\fR] \fB-T\fR addrconf [\fB-i\fR \fIinterface-id\fR]
65 [\fB-p\fR {stateful|stateless}={yes|no},..] \fIaddrobj\fR
66 .fi
67
68 .LP
69 .nf
70 \fBipadm\fR down-addr [\fB-t\fR] \fIaddrobj\fR
71 .fi
72
73 .LP
74 .nf
75 \fBipadm\fR up-addr [\fB-t\fR] \fIaddrobj\fR
76 .fi
77
78 .LP
79 .nf
80 \fBipadm\fR disable-addr \fB-t\fR \fIaddrobj\fR
81 .fi
82
83 .LP
84 .nf
85 \fBipadm\fR enable-addr \fB-t\fR \fIaddrobj\fR
86 .fi
87
88 .LP
89 .nf
90 \fBipadm\fR refresh-addr [\fB-i\fR] \fIaddrobj\fR
91 .fi
92
93 .LP
94 .nf
95 \fBipadm\fR delete-addr [\fB-r\fR] \fIaddrobj\fR
96 .fi
97
98 .LP
99 .nf
100 \fBipadm\fR show-addr [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIaddrobj\fR]
101 .fi
102
103 .LP
104 .nf
105 \fBipadm\fR set-addrprop [\fB-t\fR] \fB-p\fR \fIprop\fR=<\fIvalue\fR[,...]> \fIaddrobj\fR
106 .fi
107
108 .LP
109 .nf
110 \fBipadm\fR reset-addrprop [\fB-t\fR] \fB-p\fR \fIprop\fR=<\fIvalue\fR[,...]> \fIaddrobj\fR
111 .fi
112
113 .LP
114 .nf
115 \fBipadm\fR show-addrprop [[\fB-c\fR] \fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR,...] [\fIaddrobj\fR]
116 .fi
117
118 .LP
119 .nf
120 \fBipadm\fR set-prop [\fB-t\fR] \fB-p\fR \fIprop\fR[+|-]=<\fIvalue\fR[,...]> \fIprotocol\fR
121 .fi
122
123 .LP
124 .nf
125 \fBipadm\fR reset-prop [\fB-t\fR] \fB-p\fR \fIprop\fR \fIprotocol\fR
126 .fi
127
128 .LP
129 .nf
130 \fBipadm\fR show-prop [[\fB-c\fR] \fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR[,...]] [\fIprotocol\fR]
131 .fi
132
133 .SH DESCRIPTION
134 .sp
135 .LP
136
137 The \fBipadm\fR command is a stable replacement for the \fBifconfig\fR(1M) and
138 \fBndd\fR(1M) commands. It is used to create IP interfaces and to confgure IP
139 addresses on those interfaces. It is also used to get, set or reset properties
140 on interfaces, addresses and protocols.
141 .LP
142 For subcommands that take an \fIaddrobj\fR, the \fIaddrobj\fR specifies a
143 unique address on the system. It is made up of two parts, delimited by a '/'.
144 The first part is the name of the interface and the second part is a string up
145 to 32 characters long. For example, "lo0/v4" is a loopback interface
146 addrobj name.
147 .LP
148 For subcommands that take a \fIprotocol\fR, this can be one of
149 the following values: ip, ipv4, ipv6, icmp, tcp, sctp or udp.
150
151 .SH SUBCOMMANDS
152 .sp
153 .LP
154 The following subcommands are supported:
155 .sp
156 .ne 2
157 .na
158 \fB\fBcreate-if\fR [\fB-t\fR] \fIinterface\fR\fR
159 .ad
160 .sp .6
161 .RS 4n
162 The \fBcreate-if\fR subcommand is used to create an IP interface that will
163 handle both IPv4 and IPv6 packets. The interface will be enabled as part of
164 the creation process. The IPv4 interface will have the address 0.0.0.0.
165 The IPv6 interface will have the adress ::.
166 .sp
167 The \fB-t\fR option (also \fB--temporary\fR) means
168 that the creation is temporary and will not be persistent across reboots.
169 .sp
170
171 .RE
172
173 .sp
174 .ne 2
175 .na
176 \fB\fBdisable-if\fR \fB-t\fR \fIinterface\fR\fR
177 .ad
178 .sp .6
179 .RS 4n
180 The \fBdisable-if\fR subcommand is used to disable an IP interface.
181 .sp
182 The \fB-t\fR option (also \fB--temporary\fR) means
183 that the disable is temporary and will not be persistent across reboots.
184 .sp
185
186 .RE
187
188 .sp
189 .ne 2
190 .na
191 \fB\fBenable-if\fR \fB-t\fR \fIinterface\fR\fR
192 .ad
193 .sp .6
194 .RS 4n
195 The \fBenable-if\fR subcommand is used to enable an IP interface.
196 .sp
197 The \fB-t\fR option (also \fB--temporary\fR) means
198 that the enable is temporary and will not be persistent across reboots.
199 .sp
200
201 .RE
202
203 .sp
204 .ne 2
205 .na
206 \fB\fbdelete-if\fR \fIinterface\fR\fR
207 .ad
208 .sp .6
209 .RS 4n
210 The \fBdelete-if\fR subcommand is used to permanently delete an IP interface.
211 .sp
212
213 .RE
214
215 .sp
216 .ne 2
217 .na
218 \fB\fBshow-if\fR [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIinterface\fR]\fR
219 .ad
220 .sp .6
221 .RS 4n
222 The \fBshow-if\fR subcommand is used to show the current IP interface
223 configuration.
224 .sp
225 The \fB-p\fR option (also \fB--parsable\fR) prints
226 the output in a parsable format.
227 .sp
228 The \fB-o\fR option (also \fB--output\fR) is used
229 to select which fields will be shown. The field value can be one of the
230 following names:
231 .sp
232 .ne 2
233 .na
234 .RS 4n
235 \fBALL\fR
236 .ad
237 .RS 4n
238 Display all fields
239 .RE
240
241 .sp
242 .ne 2
243 .na
244 \fBIFNAME\fR
245 .ad
246 .RS 4n
247 The name of the interface
248 .RE
249
250 .sp
251 .ne 2
252 .na
253 \fBSTATE\fR
254 .ad
255 .RS 4n
256 The state can be one of the following values:
257 .sp
258 .ne 2
259 .na
260 .RS 4n
261 ok - resources for the interface have been allocated
262 .sp
263 offline - the interface is offline
264 .sp
265 failed - the interface's datalink is down
266 .sp
267 down - the interface is down
268 .sp
269 disabled - the interface is disabled
270 .RE
271 .RE
272
273 .sp
274 .ne 2
275 .na
276 \fBCURRENT\fR
277 .ad
278 .RS 4n
279 A set of single character flags indicating the following:
280 .sp
281 .ne 2
282 .na
283 .RS 4n
284 b - broadcast (mutually exclusive with 'p')
285 .br
286 m - multicast
287 .br
288 p - point-to-point (mutually exclusive with 'b')
289 .br
290 v - virtual interface
291 .br
292 I - IPMP
293 .br
294 s - IPMP standby
295 .br
296 i - IPMP inactive
297 .br
298 V - VRRP
299 .br
300 a - VRRP accept mode
301 .br
302 4 - IPv4
303 .br
304 6 - IPv6
305 .RE
306 .RE
307
308 .sp
309 .ne 2
310 .na
311 \fBPERSISTENT\fR
312 .ad
313 .RS 4n
314 A set of single character flags showing what configuration will be used the
315 next time the interface is enabled:
316 .sp
317 .ne 2
318 .na
319 .RS 4n
320 s - IPMP standby
321 .br
322 4 - IPv4
323 .br
324 6 - IPv6
325 .RE
326 .RE
327 .RE
328
329 .RE
330
331 .sp
332 .ne 2
333 .na
334 \fB\fBset-ifprop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR=<\fIvalue\fR[,...]> \fB-m\fR \fIprotocol\fR \fIinterface\fR\fR
335 .ad
336 .sp .6
337 .RS 4n
338 The \fBset-ifprop\fR subcommand is used to set a property's value(s) on the IP
339 interface.
340 .sp
341 The \fB-t\fR option (also \fB--temporary\fR) means
342 that the setting is temporary and will not be persistent across reboots.
343 .sp
344 The \fB-p\fR option (also \fB--prop\fR) specifies the property name and
345 value(s). The property name can be one of the following:
346 .sp
347 .ne 2
348 .na
349
350 .RS 4n
351
352 \fBarp\fR
353 .ad
354 .RS 4n
355 Enables ("on") or disables ("off") ARP.
356 .RE
357
358 .sp
359 .ne 2
360 .na
361 \fBexchange_routes\fR
362 .ad
363 .RS 4n
364 Enables ("on") or disables ("off") the exchange of routing data.
365 .RE
366
367 .sp
368 .ne 2
369 .na
370 \fBforwarding\fR
371 .ad
372 .RS 4n
373 Enables ("on") or disables ("off") IP forwarding.
374 .RE
375
376 .sp
377 .ne 2
378 .na
379 \fBmetric\fR
380 .ad
381 .RS 4n
382 Set the routing metric to the numeric value. The value is treated as extra
383 hops to the destination.
384 .RE
385
386 .sp
387 .ne 2
388 .na
389 \fBmtu\fR
390 .ad
391 .RS 4n
392 Set the maximum transmission unit to the numeric value.
393 .RE
394
395 .sp
396 .ne 2
397 .na
398 \fBnud\fR
399 .ad
400 .RS 4n
401 Enables ("on") or disables ("off") neighbor unreachability detection.
402 .RE
403
404 .sp
405 .ne 2
406 .na
407 \fBusesrc\fR
408 .ad
409 .RS 4n
410 Indicates which interface to use for source address selection. A value
411 "none" may also be used.
412 .RE
413 .RE
414
415 .sp
416 The \fB-m\fR option (also \fB--module\fR) specifies which protocol
417 the setting applies to.
418 .sp
419
420 .RE
421 .RE
422
423 .sp
424 .ne 2
425 .na
426 \fB\fBreset-ifprop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR \fB-m\fR \fIprotocol\fR \fIinterface\fR\fR
427 .ad
428 .sp .6
429 .RS 4n
430 The \fBreset-ifprop\fR subcommand is used to reset an IP interface's property
431 value to the default.
432 .sp
433 The \fB-t\fR option (also \fB--temporary\fR) means
434 that the disable is temporary and will not be persistent across reboots.
435 .sp
436 The \fB-p\fR option (also \fB--prop\fR) specifies the property name.
437 See the \fBset-ifprop\fR subcommand for the list of property names.
438 .sp
439 The \fB-m\fR option (also \fB--module\fR) specifies which protocol
440 the setting applies to.
441 .sp
442
443 .RE
444
445 .sp
446 .ne 2
447 .na
448 \fB\fBshow-ifprop\fR [[\fB-c\fR]\fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR,...] [\fB-m\fR \fIprotocol\fR]
449 [\fIinterface\fR]\fR
450 .ad
451 .sp .6
452 .RS 4n
453 The \fBshow-ifprop\fR subcommand is used to display the property values
454 for one or all of the IP interfaces.
455 .sp
456 The \fB-c\fR option (also \fB--parsable\fR) prints
457 the output in a parsable format.
458 .sp
459 The \fB-o\fR option (also \fB--output\fR) is used
460 to select which fields will be shown. The field value can be one of the
461 following names:
462 .sp
463 .ne 2
464 .na
465 .RS 4n
466 \fBALL\fR
467 .ad
468 .RS 4n
469 Display all fields
470 .RE
471
472 .sp
473 .ne 2
474 .na
475 \fBIFNAME\fR
476 .ad
477 .RS 4n
478 The name of the interface
479 .RE
480
481 .sp
482 .ne 2
483 .na
484 \fBPROPERTY\fR
485 .ad
486 .RS 4n
487 The name of the property
488 .RE
489
490 .sp
491 .ne 2
492 .na
493 \fBPROTO\fR
494 .ad
495 .RS 4n
496 The name of the protocol
497 .RE
498
499 .sp
500 .ne 2
501 .na
502 \fBPERM\fR
503 .ad
504 .RS 4n
505 If the property is readable ("r") and/or writable ("w").
506 .RE
507
508 .sp
509 .ne 2
510 .na
511 \fBCURRENT\fR
512 .ad
513 .RS 4n
514 The value of the property
515 .RE
516
517 .sp
518 .ne 2
519 .na
520 \fBPERSISTENT\fR
521 .ad
522 .RS 4n
523 The persistent value of the property
524 .RE
525
526 .sp
527 .ne 2
528 .na
529 \fBDEFAULT\fR
530 .ad
531 .RS 4n
532 The default value of the property
533 .RE
534
535 .sp
536 .ne 2
537 .na
538 \fBPOSSIBLE\fR
539 .ad
540 .RS 4n
541 The possible values for the property
542 .RE
543 .RE
544
545 .sp
546 The \fB-p\fR option (also \fB--prop\fR) is used
547 to specify which properties to display. See the \fBset-ifprop\fR
548 subcommand for the list of property names.
549 .sp
550 The \fB-m\fR option (also \fB--module\fR) specifies which protocol
551 to display.
552 .sp
553
554 .RE
555
556 .sp
557 .ne 2
558 .na
559 \fB\fBcreate-addr\fR [\fB-t\fR] \fB-T\fR static [\fB-d\fR] \\
560 \fB-a\fR {local|remote}=\fIaddr\fR[/\fIprefixlen\fR],... \fIaddrobj\fR\fR
561 .br
562 \fB\fBcreate-addr\fR [\fB-t\fR] \fB-T\fR dhcp [\fB-w\fR \fIseconds\fR | forever ] \fIaddrobj\fR\fR
563 .br
564 \fB\fBcreate-addr\fR [\fB-t\fR] \fB-T\fR addrconf [\fB-i\fR \fIinterface-id\fR] \\
565 [\fB-p\fR {stateful|stateless}={yes|no},..] \fIaddrobj\fR\fR
566 .ad
567 .sp .6
568 .RS 4n
569 The \fBcreate-addr\fR subcommand is used to set an address on an IP interface.
570 The address will be enabled but can disabled using the \fBdisable-addr\fR
571 subcommand. This subcommand has three different forms, depending on the
572 value of the \fB-T\fR option.
573 .sp
574 The \fB-t\fR option (also \fB--temporary\fR) means
575 that the address is temporary and will not be persistent across reboots.
576 .sp
577 The \fB-T\fR static option creates a static addrobj. This takes the following
578 options:
579 .RS 4n
580
581 The \fB-d\fR option (also \fB--down\fR) means the address is down.
582 .sp
583 The \fB-a\fR option (also \fB--address\fR) specifies the address.
584 The "local" or "remote" prefix can be used for a point-to-point interface.
585 In this case, both addresses must be given.
586 Otherwise, the equal sign ("=") should be omitted and the address should be
587 provided by itself and with no second address.
588 .sp
589
590 .RE
591
592 The \fB-T\fR dhcp option causes the address to be obtained via DHCP.
593 This takes the following options:
594 .RS 4n
595
596 The \fB-w\fR option (also \fB--wait\fR) gives the time, in seconds,
597 that the command should wait to obtain an address.
598 .sp
599
600 .RE
601
602 The \fB-T\fR addrconf option creates an auto-configured address.
603 This takes the following options:
604 .RS 4n
605
606 The \fB-i\fR option (also \fB--interface-id\fR) gives the interface ID to
607 be used.
608 .sp
609 The \fB-p\fR option (also \fB--prop\fR) indicates which method of
610 auto-configuration should be used.
611 .sp
612
613 .RE
614 .RE
615
616 .sp
617 .ne 2
618 .na
619 \fB\fBdown-addr\fR [\fB-t\fR] \fIaddrobj\fR\fR
620 .ad
621 .sp .6
622 .RS 4n
623 The \fBdown-addr\fR subcommand is used to down the address. This will
624 stop packets from being sent or received.
625 .sp
626 The \fB-t\fR option (also \fB--temporary\fR) means
627 that the down is temporary and will not be persistent across reboots.
628 .sp
629
630 .RE
631
632 .sp
633 .ne 2
634 .na
635 \fB\fBup-addr\fR [\fB-t\fR] \fIaddrobj\fR\fR
636 .ad
637 .sp .6
638 .RS 4n
639 The \fBup-addr\fR subcommand is used to up the address. This will
640 enable packets to be sent and received.
641 .sp
642 The \fB-t\fR option (also \fB--temporary\fR) means
643 that the up is temporary and will not be persistent across reboots.
644 .sp
645
646 .RE
647
648 .sp
649 .ne 2
650 .na
651 \fB\fBdisable-addr\fR \fB-t\fR \fIaddrobj\fR\fR
652 .ad
653 .sp .6
654 .RS 4n
655 The \fBdisable-addr\fR subcommand is used to disable the address.
656 .sp
657 The \fB-t\fR option (also \fB--temporary\fR) means
658 that the disable is temporary and will not be persistent across reboots.
659 .sp
660
661 .RE
662
663 .sp
664 .ne 2
665 .na
666 \fB\fBenable-addr\fR \fB-t\fR \fIaddrobj\fR\fR
667 .ad
668 .sp .6
669 .RS 4n
670 The \fBenable-addr\fR subcommand is used to enable the address.
671 .sp
672 The \fB-t\fR option (also \fB--temporary\fR) means
673 that the disable is temporary and will not be persistent across reboots.
674 .sp
675
676 .RE
677
678 .sp
679 .ne 2
680 .na
681 \fB\fBrefresh-addr\fR [\fB-i\fR] \fIaddrobj\fR\fR
682 .ad
683 .sp .6
684 .RS 4n
685 The \fBrefresh-addr\fR subcommand is used to extend the lease for DHCP
686 addresses. It also restarts duplicate address detection for Static addresses.
687 .sp
688 The \fB-i\fR option (also \fB--inform\fR) means
689 that the network configuration will be obtained from DHCP without taking
690 a lease on the address.
691 .sp
692
693 .RE
694
695 .sp
696 .ne 2
697 .na
698 \fB\fBdelete-addr\fR [\fB-r\fR] \fIaddrobj\fR\fR
699 .ad
700 .sp .6
701 .RS 4n
702 The \fBdelete-addr\fR subcommand deletes the given address.
703 .sp
704 The \fB-r\fR option (also \fB--release\fR) is used for DHCP-assigned
705 addresses to indicate that the address should be released.
706 .sp
707
708 .RE
709
710 .sp
711 .ne 2
712 .na
713 \fB\fBshow-addr\fR [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIaddrobj\fR]\fR
714 .ad
715 .sp .6
716 .RS 4n
717 The \fBshow-addr\fR subcommand is used to show the current address properties.
718 .sp
719 The \fB-p\fR option (also \fB--parsable\fR) prints
720 the output in a parsable format.
721 .sp
722 The \fB-o\fR option (also \fB--output\fR) is used
723 to select which fields will be shown. The field value can be one of the
724 following names:
725 .sp
726 .ne 2
727 .na
728 .RS 4n
729 \fBALL\fR
730 .ad
731 .RS 4n
732 Display all fields
733 .RE
734
735 .sp
736 .ne 2
737 .na
738 \fBADDROBJ\fR
739 .ad
740 .RS 4n
741 The name of the address
742 .RE
743
744 .sp
745 .ne 2
746 .na
747 \fBTYPE\fR
748 .ad
749 .RS 4n
750 The type of the address. It can be "static", "dhcp" or "addrconf".
751 .RE
752
753 .sp
754 .ne 2
755 .na
756 \fBSTATE\fR
757 .ad
758 .RS 4n
759 The state of the address. It can be one of the following values:
760 .sp
761 .ne 2
762 .na
763 .RS 4n
764 disabled s see the \fBdisable-addr\fR subcommand
765 .sp
766 down - see the \fBdown-addr\fR subcommand
767 .sp
768 duplicate - the address is a duplicate
769 .sp
770 inaccessible - the interface for this address has failed
771 .sp
772 ok - the address is up
773 .sp
774 tentative - duplicate address detection in progress
775 .RE
776 .RE
777
778 .sp
779 .ne 2
780 .na
781 \fBCURRENT\fR
782 .ad
783 .RS 4n
784 A set of single character flags indicating the following:
785 .sp
786 .ne 2
787 .na
788 .RS 4n
789 U - up
790 .br
791 u - unnumbered (matches another local address)
792 .br
793 p - private, not advertised to routing
794 .br
795 t - temporary IPv6 address
796 .br
797 d - deprecated (not used for outgoing packets)
798 .RE
799 .RE
800
801 .sp
802 .ne 2
803 .na
804 \fBPERSISTENT\fR
805 .ad
806 .RS 4n
807 A set of single character flags showing the configuration which will be used
808 when the address is enabled.
809 .sp
810 .ne 2
811 .na
812 .RS 4n
813 U - up
814 .br
815 p - private, not advertised to routing
816 .br
817 d - deprecated (not used for outgoing packets)
818 .RE
819 .RE
820
821 .sp
822 .ne 2
823 .na
824 \fBADDR\fR
825 .ad
826 .RS 4n
827 The address
828 .RE
829 .RE
830
831 .RE
832
833 .sp
834 .ne 2
835 .na
836 \fB\fBset-addrprop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR=<\fIvalue\fR[,...]> \fIaddrobj\fR
837 .ad
838 .sp .6
839 .RS 4n
840 The \fBset-addrprop\fR subcommand is used to set a property's value(s) on the
841 addrobj.
842 .sp
843 The \fB-t\fR option (also \fB--temporary\fR) means
844 that the setting is temporary and will not be persistent across reboots.
845 .sp
846 The \fB-p\fR option (also \fB--prop\fR) specifies the property name and
847 value(s). The property name can be one of the following:
848 .sp
849 .ne 2
850 .na
851
852 .RS 4n
853
854 \fBbroadcast\fR
855 .ad
856 .RS 4n
857 The broadcast address (read-only)
858 .RE
859
860 .sp
861 .ne 2
862 .na
863 \fBdeprecated\fR
864 .ad
865 .RS 4n
866 The address should not be used to send packets but can still receive packets.
867 Can be "on" or "off".
868 .RE
869
870 .sp
871 .ne 2
872 .na
873 \fBprefixlen\fR
874 .ad
875 .RS 4n
876 The number of bits in the IPv4 netmask or IPv6 prefix.
877 .RE
878
879 .sp
880 .ne 2
881 .na
882 \fBprivate\fR
883 .ad
884 .RS 4n
885 The address is not advertised to routing.
886 Can be "on" or "off".
887 .RE
888
889 .sp
890 .ne 2
891 .na
892 \fBtransmit\fR
893 .ad
894 .RS 4n
895 Packets can be transmitted.
896 Can be "on" or "off".
897 .RE
898
899 .sp
900 .ne 2
901 .na
902 \fBzone\fR
903 .ad
904 .RS 4n
905 The zone the addrobj is in.
906 .RE
907
908 .RE
909 .RE
910
911 .sp
912 .ne 2
913 .na
914 \fB\fBreset-addrprop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR \fIaddrobj\fR\fR
915 .ad
916 .sp .6
917 .RS 4n
918 The \fBreset-addrprop\fR subcommand is used to reset an addrobj's property
919 value to the default.
920 .sp
921 The \fB-t\fR option (also \fB--temporary\fR) means
922 that the disable is temporary and will not be persistent across reboots.
923 .sp
924 The \fB-p\fR option (also \fB--prop\fR) specifies the property name.
925 See the \fBset-addrprop\fR subcommand for the list of property names.
926 .sp
927
928 .RE
929
930 .sp
931 .ne 2
932 .na
933 \fB\fBshow-addrprop\fR [[\fB-c\fR]\fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR,...] \fIaddrobj\fR]
934 .ad
935 .sp .6
936 .RS 4n
937 The \fBshow-addrprop\fR subcommand is used to display the property values
938 for one or all of the addrobjs.
939 .sp
940 The \fB-c\fR option (also \fB--parsable\fR) prints
941 the output in a parsable format.
942 .sp
943 The \fB-o\fR option (also \fB--output\fR) is used
944 to select which fields will be shown. The field value can be one of the
945 following names:
946 .sp
947 .ne 2
948 .na
949 .RS 4n
950 \fBALL\fR
951 .ad
952 .RS 4n
953 Display all fields
954 .RE
955
956 .sp
957 .ne 2
958 .na
959 \fBADDROBJ\fR
960 .ad
961 .RS 4n
962 The name of the addrobj
963 .RE
964
965 .sp
966 .ne 2
967 .na
968 \fBPROPERTY\fR
969 .ad
970 .RS 4n
971 The name of the property
972 .RE
973
974 .sp
975 .ne 2
976 .na
977 \fBPERM\fR
978 .ad
979 .RS 4n
980 If the property is readable ("r") and/or writable ("w").
981 .RE
982
983 .sp
984 .ne 2
985 .na
986 \fBCURRENT\fR
987 .ad
988 .RS 4n
989 The value of the property
990 .RE
991
992 .sp
993 .ne 2
994 .na
995 \fBPERSISTENT\fR
996 .ad
997 .RS 4n
998 The persistent value of the property
999 .RE
1000
1001 .sp
1002 .ne 2
1003 .na
1004 \fBDEFAULT\fR
1005 .ad
1006 .RS 4n
1007 The default value of the property
1008 .RE
1009
1010 .sp
1011 .ne 2
1012 .na
1013 \fBPOSSIBLE\fR
1014 .ad
1015 .RS 4n
1016 The possible values for the property
1017 .RE
1018 .RE
1019
1020 .sp
1021 The \fB-p\fR option (also \fB--prop\fR) is used
1022 to specify which properties to display. See the \fBset-addrprop\fR
1023 subcommand for the list of property names.
1024 .sp
1025
1026 .RE
1027
1028 .sp
1029 .ne 2
1030 .na
1031 \fB\fBset-prop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR[+|-]=<\fIvalue\fR[,...]> \fIprotocol\fR
1032 .ad
1033 .sp .6
1034 .RS 4n
1035 The \fBset-prop\fR subcommand is used to set a property's value(s) on the
1036 protocol.
1037 .sp
1038 The \fB-t\fR option (also \fB--temporary\fR) means
1039 that the setting is temporary and will not be persistent across reboots.
1040 .sp
1041 The \fB-p\fR option (also \fB--prop\fR) specifies the property name and
1042 value(s). The optional [+|-] syntax can be used to add/remove values from the
1043 current list of values on the property.
1044 The property name can be one of the following:
1045 .sp
1046 .ne 2
1047 .na
1048
1049 .RS 4n
1050
1051 \fBecn\fR
1052 .ad
1053 .RS 4n
1054 Explicit congestion control (TCP-only)
1055 Can be "never", "passive" or "active".
1056 .RE
1057
1058 \fBextra_priv_ports\fR
1059 .ad
1060 .RS 4n
1061 Additional privileged ports (SCTP, TCP or UDP)
1062 .RE
1063
1064 \fBforwarding\fR
1065 .ad
1066 .RS 4n
1067 Packet forwarding is enabled.
1068 Can be "on" or "off".
1069 .RE
1070
1071 \fBhoplimit\fR
1072 .ad
1073 .RS 4n
1074 The IPv6 hoplimit.
1075 .RE
1076
1077 \fBlargest_anon_port\fR
1078 .ad
1079 .RS 4n
1080 Largest ephemeral port (SCTP, TCP or UDP)
1081 .RE
1082
1083 \fBrecv_maxbuf\fR
1084 .ad
1085 .RS 4n
1086 Receive buffer size (ICMP, SCTP, TCP or UDP)
1087 .RE
1088
1089 \fBsack\fR
1090 .ad
1091 .RS 4n
1092 Selective acknowledgement (TCP).
1093 Can be "active", "passive" or "never".
1094 .RE
1095
1096 \fBsend_maxbuf\fR
1097 .ad
1098 .RS 4n
1099 Send buffer size (ICMP, SCTP, TCP or UDP)
1100 .RE
1101
1102 \fBsmallest_anon_port\fR
1103 .ad
1104 .RS 4n
1105 Smallest ephemeral port (SCTP, TCP or UDP)
1106 .RE
1107
1108 \fBsmallest_nonpriv_port\fR
1109 .ad
1110 .RS 4n
1111 Smallest non-privileged port (SCTP, TCP or UDP)
1112 .RE
1113
1114 \fBttl\fR
1115 .ad
1116 .RS 4n
1117 The IPv4 time-to-live.
1118 .RE
1119
1120 .RE
1121 .RE
1122
1123 .sp
1124 .ne 2
1125 .na
1126 \fB\fBreset-prop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR \fIprotocol\fR\fR
1127 .ad
1128 .sp .6
1129 .RS 4n
1130 The \fBreset-prop\fR subcommand is used to reset a protocol's property
1131 value to the default.
1132 .sp
1133 The \fB-t\fR option (also \fB--temporary\fR) means
1134 that the disable is temporary and will not be persistent across reboots.
1135 .sp
1136 The \fB-p\fR option (also \fB--prop\fR) specifies the property name.
1137 See the \fBset-prop\fR subcommand for the list of property names.
1138 .sp
1139
1140 .RE
1141
1142 .sp
1143 .ne 2
1144 .na
1145 \fB\fBshow-prop\fR [[\fB-c\fR]\fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR,...] \fIprotocol\fR]
1146 .ad
1147 .sp .6
1148 .RS 4n
1149 The \fBshow-prop\fR subcommand is used to display the property values
1150 for one or all of the protocols.
1151 .sp
1152 The \fB-c\fR option (also \fB--parsable\fR) prints
1153 the output in a parsable format.
1154 .sp
1155 The \fB-o\fR option (also \fB--output\fR) is used
1156 to select which fields will be shown. The field value can be one of the
1157 following names:
1158 .sp
1159 .ne 2
1160 .na
1161 .RS 4n
1162 \fBALL\fR
1163 .ad
1164 .RS 4n
1165 Display all fields
1166 .RE
1167
1168 .sp
1169 .ne 2
1170 .na
1171 \fBPROTO\fR
1172 .ad
1173 .RS 4n
1174 The name of the protocol
1175 .RE
1176
1177 .sp
1178 .ne 2
1179 .na
1180 \fBPROPERTY\fR
1181 .ad
1182 .RS 4n
1183 The name of the property
1184 .RE
1185
1186 .sp
1187 .ne 2
1188 .na
1189 \fBPERM\fR
1190 .ad
1191 .RS 4n
1192 If the property is readable ("r") and/or writable ("w").
1193 .RE
1194
1195 .sp
1196 .ne 2
1197 .na
1198 \fBCURRENT\fR
1199 .ad
1200 .RS 4n
1201 The value of the property
1202 .RE
1203
1204 .sp
1205 .ne 2
1206 .na
1207 \fBPERSISTENT\fR
1208 .ad
1209 .RS 4n
1210 The persistent value of the property
1211 .RE
1212
1213 .sp
1214 .ne 2
1215 .na
1216 \fBDEFAULT\fR
1217 .ad
1218 .RS 4n
1219 The default value of the property
1220 .RE
1221
1222 .sp
1223 .ne 2
1224 .na
1225 \fBPOSSIBLE\fR
1226 .ad
1227 .RS 4n
1228 The possible values for the property
1229 .RE
1230 .RE
1231
1232 .sp
1233 The \fB-p\fR option (also \fB--prop\fR) is used
1234 to specify which properties to display. See the \fBset-prop\fR
1235 subcommand for the list of property names.
1236 .sp
1237
1238 .RE
1239
1240 .SH SEE ALSO
1241 .sp
1242 .LP
1243 \fBifconfig\fR(1M), \fBdladm\fR(1M), \fBndd\fR(1M), \fBzonecfg\fR(1M),
1244 \fBarp\fR(1M), \fBcfgadm\fR(1M), \fBif_mpadm\fR(1M), \fBnsswitch.conf\fR(4),
1245 and \fBdhcp\fR(5).