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 2014 Nexenta Systems, Inc. All rights reserved.
15 .\"
16 .Dd April 9, 2016
17 .Dt IPADM 1M
18 .Os
19 .Sh NAME
20 .Nm ipadm
21 .Nd configure IP interfaces, addresses and protocols
22 .Sh SYNOPSIS
23 .Nm
24 .Ic create-if
25 .Op Fl t
26 .Ar interface
27 .Nm
28 .Ic disable-if
29 .Fl t
30 .Ar interface
31 .Nm
32 .Ic enable-if
33 .Fl t
34 .Ar interface
35 .Nm
36 .Ic delete-if
53 .Ar interface
54 .Nm
55 .Ic show-ifprop
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 ...
58 .Op Fl m Ar protocol
59 .Op Ar interface
60 .Nm
61 .Ic create-addr
62 .Op Fl t
63 .Fl T Cm static
64 .Op Fl d
65 .Fl a Oo Cm local Ns | Ns Cm remote Ns = Oc Ns
66 .Ar addr Ns Oo / Ns Ar prefixlen Oc Ns ...
67 .Ar addrobj
68 .Nm
69 .Ic create-addr
70 .Op Fl t
71 .Fl T Cm dhcp
72 .Op Fl w Ar seconds Ns | Ns Cm forever
73 .Ar addrobj
74 .Nm
75 .Ic create-addr
76 .Op Fl t
77 .Fl T Cm addrconf
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 ...
81 .Ar addrobj
82 .Nm
83 .Ic down-addr
84 .Op Fl t
85 .Ar addrobj
86 .Nm
87 .Ic up-addr
88 .Op Fl t
89 .Ar addrobj
90 .Nm
91 .Ic disable-addr
92 .Op Fl t
394 .It Fl p Ns , Ns Fl -prop
395 Specify which properties to display. See the
396 .Nm ipadm Ic set-ifprop
397 subcommand for the list of property names.
398 .El
399 .It Xo
400 .Nm
401 .Ic create-addr
402 .Op Fl t
403 .Fl T Cm static
404 .Op Fl d
405 .Fl a Oo Cm local Ns | Ns Cm remote Ns = Oc Ns
406 .Ar addr Ns Oo / Ns Ar prefixlen Oc Ns ...
407 .Ar addrobj
408 .br
409 .Nm
410 .Ic create-addr
411 .Op Fl t
412 .Fl T Cm dhcp
413 .Op Fl w Ar seconds Ns | Ns Cm forever
414 .Ar addrobj
415 .br
416 .Nm
417 .Ic create-addr
418 .Op Fl t
419 .Fl T Cm addrconf
420 .Op Fl i Ar interface-id
421 .Oo Fl p Bro Cm stateful Ns | Ns Cm stateless Brc Ns = Ns
422 .Bro Cm yes Ns | Ns Cm no Brc Oc Ns ...
423 .Ar addrobj
424 .Xc
425 Create an address on an IP interface. The address will be enabled but can
426 disabled using the
427 .Nm ipadm Ic disable-addr
428 subcommand. This subcommand has three different forms, depending on the
429 value of the
430 .Fl T
431 option.
432 .Bl -tag -width ""
433 .It Fl T Cm static
437 .Cm static
438 IPv6 address on the same interface. This takes the following options:
439 .Bl -tag -width ""
440 .It Fl a Ns , Ns Fl -address
441 Specify the address. The
442 .Cm local
443 or
444 .Cm remote
445 prefix can be used for a point-to-point interface. In this case, both addresses
446 must be given. Otherwise, the equal sign
447 .Pq Qq =
448 should be omitted and the address should be provided by itself without second
449 address.
450 .It Fl d Ns , Ns Fl -down
451 The address is down.
452 .El
453 .It Fl T Cm dhcp
454 Obtain the address via DHCP. This takes the following options:
455 .Bl -tag -width ""
456 .It Fl w Ns , Ns Fl -wait
457 Specify the time, in seconds, that the command should wait to obtain an address.
458 .El
459 .It Fl T Cm addrconf
460 Create an auto-configured address. This takes the following options:
461 .Bl -tag -width ""
462 .It Fl i Ns , Ns Fl -interface-id
463 Specify the interface ID to be used.
464 .It Fl p Ns , Ns Fl -prop
465 Specify which method of auto-configuration should be used.
466 .El
467 .It Fl t Ns , Ns Fl -temporary
468 Temporary, not persistent across reboots.
469 .El
470 .It Xo
471 .Nm
472 .Ic down-addr
473 .Op Fl t
474 .Ar addrobj
475 .Xc
476 Down the address. This will stop packets from being sent or received.
477 .Bl -tag -width ""
614 .It Xo
615 .Nm
616 .Ic set-addrprop
617 .Op Fl t
618 .Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
619 .Ar addrobj
620 .Xc
621 Set a property's value(s) on the addrobj.
622 .Bl -tag -width ""
623 .It Fl p Ns , Ns Fl -prop
624 Specify the property name and value(s). The property name can be one of the
625 following:
626 .Bl -tag -compact -width "deprecated"
627 .It Cm broadcast
628 The broadcast address (read-only).
629 .It Cm deprecated
630 The address should not be used to send packets but can still receive packets
631 .Pq Cm on Ns / Ns Cm off .
632 .It Cm prefixlen
633 The number of bits in the IPv4 netmask or IPv6 prefix.
634 .It Cm private
635 The address is not advertised to routing
636 .Pq Cm on Ns / Ns Cm off .
637 .It Cm transmit
638 Packets can be transmitted
639 .Pq Cm on Ns / Ns Cm off .
640 .It Cm zone
641 The zone the addrobj is in.
642 .El
643 .It Fl t Ns , Ns Fl -temporary
644 Temporary, not persistent across reboots.
645 .El
646 .It Xo
647 .Nm
648 .Ic reset-addrprop
649 .Op Fl t
650 .Fl p Ar prop
651 .Ar addrobj
652 .Xc
653 Reset an addrobj's property value to the default.
654 .Bl -tag -width ""
655 .It Fl p Ns , Ns Fl -prop
656 Specify the property name. See the
657 .Nm ipadm Ic set-addrprop
658 subcommand for the list of property names.
659 .It Fl t Ns , Ns Fl -temporary
660 Temporary, not persistent across reboots.
661 .El
813 The persistent value of the property.
814 .It Cm DEFAULT
815 The default value of the property.
816 .It Cm POSSIBLE
817 The possible values for the property.
818 .El
819 .It Fl p Ns , Ns Fl -prop
820 Specify which properties to display. See the
821 .Nm ipadm Ic set-prop
822 subcommand for the list of property names.
823 .El
824 .El
825 .Sh SEE ALSO
826 .Xr arp 1M ,
827 .Xr cfgadm 1M ,
828 .Xr dladm 1M ,
829 .Xr if_mpadm 1M ,
830 .Xr ifconfig 1M ,
831 .Xr ndd 1M ,
832 .Xr zonecfg 1M ,
833 .Xr nsswitch.conf 4 ,
834 .Xr dhcp 5
|
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 2014 Nexenta Systems, Inc. All rights reserved.
15 .\" Copyright (c) 2016, Chris Fraire <cfraire@me.com>.
16 .\"
17 .Dd November 7, 2016
18 .Dt IPADM 1M
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
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 w Ar seconds Ns | Ns Cm forever
74 .Op Fl 1
75 .Op Fl h Ar hostname
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
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.
401 .El
402 .It Xo
403 .Nm
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
411 .br
412 .Nm
413 .Ic create-addr
414 .Op Fl t
415 .Fl T Cm dhcp
416 .Op Fl w Ar seconds Ns | Ns Cm forever
417 .Op Fl 1
418 .Op Fl h Ar hostname
419 .Ar addrobj
420 .br
421 .Nm
422 .Ic create-addr
423 .Op Fl t
424 .Fl T Cm addrconf
425 .Op Fl i Ar interface-id
426 .Oo Fl p Bro Cm stateful Ns | Ns Cm stateless Brc Ns = Ns
427 .Bro Cm yes Ns | Ns Cm no Brc Oc Ns ...
428 .Ar addrobj
429 .Xc
430 Create an address on an IP interface. The address will be enabled but can
431 disabled using the
432 .Nm ipadm Ic disable-addr
433 subcommand. This subcommand has three different forms, depending on the
434 value of the
435 .Fl T
436 option.
437 .Bl -tag -width ""
438 .It Fl T Cm static
442 .Cm static
443 IPv6 address on the same interface. This takes the following options:
444 .Bl -tag -width ""
445 .It Fl a Ns , Ns Fl -address
446 Specify the address. The
447 .Cm local
448 or
449 .Cm remote
450 prefix can be used for a point-to-point interface. In this case, both addresses
451 must be given. Otherwise, the equal sign
452 .Pq Qq =
453 should be omitted and the address should be provided by itself without second
454 address.
455 .It Fl d Ns , Ns Fl -down
456 The address is down.
457 .El
458 .It Fl T Cm dhcp
459 Obtain the address via DHCP. This takes the following options:
460 .Bl -tag -width ""
461 .It Fl w Ns , Ns Fl -wait
462 Specify the time, in seconds, that the command should wait to obtain an
463 address; or specify
464 .Cm forever
465 to wait without interruption. The default value is 120.
466 .It Fl 1 Ns , Ns Fl -primary
467 Specify that the interface is primary. One effect will be that
468 .Xr nodename 4
469 will serve as
470 .Fl h Ns , Ns Fl -reqhost
471 if that switch is not otherwise specified.
472 .It Fl h Ns , Ns Fl -reqhost
473 Specify the host name to send to the DHCP server in order to request an
474 association of a Fully Qualified Domain Name to the interface. An FQDN is
475 determined from
476 .Ar hostname
477 if it is "rooted" (ending in a '.'), or if it consists of at least three
478 DNS labels, or by appending to
479 .Ar hostname
480 the value configured separately using either
481 .Xr defaultdomain 4
482 or
483 .Xr resolv.conf 4 .
484 N.b. that the DHCP server implementation ultimately determines whether and
485 how the client-sent FQDN is used.
486 .El
487 .It Fl T Cm addrconf
488 Create an auto-configured address. This takes the following options:
489 .Bl -tag -width ""
490 .It Fl i Ns , Ns Fl -interface-id
491 Specify the interface ID to be used.
492 .It Fl p Ns , Ns Fl -prop
493 Specify which method of auto-configuration should be used.
494 .El
495 .It Fl t Ns , Ns Fl -temporary
496 Temporary, not persistent across reboots.
497 .El
498 .It Xo
499 .Nm
500 .Ic down-addr
501 .Op Fl t
502 .Ar addrobj
503 .Xc
504 Down the address. This will stop packets from being sent or received.
505 .Bl -tag -width ""
642 .It Xo
643 .Nm
644 .Ic set-addrprop
645 .Op Fl t
646 .Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
647 .Ar addrobj
648 .Xc
649 Set a property's value(s) on the addrobj.
650 .Bl -tag -width ""
651 .It Fl p Ns , Ns Fl -prop
652 Specify the property name and value(s). The property name can be one of the
653 following:
654 .Bl -tag -compact -width "deprecated"
655 .It Cm broadcast
656 The broadcast address (read-only).
657 .It Cm deprecated
658 The address should not be used to send packets but can still receive packets
659 .Pq Cm on Ns / Ns Cm off .
660 .It Cm prefixlen
661 The number of bits in the IPv4 netmask or IPv6 prefix.
662 .It Cm primary
663 The DHCP primary interface flag (read-only).
664 .It Cm private
665 The address is not advertised to routing
666 .Pq Cm on Ns / Ns Cm off .
667 .It Cm reqhost
668 The host name to send to the DHCP server in order to request an association
669 of an FQDN to the interface. For a primary DHCP interface,
670 .Xr nodename 4
671 is sent if this property is not defined. See the
672 .Nm
673 .Ic create-addr
674 .Fl T Cm dhcp
675 subcommand for an explanation of how an FQDN is determined.
676 .It Cm transmit
677 Packets can be transmitted
678 .Pq Cm on Ns / Ns Cm off .
679 .It Cm zone
680 The zone the addrobj is in. (temporary-only. Use
681 .Xr zonecfg 1M
682 to make persistent).
683 .El
684 .It Fl t Ns , Ns Fl -temporary
685 Temporary, not persistent across reboots.
686 .El
687 .It Xo
688 .Nm
689 .Ic reset-addrprop
690 .Op Fl t
691 .Fl p Ar prop
692 .Ar addrobj
693 .Xc
694 Reset an addrobj's property value to the default.
695 .Bl -tag -width ""
696 .It Fl p Ns , Ns Fl -prop
697 Specify the property name. See the
698 .Nm ipadm Ic set-addrprop
699 subcommand for the list of property names.
700 .It Fl t Ns , Ns Fl -temporary
701 Temporary, not persistent across reboots.
702 .El
854 The persistent value of the property.
855 .It Cm DEFAULT
856 The default value of the property.
857 .It Cm POSSIBLE
858 The possible values for the property.
859 .El
860 .It Fl p Ns , Ns Fl -prop
861 Specify which properties to display. See the
862 .Nm ipadm Ic set-prop
863 subcommand for the list of property names.
864 .El
865 .El
866 .Sh SEE ALSO
867 .Xr arp 1M ,
868 .Xr cfgadm 1M ,
869 .Xr dladm 1M ,
870 .Xr if_mpadm 1M ,
871 .Xr ifconfig 1M ,
872 .Xr ndd 1M ,
873 .Xr zonecfg 1M ,
874 .Xr defaultdomain 4 ,
875 .Xr nodename 4 ,
876 .Xr nsswitch.conf 4 ,
877 .Xr resolv.conf 4 ,
878 .Xr dhcp 5
|