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
*** 17,47 ****
.Dd February 6, 2018
.Dt IPADM 1M
.Os
.Sh NAME
.Nm ipadm
! .Nd configure IP interfaces, addresses and protocols
.Sh SYNOPSIS
.Nm
! .Ic create-if
.Op Fl t
.Ar interface
.Nm
.Ic disable-if
.Fl t
.Ar interface
.Nm
.Ic enable-if
.Fl t
.Ar interface
.Nm
- .Ic delete-if
- .Ar interface
- .Nm
.Ic show-if
.Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
.Op Ar interface
.Nm
.Ic set-ifprop
.Op Fl t
.Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
.Fl m Ar protocol
--- 17,67 ----
.Dd February 6, 2018
.Dt IPADM 1M
.Os
.Sh NAME
.Nm ipadm
! .Nd configure IP and IPMP interfaces, addresses and protocols
.Sh SYNOPSIS
.Nm
! .Ic create-ip
.Op Fl t
.Ar interface
.Nm
+ .Ic delete-ip
+ .Ar interface
+ .Pp
+ .Nm
+ .Ic create-ipmp
+ .Op Fl t
+ .Ar ipmp-interface
+ .Nm
+ .Ic delete-ipmp
+ .Ar ipmp-interface
+ .Nm
+ .Ic add-ipmp
+ .Op Fl t
+ .Fl i Ar interface No ...
+ .Ar ipmp-interface
+ .Nm
+ .Ic remove-ipmp
+ .Op Fl t
+ .Fl i Ar interface No ...
+ .Ar ipmp-interface
+ .Pp
+ .Nm
.Ic disable-if
.Fl t
.Ar interface
.Nm
.Ic enable-if
.Fl t
.Ar interface
.Nm
.Ic show-if
.Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
.Op Ar interface
+ .Pp
.Nm
.Ic set-ifprop
.Op Fl t
.Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
.Fl m Ar protocol
*** 56,65 ****
--- 76,86 ----
.Ic show-ifprop
.Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar value Oc Ns ...
.Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
.Op Fl m Ar protocol
.Op Ar interface
+ .Pp
.Nm
.Ic create-addr
.Op Fl t
.Fl T Cm static
.Op Fl d
*** 81,90 ****
--- 102,123 ----
.Op Fl i Ar interface-id
.Oo Fl p Bro Cm stateful Ns | Ns Cm stateless Brc Ns = Ns
.Bro Cm yes Ns | Ns Cm no Brc Oc Ns ...
.Ar addrobj
.Nm
+ .Ic delete-addr
+ .Op Fl r
+ .Ar addrobj
+ .Nm
+ .Ic show-addr
+ .Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
+ .Op Ar addrobj
+ .Nm
+ .Ic refresh-addr
+ .Op Fl i
+ .Ar addrobj
+ .Nm
.Ic down-addr
.Op Fl t
.Ar addrobj
.Nm
.Ic up-addr
*** 96,118 ****
.Ar addrobj
.Nm
.Ic enable-addr
.Op Fl t
.Ar addrobj
.Nm
- .Ic refresh-addr
- .Op Fl i
- .Ar addrobj
- .Nm
- .Ic delete-addr
- .Op Fl r
- .Ar addrobj
- .Nm
- .Ic show-addr
- .Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
- .Op Ar addrobj
- .Nm
.Ic set-addrprop
.Op Fl t
.Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
.Ar addrobj
.Nm
--- 129,140 ----
.Ar addrobj
.Nm
.Ic enable-addr
.Op Fl t
.Ar addrobj
+ .Pp
.Nm
.Ic set-addrprop
.Op Fl t
.Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
.Ar addrobj
.Nm
*** 123,132 ****
--- 145,155 ----
.Nm
.Ic show-addrprop
.Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
.Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
.Op Ar addrobj
+ .Pp
.Nm
.Ic set-prop
.Op Fl t
.Fl p Ar prop Ns Oo Cm + Ns | Ns Cm - Oc Ns = Ns
.Ar value Ns Oo , Ns Ar value Oc Ns ...
*** 156,166 ****
.Pp
For subcommands that take an
.Em addrobj ,
the
.Em addrobj
! specifies a unique address on the system.
It is made up of two parts, delimited by a
.Sq / .
The first part is the name of the interface and the second part is a string up
to 32 characters long.
For example,
--- 179,189 ----
.Pp
For subcommands that take an
.Em addrobj ,
the
.Em addrobj
! specifies unique address on the system.
It is made up of two parts, delimited by a
.Sq / .
The first part is the name of the interface and the second part is a string up
to 32 characters long.
For example,
*** 177,206 ****
.Cm ipv6 ,
.Cm icmp ,
.Cm tcp ,
.Cm sctp
or
! .Cm udp .
.Sh SUBCOMMANDS
The following subcommands are supported:
.Bl -tag -width Ds
.It Xo
.Nm
! .Ic create-if
.Op Fl t
.Ar interface
.Xc
! Create an IP interface that will handle both IPv4 and IPv6 packets.
The interface will be enabled as part of the creation process.
The IPv4 interface will have the address 0.0.0.0.
The IPv6 interface will have the address ::.
.Bl -tag -width Ds
.It Fl t Ns \&, Ns Fl -temporary
Temporary, not persistent across reboots.
.El
.It Xo
.Nm
.Ic disable-if
.Fl t
.Ar interface
.Xc
Disable the specified IP interface.
--- 200,289 ----
.Cm ipv6 ,
.Cm icmp ,
.Cm tcp ,
.Cm sctp
or
! .Cm udp.
.Sh SUBCOMMANDS
The following subcommands are supported:
.Bl -tag -width Ds
.It Xo
.Nm
! .Ic create-ip
.Op Fl t
.Ar interface
.Xc
! Create the IP interface that will handle both IPv4 and IPv6 packets.
The interface will be enabled as part of the creation process.
The IPv4 interface will have the address 0.0.0.0.
The IPv6 interface will have the address ::.
.Bl -tag -width Ds
.It Fl t Ns \&, Ns Fl -temporary
Temporary, not persistent across reboots.
.El
.It Xo
.Nm
+ .Ic delete-ip
+ .Ar interface
+ .Xc
+ Permanently delete the specified IP interface.
+ .It Xo
+ .Nm
+ .Ic create-ipmp
+ .Op Fl t
+ .Ar ipmp-interface
+ .Xc
+ Create the IPMP interface that will handle both IPv4 and IPv6 packets.
+ The interface will be enabled as part of the creation process.
+ The IPv4 interface will have the address 0.0.0.0.
+ The IPv6 interface will have the adress ::.
+ .Bl -tag -width Ds
+ .It Fl t Ns \&, Ns Fl -temporary
+ Temporary, not persistent across reboots.
+ .El
+ .It Xo
+ .Nm
+ .Ic delete-ipmp
+ .Ar ipmp-interface
+ .Xc
+ Permanently delete the IPMP interface.
+ .It Xo
+ .Nm
+ .Ic add-ipmp
+ .Op Fl t
+ .Fl i Ar interface No ...
+ .Ar ipmp-interface
+ .Xc
+ Add the IP interface(s) to the IPMP interface (group).
+ .Bl -tag -width ""
+ .It Fl i Ns \&, Ns Fl -interface
+ Interface to be added to the IPMP interface (group).
+ More than one
+ .Fl i
+ option can be specified.
+ .It Fl t Ns \&, Ns Fl -temporary
+ Temporary, not persistent across reboots.
+ .El
+ .It Xo
+ .Nm
+ .Ic remove-ipmp
+ .Op Fl t
+ .Fl i Ar interface No ...
+ .Ar ipmp-interface
+ .Xc
+ Remove the IP interface(s) from the IPMP interface (group).
+ .Bl -tag -width ""
+ .It Fl i Ns \&, Ns Fl -interface
+ Interface to be removed from the IPMP interface (group).
+ More than one
+ .Fl i
+ option can be specified.
+ .It Fl t Ns \&, Ns Fl -temporary
+ Temporary, not persistent across reboots.
+ .El
+ .It Xo
+ .Nm
.Ic disable-if
.Fl t
.Ar interface
.Xc
Disable the specified IP interface.
*** 219,234 ****
.It Fl t Ns \&, Ns Fl -temporary
Temporary, not persistent across reboots.
.El
.It Xo
.Nm
- .Ic delete-if
- .Ar interface
- .Xc
- Permanently delete the specified IP interface.
- .It Xo
- .Nm
.Ic show-if
.Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
.Op Ar interface
.Xc
Show the current IP interface configuration.
--- 302,311 ----
*** 294,304 ****
.It Sy 6
IPv6
.El
.El
.It Fl p Ns \&, Ns Fl -parsable
! Print the output in a parsable format.
.El
.It Xo
.Nm
.Ic set-ifprop
.Op Fl t
--- 371,381 ----
.It Sy 6
IPv6
.El
.El
.It Fl p Ns \&, Ns Fl -parsable
! Print the output in parsable format.
.El
.It Xo
.Nm
.Ic set-ifprop
.Op Fl t
*** 369,379 ****
.Op Ar interface
.Xc
Display the property values for one or all of the IP interfaces.
.Bl -tag -width Ds
.It Fl c Ns \&, Ns Fl -parsable
! Print the output in a parsable format.
.It Fl m Ns \&, Ns Fl -module
Specify which protocol to display.
.It Fl o Ns \&, Ns Fl -output
Select which fields will be shown.
The field value can be one of the following names:
--- 446,456 ----
.Op Ar interface
.Xc
Display the property values for one or all of the IP interfaces.
.Bl -tag -width Ds
.It Fl c Ns \&, Ns Fl -parsable
! Print the output in parsable format.
.It Fl m Ns \&, Ns Fl -module
Specify which protocol to display.
.It Fl o Ns \&, Ns Fl -output
Select which fields will be shown.
The field value can be one of the following names:
*** 420,430 ****
The address will be enabled but can disabled using the
.Nm ipadm Ic disable-addr
subcommand.
Note that
.Cm addrconf
! address configured on an interface is required to configure
.Cm static
IPv6 address on the same interface.
This takes the following options:
.Bl -tag -width Ds
.It Fl a Ns \&, Ns Fl -address
--- 497,507 ----
The address will be enabled but can disabled using the
.Nm ipadm Ic disable-addr
subcommand.
Note that
.Cm addrconf
! address configured on the interface is required to configure
.Cm static
IPv6 address on the same interface.
This takes the following options:
.Bl -tag -width Ds
.It Fl a Ns \&, Ns Fl -address
*** 507,578 ****
.It Fl t Ns \&, Ns Fl -temporary
Temporary, not persistent across reboots.
.El
.It Xo
.Nm
- .Ic down-addr
- .Op Fl t
- .Ar addrobj
- .Xc
- Down the address.
- This will stop packets from being sent or received.
- .Bl -tag -width Ds
- .It Fl t Ns \&, Ns Fl -temporary
- Temporary, not persistent across reboots.
- .El
- .It Xo
- .Nm
- .Ic up-addr
- .Op Fl t
- .Ar addrobj
- .Xc
- Up the address.
- This will enable packets to be sent and received.
- .Bl -tag -width Ds
- .It Fl t Ns \&, Ns Fl -temporary
- Temporary, not persistent across reboots.
- .El
- .It Xo
- .Nm
- .Ic disable-addr
- .Op Fl t
- .Ar addrobj
- .Xc
- Disable the address.
- .Bl -tag -width Ds
- .It Fl t Ns \&, Ns Fl -temporary
- Temporary, not persistent across reboots.
- .El
- .It Xo
- .Nm
- .Ic enable-addr
- .Op Fl t
- .Ar addrobj
- .Xc
- Enable the address.
- .Bl -tag -width Ds
- .It Fl t Ns \&, Ns Fl -temporary
- Temporary, not persistent across reboots.
- .El
- .It Xo
- .Nm
- .Ic refresh-addr
- .Op Fl i
- .Ar addrobj
- .Xc
- Extend the lease for
- .Sy DHCP
- addresses.
- It also restarts duplicate address detection for
- .Cm static
- addresses.
- .Bl -tag -width Ds
- .It Fl i Ns \&, Ns Fl -inform
- Obtain network configuration from DHCP without taking a lease on the address.
- .El
- .It Xo
- .Nm
.Ic delete-addr
.Op Fl r
.Ar addrobj
.Xc
Delete the given address.
--- 584,593 ----
*** 610,620 ****
.It Sy down
see the
.Nm ipadm Ic down-addr
subcommand
.It Sy duplicate
! the address is a duplicate
.It Sy inaccessible
the interface for this address has failed
.It Sy ok
the address is up
.It Sy tentative
--- 625,635 ----
.It Sy down
see the
.Nm ipadm Ic down-addr
subcommand
.It Sy duplicate
! the address is duplicate
.It Sy inaccessible
the interface for this address has failed
.It Sy ok
the address is up
.It Sy tentative
*** 650,663 ****
.El
.It Cm ADDR
The address.
.El
.It Fl p Ns \&, Ns Fl -parsable
! Print the output in a parsable format.
.El
.It Xo
.Nm
.Ic set-addrprop
.Op Fl t
.Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
.Ar addrobj
.Xc
--- 665,740 ----
.El
.It Cm ADDR
The address.
.El
.It Fl p Ns \&, Ns Fl -parsable
! Print the output in parsable format.
.El
.It Xo
.Nm
+ .Ic refresh-addr
+ .Op Fl i
+ .Ar addrobj
+ .Xc
+ Extend the lease for
+ .Sy DHCP
+ addresses.
+ It also restarts duplicate address detection for
+ .Cm static
+ addresses.
+ .Bl -tag -width ""
+ .It Fl i Ns \&, Ns Fl -inform
+ Obtain network configuration from DHCP without taking a lease on the address.
+ .El
+ .It Xo
+ .Nm
+ .Ic down-addr
+ .Op Fl t
+ .Ar addrobj
+ .Xc
+ Down the address.
+ This will stop packets from being sent or received.
+ .Bl -tag -width ""
+ .It Fl t Ns \&, Ns Fl -temporary
+ Temporary, not persistent across reboots.
+ .El
+ .It Xo
+ .Nm
+ .Ic up-addr
+ .Op Fl t
+ .Ar addrobj
+ .Xc
+ Up the address.
+ This will enable packets to be sent and received.
+ .Bl -tag -width ""
+ .It Fl t Ns \&, Ns Fl -temporary
+ Temporary, not persistent across reboots.
+ .El
+ .It Xo
+ .Nm
+ .Ic disable-addr
+ .Op Fl t
+ .Ar addrobj
+ .Xc
+ Disable the address.
+ .Bl -tag -width ""
+ .It Fl t Ns \&, Ns Fl -temporary
+ Temporary, not persistent across reboots.
+ .El
+ .It Xo
+ .Nm
+ .Ic enable-addr
+ .Op Fl t
+ .Ar addrobj
+ .Xc
+ Enable the address.
+ .Bl -tag -width ""
+ .It Fl t Ns \&, Ns Fl -temporary
+ Temporary, not persistent across reboots.
+ .El
+ .It Xo
+ .Nm
.Ic set-addrprop
.Op Fl t
.Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
.Ar addrobj
.Xc
*** 726,736 ****
.Op Ar addrobj
.Xc
Display the property values for one or all of the addrobjs.
.Bl -tag -width Ds
.It Fl c Ns \&, Ns Fl -parsable
! Print the output in a parsable format.
.It Fl o Ns \&, Ns Fl -output
Select which fields will be shown.
The field value can be one of the following names:
.Bl -tag -compact -width "PERSISTENT"
.It Cm ALL
--- 803,813 ----
.Op Ar addrobj
.Xc
Display the property values for one or all of the addrobjs.
.Bl -tag -width Ds
.It Fl c Ns \&, Ns Fl -parsable
! Print the output in parsable format.
.It Fl o Ns \&, Ns Fl -output
Select which fields will be shown.
The field value can be one of the following names:
.Bl -tag -compact -width "PERSISTENT"
.It Cm ALL
*** 758,767 ****
--- 835,845 ----
See the
.Nm ipadm Ic set-addrprop
subcommand for the list of property names.
.El
.It Xo
+ .Nm
.Ic set-prop
.Op Fl t
.Fl p Ar prop Ns Oo Cm + Ns | Ns Cm - Oc Ns = Ns
.Ar value Ns Oo , Ns Ar value Oc Ns ...
.Ar protocol
*** 852,862 ****
.Op Ar protocol
.Xc
Display the property values for one or all of the protocols.
.Bl -tag -width Ds
.It Fl c Ns \&, Ns Fl -parsable
! Print the output in a parsable format.
.It Fl o Ns \&, Ns Fl -output
Select which fields will be shown.
The field value can be one of the following names:
.Bl -tag -compact -width "PERSISTENT"
.It Cm ALL
--- 930,940 ----
.Op Ar protocol
.Xc
Display the property values for one or all of the protocols.
.Bl -tag -width Ds
.It Fl c Ns \&, Ns Fl -parsable
! Print the output in parsable format.
.It Fl o Ns \&, Ns Fl -output
Select which fields will be shown.
The field value can be one of the following names:
.Bl -tag -compact -width "PERSISTENT"
.It Cm ALL