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