Monitoring IP Interfaces and Addresses

The ipadm command is also the preferred tool for monitor and obtain information about IP interfaces and their properties or parameters. The ipadm subcommands to obtain interface information use the following basic syntax:

ipadm show-* [other-arguments] [interface]

To obtain interface information, use ipadm show-if.
To obtain address information, use ipadm show-addr.
To obtain information about a specific interface property, use ipadm show-ifprop.
To obtain information about a specific address property, use ipadm show-addrprop

This section provides several examples of using the ipadm command to obtain information about the network interfaces. For other types of monitoring tasks that you perform on the network, refer to Chapter 5, Administering a TCP/IP Network, in Oracle Solaris Administration: IP Services.

Note - For an explanation of all the fields in the ipadm show-* commands, refer to the ipadm(1M) man page.

How to Obtain Information About Network Interfaces

This procedure describes how to display information about an interface's general status, address information, and IP properties.

Become an administrator.
For more information, see How to Obtain Administrative Rights in Oracle Solaris Administration: Security Services.
To obtain status information about an interface, type the following command:
```
# ipadm show-if [interface]
```
If you do not specify an interface, then the information covers all the interfaces on the system.
The fields in the command output refer to the following:
IFNAME

Refers to the interface whose information is being displayed.

CLASS
Refers to the class of interface, which can be one of four:
- ip refers to an IP interface
- ipmp refers to an IPMP interface
- vni refers to a virtual interface
- loopback refers to a loopback interface, which is automatically created. Except for the loopback interface, you can manually create the remaining 3 interface classes.
STATE

Refers to the status of the interface, which can either be ok, offline, failed, down, or disabled.
The status failed applies to IPMP groups and can refer to a datalink or an IP interface that is down and cannot host traffic. If the IP interface belongs to an IPMP group, then the IPMP interface can continue to receive and send traffic by using other active IP interfaces in the group.
The status down refers to an IP interface that is switched offline by the administrator.
The status disable refers to the IP interface that is unplumbed by using the ipadm disable-if command.

ACTIVE

Indicates whether the interface is being used to host traffic, and is set either to yesor no.

OVER

Applies only to the IPMP class of interfaces and refers to the underlying interfaces that constitute the IPMP interface or group.
To obtain address information for the interface, type the following command:
```
# ipadm show-addr [addrobj]
```
If you do not specify an address identifier, then address information is provided for all the address identifiers on the system.
The fields in the command output refer to the following:
ADDROBJ

Specifies the address object whose address is being listed.

TYPE

Indicates whether the IP address is static, dhcp, or addrconf. The addrconf setting indicates that the address was obtained by using stateless or stateful address configuration.

STATE

Describes the address object in its actual active configuration. For a full list of these values, see the ipadm(1M) man page.

ADDR

Specifies the IP address that is configured over the interface. The address can be IPv4 or IPv6. A tunnel interface will display both local and remote addresses.
For more information about tunnels, see Chapter 6, Configuring IP Tunnels, in Oracle Solaris Administration: IP Services.
To obtain information about interface properties, type the following command:
```
# ipadm show-ifprop [-p property] interface
```
If you do not specify a property, then all the properties and their settings are displayed.
The fields in the command output refer to the following:
IFNAME

Refers to the interface whose information is being displayed.

PROPERTY

Refers to the property of the interface. An interface can have several properties.

PROTO

Refers to the protocol to which the property applies, and which can either be IPv4 or IPv6.

PERM

Refers to the allowed permissions of a given property, which can be read only, write only, or both.

CURRENT

Indicates the current setting of the property in active configuration.

PERSISTENT

Refers to the setting of the property that is reapplied when the system is rebooted.

DEFAULT

Indicates the default setting of the specified property.

POSSIBLE

Refers to a list of values that can be assigned to the specified property. For numeric settings, a range of acceptable values is displayed.

Note - If any field value is unknown, such as when an interface does not support the property whose information is being requested, the setting is displayed as a question mark (?).
To obtain information about an address property, type the following command:
```
# ipadm show-addrprop [-p property,...] [addrobj]
```
The information that is displayed depends on the options that you use.
- If you do not specify a property, then all properties are listed.
- If you specify only the property, then that property for all the addresses is displayed.
- If you specify only the address object, then the properties of all existing addresses on the system are displayed.
The fields in the command output refer to the following:
ADDROBJ

Refers to the address object whose properties are being listed.

PROPERTY

Refers to the property of the address object. An address object can have several properties.

PERM

Refers to the allowed permissions of a given property, which can be read only, write only, or both.

CURRENT

Refers to the actual setting of the property in the present configuration.

PERSISTENT

Refers to the setting of the property that is reapplied when the system is rebooted.

DEFAULT

Indicates the default setting of the specified property.

POSSIBLE

Refers to a list of settings that can be assigned to the specified property. For numeric settings, a range of acceptable values is displayed.

Example 9-8 Using the ipadm Command to Monitor Interfaces

This set of examples shows the types of information that can be obtained by using the ipadm show-* subcommands. First, general interface information is displayed. Then, address information is provided. Finally, information about a specific property, the MTU of the interface net1, is provided. The examples include tunnel interfaces as well as interfaces that use a customized name.

# ipadm show-if
IFNAME       CLASS        STATE     ACTIVE     OVER
lo0          loopback     ok        yes        --
net0         ip           ok        yes        --
net1         ip           ok        yes        --
tun0         ip           ok        yes        --

# ipadm show-addr
ADDROBJ          TYPE       STATE     ADDR
lo0/?            static     ok        127.0.0.1/8
net0/v4          static     ok        192.168.84.3/24
tun0/v4tunaddr   static     ok        173.129.134.1-->173.129.134.2

Note that an address object that is listed as interface/? indicates that the address was configured on the interface by an application that did not use libipadm APIs. Such applications are not under the control of the ipadm command, which requires that the address object name use the format interface/user-defined-string. For examples of assigning IP addresses, see How to Configure an IP Interface.

# ipadm show-ifprop -p mtu net1
IFNAME  PROPERTY  PROTO  PERM  CURRENT  PERSISTENT  DEFAULT  POSSIBLE
net1    mtu       ipv4   rw    1500      --         1500     68-1500
net1    mtu       ipv6   rw    1500      --         1500     1280-1500

# ipadm show-addrprop net1/v4
ADDROBJ         PROPERTY    PERM  CURRENT         PERSISTENT  DEFAULT          POSSIBLE
net1/v4   broadcast   r-    192.168.84.255  --          192.168.84.255   --
net1/v4   deprecated  rw    off             --          off              on,off
net1/v4   prefixlen   rw    24              24          24               1-30,32
net1/v4   private     rw    off             --          off              on,off
net1/v4   transmit    rw    on              --          on               on,off
net1/v4   zone        rw    global          --          global           --

Skip Navigation Links
Exit Print View
	Oracle Solaris Administration: Network Interfaces and Network Virtualization Oracle Solaris 11 Information Library