TX packets overrun-cisco-nxos

TX packets overrun-cisco-nxos

Vendor: cisco

OS: nxos

Description:
Indeni tracks the number of packets that had issues and alerts if the ratio is too high.

Remediation Steps:
Packet overruns usually occur when there are too many packets being inserted into the port’s memory buffer, faster than the rate at which the kernel is able to process them.
|
|In a small number of cases, the overrun counter may be incremented because of a software defect. However, in the majority of cases, it indicates that the receiving capability of the interface was exceeded. Nothing can be done on the device that reports overruns. If possible, the rate that frames are coming should be controlled at the remote end of the connection.
|1. Run the “show interface” command to review the interface overrun & underun counters and the bitrate. Consider to configure the “load-interval 30” interface sub command to improve the accuracy of the interface measurements.
|2. If the number of overruns is high, the hardware should be upgraded.
|In case of high bandwidth utilization:
|1. Run the “show interface” command to review the interface counters and the bitrate. Consider to configure the “load-interval 30” interface sub command to improve the accuracy of the interface measurements.
|2. If the interface bitrate is too high and close to the upper bandwidth limit consider to use multiple links with the port-channel technology or upgrade the bandwidth of the link
|3. Consider to implement QoS in case of high bandwidth utilization.

How does this work?
This script logs into the Cisco Nexus switch using SSH and retrieves the output of the “show interface” command. The output includes all the interface related information and statistics.

Why is this important?
Capture the interface Transmit Overrun errors counter.

Without Indeni how would you find this?
It is possible to poll this data through SNMP.

nexus-show-interface

name: nexus-show-interface
description: Nexus Interface Information
type: monitoring
monitoring_interval: 1 minute
requires:
    vendor: cisco
    os.name: nxos
comments:
    network-interface-state:
        why: |
            Capture the interface state. If an interface transitions from up to down an alert would be raised.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP. Interface state transitions will generate a syslog event.
        can-with-snmp: true
        can-with-syslog: true
    network-interface-admin-state:
        why: |
            Capture the interface administrative state.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP. Interface state transitions will generate a syslog event.
        can-with-snmp: true
        can-with-syslog: true
    network-interface-description:
        why: |
            Capture the interface description.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-speed:
        why: |
            Capture the interface speed in human readable format such as 1G, 10G, etc.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-duplex:
        why: |
            Capture the interface duplex in human readable format such as full or half. In modern network environments it is very uncommon to see half-duplex interfaces, and that should be an indication for a potential exception.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP. If a duplex mismatch is detected on a port syslog messages will be generated.
        can-with-snmp: true
        can-with-syslog: true
    network-interface-rx-frame:
        why: |
            Capture the interface Receive Errors (CRC) counter. If this counter increases an alarm will be raised.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-overruns:
        why: |
            Capture the interface Transmit Overrun errors counter.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-mac:
        why: |
            Capture the interface MAC address.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-type:
        why: |
            Capture the interface type, for example "1000/10000 Ethernet".
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-rx-bytes:
        why: |
            Capture the interface Received Bytes counter. Knowing the amount of bytes and packets flowing through an interface can help estimate an interface's performance and utilization.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-rx-dropped:
        why: |
            Capture the interface Received Errors counter. Packet loss may impact traffic performance.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-rx-packets:
        why: |
            Capture the interface Received Packets counter. Knowing the amount of bytes and packets flowing through an interface can help estimate an interface's performance and utilization.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-ipv4-address:
        why: |
            Capture the interface IPv4 address. Only relevant for layer 3 interfaces, including Vlan interfaces (SVI).
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-ipv4-subnet:
        why: |
            Capture the interface IPv4 subnet mask. Only relevant for layer 3 interfaces, including Vlan interfaces (SVI).
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-carrier:
        why: |
            Capture the interface carrier state change counter. It would increase every time the interface changes state from up to down.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-mtu:
        why: |
            Capture the interface MTU (Maximum Transmit Unit).
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-bytes:
        why: |
            Capture the interface Transmitted Bytes counter. Knowing the amount of bytes and packets flowing through an interface can help estimate an interface's performance and utilization.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-errors:
        why: |
            Capture the interface Transmit Errors counter. Transmission errors indicate an issue with duplex/speed matching.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-packets:
        why: |
            Capture the interface Transmitted Packets counter. Knowing the amount of bytes and packets flowing through an interface can help estimate an interface's performance and utilization.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-rx-overruns:
        why: |
            Capture the interface Receive Overrun errors counter.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-invalid-sfp:
        why: |
            Capture interface SFP verification errors.
            Interface SFP verification can happen if the interface speed is configured incorrectly or the SFP module is an incompatible non-cisco hardware.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            Invalid detected SFPs would generate a Syslog message. The user would have to login to the device and use the "show interface" command to identify the reason for the invalid SFP.
        can-with-snmp: true
        can-with-syslog: true
    network-interface-err-disable:
        why: |
            Capture the interface error-disable status.
            Interfaces can get automatically disabled (err-disable) if different error conditions are detected. For example link flaps, a connection loop or spanning tree BPDUs detected with BPDU guard.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            Error disabled interfaces would generate a syslog event. The user would have to login to the device and use the "show interface" command to identify the reason for the error disabled port.
        can-with-snmp: true
        can-with-syslog: true
    network-interface-err-disable-description:
        why: |
            Capture additional data on the reason the interface is in error-disable status.
            Interfaces can get automatically disabled (err-disable) if different error conditions are detected. For example link flaps, a connection loop or spanning tree BPDUs detected with BPDU guard.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            Error disabled interfaces would generate a syslog event. The user would have to login to the device and use the "show interface" command to identify the reason for the error disabled port.
        can-with-snmp: true
        can-with-syslog: true
steps:
-   run:
        type: SSH
        command: show interface | xml | no-more
    parse:
        type: XML
        file: show_interface.parser.1.xml.yaml

nexus-show-interface

name: nexus-show-interface
description: Nexus Interface Information
type: monitoring
monitoring_interval: 1 minute
requires:
    vendor: cisco
    os.name: nxos
comments:
    network-interface-state:
        why: |
            Capture the interface state. If an interface transitions from up to down an alert would be raised.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP. Interface state transitions will generate a syslog event.
        can-with-snmp: true
        can-with-syslog: true
    network-interface-admin-state:
        why: |
            Capture the interface administrative state.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP. Interface state transitions will generate a syslog event.
        can-with-snmp: true
        can-with-syslog: true
    network-interface-description:
        why: |
            Capture the interface description.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-speed:
        why: |
            Capture the interface speed in human readable format such as 1G, 10G, etc.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-duplex:
        why: |
            Capture the interface duplex in human readable format such as full or half. In modern network environments it is very uncommon to see half-duplex interfaces, and that should be an indication for a potential exception.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP. If a duplex mismatch is detected on a port syslog messages will be generated.
        can-with-snmp: true
        can-with-syslog: true
    network-interface-rx-frame:
        why: |
            Capture the interface Receive Errors (CRC) counter. If this counter increases an alarm will be raised.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-overruns:
        why: |
            Capture the interface Transmit Overrun errors counter.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-mac:
        why: |
            Capture the interface MAC address.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-type:
        why: |
            Capture the interface type, for example "1000/10000 Ethernet".
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-rx-bytes:
        why: |
            Capture the interface Received Bytes counter. Knowing the amount of bytes and packets flowing through an interface can help estimate an interface's performance and utilization.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-rx-dropped:
        why: |
            Capture the interface Received Errors counter. Packet loss may impact traffic performance.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-rx-packets:
        why: |
            Capture the interface Received Packets counter. Knowing the amount of bytes and packets flowing through an interface can help estimate an interface's performance and utilization.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-ipv4-address:
        why: |
            Capture the interface IPv4 address. Only relevant for layer 3 interfaces, including Vlan interfaces (SVI).
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-ipv4-subnet:
        why: |
            Capture the interface IPv4 subnet mask. Only relevant for layer 3 interfaces, including Vlan interfaces (SVI).
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-carrier:
        why: |
            Capture the interface carrier state change counter. It would increase every time the interface changes state from up to down.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-mtu:
        why: |
            Capture the interface MTU (Maximum Transmit Unit).
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-bytes:
        why: |
            Capture the interface Transmitted Bytes counter. Knowing the amount of bytes and packets flowing through an interface can help estimate an interface's performance and utilization.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-errors:
        why: |
            Capture the interface Transmit Errors counter. Transmission errors indicate an issue with duplex/speed matching.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-packets:
        why: |
            Capture the interface Transmitted Packets counter. Knowing the amount of bytes and packets flowing through an interface can help estimate an interface's performance and utilization.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-rx-overruns:
        why: |
            Capture the interface Receive Overrun errors counter.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            It is possible to poll this data through SNMP.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-invalid-sfp:
        why: |
            Capture interface SFP verification errors.
            Interface SFP verification can happen if the interface speed is configured incorrectly or the SFP module is an incompatible non-cisco hardware.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            Invalid detected SFPs would generate a Syslog message. The user would have to login to the device and use the "show interface" command to identify the reason for the invalid SFP.
        can-with-snmp: true
        can-with-syslog: true
    network-interface-err-disable:
        why: |
            Capture the interface error-disable status.
            Interfaces can get automatically disabled (err-disable) if different error conditions are detected. For example link flaps, a connection loop or spanning tree BPDUs detected with BPDU guard.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            Error disabled interfaces would generate a syslog event. The user would have to login to the device and use the "show interface" command to identify the reason for the error disabled port.
        can-with-snmp: true
        can-with-syslog: true
    network-interface-err-disable-description:
        why: |
            Capture additional data on the reason the interface is in error-disable status.
            Interfaces can get automatically disabled (err-disable) if different error conditions are detected. For example link flaps, a connection loop or spanning tree BPDUs detected with BPDU guard.
        how: |
            This script logs into the Cisco Nexus switch using SSH and retrieves the output of the "show interface" command. The output includes all the interface related information and statistics.
        without-indeni: |
            Error disabled interfaces would generate a syslog event. The user would have to login to the device and use the "show interface" command to identify the reason for the error disabled port.
        can-with-snmp: true
        can-with-syslog: true
steps:
-   run:
        type: SSH
        command: show interface | xml | no-more
    parse:
        type: XML
        file: show_interface.parser.1.xml.yaml

cross_vendor_tx_overrun

// Deprecation warning : Scala template-based rules are deprecated. Please use YAML format rules instead.

package com.indeni.server.rules.library.templatebased.crossvendor

import com.indeni.server.rules.RuleContext
import com.indeni.server.rules.library.templates.NearingCapacityWithItemsTemplateRule
import com.indeni.server.rules.RemediationStepCondition

/**
  *
  */
case class CrossVendorTxOverrun() extends NearingCapacityWithItemsTemplateRule(
  ruleName = "cross_vendor_tx_overrun",
  ruleFriendlyName = "All Devices: TX packets overrun",
  ruleDescription = "Indeni tracks the number of packets that had issues and alerts if the ratio is too high.",
  usageMetricName = "network-interface-tx-overruns",
  limitMetricName = "network-interface-tx-packets",
  applicableMetricTag = "name",
  threshold = 0.5,
  minimumValueToAlert = 100.0, // We don't want to alert if the number of error packets is really low
  alertDescription = "Some network interfaces and ports are experiencing a high overrun rate. Review the ports below.",
  alertItemDescriptionFormat = "%.0f packets overrun out of a total of %.0f transmitted.",
  baseRemediationText = "Packet overruns usually occur when there are too many packets being inserted into the port's memory buffer, faster than the rate at which the kernel is able to process them.",
  alertItemsHeader = "Affected Ports")(
  RemediationStepCondition.VENDOR_CISCO ->
    """|
       |In a small number of cases, the overrun counter may be incremented because of a software defect. However, in the majority of cases, it indicates that the receiving capability of the interface was exceeded. Nothing can be done on the device that reports overruns. If possible, the rate that frames are coming should be controlled at the remote end of the connection.
       |1. Run the "show interface" command to review the interface overrun & underun counters and the bitrate. Consider to configure the "load-interval 30" interface sub command to improve the accuracy of the interface measurements.
       |2. If the number of overruns is high, the hardware should be upgraded.
       |In case of high bandwidth utilization:
       |1. Run the "show interface" command to review the interface counters and the bitrate. Consider to configure the "load-interval 30" interface sub command to improve the accuracy of the interface measurements.
       |2. If the interface bitrate is too high and close to the upper bandwidth limit consider to use multiple links with the port-channel technology or upgrade the bandwidth of the link
       |3. Consider to implement QoS in case of high bandwidth utilization.""".stripMargin,
  RemediationStepCondition.VENDOR_JUNIPER ->
    """|The issue can not be resolved on the device that reports overruns. The rate that frames are coming should be controlled at the remote end of the connection.
       |1. Run the “show interface extensive” command to review the interface overrun counters. 

       |2. If the number of overruns is high, consider upgrading the hardware.
       |3. Review the following article on Juniper tech support site: <a target="_blank" href="https://www.juniper.net/documentation/en_US/junos/topics/reference/command-summary/show-interfaces-security.html#jd0e1772">Operational Commands</a>""".stripMargin,
  RemediationStepCondition.VENDOR_FORTINET ->
    """
       |1. Run "diag hardware deviceinfo nic <interface>" command to display a list of hardware related error names and values. Review  the next link for more details: http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
       |2. Run command "fnsysctl cat /proc/net/dev" to get a summary of the interface statistics.
       |3. Check for speed and duplex mismatch in the interface settings on both sides of a cable, and check for a damaged cable. Review the next link for more info: http://kb.fortinet.com/kb/documentLink.do?externalID=10653""".stripMargin
)