Network port(s) running in half duplex-cisco-nxos

Network port(s) running in half duplex-cisco-nxos

Vendor: cisco

OS: nxos

Description:
Indeni will alert one or more network ports is running in half duplex.

Remediation Steps:
Many times ports are in half duplex due to an autonegotation error or a misconfiguration.
|
|1. Use the “show interface” NX-OS command to display speed and duplex settings of an interface.
|2. Use the “show interface status” and “show interface capabilities” NX-OS commands to gather more information about ports.
|3. You can disable link negotiation using the “no negotiate auto” command. Use the “negotiate auto” command to enable auto negotiation on 1-Gigabit ports when the connected peer does not support auto negotiation. By default, auto-negotiation is enabled on 1-Gigabit ports and disabled on 10-Gigabit ports.
|4. Cisco does not recommend to enable auto negotiation on 10-Gigabit ports. Enabling auto-negotiation on 10-Gigabit ports brings the link down. By default, link negotiation is disabled on 10-Gigabit ports.
|NOTE: A shut and no shut to the interface may be required after the aforementioned configuration change.

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 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.

Without Indeni how would you find this?
It is possible to poll this data through SNMP. If a duplex mismatch is detected on a port syslog messages will be generated.

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_network_port_duplex_half

// 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.ruleengine.expressions.conditions.{Equals => RuleEquals}
import com.indeni.ruleengine.expressions.data.SnapshotExpression
import com.indeni.server.rules.library.RuleHelper._
import com.indeni.server.rules.{RemediationStepCondition, RuleCategory, RuleContext}
import com.indeni.server.rules.library.templates.SingleSnapshotValueCheckTemplateRule
import com.indeni.server.rules.library.RuleHelper

/**
  *
  */
case class cross_vendor_network_port_duplex_half() extends SingleSnapshotValueCheckTemplateRule(
  ruleName = "cross_vendor_network_port_duplex_half",
  ruleFriendlyName = "All Devices: Network port(s) running in half duplex",
  ruleDescription = "Indeni will alert one or more network ports is running in half duplex.",
  ruleCategories = Set(RuleCategory.VendorBestPractices),
  metricName = "network-interface-duplex",
  applicableMetricTag = "name",
  alertItemsHeader = "Ports Affected",
  alertDescription = "One or more ports are set to half duplex. This is usually an error. Review the list of ports below.",
  baseRemediationText = "Many times ports are in half duplex due to an autonegotation error or a misconfiguration.",
  complexCondition = RuleEquals(RuleHelper.createComplexStringConstantExpression("half"), SnapshotExpression("network-interface-duplex").asSingle().mostRecent().value().noneable),
  secondaryCondition = c => networkInterfaceAdminState(c.tsDao, expected = 1.0))(
  RemediationStepCondition.VENDOR_CP -> "Review sk83760: https://supportcenter.checkpoint.com/supportcenter/portal?eventSubmit_doGoviewsolutiondetails=&solutionid=sk83760",
  RemediationStepCondition.VENDOR_PANOS -> "https://live.paloaltonetworks.com/t5/Management-Articles/How-to-Display-Port-Information-Connected-Media-Interface/ta-p/61715",
  RemediationStepCondition.VENDOR_CISCO ->
    """|
       |1. Use the "show interface" NX-OS command to display speed and duplex settings of an interface.
       |2. Use the "show interface status" and "show interface capabilities" NX-OS commands to gather more information about ports.
       |3. You can disable link negotiation using the "no negotiate auto" command. Use the "negotiate auto" command to enable auto negotiation on 1-Gigabit ports when the connected peer does not support auto negotiation. By default, auto-negotiation is enabled on 1-Gigabit ports and disabled on 10-Gigabit ports.
       |4. Cisco does not recommend to enable auto negotiation on 10-Gigabit ports. Enabling auto-negotiation on 10-Gigabit ports brings the link down. By default, link negotiation is disabled on 10-Gigabit ports.
       |NOTE: A shut and no shut to the interface may be required after the aforementioned configuration change.""".stripMargin,
  RemediationStepCondition.VENDOR_FORTINET ->
    """|
       |1. Monitor hardware network operations and speed by using the "diag hardware deviceinfo nic <interface>" FortiOS command.
       |2. Run the command "diag hardware deviceinfo nic <interface>" command to display a list of hardware related names and values. Review the next link for more details: http://help.fortinet.com/fos50hlp/54/Content/FortiOS/fortigate-toubleshooting-54/troubleshooting_tools.htm
       |3. Run the hidden FortiOS command "fnsysctl cat /proc/net/dev" to get a summary of the interface statistics.
       |4. Check for a mismatch in the speed and duplex interface settings on both sides of a cable, or for a damaged cable. Try to manually configure both sides to the same mode when you can. Review the next link "Symptoms of Ethernet speed/duplex mismatches" for more info: http://kb.fortinet.com/kb/documentLink.do?externalID=10653""".stripMargin,
  RemediationStepCondition.VENDOR_BLUECOAT ->
    """
      |1. Login via ssh to the ProxySG, run the command "show interface <interface>" and review the current link status.
      |2. Check for a mismatch in the speed and duplex interface settings on both sides of a cable, or for a damaged cable.
      |3. Try to manually configure both sides to the same mode when you can #(config interface adapter_number:interface_number) full-duplex.
    """.stripMargin
)