Table of Contents

Related Documents

27-KPI data collection commands

Title	Size	Download
27-KPI data collection commands	189.98 KB

KPI data collection commands

Available external indicators for KPI data collection

Table 1 lists some available external indicators for KPI data collection.

Table 1 Available external indicators for KPI data collection

Class	Module	Object	Indicator	Indicator description
Net-performance	IF-USAGE-EX	Interface. The value is interface-type interface-number.	Port_TXBW_Usage	Output bandwidth usage of the interface, in the range of 0% to 100%.
Net-performance	IF-USAGE-EX	Interface. The value is interface-type interface-number.	Port_RXBW_Usage	Input bandwidth usage of the interface, in the range of 0% to 100%.
Device-resource	ARP-MSG-QUEUE	Custom message queue. The value is message-queue.	ARP_PKTQ_Health	ARP packet queue health, which is the ratio of the number of messages in the queue to the total queue size. The value range is 0% to 100%.
	ARP-MSG-QUEUE	Custom message queue. The value is message-queue.	ARP_EVTQ_Health	ARP event queue health, which is the ratio of the number of messages in the queue to total queue size. The value range is 0% to 100%.
	ND-MSG-QUEUE	Custom message queue. The value is message-queue.	ND_PKTQ_Health	ND packet queue health, which is the ratio of the number of messages in the queue to the total queue size. The value range is 0% to 100%.
	ND-MSG-QUEUE	Custom message queue. The value is message-queue.	ND_EVTQ_Health	ND event queue health, which is the ratio of the number of messages in the queue to total queue size. The value range is 0% to 100%.
	MAC-USAGE	Card. The value is chassis.x/slot.y.	MAC_Addr_Useage	MAC address usage of the card, in the range of 0% to 100%.
	AGG-USAGE	Device. The value is device.	AGG_ID_Useage	Aggregate interface ID resource usage on the device, in the range of 0% to 100%.
	ACL_USE	Chip. The value is chassis.x/slot.y/chip.z.	ACL_USE_IPV4_RATIO	IPv4 ACL entry resource usage, in the range of 0% to 100%.
	ACL_USE	Chip. The value is chassis.x/slot.y/chip.z.	ACL_USE_IPV6_RATIO	IPv6 ACL entry resource usage, in the range of 0% to 100%.
	CGN	Card. The value is chassis.x/slot.y.	CGN_SESSION_USAGE	CGN session resource usage, in the range of 0% to 100%.
	CGN	Card. The value is chassis.x/slot.y.	CGN_FWD_RX_USAGE	Input bandwidth usage of the CGN card, in the range of 0% to 100%.
	CGN	Card. The value is chassis.x/slot.y.	CGN_FWD_TX_USAGE	Output bandwidth usage of the CGN card, in the range of 0% to 100%.
	NAT_ADDRGRP_RES	NAT address group usage. The value is group-name.	NAT_ADDRGRP_CUR_RES_USAGE	Resource usage of the address group, in the range of 0% to 100%.
	NAT_IPPOOL_RES	Address pool. The value is pool-name.	NAT_IPPOOL_CUR_RES_USAGE	Address pool resource usage, in the range of 0% to 100%.
	NAT_QUEUE	Queue. The value is Nat_cgn_send_queue.	NAT_QUEUE_LEN	Queue length.
	CGN_QUEUE	Queue. The value is CGN_SEND_QUEUE.	CGN_QUEUE_LEN	Queue length.
	SOFTQUEINFO	Custom message queue. The value is chassis.x/slot.y/RQ.u.	SOFTQUE_PACKET	Number of packets in the software queue.
	SOFTQUEINFO	Custom message queue. The value is chassis.x/slot.y/RQ.u.	SOFTQUE_DROP	Number of dropped packets in the software queue.
Device-state	BFD	Device. The value is device.	BFD_TOTAL_NUMBER	Total number of BFD sessions.
	VRRP-V4	Device. The value is device.	VRRP_FAIL_STATE_RATIO_V4	Ratio of abnormal VRRPv4 sessions to total VRRPv4 sessions. The value is a decimal in the range of 0 to 1.
	VRRP-V6	Device. The value is device.	VRRP_FAIL_STATE_RATIO_V6 address family.	Ratio of abnormal VRRPv6 sessions to total VRRPv6 sessions. The value is a decimal in the range of 0 to 1.
	VRRP-V4 address family.	Device. The value is device.	VRRP_STATE_CONVER_V4 address family.	Number of master/backup switchovers in the VRRPv4 group.
	VRRP-V6 address family.	Device. The value is device.	VRRP_STATE_CONVER_V6 address family.	Number of master/backup switchovers in the VRRPv6 group.
	STRUNK	Subcard. The value is chassis.x/slot.y/subslot.z.	STRUNK_FAIL_STATE_RATIO	Ratio of abnormal S-Trunk sessions to total S-Trunk sessions. The value is a decimal in the range of 0 to 1.
	STRUNK	Device. The value is device.	STRUNK_GROUP_STATE_CONVER	Number of S-Trunk group state changes.
	STRUNK	Device. The value is device.	STRUNK_MEMBER_STATE_CONVER	Number of S-Trunk member state changes.
	ACL_STATE	Card. The value is chassis.x/slot.y.	ACL_COPP_IPV4_USE_STATE	State of IPv4 ACL entry operation in a COPP service cycle: · 0—Normal. · 1—Abnormal.
	ACL_STATE	Card. The value is chassis.x/slot.y.	ACL_COPP_IPV6_USE_STATE	State of IPv6 ACL entry operation in a COPP service cycle: · 0—Normal. · 1—Abnormal.
	ACL_STATE	Card. The value is chassis.x/slot.y.	ACL_ATTACK_USE_STATE	State of ACL entry operation in an anti-attack service cycle: · 0—Normal. · 1—Abnormal.
	ARP_ND	Card. The value is chassis.x/slot.y.	ARP_USE_NUM	Number of ARP entry deployments within a collection interval.
	FIB	Card. The value is chassis.x/slot.y.	FIB_USE_NUM	Number of FIB entry deployments within a collection interval.
	IBC_CHAN	Device. The value is device.	IBC_GE_STATE	GE channel link state: · 0—Normal. · 1—Abnormal.
	IBC_CHAN	Device. The value is device.	IBC_FE_STATE	FE channel link state: · 0—Normal. · 1—Abnormal.
	ARP_ND	Card. The value is chassis.x/slot.y.	ND_USE_NUM	Number of ND entry deployments within a collection interval.
	ARP_ND	Card. The value is chassis.x/slot.y.	ARP_USE_STATE	Whether ARP entry deployment to the driver is abnormal within a collection interval.
	ARP_ND	Card. The value is chassis.x/slot.y.	ND_USE_STATE	Whether ND entry deployment to the driver is abnormal within a collection interval.
	FIB	Card. The value is chassis.x/slot.y.	FIB6_USE_NUM address family.	Number of IPv6 FIB entry deployments within a collection interval.
	FIB	Card. The value is chassis.x/slot.y.	FIB4_USE_STATE	Whether IPv4 FIB entry deployment to the driver is abnormal within a collection interval.
	FIB	Card. The value is chassis.x/slot.y.	FIB6_USE_STATE	Whether IPv6 FIB entry deployment to the driver is abnormal within a collection interval.
	VSRP_INSTANCE	VSRP instance. The value is instance-name.	VSRP_INSTANCE_STATE	VSRP instance state: · Master. · Backup. · Down.
	VSRP_PEER	VSRP peer. The value is peer-name.	VSRP_PEER_STATE	VSRP peer state: · 0—Connected. · 1—Not connected.
	BFD	Device. The value is device.	BFD_NORMAL_NUMBER	Number of normal BFD sessions.
	PROTORATE	Protocol type: · 1588_FD. · 1588_FE. · 1588_FF. · 8021x_B.	PROTO_RATE	Rate of protocol packets sent to the operating system, in pps.

display kpi data

Use display kpi data to display the KPI data for an object of a module within a time range on the storage media.

Syntax

display kpi data module module-name object object-name from time1 date1 to time2 date2 [ file file-path ]

Views

Any view

Predefined user roles

network-admin

network-operator

Parameters

module module-name: Specifies a module by its name. For more information, see "Available external indicators for KPI data collection."

object object-name: Specifies an object by its name. An object is a physical or logical entity to which indicators belong, such as device, card, or subcard. The value for the object-name argument varies by object type. For external indicators, the object type and the value for the object-name argument vary by module and device model. For more information, see "Available external indicators for KPI data collection." Object name examples are as follows:

· device—Specifies a device. Indicators for this object describe the overall condition of the device.

· chassis.x/slot.y—Specifies a card. Indicators for this object describe the performance of the card. The value for the x argument is 0, and the y argument represents the slot number of the card. (In standalone mode.)

· chassis.x/slot.y—Specifies a card. Indicators for this object describe the performance of the card. The x argument represents the member ID of the IRF member device, and the y argument represents the slot number of the card. (In IRF mode.) ‌

· chassis.x/slot.y/subslot.z—Specifies a subcard. Indicators for this object describe the performance of the subcard. The value for the x argument is 0, the y argument represents the slot number of the card, and the z argument represents the subcard ID. (In standalone mode.)

· chassis.x/slot.y/subslot.z—Specifies a subcard. Indicators for this object describe the performance of the subcard. The x argument represents the member ID of the IRF member device, the y argument represents the slot number of the card, and the y argument represents the subcard ID. (In IRF mode.) ‌

· interface-type interface-number—Specifies an interface by its type and number. Indicators for this object describe the running status of the physical interface.

· chassis.x/slot.y/chip.z—Specifies a chip. The value for the x argument is 0, the y argument represents the member ID of the IRF member device, and the z argument represents the chip ID. (In standalone mode.)

· chassis.x/slot.y/chip.z—Specifies a chip. The x argument represents the member ID of the IRF member device or the virtual chassis number of the PEX, the y argument represents the slot number of the card, and the z argument represents the chip ID. (In IRF mode.) ‌

· chassis.x/slot.y/chip.z—Specifies a chip. The value for the x argument is 0, the y argument represents the slot number of the card, and the z argument represents the chip ID. ‌(In standalone mode.)

· chassis.x/slot.y/chip.z—Specifies a chip. The x argument represents the member ID of the IRF member device, the y argument represents the slot number of the card, and the z argument represents the chip ID. (In IRF mode.) ‌

· up-x—Specifies a UP. The x argument represents the UP ID, in the range of 1024 to 2047.

from time1 date1: Specifies the start time and date for KPI data collection. The time1 argument specifies the time of the day in hh:mm:ss format. Its value is in the range of 00:00:00 to 23:59:59. The date1 argument specifies a date in MM/DD/YYYY or YYYY/MM/DD format. MM represents the month, in the range of 1 to 12. DD represents the day and its value range depends on the specified month. YYYY represents the year, in the range of 2000 to 2035.

to time2 date2: Specifies the end time and date for KPI data collection. The time2 argument has the same format and value range as the time1 argument. The date2 argument has the same format and value range as the date1 argument. The end time and date must be later than the start time and date.

file file-path: Specifies the KPI cache file path on the storage media. If you do not specify this option, the command displays the KPI data in all cache files.

Examples

# Display the KPI data for the Ten-GigabitEthernet 3/1/1 object of the IF-USAGE-EX module in the time range from 2025/5/13 14:00:00 to 2025/5/13 23:00:00.

<Sysname> display kpi data module IF-USAGE-EX object Ten-GigabitEthernet3/1/1 from 14

:00:00 2025/5/13 to 23:00:00 2025/5/13

Module : IF-USAGE-EX

Object : Ten-GigabitEthernet3/1/1

Slot : 8

Indicator Value Latest collect time

Port_RXBW_Usage 100 2025-05-13 15:38:41

Port_RXBW_Usage 100 2025-05-13 15:33:40

Table 2 Command output

Field	Description
Module	Module name. For more information, see "Available external indicators for KPI data collection."
Slot	Slot on which the object resides.
Object	Object for KPI data collection.
Indicator	Indicator for KPI data collection. For more information, see "Available external indicators for KPI data collection."
Value	Value for the indicator.
Latest collect time	Most recent time when the indicator value was collected.

Related commands

kpi collect module enable

display kpi module-info

Use display kpi module-info to display KPI data collection information for a module.

Syntax

display kpi module-info [ module-name ] [ verbose ]

Views

Any view

Predefined user roles

network-admin

network-operator

Parameters

module-name: Specifies a module by its name. For more information, see "Available external indicators for KPI data collection." If you do not specify a module name, the command displays KPI data collection information for all available modules.

verbose: Displays detailed KPI data collection information about the module. If you do not specify this keyword, the command displays brief KPI data collection information about the module.

Examples

# Display brief KPI data collection information for the ARP_ND module.

<Sysname> display kpi module-info ARP_ND

Module : ARP_ND

Class : Device-state

KPI Collect : Enabled

Collect interval : 60 seconds

Collect times : 163

# Display detailed KPI data collection information for the ARP_ND module.

<Sysname> display kpi module-info ARP_ND verbose

Module : ARP_ND

Class : Device-state

KPI Collect : Enabled

Collect interval : 60 seconds

Collect times : 1632

Slot : 18

Object : chassis.0/slot.18

Indicator Value Latest collect time

ARP_USE_NUM 0 2025-05-15 18:12:54

ND_USE_NUM 0 2025-05-15 18:12:54

ARP_USE_STATE 0 2025-05-15 18:12:54

ND_USE_STATE 0 2025-05-15 18:12:5

Table 3 Command output

Field	Description
Module	Module name. For more information, see"Available external indicators for KPI data collection."
Class	KPI class to which the module belongs. For more information, see "Available external indicators for KPI data collection."
KPI Collect	State of KPI data collection: · Enabled. · Disabled.
Collect interval	KPI data collection interval, in seconds.
Collect times	Number of KPI data collections.
Chassis	Chassis number of the object.
Slot	Slot number of the object.
Object	Object name.
Indicator	Indicator for KPI data collection. For more information, see "Available external indicators for KPI data collection."
Value	Value for the indicator.
Latest collect time	Most recent time when the indicator value was collected.

display system internal kpi register-status

Use display system internal kpi register-status to display the running status and registration information of KPI data collection for a module.

Syntax

display system internal kpi register-status [ module module-name ]

Views

Any view

Predefined user roles

network-admin

network-operator

Parameters

module-name: Specifies the module name. If you do not specify a module, the command displays the running status and registration information of KPI data collection for all available modules. For more information, see "Available external indicators for KPI data collection."

Usage guidelines

Use this command to display external indicators for KPI data collection.

Examples

# Display the running status and registration information of KPI data collection for the IF-USAGE-EX module.

<Sysname> display system internal kpi register-status module IF-USAGE-EX

Module : IF-USAGE-EX

Support suppress : True

Indicator : Port_TXBW_Usage

Support alarm : True

Support eai : False

Collect type : Always

Low threshold : 0

Normal threshold : 30

Level 1 threshold : 50

Level 2 threshold : 70

Level 3 threshold : 90

Indicator : Port_RXBW_Usage

Support alarm : True

Support eai : False

Collect type : Always

Low threshold : 0

Normal threshold : 30

Level 1 threshold : 50

Level 2 threshold : 70

Level 3 threshold : 90

Table 4 Command output

Field	Description
Module	Module name.
Support suppress	Whether the module supports data collection suppression: · True—The module supports data collection suppression. When the CPU or memory usage exceeds the upper limit, data collection for the module suspends. · False—The module does not support data collection suppression. When the CPU or memory usage exceeds the upper limit, data collection for the module does not suspend.
Indicator	Indicator name.
Support alarm	Whether alarms are supported: · True. · False.
Support eai	Whether EAI monitoring and prediction are supported: · True. · False.
Collect type	Alarm and log report mode of the indicator: · Always. · Change. · Threshold.
Low threshold	Low threshold for the indicator. This field displays a hyphen (-) if the indicator does not have a threshold specified or the default custom threshold does not exist.
Normal threshold	Normal threshold for the indicator. This field displays a hyphen (-) if the indicator does not have a threshold specified or the default custom threshold does not exist.
L1 threshold	Level-1 threshold for the indicator. This field displays a hyphen (-) if the indicator does not have a threshold specified or the default custom threshold does not exist.
L2 threshold	Level-2 threshold for the indicator. This field displays a hyphen (-) if the indicator does not have a threshold specified or the default custom threshold does not exist.
L3 threshold	Level-3 threshold for the indicator. This field displays a hyphen (-) if the indicator does not have a threshold specified or the default custom threshold does not exist.

display system internal kpi status

Use display system internal kpi status to display the running status of KPI data collection for a module.

Syntax

display system internal kpi status [ module module-name ]

Views

Any view

Predefined user roles

network-admin

network-operator

Parameters

module-name: Specifies the module name. If you do not specify a module, the command displays the running status of KPI data collection for all available modules. For more information, see "Available external indicators for KPI data collection."

Examples

# Display the running status of KPI data collection for the IF-USAGE-EX module.

<Sysname> display system internal kpi status

Module : IF-USAGE-EX

Slot : 3(Fd : 9)

Discard times : 0

Module collect state : Suppressing(CPU Alert)

Last collect duration : 1 ms

Max collect duration : 22 ms

Avg collect duration : 0 ms

Collect failures : 1326

Slot : 4(Fd : 22)

Discard times : 0

Module collect state : Suppressing(CPU Alert)

Last collect duration : 2 ms

Max collect duration : 25 ms

Avg collect duration : 0 ms

Collect failures : 1112

Slot : 5

Discard times : 0

Module collect state : Suppressing(CPU Alert)

Last collect duration : 1 ms

Max collect duration : 23 ms

Avg collect duration : 0 ms

Collect failures : 892

Table 5 Command output

Field	Description
Module	Module name.
Discard times	Number of collection failures caused by anomalies in the previous collection.
Module collect state	Module collection state: · Idle. · Collecting. · Suppressing. This state is followed by the reason in brackets: ¡ CPU alert: The CPU usage exceeds an alarm threshold. ¡ Memory alert: The memory usage exceeds an alarm threshold. ¡ CPU and Memory alert: Both CPU usage and memory usage exceed alarm thresholds.
Last collect duration	Duration of the previous collection, in milliseconds.
Max collect duration	Maximum collection duration, in milliseconds.
Avg collect duration	Average collection duration, in milliseconds.
Collect failures	Number of collection failures.

kpi collect indicator alarm-enable

Use kpi collect indicator alarm-enable to enable alarms for a KPI data collection indicator.

Use undo kpi collect indicator alarm-enable to restore the default.

Syntax

kpi collect indicator indicator-name alarm-enable

undo kpi collect indicator indicator-name alarm-enable

Views

System view

Default

The enabling status of alarms varies by module and device model. To obtain the enabling status of alarms, execute the display system internal kpi register-status command.

Predefined user roles

network-admin

Parameters

indicator-name: Specifies the indicator name. For more information, see "Available external indicators for KPI data collection."

Usage guidelines

After you enable alarms for a KPI data collection indicator, the device reports the collected data to NMS via SNMP and generates a log for it.

This feature is only supported by external indicators. For more information about alarms for indicators, execute the display system internal kpi register-status command.

Examples

# Enable alarms for the Port_TXBW_Usage indicator.

<Sysname> system-view

[Sysname] kpi collect indicator Port_TXBW_Usage alarm-enable

Related commands

display system internal kpi register-status

kpi collect module enable

Use kpi collect module enable to enable KPI data collection for a module.

Use undo kpi collect module enable to disable KPI data collection for a module.

Syntax

kpi collect module [ module-name ] enable

undo kpi collect module [ module-name ] enable

Views

System view

Default

KPI data collection is enabled for all modules.

Predefined user roles

network-admin

Parameters

module-name: Specifies the module name. For more information, see "Available external indicators for KPI data collection." If you do not specify a module name, the command enables KPI data collection for all modules.

Examples

# Enable KPI data collection for the IF-USAGE-EX module.

<Sysname> system-view

[Sysname] kpi collect module IF-USAGE-EX enable

Related commands

display kpi module-info

kpi collect indicator collect-type

Use kpi collect indicator collect-type to specify a log and alarm report mode for an indicator.

Use undo kpi collect indicator collect-type to restore the default.

Syntax

kpi collect indicator indicator-name collect-type { always | change | threshold }

undo kpi collect indicator indicator-name collect-type

Views

System view

Default

The log and alarm report mode is customized for each module. To view the report mode for an indicator, execute the display system internal kpi register-status command.

Predefined user roles

network-admin

Parameters

indicator-name: Specifies the indicator name. For more information, see "Available external indicators for KPI data collection."

always: Specifies the always mode.

change: Specifies the change mode.

threshold: Specifies the threshold mode.

Usage guidelines

Operating mechanism

After you enable alarms for a KPI data collection indicator, the device can send the collected data in SNMP traps to NMS and generate logs for it. Whether a trap and a log are generated and reported for an indicator varies by module and report mode.

· Always—Reports an alarm and a log every time an indicator value is collected.

· Change—Reports an alarm and a log only if the collected indicator value is different from that collected previously.

· Threshold—Reports an alarm and a log only if the collected indicator value exceeds an threshold.

Restrictions and guidelines

This feature is only supported by external indicators. For more information about alarms for indicators, execute the display system internal kpi register-status command.

Examples

# Set the log and alarm report mode to change for the Port_TXBW_Usage indicator.

<Sysname> system-view

[Sysname] kpi collect indicator Port_TXBW_UsageE collect-type change

Related commands

display system internal kpi register-status

kpi collect indicator alarm enable

kpi collect indicator threshold

Use kpi collect indicator threshold to configure alarm thresholds for an indicator.

Use undo kpi collect indicator threshold to restore the default.

Syntax

kpi collect [ percentage ] indicator indicator-name threshold low low-threshold normal normal-threshold l1warning l1-threshold l2warning l2-threshold l3warning l3-threshold

undo kpi collect indicator indicator-name threshold

Views

System view

Default

The alarm thresholds for an indicator are customized for each module. To view the alarm thresholds, execute the display system internal kpi register-status command.

Predefined user roles

network-admin

Parameters

indicator-name: Specifies the indicator name. For more information, see "Available external indicators for KPI data collection."

percentage: Specifies the percentage format for alarm thresholds.

· Specify this keyword for an indicator if its value is a decimal in the range of 0 to 1. Then, the values for all alarms thresholds are in the range of 0 to 100.

· You cannot specify this keyword if the value for an indicator is an integer.

low low-threshold: Specifies the low alarm threshold, which indicates that the indicator value is too low. The value range varies by indicator. For more information, see "Available external indicators for KPI data collection."

normal normal-threshold: Specifies the reference value, which indicates that the indicator value is normal. The value range varies by indicator. For more information, see "Available external indicators for KPI data collection."

l1warning l1-threshold: Specifies the level-1 alarm threshold, which indicates that the indicator value is slightly high and requires attention. The value range varies by indicator. For more information, see "Available external indicators for KPI data collection." The level-1 alarm threshold cannot be lower than the reference value.

l2warning l2-threshold: Specifies the level-2 alarm threshold, which indicates that the indicator value is relatively high and a risk exists. The value range varies by indicator. For more information, see "Available external indicators for KPI data collection." The level-2 alarm threshold cannot be lower than the level-1 alarm threshold.

l3warning l3-threshold: Specifies the level-3 alarm threshold, which indicates that the indicator value is too high and a severe risk exists. The value range varies by indicator. For more information, see "Available external indicators for KPI data collection." The level-3 alarm threshold cannot be lower than the level-2 alarm threshold.

Usage guidelines

Operating mechanism

The device generates an alarm in the following conditions:

· The device generates a level-1 alarm if the indicator value collected by KPI exceeds the level-1 alarm threshold.

· The device generates a level-2 alarm if the indicator value collected by KPI exceeds the level-2 alarm threshold.

· The device generates a level-3 alarm if the indicator value collected by KPI exceeds the level-3 alarm threshold.

· The device generates a low value alarm if the indicator value collected by KPI drops below the low alarm threshold.

The device generates an alarm clearance notification in the following conditions:

· The device generates a level-3 alarm clearance notification if the indicator value collected by KPI drops below the level-3 alarm threshold.

· The device generates a level-2 alarm clearance notification if the indicator value collected by KPI drops below the level-2 alarm threshold.

· The device generates a level-1 alarm clearance notification if the indicator value collected by KPI drops below the level-1 alarm threshold.

· The device generates a low value alarm clearance notification if the indicator value collected by KPI exceeds the low alarm threshold but does not exceed the level-1 alarm threshold.

Restrictions and guidelines

This feature is supported only by external indicators.

For more information about the alarm thresholds for indicators, execute the display system internal kpi register-status command.

Examples

# Set the low alarm threshold to 1, reference value to 30, level-1 threshold to 50, level-2 threshold to 70, and level-3 threshold to 90 for the Port_TXBW_Usage indicator.

<Sysname> system-view

[Sysname] kpi collect indicator-threshold Port_TXBW_Usage low 1 normal 30 l1warning 50 l2warning 70 l3warning 90

Related commands

display system internal kpi register-status

kpi collect indicator alarm enable

kpi copy-file to active-mpu

Use kpi copy-file to active-mpu to copy the KPI data on the standby MPU to the active MPU.

Syntax

kpi copy-file to active-mpu

Views

System view

Predefined user roles

network-admin

Usage guidelines

After an MPU active/standby switchover on the device, the new active MPU cannot automatically obtain the KPI data from the old active MPU (current standby MPU). To ensure service continuity, you must use this feature to copy the KPI data on the old active MPU to the new active MPU.

Examples

# Copy the KPI data on the standby MPU to the active MPU.

<Sysname> system-view

[Sysname] kpi copy-file to active-mpu

kpi file save-interval

Use kpi file save-interval to specify the interval for saving KPI files to the storage media.

Use undo kpi file save-interval to restore the default.

Syntax

kpi file save-interval interval

undo kpi file save-interval

Views

System view

Default

KPI files are saved to the storage media at an interval of 1440 minutes.

Predefined user roles

network-admin

Parameters

interval: Specifies the interval for saving KPI files to the storage media, in the range of 60 to 65535 minutes.

Examples

# Set the interval for saving KPI files to the storage media to 60 minutes.

<Sysname> system-view

[Sysname] kpi file save-interval 60

kpi file aging threshold remain-disk-size

Use kpi file aging threshold remain-disk-size to set the free storage media capacity threshold for triggering KPI file aging.

Use undo kpi file aging threshold remain-disk-size to restore the default.

Syntax

kpi file aging threshold remain-disk-size size

undo kpi file aging threshold remain-disk-size

Views

System view

Default

The free storage media capacity threshold for triggering KPI file aging is 128 MB.

Predefined user roles

network-admin

Parameters

size: Specifies the free storage media capacity threshold in the range of 128 to 65535 MB.

Usage guidelines

When the free storage media capacity is less than the specified threshold, the device automatically deletes the earliest saved KPI files until the free capacity is greater than or equal to the specified threshold.

Examples

# Set the free storage media capacity threshold for triggering KPI file aging to 1000 MB.

<Sysname> system-view

[Sysname] kpi file aging threshold remain-disk-size 1000

kpi file aging threshold total-file-size

Use kpi file aging threshold total-file-size to set the KPI file size threshold for triggering KPI file aging.

Use undo kpi file aging threshold total-file-size to restore the default.

Syntax

kpi file aging threshold total-file-size size

undo kpi file aging threshold total-file-size

Views

System view

Default

The KPI file size threshold for triggering KPI file aging is 128 MB.

Predefined user roles

network-admin

Parameters

size: Specifies the KPI file size threshold in the range of 32 to 2048 MB.

Usage guidelines

When the total KPI file size on the storage media exceeds the specified threshold, the device automatically deletes the earliest saved KPI files until the total KPI file size is less than or equal to the specified threshold.

Examples

# Set the KPI file size threshold for triggering KPI file aging to 500 MB.

<Sysname> system-view

[Sysname] kpi file aging threshold total-file-size 500

kpi file directory

Use kpi file directory to specify the KPI file directory.

Syntax

kpi file directory dir-name

Views

System view

Default

KPI files are stored in the flash:/kpi directory.

Predefined user roles

network-admin

Parameters

dir-name: Specifies the directory name, a string of any length.

Examples

# Set the KPI file directory to flash:/.

<Sysname> system-view

[Sysname] kpi file directory flash:/

kpi module collect-interval

Use kpi module collect-interval to configure the KPI data collection interval for a module.

Use undo kpi module collect-interval to restore the default.

Syntax

kpi module module-name collect-interval collect-interval

undo kpi module module-name collect-interval

Views

System view

Default

The KPI data collection intervals for modules to which external indicators belong are customized.

Predefined user roles

network-admin

Parameters

module-name: Specifies the module name. For more information, see "Available external indicators for KPI data collection."

collect-interval: Specifies the KPI data collection interval, in the range of 60 to 65535 seconds.

Usage guidelines

To view the KPI data collection intervals for different modules, execute the display kpi module-info command.

Examples

# Set the KPI data collection interval to 200 seconds for the IF-USAGE-EX module.

<Sysname> system-view

[Sysname] kpi module IF-USAGE-EX collect-interval 200

Related commands

display kpi module-info

snmp-agent trap enable kpi

Use snmp-agent trap enable kpi to enable SNMP notifications for KPI.

Use undo snmp-agent trap enable kpi to disable SNMP notifications for KPI.

Syntax

snmp-agent trap enable kpi

undo snmp-agent trap enable kpi

Default

SNMP notifications are enabled for KPI.

Views

System view

Predefined user roles

network-admin

Usage guidelines

Operating mechanism

With SNMP notifications enabled for KPI, the device sends related information to the SNMP module when an indicator value falls outside or within the alarm threshold range.

For the notifications to be sent correctly, you must also configure SNMP on the device. For more information about SNMP notifications, see "Configuring SNMP."

Examples

# Enable SNMP notifications for KPI.

<Sysname> system-view

[Sysname] snmp-agent trap enable kpi

15-Network Management and Monitoring Command Reference

Operating mechanism

Restrictions and guidelines

Operating mechanism

Restrictions and guidelines

kpi module collect-interval

Operating mechanism

Intelligent Terminal Products

Product Support Services

Technical Service Solutions

Resource Center

Policy

Online Help

Become a Partner

Partner Policy & Program

Global Learning

Partner Sales Resources

Service Business

News & Events

Contact Us