- Table of Contents
- Related Documents
-
Title | Size | Download |
---|---|---|
03-MOD commands | 124.00 KB |
MOD commands
collector
Use collector to configure the encapsulation information for packets sent to the collector by MOD.
Use undo collector to restore the default.
Syntax
collector source-ip source-address destination-ip destination-address source-port source-port destination-port destination-port [ vlan vlan-id ]
undo collector
Defaults
The encapsulation information for packets sent to the collector by MOD is not configured.
Views
MOD view
Predefined user roles
network-admin
Parameters
source-ip source-address: Specifies the source IP address for packets sent to the collector by MOD.
destination-ip destination-address: Specifies the destination IP address for packets sent to the collector by MOD.
source-port source-port: Specifies the source port number for packets sent to the collector by MOD.
destination-port destination-port: Specifies the destination port number for packets sent to the collector by MOD.
vlan vlan-id: Specifies the VLAN for packets sent to the collector by MOD.
Usage guidelines
The packets are encapsulated with the information specified by using this command and then routed to the remote collector.
Examples
# Encapsulate the packets sent to the collector by MOD with the following information: source IP address 10.10.10.10, destination IP address 20.20.20.20, source port number 10, and destination port number 20.
<Sysname> system-view
[Sysname] telemetry mod
[Sysname-telemetry-mod] collector source-ip 10.10.10.10 destination-ip 20.20.20.20 source-port 10 destination-port 20
Related commands
telemetry mod
device-id
Use device-id to configure the device ID for MOD.
Use undo device-id to restore the default.
Syntax
device-id address
undo device-id
Defaults
No device ID is configured for MOD.
Views
MOD view
Predefined user roles
network-admin
Parameters
address: Specifies the device ID for MOD. This argument can be any IPv4 address except 0.0.0.0. The device ID will be padded in the packets sent to the collector, so that the collector can identify the source of packets.
Examples
# Configure the device ID for MOD as 10.10.10.10.
<Sysname> system-view
[Sysname] telemetry mod
[Sysname-telemetry-mod] device-id 10.10.10.10
Related commands
telemetry mod
display telemetry mod
Use display telemetry mod to display MOD configuration information.
Syntax
display telemetry mod [ slot slot-number ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
slot slot-number: Specifies a card by its slot number. If you do not specify a card, this command displays entries on the active MPU.
Examples
# Display MOD configuration information.
<Sysname> system-view
[Sysname] display telemetry mod
Status : Successful
Drop reason list :
ipv4-dip-miss
smac-equal-dmac
denied-vlan
Drop group list :
drop-precedence-drop
Device ID : 192.168.56.2
Transport protocol : UDP
Collector
Source IP : 1.1.1.1
Destination IP : 1.1.1.2
Source port : 80
Destination port : 90
VLAN ID : 20
Table 1 Command output
Field |
Description |
Status |
MOD configuration deployment state: · Successful. · Failed. · Inactive—The reason-list command is not executed. |
Drop reason list |
Packet drop reasons (see Table 6). None—No packet drop reason is configured. |
Drop group list |
Packet drop reason groups: · drop-precedence-drop—Drop reason group related to drop precedence. · invalid-queue-drop—Drop reason group related to invalid queues. · multicast-replication-fail—Drop reason group related to multicast replication failures. This value is not supported in the current software version. · pfc-fc-drop—Drop reason group related to PFC flow control. · tail-or-wred-drop—Drop reason group related to tail drop or WRED drop. · traffic-management-fail—Drop reason group related to traffic management failures. · user-defined—User-defined drop reason group. · voq-ram-drop—Drop reason group related to VOQ RAM drop. |
Transport protocol |
Transport protocol that MOD uses to send packets to the collector. In the current software version, only UDP is supported. |
Collector |
Encapsulation information for packets sent to the collector by MOD. · Source IP. · Destination IP. · Source port. · Destination port. · VLAN ID. |
display telemetry mod reason-list-map
Use display telemetry mod reason-list-map to display the mappings between drop reasons and drop reason groups in MOD.
Syntax
display telemetry mod reason-list-map [ group [ group-name ] ] [ slot slot-number ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
group [ group-name ]: Specifies a drop reason group by its name. If you do not specify the group keyword, all drop reason groups are specified. If you do not specify the group-name argument, this command displays mappings between all drop reason groups and all drop reasons.
slot slot-number: Specifies a card by its slot number. If you do not specify a card, this command displays entries on the active MPU.
Examples
# Display the mappings between all drop reasons and drop reason groups.
<Sysname> system-view
[Sysname] display telemetry mod reason-list-map
Reason Group
global-dram-bdbs traffic-management-fail
global-sram-buffers traffic-management-fail
...
# Display the mappings between all drop reason groups and drop reasons.
<Sysname> system-view
[Sysname] display telemetry mod reason-list-map group
Group Reason
drop-precedence-drop drop-precedence-level
invalid-queue-drop queue-num-resolution-error
...
Table 2 Command output
Field |
Description |
Reason |
Packet drop reason. |
Group |
Packet drop reason group. |
For information about the other fields in the command output, see Table 3 and Table 5.
group-list
Use group-list to configure the drop reason groups monitored by MOD.
Use undo group-list to remove the drop reason groups monitored by MOD.
Syntax
group-list { group-list | all }
undo group-list { group-list | all }
Default
No drop reason groups monitored by MOD are configured, and group MOD is disabled.
Views
MOD view
Predefined user roles
network-admin
Parameters
group-list: Specifies a list of drop reason groups for MOD. You can specify a space-separated list of up to eight drop reason groups one time. Table 3 shows the possible values.
Table 3 Predefined drop reason groups
Value |
Description |
drop-precedence-drop |
Drop reason group related to drop precedence. |
invalid-queue-drop |
Drop reason group related to invalid queues. |
multicast-replication-fail |
This value is not supported in the current software version. Drop reason group related to multicast replication failures. |
pfc-fc-drop |
Drop reason group related to PFC flow control. |
tail-or-wred-drop |
Drop reason group related to tail drop or WRED drop. |
traffic-management-fail |
Drop reason group related to traffic management failures. |
user-defined |
User-defined drop reason group. |
voq-ram-drop |
Drop reason group related to virtual output queue (VOQ) random access memory (RAM) drop. |
all: Specifies all drop reason groups.
Usage guidelines
If you execute the group-list command multiple times, the drop reason groups accumulate.
If you execute the undo group-list command multiple times, the specified drop reason groups are removed from existing drop reason groups.
Examples
# Configure MOD to monitor drop reason group drop-precedence-drop.
<Sysname> system-view
[Sysname] telemetry mod
[Sysname-telemetry-mod] group-list drop-precedence-drop
Related commands
telemetry mod
mapping reason-list group
Use mapping reason-list group to configure the mappings between drop reasons and drop reason groups.
Use undo mapping reason-list group to restore the default mappings between drop reasons and drop reason groups.
Syntax
mapping reason-list { reason-list | all } group name
undo mapping reason-list { reason-list | all } group name
Default
Table 4 shows the default mappings between drop reasons and drop reason groups.
Table 4 Drop reasons in drop reason groups
Drop reason |
Drop reason description |
Drop reason group |
Drop reason group description |
drop-precedence-level |
Packet drop caused by drop precedence levels. |
drop-precedence-drop |
Drop precedence |
external-error |
Packet drop caused by external errors. |
traffic-management-fail |
Traffic management failure |
global-dram-bdbs |
Packet drop because the buffer description block (BDB) resources of the global dynamic random access memory (DRAM) are full. |
traffic-management-fail |
Traffic management failure |
global-sram-buffers |
Packet drop because the buffer resources of the global static random access memory (SRAM) are full. |
traffic-management-fail |
Traffic management failure |
global-sram-pdbs |
Packet drop because the PDB resources of the global SRAM are full. |
traffic-management-fail |
Traffic management failure |
latency |
Packet drop caused by latency. |
traffic-management-fail |
Traffic management failure |
multicast-fifo-full |
Packet drop because the multicast FIFO queue is full. |
multicast-replication-fail |
Multicast replication failure |
multicast-replication-error |
Packet drop caused by multicast replication errors. |
multicast-replication-fail |
Multicast replication failure |
packet-size-error |
Packet drop caused by packet size errors. |
traffic-management-fail |
Traffic management failure |
pb-vsq-sram-buffers-shared-max-size |
Packet drop because the buffer resources of the port-based shared virtual statistics queue (VSQ) SRAM exceed the threshold. |
pfc-fc-drop |
PFC flow control |
pb-vsq-sram-buffers-total-free-shared |
Packet drop because the buffer resources of the port-based total VSQ SRAM exceed the threshold. |
pfc-fc-drop |
PFC flow control |
pb-vsq-sram-pds-shared-max-size |
Packet drop because the packet description (PD) resources of the port-based shared VSQ SRAM exceed the threshold. |
pfc-fc-drop |
PFC flow control |
pb-vsq-sram-pds-total-free-shared |
Packet drop because the PD resources of the port-based total VSQ SRAM exceed the threshold. |
pfc-fc-drop |
PFC flow control |
pb-vsq-words-shared-max-size |
Packet drop because the Word resources of the port-based shared VSQ exceed the threshold. A Word resource is 16 bytes. |
pfc-fc-drop |
PFC flow control |
pb-vsq-words-total-free-shared |
Packet drop because the Word resources of the port-based total VSQ exceed the threshold. |
pfc-fc-drop |
PFC flow control |
queue-num-not-valid |
Packet drop caused by invalid queue numbers. |
invalid-queue-drop |
Invalid queue |
queue-num-resolution-error |
Packet drop because the queue number is out of range. |
invalid-queue-drop |
Invalid queue |
sram-resource-error |
Packet drop caused by SRAM resource errors. |
traffic-management-fail |
Traffic management failure |
tar-fifo-full |
Packet drop because the traffic management action message FIFO queue is full. |
traffic-management-fail |
Traffic management failure |
voq-dram-block |
Packet drop because the VOQ DRAM is blocked. |
voq-ram-drop |
Virtual output queue (VOQ) Random Access Memory (RAM) |
voq-sram-buffers-shared-max-size |
Packet drop because the buffer resources of the shared VOQ SRAM exceed the threshold. |
voq-ram-drop |
VOQ RAM |
voq-sram-buffers-total-free-shared |
Packet drop because the buffer resources of the total VOQ SRAM exceed the threshold. |
voq-ram-drop |
VOQ RAM |
voq-sram-pds-shared-max-size |
Packet drop because the PD resources of the shared VOQ SRAM exceed the threshold. |
voq-ram-drop |
VOQ RAM |
voq-sram-pds-total-free-shared |
Packet drop because the PD resources of the total VOQ SRAM exceed the threshold. |
voq-ram-drop |
VOQ RAM |
voq-words-shared-max-size |
Packet drop because the Word resources of the shared VOQ exceed the threshold. |
tail-or-wred-drop |
Tail drop or WRED |
voq-words-total-free-shared |
Packet drop because the Word resources of the total VOQ exceed the threshold. |
voq-ram-drop |
VOQ RAM |
voq-wred |
Packet drop caused by VOQ. |
tail-or-wred-drop |
Tail drop or WRED |
vsq-wred-pfc |
Packet drop caused by WRED drop in PFC-related VSQ groups. |
traffic-management-fail |
Traffic management failure |
vsq-wred-tm |
Packet drop caused by WRED drop in flow control-related VSQ groups. |
traffic-management-fail |
Traffic management failure |
Views
Drop reason mapping view
Predefined user roles
network-admin
Parameters
reason-list: Specifies a list of packet drop reasons. You can specify a space-separated list of up to eight packet drop reasons one time. Table 5 shows the possible values.
Table 5 Drop reasons in drop reason groups
Value |
Description |
drop-precedence-level |
Packet drop caused by drop precedence levels. |
external-error |
Packet drop caused by external errors. |
global-dram-bdbs |
Packet drop because the buffer description block (BDB) resources of the global dynamic random access memory (DRAM) are full. |
global-sram-buffers |
Packet drop because the buffer resources of the global static random access memory (SRAM) are full. |
global-sram-pdbs |
Packet drop because the PDB resources of the global SRAM are full. |
latency |
Packet drop caused by latency. |
multicast-fifo-full |
This value is not supported in the current software version. Packet drop because the multicast FIFO queue is full. |
multicast-replication-error |
This value is not supported in the current software version. Packet drop caused by multicast replication errors. |
packet-size-error |
Packet drop caused by packet size errors. |
pb-vsq-sram-buffers-shared-max-size |
Packet drop because the buffer resources of the port-based shared virtual statistics queue (VSQ) SRAM exceed the threshold. |
pb-vsq-sram-buffers-total-free-shared |
Packet drop because the buffer resources of the port-based total VSQ SRAM exceed the threshold. |
pb-vsq-sram-pds-shared-max-size |
Packet drop because the packet description (PD) resources of the port-based shared VSQ SRAM exceed the threshold. |
pb-vsq-sram-pds-total-free-shared |
Packet drop because the PD resources of the port-based total VSQ SRAM exceed the threshold. |
pb-vsq-words-shared-max-size |
Packet drop because the Word resources of the port-based shared VSQ exceed the threshold. A Word resource is 16 bytes. |
pb-vsq-words-total-free-shared |
Packet drop because the Word resources of the port-based total VSQ exceed the threshold. |
queue-num-not-valid |
Packet drop caused by invalid queue numbers. |
queue-num-resolution-error |
Packet drop because the queue number is out of range. |
sram-resource-error |
Packet drop caused by SRAM resource errors. |
tar-fifo-full |
Packet drop because the traffic management action message FIFO queue is full. |
voq-dram-block |
Packet drop because the VOQ DRAM is blocked. |
voq-sram-buffers-shared-max-size |
Packet drop because the buffer resources of the shared VOQ SRAM exceed the threshold. |
voq-sram-buffers-total-free-shared |
Packet drop because the buffer resources of the total VOQ SRAM exceed the threshold. |
voq-sram-pds-shared-max-size |
Packet drop because the PD resources of the shared VOQ SRAM exceed the threshold. |
voq-sram-pds-total-free-shared |
Packet drop because the PD resources of the total VOQ SRAM exceed the threshold. |
voq-words-shared-max-size |
Packet drop because the Word resources of the shared VOQ exceed the threshold. |
voq-words-total-free-shared |
Packet drop because the Word resources of the total VOQ exceed the threshold. |
voq-wred |
Packet drop caused by VOQ. |
vsq-wred-pfc |
Packet drop caused by WRED drop in PFC-related VSQ groups. |
vsq-wred-tm |
Packet drop caused by WRED drop in flow control-related VSQ groups. |
all: Specifies all drop reasons.
group name: Specifies a drop reason group by its name, a case-sensitive string of 1 to 63 characters. In the current software version, only the user-defined name is supported.
Usage guidelines
In the current software version, you can only map the packet drop reasons in predefined drop reason groups to the user-defined group.
When MOD monitors drop reason groups, MOD cannot identify the specific reason. To obtain the specific reason, you can map the concerned drop reason to the user-defined group, and then configure MOD to monitor the user-defined group.
Examples
# Map drop reason global-dram-bdbs to drop reason group user-defined.
<Sysname> system-view
[Sysname] telemetry mod reason-group-map
[Sysname-telemetry-mod-reason-group-map] mapping reason-list global-dram-bdbs group user-defined
Related commands
telemetry mod reason-group-map
reason-list
Use reason-list to configure a list of packet drop reasons monitored by MOD.
Use undo reason-list to remove a list of packet drop reasons monitored by MOD.
Syntax
reason-list { reason-list | all }
undo reason-list { reason-list | all }
Defaults
No packet drop reasons monitored by MOD are configured. The device does not monitor packet drops.
Views
MOD view
Predefined user roles
network-admin
Parameters
reason-list: Specifies a list of packet drop reasons. You can specify a space-separated list of up to eight reasons one time. Table 6 shows the possible packet drop reasons.
Value |
Description |
denied-vlan |
The VLAN carried in the packet is not an allowed VLAN on the port. |
ipv4-dip-miss |
The destination IPv4 address of a packet does not match a route or matches the default route. |
all: Specifies all packet drop reasons.
Usage guidelines
If you execute the reason-list reason-list command multiple times, the added packet drop reasons accumulate.
If you execute the undo reason-list reason-list command multiple times, the deleted packet drop reasons accumulated.
Examples
# Configure MOD to monitor all packet drop reasons.
<Sysname> system-view
[Sysname] telemetry mod
[Sysname-telemetry-mod] reason-list all
Related commands
telemetry mod
telemetry mod
Use telemetry mod to enter MOD view.
Syntax
telemetry mod
Views
System view
Predefined user roles
network-admin
Examples
# Enter MOD view.
<Sysname> system-view
[Sysname] telemetry mod
[Sysname-telemetry-mod]
telemetry mod reason-group-map
Use telemetry mod reason-group-map to enter drop reason mapping view.
Syntax
telemetry mod reason-group-map
Views
System view
Predefined user roles
network-admin
Examples
# Enter drop reason mapping view.
<Sysname> system-view
[Sysname] telemetry mod reason-group-map
[Sysname-telemetry-reason-group-map]