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
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.
12 .\" Copyright (c) 2012, Joyent, Inc. All Rights Reserved
13 .\" Copyright (c) 2013 by Delphix. All rights reserved.
14 .\" Copyright 2014 Nexenta Systems, Inc. All rights reserved.
21 .Nd configure IP interfaces, addresses and protocols
40 .Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
45 .Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
56 .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar value Oc Ns ...
57 .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
65 .Fl a Oo Cm local Ns | Ns Cm remote Ns = Oc Ns
66 .Ar addr Ns Oo / Ns Ar prefixlen Oc Ns ...
72 .Op Fl w Ar seconds Ns | Ns Cm forever
78 .Op Fl i Ar interface-id
79 .Oo Fl p Bro Cm stateful Ns | Ns Cm stateless Brc Ns = Ns
80 .Bro Cm yes Ns | Ns Cm no Brc Oc Ns ...
108 .Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
113 .Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
122 .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
123 .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
128 .Fl p Ar prop Ns Oo Cm + Ns | Ns Cm - Oc Ns = Ns
129 .Ar value Ns Oo , Ns Ar value Oc Ns ...
138 .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
139 .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
144 command is a stable replacement for the
147 commands. It is used to create IP interfaces and to configure IP addresses on
148 those interfaces. It is also used to get, set or reset properties on interfaces,
149 addresses and protocols.
151 For subcommands that take an
155 specifies a unique address on the system. It is made up of two parts, delimited
158 The first part is the name of the interface and the second part is a string up
159 to 32 characters long. For example,
161 is a loopback interface
165 For subcommands that take a
167 this can be one of the following values:
177 The following subcommands are supported:
185 Create an IP interface that will handle both IPv4 and IPv6 packets. The
186 interface will be enabled as part of the creation process. The IPv4 interface
187 will have the address 0.0.0.0. The IPv6 interface will have the address ::.
189 .It Fl t Ns , Ns Fl -temporary
190 Temporary, not persistent across reboots.
198 Disable an IP interface.
200 .It Fl t Ns , Ns Fl -temporary
201 Temporary, not persistent across reboots.
209 Enable an IP interface.
211 .It Fl t Ns , Ns Fl -temporary
212 Temporary, not persistent across reboots.
219 Permanently delete an IP interface.
223 .Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
226 Show the current IP interface configuration.
228 .It Fl o Ns , Ns Fl -output
229 Select which fields will be shown. The field value can be one of the following
231 .Bl -tag -compact -width "PERSISTENT"
235 The name of the interface.
237 The state can be one of the following values:
238 .Bl -tag -compact -width "disabled"
240 resources for the interface have been allocated
242 the interface is offline
244 the interface's datalink is down
246 the interface is down
248 the interface is disabled
251 A set of single character flags indicating the following:
252 .Bl -tag -compact -width "b"
254 broadcast (mutually exclusive with
259 point-to-point (mutually exclusive with
279 A set of single character flags showing what configuration will be used the
280 next time the interface is enabled:
281 .Bl -tag -compact -width "s"
290 .It Fl p Ns , Ns Fl -parsable
291 Print the output in a parsable format.
297 .Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
301 Set a property's value(s) on the IP interface.
303 .It Fl m Ns , Ns Fl -module
304 Specify which protocol the setting applies to.
305 .It Fl p Ns , Ns Fl -prop
306 Specify the property name and value(s). The property name can be one of the
308 .Bl -tag -compact -width "exchange_routes"
310 Address resolution protocol
311 .Pq Cm on Ns / Ns Cm off .
312 .It Cm exchange_routes
313 Exchange of routing data
314 .Pq Cm on Ns / Ns Cm off .
317 .Pq Cm on Ns / Ns Cm off
319 Set the routing metric to the numeric value. The value is treated as extra
320 hops to the destination.
322 Set the maximum transmission unit to the numeric value.
324 Neighbor unreachability detection
325 .Pq Cm on Ns / Ns Cm off
327 Indicates which interface to use for source address selection. A value
331 .It Fl t Ns , Ns Fl -temporary
332 Temporary, not persistent across reboots.
342 Reset an IP interface's property value to the default.
344 .It Fl m Ns , Ns Fl -module
345 Specify which protocol the setting applies to.
346 .It Fl p Ns , Ns Fl -prop
347 Specify the property name. See the
348 .Nm ipadm Ic set-ifprop
349 subcommand for the list of property names.
350 .It Fl t Ns , Ns Fl -temporary
351 Temporary, not persistent across reboots.
356 .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar value Oc Ns ...
357 .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
361 Display the property values for one or all of the IP interfaces.
363 .It Fl c Ns , Ns Fl -parsable
364 Print the output in a parsable format.
365 .It Fl m Ns , Ns Fl -module
366 Specify which protocol to display.
367 .It Fl o Ns , Ns Fl -output
368 Select which fields will be shown. The field value can be one of the following
370 .Bl -tag -compact -width "PERSISTENT"
374 The name of the interface.
376 The name of the property.
378 The name of the protocol.
380 If the property is readable
385 The value of the property.
387 The persistent value of the property.
389 The default value of the property.
391 The possible values for the property.
393 .It Fl p Ns , Ns Fl -prop
394 Specify which properties to display. See the
395 .Nm ipadm Ic set-ifprop
396 subcommand for the list of property names.
404 .Fl a Oo Cm local Ns | Ns Cm remote Ns = Oc Ns
405 .Ar addr Ns Oo / Ns Ar prefixlen Oc Ns ...
412 .Op Fl w Ar seconds Ns | Ns Cm forever
419 .Op Fl i Ar interface-id
420 .Oo Fl p Bro Cm stateful Ns | Ns Cm stateless Brc Ns = Ns
421 .Bro Cm yes Ns | Ns Cm no Brc Oc Ns ...
424 Create an address on an IP interface. The address will be enabled but can
426 .Nm ipadm Ic disable-addr
427 subcommand. This subcommand has three different forms, depending on the
433 Create a static addrobj. Note that
435 address configured on an interface is required to configure
437 IPv6 address on the same interface. This takes the following options:
439 .It Fl a Ns , Ns Fl -address
440 Specify the address. The
444 prefix can be used for a point-to-point interface. In this case, both addresses
445 must be given. Otherwise, the equal sign
447 should be omitted and the address should be provided by itself without second
449 .It Fl d Ns , Ns Fl -down
453 Obtain the address via DHCP. This takes the following options:
455 .It Fl w Ns , Ns Fl -wait
456 Specify the time, in seconds, that the command should wait to obtain an address.
459 Create an auto-configured address. This takes the following options:
461 .It Fl i Ns , Ns Fl -interface-id
462 Specify the interface ID to be used.
463 .It Fl p Ns , Ns Fl -prop
464 Specify which method of auto-configuration should be used.
466 .It Fl t Ns , Ns Fl -temporary
467 Temporary, not persistent across reboots.
475 Down the address. This will stop packets from being sent or received.
477 .It Fl t Ns , Ns Fl -temporary
478 Temporary, not persistent across reboots.
486 Up the address. This will enable packets to be sent and received.
488 .It Fl t Ns , Ns Fl -temporary
489 Temporary, not persistent across reboots.
499 .It Fl t Ns , Ns Fl -temporary
500 Temporary, not persistent across reboots.
510 .It Fl t Ns , Ns Fl -temporary
511 Temporary, not persistent across reboots.
521 addresses. It also restarts duplicate address
526 .It Fl i Ns , Ns Fl -inform
527 Obtain network configuration from DHCP without taking a lease on the address.
535 Delete the given address.
537 .It Fl r Ns , Ns Fl -release
538 Indicate that the DHCP-assigned address should be released.
543 .Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
546 Show the current address properties.
548 .It Fl o Ns , Ns Fl -output
549 Select which fields will be shown. The field value can be one of the following
551 .Bl -tag -compact -width "PERSISTENT"
555 The name of the address.
557 The type of the address
558 .Pq Sy static Ns / Ns Sy dhcp Ns / Ns Sy addrconf .
560 The state of the address. It can be one of the following values:
561 .Bl -tag -compact -width "inaccessible"
564 .Nm ipadm Ic disable-addr
568 .Nm ipadm Ic down-addr
571 the address is a duplicate
573 the interface for this address has failed
577 duplicate address detection in progress
580 A set of single character flags indicating the following:
581 .Bl -tag -compact -width "U"
586 .Pq matches another local address
588 private, not advertised to routing
590 temporary IPv6 address
593 .Pq not used for outgoing packets
596 A set of single character flags showing the configuration which will be used
597 when the address is enabled.
598 .Bl -tag -compact -width "U"
602 private, not advertised to routing
605 .Pq not used for outgoing packets
610 .It Fl p Ns , Ns Fl -parsable
611 Print the output in a parsable format.
617 .Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
620 Set a property's value(s) on the addrobj.
622 .It Fl p Ns , Ns Fl -prop
623 Specify the property name and value(s). The property name can be one of the
625 .Bl -tag -compact -width "deprecated"
627 The broadcast address (read-only).
629 The address should not be used to send packets but can still receive packets
630 .Pq Cm on Ns / Ns Cm off .
632 The number of bits in the IPv4 netmask or IPv6 prefix.
634 The address is not advertised to routing
635 .Pq Cm on Ns / Ns Cm off .
637 Packets can be transmitted
638 .Pq Cm on Ns / Ns Cm off .
640 The zone the addrobj is in.
642 .It Fl t Ns , Ns Fl -temporary
643 Temporary, not persistent across reboots.
652 Reset an addrobj's property value to the default.
654 .It Fl p Ns , Ns Fl -prop
655 Specify the property name. See the
656 .Nm ipadm Ic set-addrprop
657 subcommand for the list of property names.
658 .It Fl t Ns , Ns Fl -temporary
659 Temporary, not persistent across reboots.
664 .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
665 .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
668 Display the property values for one or all of the addrobjs.
670 .It Fl c Ns , Ns Fl -parsable
671 Print the output in a parsable format.
672 .It Fl o Ns , Ns Fl -output
673 Select which fields will be shown. The field value can be one of the following
675 .Bl -tag -compact -width "PERSISTENT"
679 The name of the addrobj.
681 The name of the property.
683 If the property is readable
688 The value of the property.
690 The persistent value of the property.
692 The default value of the property.
694 The possible values for the property.
696 .It Fl p Ns , Ns Fl -prop
697 Specify which properties to display. See the
698 .Nm ipadm Ic set-addrprop
699 subcommand for the list of property names.
704 .Fl p Ar prop Ns Oo Cm + Ns | Ns Cm - Oc Ns = Ns
705 .Ar value Ns Oo , Ns Ar value Oc Ns ...
708 Set a property's value(s) on the protocol.
710 .It Fl p Ns , Ns Fl -prop
711 Specify the property name and value(s). The optional
713 syntax can be used to add/remove values from the current list of values on the
714 property. The property name can be one of the following:
715 .Bl -tag -compact -width "smallest_nonpriv_port"
717 Explicit congestion control
718 .Pq Cm never Ns / Ns Cm passive Ns / Ns Cm active
720 .It Cm extra_priv_ports
721 Additional privileged ports
725 .Pq Cm on Ns / Ns Cm off .
728 .It Cm largest_anon_port
729 Largest ephemeral port
732 Maximum receive or send buffer size
733 .Pq ICMP/SCTP/TCP/UDP .
734 This also sets the upper limit for the
740 Default receive buffer size
741 .Pq ICMP/SCTP/TCP/UDP .
742 The maximum value for this property is controlled by the
746 Selective acknowledgement
747 .Pq Cm active Ns / Ns Cm passive Ns / Ns Cm never
750 Default send buffer size
751 .Pq ICMP/SCTP/TCP/UDP .
752 The maximum value for this property is controlled by the
755 .It Cm smallest_anon_port
756 Smallest ephemeral port
758 .It Cm smallest_nonpriv_port
759 Smallest non-privileged port
762 The IPv4 time-to-live.
764 .It Fl t Ns , Ns Fl -temporary
765 Temporary, not persistent across reboots.
774 Reset a protocol's property value to the default.
776 .It Fl p Ns , Ns Fl -prop
777 Specify the property name. See the
778 .Nm ipadm Ic set-prop
779 subcommand for the list of property names.
780 .It Fl t Ns , Ns Fl -temporary
781 Temporary, not persistent across reboots.
786 .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
787 .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
790 Display the property values for one or all of the protocols.
792 .It Fl c Ns , Ns Fl -parsable
793 Print the output in a parsable format.
794 .It Fl o Ns , Ns Fl -output
795 Select which fields will be shown. The field value can be one of the following
797 .Bl -tag -compact -width "PERSISTENT"
801 The name of the protocol.
803 The name of the property.
805 If the property is readable
810 The value of the property.
812 The persistent value of the property.
814 The default value of the property.
816 The possible values for the property.
818 .It Fl p Ns , Ns Fl -prop
819 Specify which properties to display. See the
820 .Nm ipadm Ic set-prop
821 subcommand for the list of property names.
832 .Xr nsswitch.conf 4 ,