Rittal CMC III: Add device support for PU and PU Compact (#12268)

* Rittal CMC III: Add device support for PU and PU Compact

* Rittal CMC III: Readd accidentally removed sysObjectID

* Rittal CMC III: Some small fixes

* Rittal CMC III: Use device serial number instead of the internal device id for state index naming
- version, hardware and serial is now read via yaml
- update test files

* Rittal CMC III: Check if the serial number is available

* Rittal CMC III: Update test data

* Rittal CMC III: Update unset

* Rittal CMC III: Remove space in yaml

includes/definitions/discovery/rittal-cmc-iii-pu.yaml

@@ -0,0 +1,20 @@
+mib: RITTAL-CMC-III-MIB
+modules:
+    os:
+        hardware: RITTAL-CMC-III-MIB::cmcIIIDevName.1
+        serial: RITTAL-CMC-III-MIB::cmcIIIUnitSerial.0
+        version: RITTAL-CMC-III-MIB::cmcIIIUnitFWRev.0
+    sensors:
+        state:
+            data:
+                -
+                    oid: cmcIIIUnitStatus
+                    value: cmcIIIUnitStatus
+                    state_name: cmcIIIUnitStatus
+                    num_oid: '.1.3.6.1.4.1.2606.7.2.1.{{ $index }}'
+                    index: 'cmcIIIUnitStatus.{{ $index }}'
+                    descr: Unit Status
+                    states:
+                        - { descr: OK, graph: 1, value: 1, generic: 0 }
+                        - { descr: Failed, graph: 1, value: 2, generic: 2 }
+                        - { descr: Overload, graph: 1, value: 3, generic: 1 }

includes/definitions/discovery/rittal-lcp.yaml

@@ -1,5 +1,9 @@
 mib: RITTAL-CMC-III-MIB
 modules:
+    os:
+        hardware: RITTAL-CMC-III-MIB::cmcIIIDevName.1
+        serial: RITTAL-CMC-III-MIB::cmcIIIUnitSerial.0
+        version: RITTAL-CMC-III-MIB::cmcIIIUnitFWRev.0
     sensors:
         state:
             data:

includes/definitions/rittal-cmc-iii-pu.yaml

@@ -0,0 +1,19 @@
+os: rittal-cmc-iii-pu
+text: 'Rittal CMC III PU'
+type: environment
+icon: rittal
+mib_dir: rittal
+over:
+    - { graph: device_temperature, text: Temperatures }
+discovery_modules:
+    storage: false
+    mempools: false
+    processors: false
+    entity-physical: false
+discovery:
+    -
+        sysObjectID:
+            - .1.3.6.1.4.1.2606.7
+        sysDescr_regex:
+            - '/^Rittal CMC III PU/'
+            - '/^Rittal CMC III PU Compact/'

includes/definitions/rittal-lcp.yaml

@@ -2,10 +2,10 @@ os: rittal-lcp
 text: 'Rittal LCP'
 type: environment
 icon: rittal
+mib_dir: rittal
 over:
     - { graph: device_temperature, text: Temperatures }
     - { graph: device_power, text: 'Cooling capacity' }
-mib_dir: rittal
 discovery_modules:
     storage: false
     mempools: false
@@ -14,6 +14,7 @@ discovery:
     -
         sysObjectID:
             - .1.3.6.1.4.1.2606.7
-    -
         sysDescr:
             - 'Rittal LCP'
+        sysDescr_regex:
+            - '/^Rittal LCP/'

includes/discovery/sensors.inc.php

@@ -8,10 +8,14 @@ $valid['sensor'] = [];
 /** @var OS $os */
 $pre_cache = $os->preCache();
 
-// Run custom sensors
-require 'includes/discovery/sensors/cisco-entity-sensor.inc.php';
-require 'includes/discovery/sensors/entity-sensor.inc.php';
-require 'includes/discovery/sensors/ipmi.inc.php';
+if ($device['os'] == 'rittal-cmc-iii-pu') {
+    include 'includes/discovery/sensors/rittal-cmc-iii-sensors.inc.php';
+} else {
+    // Run custom sensors
+    require 'includes/discovery/sensors/cisco-entity-sensor.inc.php';
+    require 'includes/discovery/sensors/entity-sensor.inc.php';
+    require 'includes/discovery/sensors/ipmi.inc.php';
+}
 
 if ($device['os'] == 'netscaler') {
     include 'includes/discovery/sensors/netscaler.inc.php';

includes/discovery/sensors/rittal-cmc-iii-sensors.inc.php

@@ -0,0 +1,157 @@
+<?php
+/**
+ * rittal-cmc-iii-sensors.inc.php
+ *
+ * LibreNMS sensors discovery module for Rittal CMC III
+ *
+ * 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/>.
+ *
+ * @link      http://librenms.org
+ * @copyright 2020 Denny Friebe
+ * @author    Denny Friebe <denny.friebe@icera-network.de>
+ */
+$cmc_iii_var_table = snmpwalk_cache_oid($device, 'cmcIIIVarTable', [], 'RITTAL-CMC-III-MIB', null);
+$cmc_iii_sensors = [];
+
+foreach ($cmc_iii_var_table as $index => $entry) {
+    $var_name_parts = explode('.', $entry['cmcIIIVarName']);
+    array_pop($var_name_parts);
+    $sensor_name = implode(' ', $var_name_parts);
+    $var_type = $entry['cmcIIIVarType'];
+    $sensor_id = count($cmc_iii_sensors);
+
+    switch ($var_type) {
+        case 'description':
+            // Every new sensor starts with their description.
+            if ($sensor_id == 0) {
+                $sensor_id = 1;
+            } else {
+                $sensor_id++;
+            }
+
+            $cmc_iii_sensors[$sensor_id]['name'] = $sensor_name;
+            $cmc_iii_sensors[$sensor_id]['desc'] = $entry['cmcIIIVarValueStr'];
+            break;
+        case 'setHigh':
+            $cmc_iii_sensors[$sensor_id]['high_limit'] = $entry['cmcIIIVarValueInt'];
+            break;
+        case 'setWarn':
+            $cmc_iii_sensors[$sensor_id]['warn_limit'] = $entry['cmcIIIVarValueInt'];
+            break;
+        case 'setLow':
+            $cmc_iii_sensors[$sensor_id]['low_limit'] = $entry['cmcIIIVarValueInt'];
+            break;
+        case 'logic':
+            $sensor_logic = explode(' / ', $entry['cmcIIIVarValueStr']);
+            $cmc_iii_sensors[$sensor_id]['logic'][0] = substr($sensor_logic[0], 2);
+            $cmc_iii_sensors[$sensor_id]['logic'][1] = substr($sensor_logic[1], 2);
+            break;
+        case 'value':
+            $cmc_iii_sensors[$sensor_id]['oid'] = '.1.3.6.1.4.1.2606.7.4.2.2.1.11.' . $index;
+
+            if (! empty($entry['cmcIIIVarValueInt'])) {
+                $cmc_iii_sensors[$sensor_id]['value'] = $entry['cmcIIIVarValueInt'];
+            } else {
+                $cmc_iii_sensors[$sensor_id]['value'] = $entry['cmcIIIVarValueStr'];
+            }
+
+            $unit = $entry['cmcIIIVarUnit'];
+            $type = 'state';
+            if (Str::endsWith($unit, 'A')) {
+                $type = 'current';
+            } elseif (Str::endsWith($unit, 'degree C') or Str::endsWith($unit, 'degree F')) {
+                $type = 'temperature';
+            } elseif (Str::endsWith($unit, 'l/min')) {
+                $type = 'waterflow';
+            } elseif (Str::endsWith($unit, 'V')) {
+                $type = 'voltage';
+            } elseif (Str::endsWith($unit, 'W')) {
+                $type = 'power';
+            }
+
+            $cmc_iii_sensors[$sensor_id]['type'] = $type;
+
+            if ($entry['cmcIIIVarScale'][0] == '-') {
+                $cmc_iii_sensors[$sensor_id]['divisor'] = substr($entry['cmcIIIVarScale'], 1);
+            } elseif ($entry['cmcIIIVarScale'][0] == '+') {
+                $cmc_iii_sensors[$sensor_id]['multiplier'] = substr($entry['cmcIIIVarScale'], 1);
+            }
+            break;
+    }
+}
+
+//At first device discovery the serial number is not set. But we need this in the next step for our state indexes.
+if (! $device['serial']) {
+    $serial_number = snmp_get($device, 'cmcIIIUnitSerial.0', '-Oqv', 'RITTAL-CMC-III-MIB');
+} else {
+    $serial_number = $device['serial'];
+}
+
+foreach ($cmc_iii_sensors as $sensor_id => $sensor_data) {
+    // Some sensors provide either no useful data at all or only partially useful data.
+    if (! isset($sensor_data['oid']) || $sensor_data['name'] == 'System V24 Port' || $sensor_data['name'] == 'Memory USB-Stick' || $sensor_data['name'] == 'Memory SD-Card' || $sensor_data['name'] == 'Login') {
+        echo "\n" . $sensor_data['name'] . " skipped!\n";
+        continue;
+    }
+
+    // No logic is provided for the sensor types 'Smoke' and 'Access'.
+    if ($sensor_data['name'] == 'Smoke') {
+        $sensor_data['logic'][0] = 'OK';
+        $sensor_data['logic'][1] = 'Alarm';
+    } elseif ($sensor_data['name'] == 'Access') {
+        $sensor_data['logic'][0] = 'Closed';
+        $sensor_data['logic'][1] = 'Open';
+    }
+
+    if (isset($sensor_data['logic'])) {
+        // We need separate state indexes for each device because the sensor logic can vary from device to device depending on its configuration. So we add our device serial here.
+        $sensor_data['name'] = $sensor_data['name'] . '_' . $serial_number;
+        $sensor_logic = [
+            [
+                'value'   => 0,
+                'generic' => 0,
+                'graph'   => 1,
+                'descr'   => $sensor_data['logic'][0],
+            ],
+            [
+                'value'   => 1,
+                'generic' => 0,
+                'graph'   => 1,
+                'descr'   => $sensor_data['logic'][1],
+            ],
+        ];
+
+        create_state_index($sensor_data['name'], $sensor_logic);
+    }
+
+    if (isset($sensor_data['divisor'])) {
+        $sensor_data['low_limit'] = ($sensor_data['low_limit'] / $sensor_data['divisor']);
+        $sensor_data['warn_limit'] = ($sensor_data['warn_limit'] / $sensor_data['divisor']);
+        $sensor_data['high_limit'] = ($sensor_data['high_limit'] / $sensor_data['divisor']);
+        $sensor_data['value'] = ($sensor_data['value'] / $sensor_data['divisor']);
+    } elseif (isset($sensor_data['multiplier'])) {
+        $sensor_data['low_limit'] = ($sensor_data['low_limit'] * $sensor_data['multiplier']);
+        $sensor_data['warn_limit'] = ($sensor_data['warn_limit'] * $sensor_data['multiplier']);
+        $sensor_data['high_limit'] = ($sensor_data['high_limit'] * $sensor_data['multiplier']);
+        $sensor_data['value'] = ($sensor_data['value'] * $sensor_data['multiplier']);
+    }
+
+    discover_sensor($valid['sensor'], $sensor_data['type'], $device, $sensor_data['oid'], $sensor_id, $sensor_data['name'], $sensor_data['desc'], $sensor_data['divisor'], $sensor_data['multiplier'], $sensor_data['low_limit'], null, $sensor_data['warn_limit'], $sensor_data['high_limit'], $sensor_data['value']);
+
+    if (isset($sensor_data['logic'])) {
+        create_sensor_to_state_index($device, $sensor_data['name'], $sensor_id);
+    }
+}
+
+unset($cmc_iii_var_table, $cmc_iii_sensors, $index, $entry, $var_name_parts, $sensor_name, $var_type, $sensor_id, $sensor_logic, $unit, $type, $sensor_data, $serial_number);

includes/polling/os/rittal-lcp.inc.php

@@ -1,10 +0,0 @@
-<?php
-
-$oids = ['cmcIIIUnitFWRev.0', 'cmcIIIDevName.1', 'cmcIIIUnitSerial.0'];
-
-$data = snmp_get_multi($device, $oids, '-OQUs', 'RITTAL-CMC-III-MIB');
-d_echo($data);
-
-$version = $data[0]['cmcIIIUnitFWRev'];
-$hardware = $data[1]['cmcIIIDevName'];
-$serial = $data[0]['cmcIIIUnitSerial'];