Hardware element down-fortinet-FortiOS

Hardware element down-fortinet-FortiOS
0

Hardware element down-fortinet-FortiOS

Vendor: fortinet

OS: FortiOS

Description:
Alert if any hardware elements are not operating correctly.

Remediation Steps:
Troubleshoot the hardware element as soon as possible.

How does this work?
This script logs in to the Fortinet Firewall and retrieves the output of the “exec sensor list” command. The output includes a table with info about the temperature, fan and power supply status.

Why is this important?
It checks the sensors and readings of every hardware component (i.e. Temperature, Power Supply Status and Fan Status). In particular, it gets the alarm status from the “exec sensor list” command output (when flag is set to 0, the component is working correctly and when flag is set to 1, the component is not working properly). Only the fortinet firewall models with temperature sensors will provide this information. More details can be found to at: http://kb.fortinet.com/kb/viewContent.do?externalId=FD36793&sliceId=1

Without Indeni how would you find this?
An administrator would need to manually log into the device and run the FortiOS command “exec sensor list” and review pertinent information.

fortios-exec-sensor-list

name: fortios-exec-sensor-list
description: Fortinet Firewall retrieves tempetature sensors list
type: monitoring
monitoring_interval: 20 minutes
requires:
    vendor: fortinet
    os.name: FortiOS
    product: firewall
comments:
    hardware-element-status:
        why: |
            It checks the sensors and readings of every hardware component (i.e. Temperature, Power Supply Status and Fan
            Status). In particular, it gets the alarm status from the "exec sensor list" command output (when flag is set
            to 0, the component is working correctly and when flag is set to 1, the component is not working properly). Only
            the fortinet firewall models with temperature sensors will provide this information. More details can be found
            to at: http://kb.fortinet.com/kb/viewContent.do?externalId=FD36793&sliceId=1
        how: |
            This script logs in to the Fortinet Firewall and retrieves the output of the "exec sensor list" command. The
            output includes a table with info about the temperature, fan and power supply status.
        without-indeni: |
            An administrator would need to manually log into the device and run the FortiOS command "exec sensor list" and
            review pertinent information.
        can-with-snmp: true
        can-with-syslog: false
steps:
-   run:
        type: SSH
        command: exec sensor list
    parse:
        type: AWK
        file: exec_sensor_list.parser.1.awk

cross_vendor_hardware_element_status

// 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.StateDownTemplateRule
import com.indeni.server.rules.RemediationStepCondition

/**
  *
  */
case class cross_vendor_hardware_element_status() extends StateDownTemplateRule(
  ruleName = "cross_vendor_hardware_element_status",
  ruleFriendlyName = "All Devices: Hardware element down",
  ruleDescription = "Alert if any hardware elements are not operating correctly.",
  metricName = "hardware-element-status",
  applicableMetricTag = "name",
  alertItemsHeader = "Hardware Elements Affected",
  alertDescription = "The hardware elements listed below are not operating correctly.",
  baseRemediationText = "Troubleshoot the hardware element as soon as possible.")(
  RemediationStepCondition.VENDOR_CISCO ->
    """|While the port may be in up status, the link quality might be degraded and is not between the threshold levels. Check the following to troubleshoot this issue.
       |1.	Run the “show interface transceiver detailed” NX-OS command to display information about the transceivers connected to a specific interface. Besides, this NX-OS command output provides information about the Cisco SFP Product ID (PID). NOTE: In case that have been used 3rd party SFPs it is possible to get an Indeni alert because the current light signal is different than the recommended min/max thresholds defined by Cisco.
       |2.	Use the “show interface transceiver calibrations” NX-OS command to display calibration information for the transceiver interfaces.
       |3.	Consider to enable DOM (if supported). Digital Optical Monitoring or DOM is an industry wide standard, intended to define a SFP to access real-time operating parameters such as Tx power, Rx power etc. More details can be found below: https://www.cisco.com/c/en/us/td/docs/interfaces_modules/transceiver_modules/compatibility/matrix/DOM_matrix.html
       |4.	Cisco has published official specifications (Rx, Tx power level etc) per transceiver category and can be found at the following link:
        https://www.cisco.com/c/en/us/products/interfaces-modules/transceiver-modules/index.""".stripMargin,
  RemediationStepCondition.VENDOR_FORTINET ->
    """
      |1. Login via ssh to the Fortinet firewall and run the FortiOS command "exec sensor list" to review the status of the hardware components and temperature
      |>>> thresholds. When the flag to the command output is set to 0, the component is working correctly and when flag is set to 1, the component has a problem.
      |>>> The FortiOS command "execute sensor detail" will show extra information such as the low/high thresholds. More details can be found here:
      |>>> http://kb.fortinet.com/kb/viewContent.do?externalId=FD36793&sliceId=1
      |2. Consider running the fotrinet hardware diagnostics commands. While they do not detect all hardware malfunctions, tests for the most common hardware
      |>>> problems are performed. More details can be found here:
      |- http://kb.fortinet.com/kb/viewContent.do?externalId=FD39581&sliceId=1
      |- http://kb.fortinet.com/kb/documentLink.do?externalID=FD34745
      |3. It is recommended that any failed fan or power supply unit should be replaced immediately.
      |4. The cooling system for the devices should be installed to avoid overheat.
      |5. If the problem persists, contact Fortinet Technical support at https://support.fortinet.com/ for further assistance.""".stripMargin.replaceAll("\n>>>", "")
)