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
*** 1,37 ****
IPADM(1M) Maintenance Commands IPADM(1M)
NAME
! ipadm - configure IP interfaces, addresses and protocols
SYNOPSIS
! ipadm create-if [-t] interface
ipadm disable-if -t interface
ipadm enable-if -t interface
- ipadm delete-if interface
ipadm show-if [[-p] -o field[,field]...] [interface]
ipadm set-ifprop [-t] -p prop=value[,value]... -m protocol interface
ipadm reset-ifprop [-t] -p prop -m protocol interface
ipadm show-ifprop [[-c] -o field[,value]...] [-p prop[,prop]...]
[-m protocol] [interface]
ipadm create-addr [-t] -T static [-d]
-a [local|remote=]addr[/prefixlen]... addrobj
ipadm create-addr [-t] -T dhcp [-1] [-h hostname] [-w {seconds|forever}]
addrobj
ipadm create-addr [-t] -T addrconf [-i interface-id]
[-p {stateful|stateless}={yes|no}]... addrobj
ipadm down-addr [-t] addrobj
ipadm up-addr [-t] addrobj
ipadm disable-addr [-t] addrobj
ipadm enable-addr [-t] addrobj
! ipadm refresh-addr [-i] addrobj
! ipadm delete-addr [-r] addrobj
! ipadm show-addr [[-p] -o field[,field]...] [addrobj]
ipadm set-addrprop [-t] -p prop=value[,value]... addrobj
ipadm reset-addrprop [-t] -p prop addrobj
ipadm show-addrprop [[-c] -o field[,field]...] [-p prop[,prop]...]
[addrobj]
ipadm set-prop [-t] -p prop[+|-]=value[,value]... protocol
ipadm reset-prop [-t] -p prop protocol
ipadm show-prop [[-c] -o field[,field]...] [-p prop[,prop]...] [protocol]
DESCRIPTION
--- 1,47 ----
IPADM(1M) Maintenance Commands IPADM(1M)
NAME
! ipadm - configure IP and IPMP interfaces, addresses and protocols
SYNOPSIS
! ipadm create-ip [-t] interface
! ipadm delete-ip interface
!
! ipadm create-ipmp [-t] ipmp-interface
! ipadm delete-ipmp ipmp-interface
! ipadm add-ipmp [-t] -i interface ... ipmp-interface
! ipadm remove-ipmp [-t] -i interface ... ipmp-interface
!
ipadm disable-if -t interface
ipadm enable-if -t interface
ipadm show-if [[-p] -o field[,field]...] [interface]
+
ipadm set-ifprop [-t] -p prop=value[,value]... -m protocol interface
ipadm reset-ifprop [-t] -p prop -m protocol interface
ipadm show-ifprop [[-c] -o field[,value]...] [-p prop[,prop]...]
[-m protocol] [interface]
+
ipadm create-addr [-t] -T static [-d]
-a [local|remote=]addr[/prefixlen]... addrobj
ipadm create-addr [-t] -T dhcp [-1] [-h hostname] [-w {seconds|forever}]
addrobj
ipadm create-addr [-t] -T addrconf [-i interface-id]
[-p {stateful|stateless}={yes|no}]... addrobj
+ ipadm delete-addr [-r] addrobj
+ ipadm show-addr [[-p] -o field[,field]...] [addrobj]
+ ipadm refresh-addr [-i] addrobj
ipadm down-addr [-t] addrobj
ipadm up-addr [-t] addrobj
ipadm disable-addr [-t] addrobj
ipadm enable-addr [-t] addrobj
!
ipadm set-addrprop [-t] -p prop=value[,value]... addrobj
ipadm reset-addrprop [-t] -p prop addrobj
ipadm show-addrprop [[-c] -o field[,field]...] [-p prop[,prop]...]
[addrobj]
+
ipadm set-prop [-t] -p prop[+|-]=value[,value]... protocol
ipadm reset-prop [-t] -p prop protocol
ipadm show-prop [[-c] -o field[,field]...] [-p prop[,prop]...] [protocol]
DESCRIPTION
*** 38,48 ****
The ipadm command is a stable replacement for the ifconfig(1M) and
ndd(1M) commands. It is used to create IP interfaces and to configure IP
addresses on those interfaces. It is also used to get, set or reset
properties on interfaces, addresses and protocols.
! For subcommands that take an addrobj, the addrobj specifies a unique
address on the system. It is made up of two parts, delimited by a `/'.
The first part is the name of the interface and the second part is a
string up to 32 characters long. For example, "lo0/v4" is a loopback
interface addrobj name.
--- 48,58 ----
The ipadm command is a stable replacement for the ifconfig(1M) and
ndd(1M) commands. It is used to create IP interfaces and to configure IP
addresses on those interfaces. It is also used to get, set or reset
properties on interfaces, addresses and protocols.
! For subcommands that take an addrobj, the addrobj specifies unique
address on the system. It is made up of two parts, delimited by a `/'.
The first part is the name of the interface and the second part is a
string up to 32 characters long. For example, "lo0/v4" is a loopback
interface addrobj name.
*** 50,68 ****
values: ip, ipv4, ipv6, icmp, tcp, sctp or udp.
SUBCOMMANDS
The following subcommands are supported:
! ipadm create-if [-t] interface
! 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 ::.
-t,--temporary
Temporary, not persistent across reboots.
ipadm disable-if -t interface
Disable the specified IP interface.
-t,--temporary
Temporary, not persistent across reboots.
--- 60,113 ----
values: ip, ipv4, ipv6, icmp, tcp, sctp or udp.
SUBCOMMANDS
The following subcommands are supported:
! ipadm create-ip [-t] interface
! 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 ::.
-t,--temporary
Temporary, not persistent across reboots.
+ ipadm delete-ip interface
+ Permanently delete the specified IP interface.
+
+ ipadm create-ipmp [-t] ipmp-interface
+ 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 ::.
+
+ -t,--temporary
+ Temporary, not persistent across reboots.
+
+ ipadm delete-ipmp ipmp-interface
+ Permanently delete the IPMP interface.
+
+ ipadm add-ipmp [-t] -i interface ... ipmp-interface
+ Add the IP interface(s) to the IPMP interface (group).
+
+ -i,--interface
+ Interface to be added to the IPMP interface (group). More than
+ one -i option can be specified.
+
+ -t,--temporary
+ Temporary, not persistent across reboots.
+
+ ipadm remove-ipmp [-t] -i interface ... ipmp-interface
+ Remove the IP interface(s) from the IPMP interface (group).
+
+ -i,--interface
+ Interface to be removed from the IPMP interface (group). More
+ than one -i option can be specified.
+
+ -t,--temporary
+ Temporary, not persistent across reboots.
+
ipadm disable-if -t interface
Disable the specified IP interface.
-t,--temporary
Temporary, not persistent across reboots.
*** 71,83 ****
Enable the specified IP interface.
-t,--temporary
Temporary, not persistent across reboots.
- ipadm delete-if interface
- Permanently delete the specified IP interface.
-
ipadm show-if [[-p] -o field[,field]...] [interface]
Show the current IP interface configuration.
-o,--output
Select which fields will be shown. The field value can
--- 116,125 ----
*** 111,121 ****
s IPMP standby
4 IPv4
6 IPv6
-p,--parsable
! Print the output in a parsable format.
ipadm set-ifprop [-t] -p prop=value[,value]... -m protocol interface
Set a property's value(s) on the specified IP interface.
-m,--module
--- 153,163 ----
s IPMP standby
4 IPv4
6 IPv6
-p,--parsable
! Print the output in parsable format.
ipadm set-ifprop [-t] -p prop=value[,value]... -m protocol interface
Set a property's value(s) on the specified IP interface.
-m,--module
*** 157,167 ****
ipadm show-ifprop [[-c] -o field[,value]...] [-p prop[,prop]...] [-m
protocol] [interface]
Display the property values for one or all of the IP interfaces.
-c,--parsable
! Print the output in a parsable format.
-m,--module
Specify which protocol to display.
-o,--output
--- 199,209 ----
ipadm show-ifprop [[-c] -o field[,value]...] [-p prop[,prop]...] [-m
protocol] [interface]
Display the property values for one or all of the IP interfaces.
-c,--parsable
! Print the output in parsable format.
-m,--module
Specify which protocol to display.
-o,--output
*** 185,195 ****
ipadm create-addr [-t] -T static [-d] -a
[local|remote=]addr[/prefixlen]... addrobj
Create an address on the specified IP interface using static
configuration. The address will be enabled but can disabled
using the ipadm disable-addr subcommand. Note that addrconf
! address configured on an interface is required to configure
static IPv6 address on the same interface. This takes the
following options:
-a,--address
Specify the address. The local or remote prefix can be
--- 227,237 ----
ipadm create-addr [-t] -T static [-d] -a
[local|remote=]addr[/prefixlen]... addrobj
Create an address on the specified IP interface using static
configuration. The address will be enabled but can disabled
using the ipadm disable-addr subcommand. Note that addrconf
! address configured on the interface is required to configure
static IPv6 address on the same interface. This takes the
following options:
-a,--address
Specify the address. The local or remote prefix can be
*** 246,289 ****
used.
-t,--temporary
Temporary, not persistent across reboots.
- ipadm down-addr [-t] addrobj
- Down the address. This will stop packets from being sent or
- received.
-
- -t,--temporary
- Temporary, not persistent across reboots.
-
- ipadm up-addr [-t] addrobj
- Up the address. This will enable packets to be sent and
- received.
-
- -t,--temporary
- Temporary, not persistent across reboots.
-
- ipadm disable-addr [-t] addrobj
- Disable the address.
-
- -t,--temporary
- Temporary, not persistent across reboots.
-
- ipadm enable-addr [-t] addrobj
- Enable the address.
-
- -t,--temporary
- Temporary, not persistent across reboots.
-
- ipadm refresh-addr [-i] addrobj
- Extend the lease for DHCP addresses. It also restarts duplicate
- address detection for static addresses.
-
- -i,--inform
- Obtain network configuration from DHCP without taking a
- lease on the address.
-
ipadm delete-addr [-r] addrobj
Delete the given address.
-r,--release
Indicate that the DHCP-assigned address should be
--- 288,297 ----
*** 303,313 ****
the following values:
disabled see the ipadm disable-addr
subcommand
down see the ipadm down-addr
subcommand
! duplicate the address is a duplicate
inaccessible the interface for this address
has failed
ok the address is up
tentative duplicate address detection in
progress
--- 311,321 ----
the following values:
disabled see the ipadm disable-addr
subcommand
down see the ipadm down-addr
subcommand
! duplicate the address is duplicate
inaccessible the interface for this address
has failed
ok the address is up
tentative duplicate address detection in
progress
*** 325,336 ****
p private, not advertised to routing
d deprecated (not used for outgoing packets)
ADDR The address.
-p,--parsable
! Print the output in a parsable format.
ipadm set-addrprop [-t] -p prop=value[,value]... addrobj
Set a property's value(s) on the addrobj.
-p,--prop
Specify the property name and value(s). The property
--- 333,378 ----
p private, not advertised to routing
d deprecated (not used for outgoing packets)
ADDR The address.
-p,--parsable
! Print the output in parsable format.
+ ipadm refresh-addr [-i] addrobj
+ Extend the lease for DHCP addresses. It also restarts duplicate
+ address detection for static addresses.
+
+ -i,--inform
+ Obtain network configuration from DHCP without taking a lease
+ on the address.
+
+ ipadm down-addr [-t] addrobj
+ Down the address. This will stop packets from being sent or
+ received.
+
+ -t,--temporary
+ Temporary, not persistent across reboots.
+
+ ipadm up-addr [-t] addrobj
+ Up the address. This will enable packets to be sent and
+ received.
+
+ -t,--temporary
+ Temporary, not persistent across reboots.
+
+ ipadm disable-addr [-t] addrobj
+ Disable the address.
+
+ -t,--temporary
+ Temporary, not persistent across reboots.
+
+ ipadm enable-addr [-t] addrobj
+ Enable the address.
+
+ -t,--temporary
+ Temporary, not persistent across reboots.
+
ipadm set-addrprop [-t] -p prop=value[,value]... addrobj
Set a property's value(s) on the addrobj.
-p,--prop
Specify the property name and value(s). The property
*** 371,381 ****
ipadm show-addrprop [[-c] -o field[,field]...] [-p prop[,prop]...]
[addrobj]
Display the property values for one or all of the addrobjs.
-c,--parsable
! Print the output in a parsable format.
-o,--output
Select which fields will be shown. The field value can
be one of the following names:
ALL Display all fields.
--- 413,423 ----
ipadm show-addrprop [[-c] -o field[,field]...] [-p prop[,prop]...]
[addrobj]
Display the property values for one or all of the addrobjs.
-c,--parsable
! Print the output in parsable format.
-o,--output
Select which fields will be shown. The field value can
be one of the following names:
ALL Display all fields.
*** 390,400 ****
-p,--prop
Specify which properties to display. See the ipadm
set-addrprop subcommand for the list of property names.
! set-prop [-t] -p prop[+|-]=value[,value]... protocol
Set a property's value(s) on the protocol.
-p,--prop
Specify the property name and value(s). The optional +|-
syntax can be used to add/remove values from the current
--- 432,442 ----
-p,--prop
Specify which properties to display. See the ipadm
set-addrprop subcommand for the list of property names.
! ipadm set-prop [-t] -p prop[+|-]=value[,value]... protocol
Set a property's value(s) on the protocol.
-p,--prop
Specify the property name and value(s). The optional +|-
syntax can be used to add/remove values from the current
*** 445,455 ****
ipadm show-prop [[-c] -o field[,field]...] [-p prop[,prop]...] [protocol]
Display the property values for one or all of the protocols.
-c,--parsable
! Print the output in a parsable format.
-o,--output
Select which fields will be shown. The field value can
be one of the following names:
ALL Display all fields.
--- 487,497 ----
ipadm show-prop [[-c] -o field[,field]...] [-p prop[,prop]...] [protocol]
Display the property values for one or all of the protocols.
-c,--parsable
! Print the output in parsable format.
-o,--output
Select which fields will be shown. The field value can
be one of the following names:
ALL Display all fields.