Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

dlstat(8)

Name

dlstat - report data links statistics

Synopsis

dlstat [-r] [-t] [
-Z] [-i interval] [
-z zone[,...]] [-T d|u] [link] [interval [count]]
dlstat [-a | -A] [
-Z] [-i interval] [
-p] [ -o field[,...]] [interval [count]]
     [-u R|K|M|G|T|P] [-z zone
[,...]] [link] [-T d|u] [link]
dlstat show-phys [-r] [-t
] [-Z] [-i interval] [
-a]
     [-p] [-o field[,...]] [
-u R|K|M|G|T|P] [-z zone[,...]] [-T d|u] [link] [interval [count]]
dlstat show-link [-r] [-t
] [-Z] [-i interval] [
-a] [-f]
     [-p] [-o field[,...]] [
-u R|K|M|G|T|P] [-z zone[,...]] [-T d|u] [link] [interval [count]]
dlstat show-link -h [-Z] [
-a] -f filename [
-d] [-F format] [
-s time]
          [-e time] [-z zone[,...]] [
link]
dlstat show-aggr [-r] [-t
] [-Z] [-i interval] [
-P probetype[,...]] [-p]
[-o field[,...]] [-u R|K|M|G|T|P] [
-z zone[,...]] [-T d|u] [link] [interval [count]]
dlstat show-ether -P 
protocol [-Z] [-i 
interval] [-p] [-o 
field[,...]]
     [-u R|K|M|G|T|P] [-T d|u] [ether-link] [interval [count]]
dlstat show-bridge [-r] [
-t] [-Z] [-i interval
] [-p] [-o field
[,...]] [-u R|K|M|G|T|P] [-z 
zone[,...]] [bridge]
dlstat show-cap [-i <interval>] [-a] [-p] -ofield,[...]] [-u 
R|K|M|G|T|P] [link] [interval [count]]
dlstat help [subcommand-name]

Description

The dlstat command reports run time statistics about data links. dladm(8) show-phys provides link-name information to dlstat show-phys. dladm(8) show-link provides link-name information to dlstat show-link. dladm(8) show-aggr provides link-aggregation information to dlstat show-aggr.

For all valid fields, dlstat displays numerical value; otherwise, it displays "--", which means not applicable.

dlstat has the forms of commands shown in the SYNOPSIS, above. The first two forms do not have subcommands, while the remaining forms do. All forms are described under “Subcommands,” below.

Options

The dlstat command has the following options and operands that are common (unless explicitly marked otherwise) among a number of command forms shown under “Subcommands,” below.

–a

Dump all statistics fields for a particular dlstat subcommand. Cannot be used with the –p option.

–i interval

If specified, it denotes the interval at which output rows are refreshed. The first row of the output is the summary that shows the total numbers since the creation of the link. The second row and beyond show the normalized (per second) statistics. If not specified, you obtain one summary since the creation of the specified link. This option is obsolete. Interval instead (and count also if you want) must be supplied as operand at the end of the command. Also, you cannot supply interval at both option and operand. Doing so will result in error.

–o field[,...]

Display a case-insensitive, comma-separated list of output fields to display. The field name must be one of the fields listed below, or the special value all to display all supported fields.

List of supported RX fields:

  • link

  • index

  • rbytes

  • ipkts

  • intrs (only applicable without a subcommand or with show-link)

  • polls (only applicable without a subcommand or with show-link)

  • idrops (applicable with the –r option, or without a subcommand, or with show-link or, with show-aggr or, with show-phys)

  • idropbytes (applicable with show-aggr or, with show-phys or, with show-link)

List of TX side fields:

  • link

  • index

  • obytes

  • opkts

  • odrops (applicable either with the –t option or, either without a subcommand or, with show-link or, with show-aggr or, with show-phys)

  • odropbytes (applicable with show-aggr or, with show-phys or, with show-link)

For the show-phys subcommand, the index column identifies individual RX and TX hardware rings within a physical device. For the show-link subcommand, the index column identifies RX and TX hardware lanes within a data link. See Oracle Solaris Administration: Network Interfaces and Network Virtualization for an explanation of the difference between hardware rings and hardware lanes.

For the show-phys subcommand, idrops/idropbytes/odrops/odropbytes correspond to the packets dropped per MAC instance by the hardware, as reported by the device driver. For the show-link subcommand, idrops/idropbytes/odrops/odropbytes correspond to the packets dropped per datalink in the software.

–p

Display output in a stable, machine-parseable format.

–r

Display receive-side statistics only. Includes bytes and packets received, hardware and software drops, and so forth. See “Examples” for complete listing.

–r and –t could be used together in one command to display both receive-side as well as transmit-side statistics simultaneously.

–t

Display transmit-side statistics only. Includes bytes and packets sent, drops, and so forth. See “Examples” for complete listing.

–u R|K| M|G|T|P

If used, allows choosing the unit in which to display all statistics, for example, R:raw count, K:Kilobytes, M:Megabytes, G:Gigabytes, T:Terabytes, P:Petabytes. If not used, then different units, as appropriate, are used to display the statistics, using the format xy.zU, where x, y, and z are numbers and U is the appropriate unit.

–Z

Display ZONE column in the output.

–z zone[,...]

Display the statistics only for links in the specified zone. By default, dlstat displays the statistics for links in all the zones when it is run from the global zone.

When run from a non-global zone, dlstat displays statistics only for links in that zone. A non-global zone cannot see links in other zones.

–T u|d

Specify u for a printed representation of the internal representation of time. for more information, see the time(2) man page. Specify d for standard date format. for more information, see the date(1) man page.

interval

If specified, it denotes the interval at which output rows are refreshed. The first row of the output is the summary that shows the total numbers since the creation of the link. The second row and beyond show the normalized (per second) statistics. If not specified, you obtain one summary since the creation of the specified link.

count

If specified, only print 'count' rows. If not specified, print indefinitely.

link

If specified, display the statistics only for the named link, physical device (for show-phys), or aggregation (for show-aggr). Otherwise, display statistics for all links, devices, or aggregations.

Sub Commands

dlstat supports the following command forms.

dlstat [–r] [–t] [–Z] [–i interval] [–z zone[,...]] [link] [interval [count]]

Iteratively examine all links and report statistics. The output is sorted in descending order of link utilization. If no link is specified, the system displays statistics for all links. The traffic statistics are displayed per link and not per physical device. For example, for a VNIC configured on a physical link, traffic flowing through that VNIC is not reflected in the statistics for the underlying physical link. However, the link statistics will include traffic that matches user-defined flows configured on top of that link.

This command form has one option that is not described under “Options,” above:

–A

Dump all statistics fields for this data-link. Output statistics of this command are inclusive of all the statistics reported by all other dlstat commands. Cannot be used with the –p option.

dlstat [–a | –A] [–Z] [–i interval] [–p] [ –o field[,...]] [–u R|K|M| G|T|P] [–z zone[,...]] [link] [interval [count]]

Allows specifying which statistics to display.

The options for this command form are described under “Options,” above.

dlstat show-phys [–r] [–t] [–Z] [–i interval ] [–a] [–p] [ –o field[,...]] [–u R|K| M|G|T|P] [–z zone[,...]] [link] [interval [count]]

Display statistics for a physical device.

The options for this subcommand are described under “Options,” above.

dlstat show-link [–r] [–t] [–Z] [–i interval ] [–a] [–f] [–p] [ –o field[,...]] [–u R|K| M|G|T|P] [–z zone[,...]] [link] [interval [count]]

Display statistics for a link. In show-link output, under the ID heading, there can be:

local

Traffic loopback in L2.

hw

Hardware lane.

sw

Software lane.

other

Includes broadcast and multicast traffic. Over the lifetime of a datalink, some hardware lanes might go away. Traffic as seen by those hardware lanes is added to the other count.

The INDEX heading in show-link output is as described in the –o option under “Options,” above. Numbers displayed under INDEX apply only to hardware lanes.

dlstat show-link –h [– Z] [–a] –f filename [– d] [–F format] [–s time] [–e time] [– z zone[,...]] [link] [interval [count]]

Show the network usage history from a stored extended accounting file. Use of this syntax requires that net accounting has been previously configured and enabled by using acctadm(8). The default output is the summary of network usage of the existing links for the entire period when extended accounting was enabled.

The link argument is as described under “Options,” above.

–a

Display all historical network usage for the specified period when extended accounting is enabled. This includes usage information about links that have already been deleted.

–f filename

Specify the file from which extended accounting records of network usage history are read. This option can also be used to report per-RX fanout packets and packet drops.

–d

Display the dates for which there is logging information. The date is in the format mm/dd/ yyyy.

–F format

Specify the output format of the network usage history information. gnuplot is the only supported format.

–s time
–e time

Specify start and stop times for data display. Time is in the format MM/DD/ YYYY,hh:mm:ss. hh uses 24-hour clock notation.

dlstat show-aggr [–r] [–t] [–Z] [–i interval ] [–P probetype[,...]] [–p] [ –o field[,...]] [–u R|K|M| G|T|P] [–z zone[,...]] [link] [interval [count]]

Display per-port statistics for an aggregation. Note that –r and –t options display per-ring statistics of the aggregation.

–P probetype[,...]

Display the probe information for the given DLMP mode aggregation ["probe" output mode]. Note that the –P option cannot be used together with the –z, –i, –Z, – u or –r options.

It takes case-insensitive, common-separated list of probetype options, which can be one of "m", "u", "x" or "all", representing the ICMP multicast probes, ICMP unicast probes, transitive probes or all types of probes respectively.

Once the "probe" output mode is used, it runs until explicitly terminated using Ctrl+C. The following output fields are supported:

TIME

The time the probe was sent, relative to when dlstat show-aggr -P was started. If the probe was sent prior to starting dlstat, the time will be negative.

AGGR

The aggregation name for which the probe was sent.

PORT

The port name for which the probe was sent.

LOCAL

For ICMP probes, this is the source IP address of the probes. For transitive probes, this is the port name the transitive probe was originated from.

REMOTE

For ICMP probes, this is the destination IP address of the probes. For transitive probes, this is the port name the transitive probe was targeted to.

PROBE

An identifier number representing the probe. The identifier embeds a prefix denoting the probe type, followed by a numerical identifier for the probe. The permissible values for the probe type are:

u

ICMP unicast probes

m

ICMP multicast discovery probes

x

Transitive probes

NETRTT

The network round-trip-time for the probe. This is the time between when the IP module sends the probe and when the IP module receives the acknowledgment. If in.dlmpd has concluded that the probe has been lost, this field will be empty.

RTT

The total round-trip-time for the probe. This is the time between when in.dlmpd starts executing the code to send the probe, and when it completes processing the ack. If in.dlmpd has concluded that the probe has been lost, this field will be empty. Spikes in the total round-trip time that are not present in the network round-trip time indicate that the local system itself is overloaded.

Other options for this subcommand are described under "Options" above.

dlstat show-ether –P protocol [–Z] [–I interval ] [–p] [–o field[,...]] [–u R|K|M|G|T|P] [ether-link] [interval [count]]

Display statistics for a given Ethernet protocol on a link. Supported IEEE protocols include vdp, the VSI Discovery and Configuration Protocol and ecp, Edge Control Protocol.

VDP statistics can be obtained on VNICs or a physical link. The VDP statistics for a physical link is the cumulative statistics of all the VNICs over it.

ECP statistics can be obtained for a physical link.

Fields displayed for VDP include:

LINK

The name of the link.

IPKTS

The number of inbound VDP packets.

OPKTS

The number of outbound VDP packets.

KeepAlives

The number KEEP-ALIVE packets transmitted.

Fields displayed for ECP include:

LINK

The name of the link.

IPKTS

The number of inbound ECP packets.

IERRORS

The number of inbound ECP packets in error.

OPKTS

The number of outbound ECP packets.

OERRORS

The number of errors when transmitting an ECP packet.

RETRANSMITS

The number of packets retransmitted.

TIMEOUTS

The number of timeouts, that is, the number of packets not acknowledged by the peer.

dlstat show-bridge [–r] [–t] [–Z] [–i interval ] [–p] [–o field[,...]] [–u R|K|M|G|T|P] [–z zone[,...]] [bridge]

Displays per-link statistics for bridges. The options for this subcommand are described under "Options". The optional bridge field is used to display the statistics of only one bridge.

Fields displayed for this subcommand include:

BRIDGE

Bridge name.

LINK

The name of link connected to bridge.

IPKTS

The number of inbound packets.

RBYTES

The number of bytes of the inbound packets.

OPKTS

The number of outbound packets.

OBYTES

The number of bytes of the outbound packets.

DROPS

Number of packets dropped due to resource problems.

FORWARDS

Number of packets forwarded from one link to another.

MBCAST

Number of multicast and broadcast packets handled by the bridge.

UNKNOWN

Number of packets handled that have an unknown destination. Such packets are sent to all links.

CFGBPDU

Number of configuration BPDUs received.

TCNBPDU

Number of topology change BPDUs received.

RSTPBPDU

Number of Rapid Spanning Tree BPDUs received.

TXBPDU

Number of BPDUs transmitted.

When the –o option is not specified, only the BRIDGE , LINK, IPKTS, RBYTES, OPKTS, OBYTES, DROPS and FORWARDS fields are shown.

dlstat show-cap [–i interval] [–p] [–o field[,...]] [–u R|K|M|G|T|P] [link] [interval [count]]

Display statistics for capture links/individual link bound to zone, where dlstat command is running. The options for this subcommand are described under "Options".

help [subcommand-name]

Displays all the supported dlstat subcommands or usage for the given subcommand. If you invoke help for a specific subcommand, the command syntax is displayed, along with an example. Using dlstat help without any argument displays all of the subcommands.

Examples

Example 1 Displaying Statistics

To display statistics for all the links, enter following command. Statistics are displayed as 3-digits followed by decimal and then 2 digits with the appropriate unit.

# dlstat
      LINK   IPKTS  RBYTES   OPKTS  OBYTES
   e1000g0 101.88K  32.86M  40.16K   4.37M
     nxge1   4.50M   6.78G   1.38M  90.90M
     vnic1       8     336       0       0
      net0  73.96K   6.81M       0       0
zone1/net0 144.47K  13.32M     247  16.29K
zone2/net0 132.89K  12.25M     236  15.82K
Example 2 Displaying RX-side Statistics

The following command displays receive-side statistics every two seconds for three times.

# dlstat 2 2
    LINK   IPKTS  RBYTES   INTRS   POLLS   IDROPS
e1000g0 101.91K  32.86M  87.56K  14.35K         0
  nxge1   9.61M  14.47G   5.79M   3.82M         0
  vnic1       8     336       0       0         0
e1000g0       0       0       0       0         0
  nxge1  82.13K 123.69M  50.00K  32.13K         0
  vnic1       0       0       0       0         0
e1000g0       0       0       0       0         0
nxge1    85.74K 126.41M  48.71K  28.87K         0
  vnic1       0       0       0       0         0
Example 3 Displaying Statistics per Physical Device

The following command displays statistics for a specific physical device.

# dlstat show-phys ixgbe0
   LINK   IPKTS  RBYTES   INTRS   POLLS
 ixgbe0 101.91K  32.86M  87.56K  14.35K
Example 4 Displaying Statistics per Datalink

The following command displays statistics for a specific datalink.

# dlstat show-link ixgbe0
  LINK    IPKTS   RBYTES    OPKTS   OBYTES
ixgbe0    2.14M  257.48M    3.19M  210.88M
Example 5 Displaying Statistics per Hardware Ring

The following commands displays statistics on a per receive-side hardware ring basis.

# dlstat show-phys -r nxge1
 LINK TYPE   INDEX   IPKTS  RBYTES
nxge1   rx       0       0       0
nxge1   rx       1       0       0
nxge1   rx       2   1.73M   2.61G
nxge1   rx       3       0       0
nxge1   rx       4   8.44M  12.71G
nxge1   rx       5   5.68M   8.56G
nxge1   rx       6   4.90M   7.38G
nxge1   rx       7       0       0
Example 6 Displaying Statistics per Lane

The following commands displays statistics on a per receive-side lane basis. First, an interface with dedicated hardware lanes:

# dlstat show-link -r nxge1
 LINK TYPE     ID INDEX   IPKTS  RBYTES   INTRS   POLLS  IDROPS
nxge1   rx  local    --       0       0       0       0       0
nxge1   rx     hw     1       0       0       0       0       0
nxge1   rx     hw     2   1.73M   2.61G   1.33M 400.22K       0
nxge1   rx     hw     3       0       0       0       0       0
nxge1   rx     hw     4   8.44M  12.71G   4.35M   4.09M       0
nxge1   rx     hw     5   5.68M   8.56G   3.72M   1.97M       0
nxge1   rx     hw     6   4.90M   7.38G   3.11M   1.80M       0
nxge1   rx     hw     7       0       0       0       0       0

Then, an interface without dedicated hardware lanes, that is, a software lane only:

# dlstat show-link -r ixgbe0
  LINK TYPE     ID INDEX   IPKTS  RBYTES   INTRS   POLLS IDROPS
ixgbe0   rx  local    --       0       0       0       0      0
ixgbe0   rx     sw    -- 794.28K   1.19G 794.28K       0      0
Example 7 Displaying Transmit-Side Statistics

The following command displays transmit-side statistics at five-second intervals.

# dlstat -t 5
  LINK   OPKTS  OBYTES  ODROPS
e1000g0  40.24K   4.37M      0
  nxge1   9.76M 644.14M      0
  vnic1       0       0      0
e1000g0       0       0      0
  nxge1  26.82K   1.77M      0
  vnic1       0       0      0
      .       .       .      .
      .       .       .      .
      .       .       .      .
Example 8 Displaying Transmit-Side Ring Statistics

The following command displays transmit-side hardware ring statistics.

# dlstat show-phys -t nxge1
 LINK TYPE INDEX   OPKTS  OBYTES
nxge1   tx     0      44   3.96K
nxge1   tx     1       0       0
nxge1   tx     2   1.48M 121.68M
nxge1   tx     3   2.45M 201.11M
nxge1   tx     4   1.47M 120.82M
nxge1   tx     5       0       0
nxge1   tx     6   1.97M 161.57M
nxge1   tx     7   4.59M 376.21M
nxge1   tx     8   2.43M 199.24M
nxge1   tx     9       0       0
nxge1   tx     10  3.23M 264.69M
nxge1   tx     11  1.88M 153.96M
Example 9 Displaying Transmit-Side Lane Statistics

The following command displays transmit-side lane statistics.

# dlstat show-link -t nxge1
 LINK TYPE     ID INDEX   OPKTS  OBYTES  ODROPS
nxge1   tx     hw     0      32   1.44K       0
nxge1   tx     hw     1       0       0       0
nxge1   tx     hw     2   1.48M  97.95M       0
nxge1   tx     hw     3   2.45M 161.87M       0
nxge1   tx     hw     4   1.47M  97.25M       0
nxge1   tx     hw     5       3     276       0
nxge1   tx     hw     6   1.97M 130.05M       0
nxge1   tx     hw     7   4.59M 302.80M       0
nxge1   tx     hw     8   2.42M 302.80M       0
nxge1   tx     hw     9       0       0       0
nxge1   tx     hw     10  3.23M 213.05M       0
nxge1   tx     hw     11  1.88M 123.93M       0
Example 10 Displaying Both RX and TX Lane Statistics

The following command displays both receive-side and transmit-side lane statistics.

# dlstat show-link -rt nxge0
 LINK  TYPE      ID  INDEX     PKTS    BYTES
nxge0    rx   local     --        0        0
nxge0    rx   other     --        0        0
nxge0    rx      hw      0        0        0
nxge0    rx      hw      1        0        0
nxge0    rx      hw      2        0        0
nxge0    rx      hw      3        0        0
nxge0    rx      hw      4        0        0
nxge0    rx      hw      5        0        0
nxge0    rx      hw      6        0        0
nxge0    rx      hw      7        0        0
nxge0    tx   local     --        0        0
nxge0    tx   other     --        3      126
nxge0    tx      hw      0        0        0
nxge0    tx      hw      1        0        0
nxge0    tx      hw      2        0        0
nxge0    tx      hw      3        0        0
nxge0    tx      hw      4        0        0
nxge0    tx      hw      5        0        0
nxge0    tx      hw      6        0        0
nxge0    tx      hw      7        0        0
nxge0    tx      hw      8        0        0
nxge0    tx      hw      9        0        0
nxge0    tx      hw     10        0        0
nxge0    tx      hw     11        0        0
Example 11 Selecting a Particular Set of Statistics

The following command shows how you can select a set of statistics of particular interest.

# dlstat show-link -r -o LINK,TYPE,ID,INDEX,INTRS,POLLS nxge1
 LINK TYPE     ID INDEX   INTRS   POLLS
nxge1   rx  local    --       0       0
nxge1   rx  other    --       0       0
nxge1   rx     hw     1       0       0
nxge1   rx     hw     2   2.47M 753.90K
nxge1   rx     hw     3       0       0
nxge1   rx     hw     4   8.24M   7.72M
nxge1   rx     hw     5   6.96M   3.68M
nxge1   rx     hw     6   5.82M   3.36M
nxge1   rx     hw     7       0       0
Example 12 Displaying Historical Network Usage

Network usage history statistics can be stored by using the extended accounting facility, acctadm(8), with a command such as the following:

# acctadm -e basic -f /var/log/net.log net
acctadm net
Network accounting: active
    Network accounting file: /var/log/net.log
  Tracked Network resources: basic
Untracked Network resources: src_ip,dst_ip,src_port,dst_port,protocol,
                             dsfield

The saved historical data can then be retrieved in summary form with commands such as the following:

# dlstat show-link -h -f /var/log/net.log
LINK      DURATION  IPACKETS RBYTES      OPACKETS OBYTES      BANDWIDTH
e1000g0   80        1031     546908      0        0           2.44 Kbps

# dlstat show-ether -P vdp ixgbe1
LINK          IPKTS    OPKTS  KeepAlives
ixgbe1          3       2       1

# dlstat show-ether -P ecp ixgbe1
LINK          IPKTS    OPKTS  IERRORS  OERRORS RETRANSMITS TIMEOUTS
ixgbe1          3       2       0       0       1            0
Example 13 Displaying ICMP Unicast and Transitive Probe Information

The following command displays ICMP unicast and transitive probe information.

# dlstat show-aggr -P u,x aggr1
TIME	    AGGR	PORT   LOCAL	  TARGET  PROBE	 NETRTT	    RTT
0.53s    aggr1	s0	    s0	     s1      x16148  --	       --
0.53s    aggr1	s0	    s0	     s1      x16148  0.62ms     0.87ms
1.17s    aggr1	s1	    s1	     s0      x16148  --	       --
1.17s    aggr1	s1	    s1	     s0      x16148  0.72ms     0.99ms
2.24s    aggr1	s1    192.169.0.1 192.169.0.2 u15535 --   --
2.24s    aggr1	s1    192.169.0.1 192.169.0.2 u155350.11ms 0.55ms
Example 14 Displaying Help

The following command lists all of the dlstat subcommands.

# dlstat help
The following subcommands are supported:
Stats subcommands : show-aggr, show-link, show-phys
For more info, run: dlstat help subcommand

The following command illustrates the use of dlstat help with a specific subcommand.

# dlstat help show-phys
usage:
show-phys    [-r] [-t] [-Z] [-i interval] [-a]
             [-p] [-o field[,...]] [-u R|K|M|G|T|P] 
             [-z zone[,...]] [link]

example:
     # dlstat show-phys -r -o all -u K net0

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
system/network
Interface Stability
See below

Screen output is Uncommitted. The invocation is Committed.

See Also

attributes(7), acctadm(8), dladm(8), ifconfig(8), kstat(8), netstat(8)