Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

evsstat (8)

Name

evsstat - Reports statistics of elastic virtual switches (EVS)

Synopsis

evsstat [-f {<fname>=<val>[,...]}[,...] [[-c] -o <field>[,...]]
                    [-u R|K|M|G|T|P] [-T d|u] [<evsname>[/<vportname>]]
     		  [interval] [count]

Description

The evsstat command reports run time statistics of each vport of the EVS. It basically reports the statistics of VNICs associated with the vports. For more information on EVS and Virtual ports, please refer to evsadm manpage.

The evsstat command is a Remote Administration Daemon (RAD) client, and it communicates with a remote EVS controller to execute all the evsstat subcommands. Before using evsstat, one has to specify a resolvable hostname or the IP address of the EVS controller. This can be done by setting the 'controller' property through 'set-prop' subcommand.

evsadm set-prop -p controller=ssh://[username@]evs-controller.example.com
# evsadm show-prop
NAME            VALUE                                         DEFAULT 
controller      ssh://[username@]evs-controller.example.com   --

Where, the optional 'username' is an user assigned with Elastic Virtual Switch Administration RBAC profile. For more information, see the prof_attr(5) man page. To simplify configuration, a user called 'evsuser' who has all the authorizations and privileges to perform EVS operations will be created when you install the mandatory EVS IPS package (service/network/evs). If you want to use the shipped 'evsuser', then you would set the controller property to:

# evsadm set-prop -p controller=ssh://evsuser@evs-controller.example.com

SSH protocol is used to communicate with EVS controller. To make the communication non-interactive, you must setup SSH authentication with pre-shared public keys between the hosts (that is, the host where evsadm will be executed, and the EVS controller). For more information, see the evsadm(8) man page and the EVS chapters in Managing Network Virtualization and Network Resources in Oracle Solaris 11.4 guide.

For all valid fields, evsstat displays numerical value. It displays '--' for value which is not applicable. It displays '?' for value which is unknown.

evsstat has the forms of command shown in the SYNOPSIS above.

Options

The evsstat command has the following options and operands.

evsname

If specified, display the statistics only for the named EVS, otherwise, display statistics for all EVS.

vportname

If specified, display the statistics only for the VNIC connected to the given vport. To specify vportname, evsname is required.

–f {<fname>=<val>[,...]}[,...], –-filter {<fname>=<val>[,...]}[,...]

A comma-separated name-value pairs used to filter the output (Row selection). If multiple filters are specified, then the displayed output is a result of AND operation among the filters. If the filter value is multi-valued, then the displayed output is a result of OR operation among the filter values. The supported filters are:

tenant

Filters the vport by tenant name

evs

Filters the vport by EVS name

vport

Filters the vport by vport name

host

Filters the vport by host name

–o field[,...], –-output=field[,...]

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

  • vport

  • evs

  • tenant

  • vnic

  • host

  • ipkts

  • rbytes

  • opkts

  • obytes

  • idrops

  • odrops

–c, –-parseable

Display output in a stable, machine-parseable format. –o option is required for this option. See Parseable Output Format, below.

-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:Kilobits, M:Megabits, T:Terabits, P:Petabits. 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.

–T d|u

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

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 a VNIC was connected to virtual port. 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

Specify the number of times to refresh the statistics. To specify count, interval is required.

Examples

Example 1 Displaying Statistics

The following command displays statistics for all the EVS. Statistics are displayed as 3-digits followed by decimal and then 2 digits with the appropriate unit.

# evsstat

VPORT        EVS   TENANT      IPKTS    RBYTES   OPKTS  OBYTES
sys-vport0   evs0  sys-tenant  101.88K  32.86M   40.16K 4.37M
sys-vport2   evs0  sys-tenant    4.50M   6.78G    1.38M 90.90M
sys-vport0   evs1  sys-tenant  132.89K  12.25M      236 15.82K
sys-vport1   evs1  sys-tenant  144.47K  13.32M      247 16.29K
Example 2 Displaying Statistics of one EVS

The following command displays the statistics of all the vports of an EVS evs0.

# evsstat evs0

VPORT         EVS   TENANT      IPKTS    RBYTES   OPKTS   OBYTES
sys-vport0    evs0  sys-tenant  101.88K  32.86M   40.16K   4.37M
sys-vport2    evs0  sys-tenant    4.50M   6.78G    1.38M  90.90M
Example 3 Displaying Statistics of one vport

The following command displays the statistics of one vport

# evsstat evs0/sys-vport2

VPORT        EVS   TENANT       IPKTS   RBYTES   OPKTS OBYTES
sys-vport2   evs0  sys-tenant   4.50M   6.78G    1.38M 90.90M
Example 4 Refresh Statistics

The following command refresh the statistics of a vport with interval 1 second for 3 times.

# evsstat evs0/sys-vport2 1 3

VPORT         EVS   TENANT       IPKTS   RBYTES   OPKTS OBYTES
sys-vport2    evs0  sys-tenant   4.50M   6.78G    1.38M 90.90M
sys-vport2    evs0  sys-tenant   4.50M   6.78G    1.38M 90.90M
sys-vport2    evs0  sys-tenant   4.50M   6.78G    1.38M 90.90M
Example 5 Selecting a Particular Set of Statistics

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

# evsstat -o vport,evs,vnic,host,ipkts,opkts
     
VPORT              EVS         VNIC       HOST  IPKTS   OPKTS
sys-vport0         evs0        vnic0      host1 101.88K  40.16K
sys-vport2         evs0        vnic0	  host2   4.50M   1.38M
sys-vport0         evs1        vnic1      host1 132.89K    236
sys-vport1         evs1        vnic1      host2 144.47K    247
Example 6 Displaying Help

The following command display the usage of evsstat

# evsstat help
evsstat [-f {<fname>=<val>[,...]}[,...] [[-c] -o <field>[,...]]
   [-u R|K|M|G|T|P] [<evsname>[/<vportname>]] [interval] [count]

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
service/network/evs
Interface Stability
See below

Screen output is Uncommitted. The invocation is Committed.

See Also

attributes(7), dladm(8), evsadm(8), kstat(8)