RX packets experienced errors-fortinet-FortiOS

RX packets experienced errors-fortinet-FortiOS
0

RX packets experienced errors-fortinet-FortiOS

Vendor: fortinet

OS: FortiOS

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

Remediation Steps:
Packet errors usually occur when there is a mismatch in the speed and duplex settings on two sides of a cable, or a damaged cable.

   |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

How does this work?
This script logs into the FortiGate using SSH and retrieves the output of the “fnsysctl ifconfig” FortiOS hidden command. The output includes all the interface related information and statistics.

Why is this important?
Capture the interface Receive Errors counter. Receive errors indicate an issue with duplex/speed matching. Check the link below for more information about troubleshooting network interface problems: http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm

Without Indeni how would you find this?
An admin would need to log into the Fortinet firewall and manually review the interface statistics.

fortios-fnsysctl-ifconfig

name: fortios-fnsysctl-ifconfig
description: FortiGate Diagnose Interface
type: monitoring
monitoring_interval: 5 minutes
requires:
    vendor: fortinet
    os.name: FortiOS
    product: firewall
comments:
    network-interface-rx-errors:
        why: |
            Capture the interface Receive Errors counter. Receive errors indicate an issue with duplex/speed matching.
            Check the link below for more information about troubleshooting network interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-rx-dropped:
        why: |
            Capture the interface Receive Drop counter. Packet loss may have severe impact to the traffic utilization
            (retransmission for TCP apps) and to the performance of the applications. Check the link below for more
            information about troubleshooting network interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-rx-overruns:
        why: |
            Capture the interface Receive overruns counter. High value of overruns packets may have impact to the traffic
            utilization (retransmission for TCP apps) and to the performance of the applications. 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. Check the link below for more information about troubleshooting network interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-errors:
        why: |
            Capture the interface Transmit Errors counter. Transmit errors indicate an issue with duplex/speed matching.
            Check the link below for more information about troubleshooting network interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS
            hidden command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-dropped:
        why: |
            Capture the interface Transmit Drop counter. Packet loss may have severe impact to the traffic utilization
            (retransmission for TCP apps) and to the performance of the applications. Check the link below for more
            information about troubleshooting network interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-overruns:
        why: |
            Capture the interface Transmit Overruns counter. A high value of overrun packets may have impact on traffic
            utilization, causing a re-transmission of TCP apps and consequently degrade application performance. 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. Check the link below for more information about troubleshooting network interface
            problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-collisions:
        why: |
            Capture the interface transimit collisions counter and is valid for half duplex mode. High value of collision
            packets may have impact to the traffic utilization (retransmission for TCP apps) and to the performance of the
            applications. Check the link below for more information about troubleshooting network  interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-interrupts:
        why: |
            Capture the interrupt number information assigned to the NIC of the Fortinet firewall.
        how: |
            This script logs into the Fortigate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        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. Check the link below for more
            information about troubleshooting network interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        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. Check the link below for more
            information about troubleshooting network interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-rx-packets:
        why: |
            Capture the interface Received Packet counter. Knowing the amount of bytes and packets flowing through an
            interface can help estimate an interface's performance and utilization. Check the link below for more
            information about troubleshooting network interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-packets:
        why: |
            Capture the interface Transmitted Packet counter. Knowing the amount of bytes and packets flowing through an
            interface can help estimate an interface's performance and utilization. Check the link below for more
            information about troubleshooting network interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
steps:
-   run:
        type: SSH
        command: fnsysctl ifconfig
    parse:
        type: AWK
        file: show_interfaces_fnsysctl_ifconfig.parser.1.awk

fortios-fnsysctl-ifconfig

name: fortios-fnsysctl-ifconfig
description: FortiGate Diagnose Interface
type: monitoring
monitoring_interval: 5 minutes
requires:
    vendor: fortinet
    os.name: FortiOS
    product: firewall
comments:
    network-interface-rx-errors:
        why: |
            Capture the interface Receive Errors counter. Receive errors indicate an issue with duplex/speed matching.
            Check the link below for more information about troubleshooting network interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-rx-dropped:
        why: |
            Capture the interface Receive Drop counter. Packet loss may have severe impact to the traffic utilization
            (retransmission for TCP apps) and to the performance of the applications. Check the link below for more
            information about troubleshooting network interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-rx-overruns:
        why: |
            Capture the interface Receive overruns counter. High value of overruns packets may have impact to the traffic
            utilization (retransmission for TCP apps) and to the performance of the applications. 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. Check the link below for more information about troubleshooting network interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-errors:
        why: |
            Capture the interface Transmit Errors counter. Transmit errors indicate an issue with duplex/speed matching.
            Check the link below for more information about troubleshooting network interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS
            hidden command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-dropped:
        why: |
            Capture the interface Transmit Drop counter. Packet loss may have severe impact to the traffic utilization
            (retransmission for TCP apps) and to the performance of the applications. Check the link below for more
            information about troubleshooting network interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-overruns:
        why: |
            Capture the interface Transmit Overruns counter. A high value of overrun packets may have impact on traffic
            utilization, causing a re-transmission of TCP apps and consequently degrade application performance. 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. Check the link below for more information about troubleshooting network interface
            problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-collisions:
        why: |
            Capture the interface transimit collisions counter and is valid for half duplex mode. High value of collision
            packets may have impact to the traffic utilization (retransmission for TCP apps) and to the performance of the
            applications. Check the link below for more information about troubleshooting network  interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-interrupts:
        why: |
            Capture the interrupt number information assigned to the NIC of the Fortinet firewall.
        how: |
            This script logs into the Fortigate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        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. Check the link below for more
            information about troubleshooting network interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        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. Check the link below for more
            information about troubleshooting network interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-rx-packets:
        why: |
            Capture the interface Received Packet counter. Knowing the amount of bytes and packets flowing through an
            interface can help estimate an interface's performance and utilization. Check the link below for more
            information about troubleshooting network interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
    network-interface-tx-packets:
        why: |
            Capture the interface Transmitted Packet counter. Knowing the amount of bytes and packets flowing through an
            interface can help estimate an interface's performance and utilization. Check the link below for more
            information about troubleshooting network interface problems:
            http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
        how: |
            This script logs into the FortiGate using SSH and retrieves the output of the "fnsysctl ifconfig" FortiOS hidden
            command. The output includes all the interface related information and statistics.
        without-indeni: |
            An admin would need to log into the Fortinet firewall and manually review the interface statistics.
        can-with-snmp: true
        can-with-syslog: false
steps:
-   run:
        type: SSH
        command: fnsysctl ifconfig
    parse:
        type: AWK
        file: show_interfaces_fnsysctl_ifconfig.parser.1.awk

cross_vendor_rx_error

// 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 CrossVendorRxError() extends NearingCapacityWithItemsTemplateRule(
  ruleName = "cross_vendor_rx_error",
  ruleFriendlyName = "All Devices: RX packets experienced errors",
  ruleDescription = "Indeni tracks the number of packets that had issues and alerts if the ratio is too high.",
  usageMetricName = "network-interface-rx-errors",
  limitMetricName = "network-interface-rx-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 error rate. Review the ports below.",
  alertItemDescriptionFormat = "%.0f error packets identified out of a total of %.0f received.",
  baseRemediationText = "Packet errors usually occur when there is a mismatch in the speed and duplex settings on two sides of a cable, or a damaged cable.",
  alertItemsHeader = "Affected Ports")(
  RemediationStepCondition.VENDOR_CISCO ->
    """|
       |1. Run the "show interface" command to review the interface error counters and the bitrate. Consider to configure the "load-interval 30" interface sub command to improve the accuracy of the interface measurements.
       |2. Check for a mismatch in the speed and duplex interface settings on two sides of a cable, or for a damaged cable.
       |3. Use the "show interface counters errors" NX-OS command to display detailed interface error counters. If you do not specify an interface, this command displays information about all Layer 2 interfaces.""".stripMargin,
  RemediationStepCondition.VENDOR_JUNIPER ->
    """|1. Run the "show interface extensive" command to review the interface error counters.

       |2. Check for a mismatch in the speed and duplex interface settings on the both sides.
       |3. Check the physical cable. It might be damaged or incorrect type is used.
       |4. 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>
       |5. If the problem persists, contact the Juniper Networks Technical Assistance Center (JTAC)""",
  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
)