From af14b6a73dea6936de33f7b50f5e0d40baffe9ce Mon Sep 17 00:00:00 2001
From: Adam Bishop <TheMysteriousX@users.noreply.github.com>
Date: Sun, 5 Jul 2020 12:49:16 +0100
Subject: [PATCH] OS detection for Dell PowerVault MD arrays (#11509)

* OS detection for Dell PowerVault MD arrays

I'm not 100% sure it was worth Dell implementing SNMP - the array
exposes 6 OID's outside of MIBII, and we poll both the useful ones.

At least we get an icon.

* Test data

* Remove polling and discovery module filters
---
 includes/definitions/dell-powervault.yaml   |   9 +
 includes/polling/os/dell-powervault.inc.php |   6 +
 mibs/dell/DellMDStorageArray-MIB            | 266 ++++++++++++++++++++
 mibs/dell/SanAppliance-MIB                  | 104 ++++++++
 tests/data/dell-powervault.json             |  40 +++
 tests/snmpsim/dell-powervault.snmprec       |   8 +
 6 files changed, 433 insertions(+)
 create mode 100644 includes/definitions/dell-powervault.yaml
 create mode 100644 includes/polling/os/dell-powervault.inc.php
 create mode 100644 mibs/dell/DellMDStorageArray-MIB
 create mode 100644 mibs/dell/SanAppliance-MIB
 create mode 100644 tests/data/dell-powervault.json
 create mode 100644 tests/snmpsim/dell-powervault.snmprec

diff --git a/includes/definitions/dell-powervault.yaml b/includes/definitions/dell-powervault.yaml
new file mode 100644
index 0000000000..8846d2593b
--- /dev/null
+++ b/includes/definitions/dell-powervault.yaml
@@ -0,0 +1,9 @@
+os: dell-powervault
+text: 'Dell PowerVault MD'
+type: storage
+icon: dell
+group: dell
+discovery:
+    -
+      sysObjectID: .1.3.6.1.4.1.674.10893.2.31
+      sysDescr_regex: '/^DELL(\s)+MD/'
diff --git a/includes/polling/os/dell-powervault.inc.php b/includes/polling/os/dell-powervault.inc.php
new file mode 100644
index 0000000000..06c1806b4f
--- /dev/null
+++ b/includes/polling/os/dell-powervault.inc.php
@@ -0,0 +1,6 @@
+<?php
+
+use LibreNMS\RRD\RrdDefinition;
+
+$serial = trim(snmp_get($device, "1.3.6.1.4.1.674.10893.2.31.500.1.3.0", "-OQv"));
+$hardware = trim(snmp_get($device, "1.3.6.1.4.1.674.10893.2.31.500.1.5.0", "-OQv"));
diff --git a/mibs/dell/DellMDStorageArray-MIB b/mibs/dell/DellMDStorageArray-MIB
new file mode 100644
index 0000000000..9204fe4e87
--- /dev/null
+++ b/mibs/dell/DellMDStorageArray-MIB
@@ -0,0 +1,266 @@
+DellMDStorageArray DEFINITIONS ::= BEGIN
+
+-- Initial version. 10/1/98
+-- Second turn 10/2/98  added another trap
+-- Third version. 10/20/98
+-- Fourth version 10/23/98  Changes in this version are
+--                                      1) Deleted the FRU code from the MIB
+--                                      2) The deviceUserLabel WILL BE the same as the Storage Array Name.
+--                            3) Fixed typos.
+--                                      4) The deviceErrorCode WILL BE the same as the MEL event number.
+-- The changes came from a meeting held on 10/22/98.
+-- Changes to add componentType and componentLocation 08/11/00
+--
+-- New version of the mib.  The mibs has been renumbered. 10/28/98
+-- New version of the mib.  The mib has been renumbered to 204 08/11/00
+-- changed symbios to LSI Logic Storage Systems. 05/16/01
+-- changed version to 205 7/15/03 SM7_10.MIB
+-- SM7_10.MIB reset version back to 204 for this mib. will create a new mib for version 205. new mib is SM8_R4.MIB
+-- created SM8_R4.MIB version 205 7/15/03
+-- created SM9_R1.MIB version 206 2/12/04 to change the deviceUserLabel from 18 to 30 characters.
+-- changed LSI Logic Storage Systems to Engenio Information Technologies changed version to 300. 11/19/2004
+-- SM9_R3 replaces SM9_R2.  SM9_R2 has a coding defect. SM9_R3 has been issued to correct this defect. 06/30/2005
+-- SM10_R1 introduces support for accommodating both IPv4 and IPv6 IP addresses. 10/25/07
+-- Dell revisions made on 11/16/2009
+-- Validated MIB on 11/16/2009 using the tool at http://wwwsnmp.cs.utwente.nl/ietf/mibs/validate/
+-- Validation passed at severity level 3. 11/16/2009
+
+	IMPORTS
+		OBJECT-TYPE,
+		enterprises,
+		NOTIFICATION-TYPE,
+        MODULE-IDENTITY
+	FROM SNMPv2-SMI
+		DisplayString
+      	FROM SNMPv2-TC
+		InetAddressType,
+		InetAddress
+	FROM INET-ADDRESS-MIB;
+	      
+
+    dellMDStorageArrayMIB MODULE-IDENTITY
+        LAST-UPDATED "200911161200Z"
+        ORGANIZATION "Dell"
+        CONTACT-INFO "http://support.dell.com"
+        DESCRIPTION  "MD Storage Array MIB"
+        REVISION     "200911161200Z"
+        DESCRIPTION  "Initial"
+        ::= { mdStorageManager 0 }
+
+dell 			    OBJECT IDENTIFIER ::= { enterprises 674 }
+storage			    OBJECT IDENTIFIER ::= { dell 10893 }
+hardware		    OBJECT IDENTIFIER ::= { storage 2 }
+mdStorageManager	OBJECT IDENTIFIER ::= { hardware 30 }
+
+
+	infoTable OBJECT-TYPE
+		 SYNTAX  SEQUENCE OF InfoEntry
+		 MAX-ACCESS  not-accessible 
+		 STATUS  current
+		 DESCRIPTION
+		      "Information for array traps."
+		 ::= { mdStorageManager 1 }
+
+	infoEntry OBJECT-TYPE
+		 SYNTAX InfoEntry
+		 MAX-ACCESS not-accessible
+		 STATUS current
+		 DESCRIPTION
+		     "The data for array traps."
+		 INDEX  { deviceHostIPType }
+		 ::= { infoTable 1 }     
+	
+	
+	
+	InfoEntry ::= 
+	SEQUENCE {
+		deviceHostIPType
+			InetAddressType,
+		deviceHostIPAddr
+			InetAddress,
+		deviceHostName
+			DisplayString,
+		deviceUserLabel
+			DisplayString,
+		deviceErrorCode
+			DisplayString,
+		eventTime
+			DisplayString,
+		trapDescription
+			DisplayString,
+		componentType
+			DisplayString,
+		componentLocation
+			DisplayString
+	}			
+	deviceHostIPType OBJECT-TYPE
+		SYNTAX InetAddressType 
+		MAX-ACCESS read-only
+		STATUS current
+		DESCRIPTION 
+			"Type of IP Address of the network-attached device or device host. 0 unknown, 1 ipv4, 2 ipv6"
+		::= { infoEntry 1 }
+		
+	deviceHostIPAddr OBJECT-TYPE
+		SYNTAX InetAddress
+		MAX-ACCESS read-only
+		STATUS current
+		DESCRIPTION 
+			"IP Address of the network-attached device or device host."
+		::= { infoEntry 2 }
+				
+	deviceHostName OBJECT-TYPE
+		SYNTAX DisplayString (SIZE (0..17))
+		MAX-ACCESS read-only
+		STATUS current
+		DESCRIPTION
+			"The user label for the host of the device being reported on."
+		::= { infoEntry 3 }
+		
+	deviceUserLabel OBJECT-TYPE
+		SYNTAX DisplayString (SIZE (0..29))
+		MAX-ACCESS read-only
+		STATUS current
+		DESCRIPTION
+			"The user label for the device being reported on."
+		::= { infoEntry 4 }
+
+	deviceErrorCode OBJECT-TYPE
+		SYNTAX DisplayString (SIZE (0..19))
+		MAX-ACCESS read-only
+		STATUS current
+		DESCRIPTION
+			"The error code as reported by the device or host."
+		::= { infoEntry 5 }
+
+	eventTime OBJECT-TYPE
+		SYNTAX DisplayString (SIZE (0..39))
+		MAX-ACCESS read-only
+		STATUS current
+		DESCRIPTION 
+			"The time at which the event happen on the device."
+		::= { infoEntry 6 }
+
+	trapDescription OBJECT-TYPE
+		SYNTAX DisplayString (SIZE (0..69))
+		MAX-ACCESS read-only
+		STATUS current
+		DESCRIPTION 
+			"A string to indicate the nature of the trap"
+		::= { infoEntry 7 }
+
+	componentType OBJECT-TYPE
+		SYNTAX DisplayString (SIZE (0..59))
+		MAX-ACCESS read-only
+		STATUS current
+		DESCRIPTION 
+			"A string to identify the failing component type"
+		::= { infoEntry 8 }
+
+	componentLocation OBJECT-TYPE
+		SYNTAX DisplayString (SIZE (0..39))
+		MAX-ACCESS read-only
+		STATUS current
+		DESCRIPTION 
+			"A string to identify the location of the failing component"
+		::= { infoEntry 9 }
+
+	
+
+--End of items in the info table
+
+
+--
+--      TRAP Definitions
+--
+
+		storageArrayCritical TRAP-TYPE
+		ENTERPRISE mdStorageManager
+		VARIABLES  { deviceHostIP, deviceHostName, deviceUserLabel, deviceErrorCode, eventTime, trapDescription, componentType, componentLocation }
+		DESCRIPTION
+			"This trap indicates an event where user-interaction is required immediately.
+			Some example events are component failures or critical errors."
+
+		--#TYPE "Storage Array Critical"
+
+		--#SEVERITY "Critical"
+
+		--#SUMMARY "User-interaction is required immediately for IP Address= %s, HostName= %s, UserLabel= %s, ErrorCode= %s, TimeStamp= %s, ErrorMessage= %s, ComponentType= %s, ComponentLocation= %s"
+
+		--#ARGUMENTS {0,1,2,3,4,5,6,7}
+
+		--#CATEGORY "Error Events"
+
+		--#STATE "Failed"
+
+		--#STATUS "Mandatory"
+
+		::= 1
+
+		
+			storageArrayWarning TRAP-TYPE
+		ENTERPRISE mdStorageManager
+		VARIABLES  { deviceHostIP, deviceHostName, deviceUserLabel, deviceErrorCode, eventTime, trapDescription, componentType, componentLocation }
+		DESCRIPTION
+			"This trap indicates an event where user-interaction may be required. Example are events that put the array in a non-optimal state."
+
+		--#TYPE "Storage Array Warning"
+
+		--#SEVERITY "Warning"
+
+		--#SUMMARY "User-interaction is required for IP Address= %s, HostName= %s, UserLabel= %s, ErrorCode= %s, TimeStamp= %s, ErrorMessage= %s, ComponentType= %s, ComponentLocation= %s"
+
+		--#ARGUMENTS {0,1,2,3,4,5,6,7}
+
+		--#CATEGORY "Error Events"
+
+		--#STATE "Degraded"
+
+		--#STATUS "Optional"
+
+		::= 2
+
+	storageArrayInformational TRAP-TYPE
+		ENTERPRISE mdStorageManager
+		VARIABLES  { deviceHostIP, deviceHostName, deviceUserLabel, deviceErrorCode, eventTime, trapDescription, componentType, componentLocation }
+		DESCRIPTION
+			"This trap indicates a non-failure event of interest where user interaction is generally not required."
+
+		--#TYPE "Storage Array Informational"
+
+		--#SEVERITY "Informational"
+
+		--#SUMMARY "Non-failure event of interest for IP Address= %s, HostName= %s, UserLabel= %s, ErrorCode= %s, TimeStamp= %s, ErrorMessage= %s, ComponentType= %s, ComponentLocation= %s"
+
+		--#ARGUMENTS {0,1,2,3,4,5,6,7}
+
+		--#CATEGORY "Status Events"
+
+		--#STATE "Operational"
+
+		--#STATUS "Optional"
+
+		::= 3
+ 
+	storageArrayDebug TRAP-TYPE
+		ENTERPRISE mdStorageManager
+		VARIABLES  { deviceHostIP, deviceHostName, deviceUserLabel, deviceErrorCode, eventTime, trapDescription, componentType, componentLocation }
+		DESCRIPTION
+			"This trap indicates an interal system debug event of interest."
+
+		--#TYPE "Storage Array Debug"
+
+		--#SEVERITY "Debug"
+
+		--#SUMMARY "Internal debug event for IP Address= %s, HostName= %s, UserLabel= %s, ErrorCode= %s, TimeStamp= %s, ErrorMessage= %s, ComponentType= %s, ComponentLocation= %s"
+
+		--#ARGUMENTS {0,1,2,3,4,5,6,7}
+
+		--#CATEGORY "Status Events"
+
+		--#STATE "Operational"
+
+		--#STATUS "Optional"
+
+		::= 4
+END
diff --git a/mibs/dell/SanAppliance-MIB b/mibs/dell/SanAppliance-MIB
new file mode 100644
index 0000000000..7156e14b8f
--- /dev/null
+++ b/mibs/dell/SanAppliance-MIB
@@ -0,0 +1,104 @@
+--
+-- Copyright (c) 2000  Dell Computer Corporation.
+-- Module Name: sanappl.mib
+-- Abstract:
+--	Defines the Dell San Appliance SNMP interface.
+-- Authors:
+--   
+--
+-- Modified to include updated storage, SanRoot, and SanAppliance identifiers
+
+SanAppliance-MIB DEFINITIONS ::= BEGIN
+
+	IMPORTS
+	TRAP-TYPE FROM RFC-1215
+		enterprises
+			FROM RFC1155-SMI
+		OBJECT-TYPE
+			FROM RFC-1212
+		DisplayString
+			FROM RFC1213-MIB;
+
+		dell			OBJECT IDENTIFIER ::= { enterprises 674 }
+		storage			OBJECT IDENTIFIER ::= { dell 10893 }
+		sanRoot         	OBJECT IDENTIFIER ::= { storage 2 }
+                sanAppliance            OBJECT IDENTIFIER ::= { sanRoot 1 }
+		
+-- SanAppliance MIB
+	                              
+	sanApplGlobalStatus OBJECT-TYPE
+		SYNTAX INTEGER {
+			critical (1),
+			warning  (2),
+			normal   (3),
+			unknown  (4) }
+		ACCESS read-only
+		STATUS mandatory
+		DESCRIPTION
+			"Global health information for the Dell 
+			 San Appliance."
+			::= {sanAppliance 1}
+	                              
+-- Following Array Manager objects are used in Trap generation
+
+	sanApplEvts OBJECT IDENTIFIER ::= { sanAppliance 200 }
+
+sanApplName             OBJECT-TYPE
+                        SYNTAX OCTET STRING
+                        ACCESS read-only
+                        STATUS mandatory
+                        DESCRIPTION
+                                "Dell San Appliance"
+                        ::= { sanApplEvts 1 }
+    
+
+-- Trap definitions which use variables defined in this MIB.
+
+-- San Appliance traps.
+
+	sanApplFailed TRAP-TYPE
+		ENTERPRISE sanApplEvts
+		VARIABLES { sanApplName }
+		DESCRIPTION
+			"The Dell PowerVault 530F SAN Appliance named $1 is in a critical state."
+	--#TYPE "The Dell PowerVault 530F SAN Appliance named $1 has gone into a critical state."
+	--#ARGUMENTS { 0 }
+	--#SEVERITY CRITICAL
+	--#STATE DEGRADED
+	::= 1
+
+	sanApplNormal TRAP-TYPE
+		ENTERPRISE sanApplEvts
+		VARIABLES { sanApplName }
+		DESCRIPTION
+			"The Dell PowerVault 530F SAN Appliance named $1 is back in a normal state."
+	--#TYPE "The Dell PowerVault 530F SAN Appliance named $1 has returned to normal."
+	--#ARGUMENTS { 0 }
+	--#SEVERITY INFORMATIONAL
+	--#STATE OPERATIONAL
+	::= 2
+
+	sanApplStarted TRAP-TYPE
+		ENTERPRISE sanApplEvts
+		VARIABLES { sanApplName }
+		DESCRIPTION
+			"The Dell PowerVault 530F SAN Appliance named $1 is operational."
+	--#TYPE "The Dell PowerVault 530F SAN Appliance named $1 has started."
+	--#ARGUMENTS { 0 }
+	--#SEVERITY INFORMATIONAL
+	--#STATE OPERATIONAL
+	::= 3
+
+	sanApplStopped TRAP-TYPE
+		ENTERPRISE sanApplEvts
+		VARIABLES { sanApplName }
+		DESCRIPTION
+			"The Dell PowerVault 530F SAN Appliance named $1 is no longer running."
+	--#TYPE "The Dell PowerVault 530F SAN Appliance named $1 has stopped."
+	--#ARGUMENTS { 0 }
+	--#SEVERITY INFORMATIONAL
+	--#STATE NONOPERATIONAL
+	::= 4
+
+
+END
diff --git a/tests/data/dell-powervault.json b/tests/data/dell-powervault.json
new file mode 100644
index 0000000000..e3d587346e
--- /dev/null
+++ b/tests/data/dell-powervault.json
@@ -0,0 +1,40 @@
+{
+    "os": {
+        "discovery": {
+            "devices": [
+                {
+                    "sysName": "<private>",
+                    "sysObjectID": ".1.3.6.1.4.1.674.10893.2.31",
+                    "sysDescr": "DELL     MD38xxi          0123",
+                    "sysContact": null,
+                    "version": null,
+                    "hardware": null,
+                    "features": null,
+                    "os": "dell-powervault",
+                    "type": "storage",
+                    "serial": null,
+                    "icon": "dell.svg",
+                    "location": null
+                }
+            ]
+        },
+        "poller": {
+            "devices": [
+                {
+                    "sysName": "<private>",
+                    "sysObjectID": ".1.3.6.1.4.1.674.10893.2.31",
+                    "sysDescr": "DELL     MD38xxi          0123",
+                    "sysContact": "<private>",
+                    "version": null,
+                    "hardware": "MD38xxi",
+                    "features": null,
+                    "os": "dell-powervault",
+                    "type": "storage",
+                    "serial": "ABCD123",
+                    "icon": "dell.svg",
+                    "location": "<private>"
+                }
+            ]
+        }
+    }
+}
diff --git a/tests/snmpsim/dell-powervault.snmprec b/tests/snmpsim/dell-powervault.snmprec
new file mode 100644
index 0000000000..7a52de5be0
--- /dev/null
+++ b/tests/snmpsim/dell-powervault.snmprec
@@ -0,0 +1,8 @@
+1.3.6.1.2.1.1.1.0|4|DELL     MD38xxi          0123
+1.3.6.1.2.1.1.2.0|6|1.3.6.1.4.1.674.10893.2.31
+1.3.6.1.2.1.1.3.0|67|3507956004
+1.3.6.1.2.1.1.4.0|4|<private>
+1.3.6.1.2.1.1.5.0|4|<private>
+1.3.6.1.2.1.1.6.0|4|<private>
+1.3.6.1.4.1.674.10893.2.31.500.1.3.0|4|ABCD123
+1.3.6.1.4.1.674.10893.2.31.500.1.5.0|4|MD38xxi