newdevice: Support - ICT DC Distribution Panel (#6379)

* New Device Support for ICT DC Distribution Panels

* Fixed indexes, removed tests

* Supply name instead of oid to snmp_get call

* Fixed index conflict for current sensors

includes/definitions/ict-pdu.yaml

@@ -0,0 +1,13 @@
+os: ict-pdu
+text: 'ICT Distribution Series'
+type: power
+icon: ict
+nobulk: 1
+mib_dir:
+    - ict
+over:
+    - { graph: device_current, text: 'Current' }
+    - { graph: device_voltage, text: 'Voltage' }
+discovery:
+    - sysObjectId:
+        - .1.3.6.1.4.1.39145.10

includes/discovery/sensors/current/ict-pdu.inc.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * ict-pdu.inc.php
+ *
+ * LibreNMS current sensor discovery module for ICT DC Distribution Panel
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ * @copyright  2017 Lorenzo Zafra
+ * @author     Lorenzo Zafra<zafra@ualberta.ca>
+ */
+
+// Output Current
+$oids = snmpwalk_cache_oid($device, 'outputEntry', array(), 'ICT-MIB');
+
+foreach ($oids as $index => $entry) {
+    $output_number = (int)$entry['outputNumber'] + 1;
+
+    $descr = 'Output Current #' . $output_number;
+    if ($entry['outputName'] && $entry['outputName'] != '00') {
+        $descr .= ' ' . $entry['outputName'];
+    }
+
+    $divisor = 1;
+    $oid = '.1.3.6.1.4.1.39145.10.8.1.3.'.$index;
+    $type = 'ict-pdu';
+    $current = (float)$entry['outputCurrent'] / $divisor;
+
+    discover_sensor($valid['sensor'], 'current', $device, $oid, $index, $type, $descr, $divisor, '1', null, null, null, null, $current);
+}
+
+// System Current
+$systemCurrent = trim(snmp_get($device, 'systemCurrent.0', '-Oqv', 'ICT-MIB'), '" ');
+if (!empty($systemCurrent)) {
+    $divisor = 1;
+    $index = '7.0';
+    $descr = 'System Current';
+    $type = 'ict-pdu';
+    $oid = '.1.3.6.1.4.1.39145.10.7.0';
+    $current = $systemCurrent / $divisor;
+
+    discover_sensor($valid['sensor'], 'current', $device, $oid, $index, $type, $descr, $divisor, '1', null, null, null, null, $current);
+}

includes/discovery/sensors/state/ict-pdu.inc.php

@@ -0,0 +1,65 @@
+<?php
+/**
+ * ict-pdu.inc.php
+ *
+ * LibreNMS status sensor discovery module for ICT DC Distribution Panel
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ * @copyright  2017 Lorenzo Zafra
+ * @author     Lorenzo Zafra<zafra@ualberta.ca>
+ */
+
+$oids = snmpwalk_cache_oid($device, 'outputEntry', array(), 'ICT-MIB');
+
+if (is_array($oids)) {
+    $state_name = 'outputFuseStatus';
+    $state_index_id = create_state_index($state_name);
+
+    if ($state_index_id) {
+        $states = array(
+            array($state_index_id, 'OK', 0, 1, 0) ,
+            array($state_index_id, 'OPEN', 0, 2, 2)
+        );
+        foreach ($states as $value) {
+            $insert = array(
+                'state_index_id' => $value[0],
+                'state_descr' => $value[1],
+                'state_draw_graph' => $value[2],
+                'state_value' => $value[3],
+                'state_generic_value' => $value[4]
+            );
+            dbInsert($insert, 'state_translations');
+        }
+    }
+
+    foreach ($oids as $index => $entry) {
+        $fuse_state_oid = '.1.3.6.1.4.1.39145.10.8.1.4.' . $index;
+        $fuse_number = (int)$index + 1;
+        $descr = "Fuse #" . $fuse_number;
+
+        $current_value_string = $entry[$state_name];
+        if ($current_value_string == 'OK') {
+            $current_value = 1;
+        } else if ($current_value_string == 'OPEN') {
+            $current_value = 2;
+        }
+
+        discover_sensor($valid['sensor'], 'state', $device, $fuse_state_oid, $index, $state_name, $descr, '1', '1', null, null, null, null, $current_value, 'snmp', $index);
+
+        create_sensor_to_state_index($device, $state_name, $index);
+    }
+}

includes/discovery/sensors/voltage/ict-pdu.inc.php

@@ -0,0 +1,38 @@
+<?php
+/**
+ * ict-pdu.inc.php
+ *
+ * LibreNMS voltage sensor discovery module for ICT DC Distribution Panel
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ * @copyright  2017 Lorenzo Zafra
+ * @author     Lorenzo Zafra<zafra@ualberta.ca>
+ */
+
+// System Voltage
+$systemVoltage = trim(snmp_get($device, 'systemVoltage.0', '-Oqv', 'ICT-MIB'), '" ');
+
+if (!empty($systemVoltage)) {
+    $divisor = 1;
+    $oid = '.1.3.6.1.4.1.39145.10.6.0';
+    $index = 0;
+    $descr = 'System Voltage';
+    $type = 'ict-pdu';
+    $current_value = $systemVoltage / $divisor;
+
+    discover_sensor($valid['sensor'], 'voltage', $device, $oid, $index, $type, $descr, $divisor, '1', null, null, null, null, $current_value);
+}

includes/polling/os/ict-pdu.inc.php

@@ -0,0 +1,7 @@
+<?php
+
+//SNMPv2-SMI::enterprises.39145.10.1.0 = STRING: "ICT180S-12BRCP" -- deviceModel
+//SNMPv2-SMI::enterprises.39145.10.4.0 = STRING: "2.08" -- software version
+
+$hardware = trim(snmp_get($device, '1.3.6.1.4.1.39145.10.1.0', '-OQv', '', ''), '" ');
+$version = 'v' . trim(snmp_get($device, '1.3.6.1.4.1.39145.10.4.0', '-OQv', '', ''), '" ');

includes/polling/sensors/current/ict-pdu.inc.php

@@ -0,0 +1,9 @@
+<?php
+
+$oid_sensor = $sensor['sensor_oid'];
+
+if ($oid_sensor == '.1.3.6.1.4.1.39145.10.8.1.4.0') {
+    $sensor_value = trim(str_replace('"', '', $snmp_data[$oid_sensor]));
+} else {
+    $sensor_value = trim(str_replace('"', '', $snmp_data[$sensor['sensor_oid'].'.0']));
+}

includes/polling/sensors/state/ict-pdu.inc.php

@@ -0,0 +1,9 @@
+<?php
+
+$oid_sensor = $sensor['sensor_oid'];
+
+if ($oid_sensor == '.1.3.6.1.4.1.39145.10.8.1.4.0') {
+    $sensor_value = trim(str_replace('"', '', $snmp_data[$oid_sensor]));
+} else {
+    $sensor_value = trim(str_replace('"', '', $snmp_data[$sensor['sensor_oid'].'.0']));
+}

mibs/ict/ICT-DISTRIBUTION-PANEL-MIB

@@ -0,0 +1,320 @@
+-- MIB file for ICT Distribution Panel Series
+--
+-- Date         Version
+-- =============================
+-- 9/5/13       1.01
+--
+
+ICT-MIB DEFINITIONS ::= BEGIN
+
+IMPORTS
+	enterprises, IpAddress	FROM RFC1155-SMI
+	DisplayString		FROM RFC1213-MIB
+	OBJECT-TYPE		FROM RFC-1212
+	TRAP-TYPE		FROM RFC-1215;
+
+ictPower			OBJECT IDENTIFIER ::= { enterprises 39145 }
+
+distPanel			OBJECT IDENTIFIER ::= { ictPower 10 }
+
+deviceModel			OBJECT-TYPE
+	SYNTAX			DisplayString
+	ACCESS			read-only
+	STATUS			mandatory
+	DESCRIPTION		"Model Number"
+	::= { distPanel 1 }
+
+deviceName			OBJECT-TYPE
+	SYNTAX			DisplayString
+	ACCESS			read-only
+	STATUS			mandatory
+	DESCRIPTION		"Site Name"
+	::= { distPanel 2 }
+
+deviceHardware			OBJECT-TYPE
+	SYNTAX			INTEGER (0..127)
+	ACCESS			read-only
+	STATUS			mandatory
+	DESCRIPTION		"Hardware Version"
+	::= { distPanel 3 }
+
+deviceFirmware			OBJECT-TYPE
+	SYNTAX			DisplayString
+	ACCESS			read-only
+	STATUS			mandatory
+	DESCRIPTION		"Firmware Version"
+	::= { distPanel 4 }
+
+deviceMacAddress		OBJECT-TYPE
+	SYNTAX			DisplayString
+	ACCESS			read-only
+	STATUS			mandatory
+	DESCRIPTION		"MAC Address"
+	::= { distPanel 5 }
+
+systemVoltage			OBJECT-TYPE
+	SYNTAX			DisplayString
+	ACCESS			read-only
+	STATUS			mandatory
+	DESCRIPTION		"System Voltage (Volts)"
+	::= { distPanel 6 }
+
+systemCurrent			OBJECT-TYPE
+	SYNTAX			DisplayString
+	ACCESS			read-only
+	STATUS			mandatory
+	DESCRIPTION		"System Current (Amps)"
+	::= { distPanel 7 }
+
+outputTable			OBJECT-TYPE
+	SYNTAX SEQUENCE OF OutputEntry
+	ACCESS			not-accessible
+	STATUS			mandatory
+	DESCRIPTION		"Output Table"
+	::= { distPanel 8 }
+
+outputEntry			OBJECT-TYPE
+	SYNTAX			OutputEntry
+	ACCESS			not-accessible
+	STATUS			mandatory
+	INDEX { outputNumber }
+	::= { outputTable 1 }
+
+OutputEntry ::=
+	SEQUENCE {
+		outputNumber		INTEGER,
+		outputName		DisplayString,
+		outputCurrent		DisplayString,
+		outputFuseStatus	INTEGER,
+		outputEnable		INTEGER
+	}
+
+outputNumber			OBJECT-TYPE
+	SYNTAX			INTEGER (0..11)
+	ACCESS			read-only
+	STATUS			mandatory
+	DESCRIPTION		"Output Number"
+	::= { outputEntry 1 }
+
+outputName			OBJECT-TYPE
+	SYNTAX			DisplayString
+	ACCESS			read-only
+	STATUS			mandatory
+	DESCRIPTION		"Output Label"
+	::= { outputEntry 2 }
+
+outputCurrent			OBJECT-TYPE
+	SYNTAX			DisplayString
+	ACCESS			read-only
+	STATUS			mandatory
+	DESCRIPTION		"Output Current (Amps)"
+	::= { outputEntry 3 }
+
+outputFuseStatus		OBJECT-TYPE
+	SYNTAX			INTEGER { OK(1), OPEN(2) }
+	ACCESS			read-only
+	STATUS			mandatory
+	DESCRIPTION		"Output Fuse Status ('1' indicates Fuse is OK, and '2' indicates Fuse is OPEN)"
+	::= { outputEntry 4 }
+
+outputEnable			OBJECT-TYPE
+	SYNTAX			INTEGER { ENABLED(1), DISABLED(2) }
+	ACCESS			read-write
+	STATUS			mandatory
+	DESCRIPTION		"Output Relay Enable ('1' indicates the Output is ENABLED, and '2' indicates the Output is DISABLED)"
+	::= { outputEntry 5 }
+
+alarmTable			OBJECT-TYPE
+	SYNTAX SEQUENCE OF AlarmEntry
+	ACCESS			not-accessible
+	STATUS			mandatory
+	DESCRIPTION		"Alarm Input Table"
+	::= { distPanel 9 }
+
+alarmEntry			OBJECT-TYPE
+	SYNTAX			AlarmEntry
+	ACCESS			not-accessible
+	STATUS			mandatory
+	INDEX { alarmNumber }
+	::= { alarmTable 1 }
+
+AlarmEntry ::=
+	SEQUENCE {
+		alarmNumber		INTEGER,
+		alarmName		DisplayString,
+		alarmStatus		INTEGER
+	}
+
+alarmNumber			OBJECT-TYPE
+	SYNTAX			INTEGER (0..4)
+	ACCESS			read-only
+	STATUS			mandatory
+	DESCRIPTION		"Alarm Input Number"
+	::= { alarmEntry 1 }
+
+alarmName			OBJECT-TYPE
+	SYNTAX			DisplayString
+	ACCESS			read-only
+	STATUS			mandatory
+	DESCRIPTION		"Alarm Input Name"
+	::= { alarmEntry 2 }
+
+alarmStatus			OBJECT-TYPE
+	SYNTAX			INTEGER { INACTIVE(1), READY(2), ALARM(3) }
+	ACCESS			read-only
+	STATUS			mandatory
+	DESCRIPTION		"Alarm Input Status ('1' indicates Alarm is INACTIVE,'2' indicates Alarm is READY, and '3' indicates Alarm is in an ALARM condition)"
+	::= { alarmEntry 3 }
+
+busTable			OBJECT-TYPE
+	SYNTAX SEQUENCE OF OutputEntry
+	ACCESS			not-accessible
+	STATUS			mandatory
+	DESCRIPTION		"Output Table"
+	::= { distPanel 10 }
+
+busEntry			OBJECT-TYPE
+	SYNTAX			BusEntry
+	ACCESS			not-accessible
+	STATUS			mandatory
+	INDEX { busNumber }
+	::= { busTable 1 }
+
+BusEntry ::=
+	SEQUENCE {
+		busNumber		INTEGER,
+		busName			DisplayString,
+		busVoltage		DisplayString,
+		busCurrent		DisplayString
+	}
+
+busNumber			OBJECT-TYPE
+	SYNTAX			INTEGER (0..1)
+	ACCESS			read-only
+	STATUS			mandatory
+	DESCRIPTION		"Bus Number"
+	::= { busEntry 1 }
+
+busName				OBJECT-TYPE
+	SYNTAX			DisplayString
+	ACCESS			read-only
+	STATUS			mandatory
+	DESCRIPTION		"Bus Name"
+	::= { busEntry 2 }
+
+busVoltage			OBJECT-TYPE
+	SYNTAX			DisplayString
+	ACCESS			read-only
+	STATUS			mandatory
+	DESCRIPTION		"Bus Voltage (Volts)"
+	::= { busEntry 3 }
+
+busCurrent			OBJECT-TYPE
+	SYNTAX			DisplayString
+	ACCESS			read-only
+	STATUS			mandatory
+	DESCRIPTION		"Total Bus Current (Amps)"
+	::= { busEntry 4 }
+
+
+--
+-- Trap definitions:
+--
+
+sysUndervoltageAlarmTrap	TRAP-TYPE
+	ENTERPRISE		distPanel
+	VARIABLES		{ busNumber }
+	DESCRIPTION		"Trap generated when a System/Bus Undervoltage Alarm is triggered"
+	::= 101
+
+sysOvervoltageAlarmTrap		TRAP-TYPE
+	ENTERPRISE		distPanel
+	VARIABLES		{ busNumber }
+	DESCRIPTION		"Trap generated when a System/Bus Overvoltage Alarm is triggered"
+	::= 102
+
+sysOvercurrentAlarmTrap		TRAP-TYPE
+	ENTERPRISE		distPanel
+	VARIABLES		{ busNumber }
+	DESCRIPTION		"Trap generated when a System/Bus Overcurrent Alarm is triggered"
+	::= 103
+
+fuseAlarmTrap			TRAP-TYPE
+	ENTERPRISE		distPanel
+	VARIABLES		{ outputNumber }
+	DESCRIPTION		"Trap generated when an Output Fuse Alarm is triggered"
+	::= 104
+
+undercurrentAlarmTrap		TRAP-TYPE
+	ENTERPRISE		distPanel
+	VARIABLES		{ outputNumber }
+	DESCRIPTION		"Trap generated when an Output Undercurrent Alarm is triggered"
+	::= 105
+
+overcurrentAlarmTrap		TRAP-TYPE
+	ENTERPRISE		distPanel
+	VARIABLES		{ outputNumber }
+	DESCRIPTION		"Trap generated when an Output Overcurrent Alarm is triggered"
+	::= 106
+
+loadshedTrap			TRAP-TYPE
+	ENTERPRISE		distPanel
+	VARIABLES		{ outputNumber }
+	DESCRIPTION		"Trap generated when Load-Shedding is activated on an Output"
+	::= 107
+
+alarmInputTrap			TRAP-TYPE
+	ENTERPRISE		distPanel
+	VARIABLES		{ alarmNumber }
+	DESCRIPTION		"Trap generated when an Alarm Input is activated"
+	::= 108
+
+sysUndervoltageAlarmClear	TRAP-TYPE
+	ENTERPRISE		distPanel
+	VARIABLES		{ busNumber }
+	DESCRIPTION		"Trap generated when a System/Bus Undervoltage Alarm is cleared"
+	::= 111
+
+sysOvervoltageAlarmClear	TRAP-TYPE
+	ENTERPRISE		distPanel
+	VARIABLES		{ busNumber }
+	DESCRIPTION		"Trap generated when a System/Bus Overvoltage Alarm is cleared"
+	::= 112
+
+sysOvercurrentAlarmClear	TRAP-TYPE
+	ENTERPRISE		distPanel
+	VARIABLES		{ busNumber }
+	DESCRIPTION		"Trap generated when a System/Bus Overcurrent Alarm is cleared"
+	::= 113
+
+fuseAlarmClear			TRAP-TYPE
+	ENTERPRISE		distPanel
+	VARIABLES		{ outputNumber }
+	DESCRIPTION		"Trap generated when an Output Fuse Alarm is cleared"
+	::= 114
+
+undercurrentAlarmClear		TRAP-TYPE
+	ENTERPRISE		distPanel
+	VARIABLES		{ outputNumber }
+	DESCRIPTION		"Trap generated when an Output Undercurrent Alarm is cleared"
+	::= 115
+
+overcurrentAlarmClear		TRAP-TYPE
+	ENTERPRISE		distPanel
+	VARIABLES		{ outputNumber }
+	DESCRIPTION		"Trap generated when an Output Overcurrent Alarm is cleared"
+	::= 116
+
+loadshedClear			TRAP-TYPE
+	ENTERPRISE		distPanel
+	VARIABLES		{ outputNumber }
+	DESCRIPTION		"Trap generated when an Output has recovered from a Load-Shedding condition"
+	::= 117
+
+alarmInputClear			TRAP-TYPE
+	ENTERPRISE		distPanel
+	VARIABLES		{ alarmNumber }
+	DESCRIPTION		"Trap generated when an Alarm Input is cleared"
+	::= 118
+
+END

tests/OSDiscoveryTest.php

@@ -904,6 +904,12 @@ class DiscoveryTest extends \PHPUnit_Framework_TestCase
         $this->checkOS('ibmtl');
     }
 
+
+    public function testIctpdu()
+    {
+        $this->checkOS('ict-pdu');
+    }
+
     public function testIes()
     {
         $this->checkOS('ies');

tests/snmpsim/ict-pdu.snmprec

@@ -0,0 +1,2 @@
+1.3.6.1.2.1.1.1.0|4|ICT Distribution Panel
+1.3.6.1.2.1.1.2.0|6|1.3.6.1.4.1.39145.10