15.9. Hardware Monitor Commands

Command Purpose

Use this command to change the recording period of the watermark function. Use the no form of the command to restore the recording period to the default value (30).

Prerequisites

Command Syntax

hardware monitor watermark interval <1-60>

no hardware monitor watermark interval

Command Mode

Global Config

Default

The default value of recording period is 30 minutes.

Usage

Watermark function is used to record the biggest buffer usage and biggest time delay of a certain port within a period; this record is periodically.

Examples

The following example shows how to set the recording period of the watermark function to 2 minutes:

Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# hardware monitor watermark interval 2

Related Commands

show hardware monitor watermark interface IFPHYSICAL

Command Purpose

Use this command to display the maximum buffer cell usage and maximum delay of a port counted by the watermark function in a recording period. Use the clear form of the command to clear statistics on a port.

Prerequisites

Command Syntax

show hardware monitor watermark interface IFPHYSICAL

clear hardware monitor watermark interface IFPHYSICAL

Command Mode

Privileged EXEC

Default

None

Usage

None

Examples

The following example shows how to configure the watermarking function to record statistics on port eth-0-5 at a period of 1 minute:

Switch# configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
Switch(config)# hardware monitor watermark interval 1
Switch(config)# end
Switch# show hardware monitor watermark interface eth-0-5


Switch# show hardware monitor watermark interface eth-0-5
              Time        Latency  Buffer(total)
---------------------------------------------------------------------
   Jan 28 07:12:25       16040000          58373
   Jan 28 07:11:25       16032288          58373

Related Commands

None

Command Purpose

Use this command to configure the IP address and UDP port number of the notification server. Use the no form of the command to delete the configuration.

Prerequisites

Command Syntax

hardware monitor notify server A.B.C.D ( port <1-65535> | )

no hardware monitor notify server

Command Mode

Global Config

Default

The default port number is 20008.

Usage

After you run this command, the switch sends Buffer Stats Notify, Latency Stats Notify , Buffer Micro-burst Notify or Latency Event Notify packets the server periodically or immediately.

Examples

The following example show how to set the IP address of the notification server to 192.108.10.2 and UDP port number to 35000:

Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# hardware monitor notify server 192.108.10.2 port 35000

Related Commands

None

Command Purpose

Use this command to set the interval for sending Notify messages to the Notify server. Use the no form of this command to restore the interval to the default value (60).

Prerequisites

Command Syntax

hardware monitor notify interval <10-300>

no hardware monitor notify interval

Command Mode

Global Config

Default

The default interval is 60 seconds.

Usage

None

Examples

The following shows how to configure the interval to be 30 seconds:

Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# hardware monitor notify interval 30

Related Commands

None

Command Purpose

Use this command to enable the buffer cell statistics notification and congestion event notification functions on the interface. Use the no form of this command to disable the buffer cell statistics notification and congestion event notification function on the interface.

Prerequisites

Command Syntax

hardware buffer-monitor notify

no hardware buffer-monitor notify

Command Mode

Interface Configuration

Default

N/A

Usage

After this function is enabled, the switch periodically sends a Buffer Status Notify message to the notification server. When a congestion event occurs, the switch immediately sends a Buffer Micro-Burst Notify message to the notification server.

Examples

The following example shows how to enable Buffer Statistics Notification and congestion event notification for port eth-0-9:

Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface eth-0-9
Switch(config-if)# hardware buffer-monitor notify

Related Commands

None

Command Purpose

Use this command to enable Latency statistics norification and Latency enent notification on the interface. Use the no form of the command to disable lantency statistics notification and latency event notification on the interface.

Prerequisites

Command Syntax

hardware latency-monitor notify

no hardware latency-monitor notify

Command Mode

Interface Configuration

Default

N/A

Usage

After this function is enabled, the switch periodically sends Latency Notify packets to the notification server. If a Latency Event occurs, the switch immediately sends Latency Event Notify packets to the notification server.

Examples

The following example shows how to enable latency statistics notification and latency event notification on port eth-0-9 :

Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface eth-0-9
Switch(config-if)# hardware latency-monitor notify

Related Commands

None

Command Purpose

Use this command to display the number of Latency Interval Notify Messages and Latency Event Notify Messages and Buffer Interval Notify Messages and Buffer Event Notify Messages sent by the switch to the notification server. Use the clear form of the command to clear switch statistics.

Prerequisites

Command Syntax

show hardware monitor statistics

clear hardware monitor statistics

Command Mode

Privileged EXEC

Default

N/A

Usage

None

Examples

The following example shows the number of four types of notification messages sent by the switch to the notification server:

Switch# show hardware monitor statistics
Notify Statistics:
=======================================
Latency Interval Notify Messages : 0
Latency Event Notify Messages    : 0
Buffer Interval Notify Messages  : 0
Buffer Event Notify Messages     : 0

Related Commands

None

Command Purpose

Use this command to enable the congestion monitoring function for a port. Use no form of this command to disable the congestion monitoring function for a port.

Prerequisites

Command Syntax

hardware buffer-monitor enable

no hardware buffer-monitor enable

Command Mode

Interface Configuration

Default

N/A

Usage

None

Examples

The following example shows how to enable congestion monitoring for port eht-0-9:

Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface eth-0-9
Switch(config-if)# hardware buffer-monitor enable

Related Commands

None

Command Purpose

Use this command to enable the congestion event reporting function of the switch. Use no form of this command to disable the switch congestion event reporting function.

Prerequisites

Command Syntax

hardware buffer-monitor micro-burst enable

no hardware buffer-monitor micro-burst enable

Command Mode

Global Config

Default

N/A

Usage

None

Examples

The following example shows how to enable the switch congestion event reporting function:

Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# hardware buffer-monitor micro-burst enable

Related Commands

None

Command Purpose

Use this command to set the high and low threshold for reporting congestion events. Use the no form of this command to restore the high and low threshold to the default value.

Prerequisites

Command Syntax

hardware buffer-monitor micro-burst threshold low <8-16383> high <8-16383>

no hardware buffer-monitor micro-burst threshold

Command Mode

Global Config

Default

The default value of low threshold: 16

The defaulr value of high threshold: 64

Usage

None

Examples

The following example shows how to set the low threshold for triggering congestion events to 64 and the high threshold to 16000:

Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# hardware buffer-monitor micro-burst threshold low 64 high 16000

Related Commands

None

Command Purpose

Use this command to display all the configurations related to the buffer monitor on the switch.

Prerequisites

Command Syntax

show hardware buffer-monitor status

Command Mode

Privileged EXEC

Default

N/A

Usage

N/A

Examples

The following shows all the configuration for the buffer monitor on the switch:

Switch# show hardware buffer-monitor status
Hardware buffer micro-burst event: disable
Hardware buffer micro-burst threshold low: 16     high: 64
Port       buffer monitor
-----------------------------------------------------------------------------
eth-0-1    disable
eth-0-2    disable
eth-0-3    disable
eth-0-4    disable
eth-0-5    enable
eth-0-6    disable
eth-0-7    disable
eth-0-8    disable
eth-0-9    enable
eth-0-10   disable
eth-0-11   disable
eth-0-12   disable
eth-0-13   disable
eth-0-14   disable
eth-0-15   disable
eth-0-16   disable
eth-0-17   disable
eth-0-18   disable
eth-0-19   disable
eth-0-20   disable

Related Commands

None

Command Purpose

Use this command to display the number of packets accumulated on a port at a sampling time point (10 milliseconds). Use the clear form of the command to clear the statistics of a port.

Prerequisites

Command Syntax

show hardware buffer-monitor interface IFPHYSICAL ( | <16-300000> )

clear hardware buffer-monitor interface IFPHYSICAL

Command Mode

Privileged EXEC

Default

N/A

Usage

N/A

Examples

The following shows the top of 20 statistics of eth-0-5:

Switch# show hardware buffer-monitor interface eth-0-5 20
Brief CLI issued at : 08:39:15 UTC Fri Jan 28 2022
Flag (micro-burst)  : S - Start record     E - End record     U - Update record
Flag Time                 Total count
--------------------------------------------------------
-    08:39:11.698066906   58368
-    08:39:11.688067287   58367
-    08:39:11.678067668   58365
-    08:39:11.668068049   58366
-    08:39:11.658068430   58369
-    08:39:11.648068811   58368
-    08:39:11.638069192   58367
-    08:39:11.628069573   58366
-    08:39:11.618069954   58370
-    08:39:11.608070335   58367
-    08:39:11.598070716   58368
-    08:39:11.588071097   58369
-    08:39:11.578071478   58368
-    08:39:11.568071859   58367
-    08:39:11.558072240   58367
-    08:39:11.548072621   58369
-    08:39:11.538073002   58366
-    08:39:11.528073383   58368
-    08:39:11.518073764   58369
-    08:39:11.508074145   58369

Related Commands

None

Command Purpose

Use this command to view congestion events on a port. Use the clear form of the command to clear statistics on a port.

Prerequisites

Command Syntax

show hardware buffer-monitor micro-burst interface IFPHYSICAL

clear hardware buffer-monitor micro-burst interface IFPHYSICAL

Command Mode

Privileged EXEC

Default

N/A

Usage

N/A

Examples

The following shows congestion event statistics on port eth-0-5:

Switch# show hardware buffer-monitor micro-burst interface eth-0-5
Brief CLI issued at : 09:20:11 UTC Fri Jan 28 2022
Flag (micro-burst)  : S - Start record     E - End record
Flag Time(ns)             Total count          Threshold level
---------------------------------------------------------------------
E    09:20:06.892459921   15                   0
S    09:19:05.087003316   64                   0

Related Commands

None

Command Purpose

Use this command to enable the latency monitoring function for a port. Use no form of this command to disable the latency monitoring function for a port.

Prerequisites

Command Syntax

hardware latency-monitor enable

no hardware latency-monitor enable

Command Mode

Interface Configuration

Default

N/A

Usage

N/A

Examples

The following example shows how to enable the delay monitoring function for port eth-0-9:

Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface eth-0-9
Switch(config-if)# hardware latency-monitor enable

Related Commands

None

Command Purpose

Use this command to set the threshold for reporting the triggering delay event on a port. Use the no form of this command to restore the threshold to the default value.

Prerequisites

Command Syntax

hardware latency-monitor threshold event low <64-2147483647> high <64-2147483647>

no hardware latency-monitor threshold event

Command Mode

Global Config

Default

The default value of low threshold: 768

The defaulr value of high threshold: 3072

Usage

The value of the high or low threshold must be an integer multiple of 64. If the dalay time of a packet is higher than the upper threshold, the switch reports a delay start event. If the delay event of the packet is higher than the high threshold and lower than the low threshold, the switch reports a delay end event. Before running this command, you need to enable the delay monitoring function of the port.

Examples

The following example shows how to set the global low threshold for reporting congestion events and the global high threshold to 64000ns:

Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# hardware latency-monitor threshold event low 640 high 64000

Related Commands

None

Command Purpose

Use this command to configure eight delay intervals. Use the no form of the command to restore the dalay interval to the default value.

Prerequisites

Command Syntax

hardware latency-monitor range <1-4261412864> <1-4261412864> <1-4261412864> <1-4261412864> <1-4261412864> <1-4261412864> <1-4261412864>

no hardware latency-monitor range

Command Mode

Global Config

Default

the default value of latency range 1: 1-448

the default value of latency range 2: 448-768

the default value of latency range 3: 768-1152

the default value of latency range 4: 1152-1536

the default value of latency range 5: 1536-2048

the default value of latency range 6: 2048-3072

the default value of latency range 7: 3072-5120

the default value of latency range 8: 5120-infinity

Usage

None

Examples

The following example shows how to set the eight delay ranges to 1-640，640-3200，3200-6400，6400-12800，12800-25600，25600-128000，128000-256000，256000-infinity:

Switch# configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
Switch(config)# hardware latency-monitor range 640 3200 6400 12800 25600 128000 256000

Related Commands

None

Command Purpose

Use this command to enable the packet discarding function for a port with high forwarding delay. Use the no form of the command to disable this function.

Prerequisites

Command Syntax

hardware latency-monitor drop

no hardware latency-monitor drop

Command Mode

Interface Configuration

Default

None

Usage

None

Examples

The following shows how to enable the packet discarsion function with high forwarding delay on port eth-0-9:

Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface eth-0-9
Switch(config-if)# hardware latency-monitor drop

Related Commands

hardware latency-monitor threshold drop

Command Purpose

Use this command to set the threshold for the port to discard packets with high forwarding delay. Use the no form of this command to restore it to the default value.

Prerequisites

Command Syntax

hardware latency-monitor threshold drop <2-8>

no hardware latency-monitor threshold drop

Command Mode

Interface Configuration

Default

The default value of the discard threshold is 8. That is, packets whose forwarding delay reaches the eighth delay range are discard.

Usage

Before using this command, you need to enable the function of discarding packets with high forwarding delay on the port.

Examples

The following shows how to configure port eth-0-9 to discard the packets whose forwarding delay is in the sixth delay range:

Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface eth-0-9
Switch(config-if)# hardware latency-monitor threshold drop 6

Related Commands

hardware latency-monitor range

Command Purpose

Use this command to display all configurations related to latency monitor on the switch.

Prerequisites

Command Syntax

show hardware latency-monitor status

Command Mode

Privileged EXEC

Default

N/A

Usage

N/A

Examples

The following shows all the configurations for latency monitor on the switch:

Switch# show hardware latency-monitor status
Hardware latency monitor range(ns)
Range1:     1-448       Range2:   448-768       Range3:   768-1152      Range4:  1152-1536
Range5:  1536-2048      Range6:  2048-3072      Range7:  3072-5120      Range8:  5120-more

Port     monitor      event low    event high   drop-threshold
-----------------------------------------------------------------------------
eth-0-1  disable      disable      disable      disable
eth-0-2  disable      disable      disable      disable
eth-0-3  disable      disable      disable      disable
eth-0-4  disable      disable      disable      disable
eth-0-5  enable       768          3072         disable
eth-0-6  disable      disable      disable      disable
eth-0-7  disable      disable      disable      disable
eth-0-8  disable      disable      disable      disable
eth-0-9  enable       768          3072         disable
eth-0-10 disable      disable      disable      disable
eth-0-11 disable      disable      disable      disable
eth-0-12 disable      disable      disable      disable
eth-0-13 disable      disable      disable      disable
eth-0-14 disable      disable      disable      disable
eth-0-15 disable      disable      disable      disable
eth-0-16 disable      disable      disable      disable
eth-0-17 disable      disable      disable      disable
eth-0-18 disable      disable      disable      disable
eth-0-19 disable      disable      disable      disable
eth-0-20 disable      disable      disable      disable

Related Commands

None

Command Purpose

Use this command to display the number of packets collected by latency monitor on a certain port. Use the clear form of the command to clear data on a port.

Prerequisites

Command Syntax

show hardware latency-monitor interface IFPHYSICAL ( | range <1-8> ) ( | <16-300000> )

clear hardware latency-monitor interface IFPHYSICAL

Command Mode

Privileged EXEC

Default

N/A

Usage

N/A

Examples

The following shows the top 20 statistics of eth-0-5 port in the delay range 6.:

Switch# show hardware latency-monitor interface eth-0-5 range 6 20
Brief CLI issued at: 09:52:57 UTC Fri Jan 28 2022
Format:  0-448 - the count of packets with latency between 0ns and 448ns
                            0      448      768     1152     1536     2048     3072     5120
                            -        -        -        -        -        -        -        -
Time                      448      768     1152     1536     2048     3072     5120     more
09:52:57.366657807         35     2447     4492     3633      994     1256     1207      581
09:52:57.356657807         41     2519     4743     3675     1016     1463     1001      180
09:52:57.346657807         55     2752     5017     3957      961     1213      637       51
09:52:57.336657807         43     2463     4629     3519      877     1266     1123      721
09:52:57.326657807         41     2464     4827     3900      959     1243      805      403
09:52:57.316657807         37     2681     4951     3767     1015     1187      750      256
09:52:57.306657807         49     2411     4614     3541      848     1254     1175      754
09:52:57.296657807         32     2581     4571     3635     1038     1475     1138      167
09:52:57.286657807         41     2666     5036     3875      885     1057      874      207
09:52:57.276657807         38     2506     4802     3792      976     1163     1105      260
09:52:57.266657807         44     2602     5010     3581      826      966     1142      472
09:52:57.256657807         49     2599     5079     3855      918     1012      837      293
09:52:57.246657807         45     2539     4829     3919      923     1176      881      330
09:52:57.236657807         46     2628     4902     3658      925     1170     1040      273
09:52:57.226657807         41     2730     4940     3684      821      985      940      501
09:52:57.216657807         50     2766     5094     4038      890      959      748       96
09:52:57.206657807         42     2588     4813     3816      885     1144     1051      307
09:52:57.196657807         41     2496     4920     3728      788     1258     1227      180
09:52:57.186657807         35     2640     4810     3946     1010     1305      833       66
09:52:57.176657807         45     2496     4782     3809      873     1103     1062      474

Related Commands

hardware latency-monitor range

Command Purpose

Use this command to display the delay events collected on a port. Use the clear form of the command to clear statistics on a port.

Prerequisites

Command Syntax

show hardware latency-monitor event interface IFPHYSICAL

clear hardware latency-monitor event interface IFPHYSICAL

Command Mode

Privileged EXEC

Default

N/A

Usage

N/A

Examples

The following shows the statistics of delayed events on port eth-0-5:

Switch# show hardware latency-monitor event interface eth-0-5
Brief CLI issued at: 10:06:13 UTC Fri Jan 28 2022
Flags              : S - Start record     E - End record
                Time  RangeId  Latency(ns)     Status      Source Port
----------------------------------------------------------------------------------
  10:06:13.098854000        7         3232          S          eth-0-3
  10:06:13.098849000        2          576          E          eth-0-3
  10:06:13.098845000        7         3360          S          eth-0-3
  10:06:13.098840000        2          576          E          eth-0-3
  10:06:13.098836000        7         3232          S          eth-0-3
  10:06:13.098832000        2          736          E          eth-0-1
  10:06:13.098827000        7         3072          S          eth-0-3
  10:06:13.098823000        2          672          E          eth-0-1
  10:06:13.098818000        7         3968          S          eth-0-3
  10:06:13.098814000        2          672          E          eth-0-3
  10:06:13.098810000        7         3488          S          eth-0-3
  10:06:13.098805000        2          704          E          eth-0-3
  10:06:13.098801000        7         3168          S          eth-0-3
  10:06:13.098797000        2          640          E          eth-0-3

Related Commands

None