WIP - Rewrite Wireless Controller polling

.gitignore

@@ -35,6 +35,7 @@ _ide_helper.php
 _ide_helper_models.php
 resources/views/menu/custom.blade.php
 resources/js/vue-i18n-locales.generated.js
+debug.txt
 
 # Docs #
 ########

LibreNMS/DB/SyncsModels.php

@@ -45,7 +45,10 @@ protected function syncModels($device, $relationship, $models): Collection
 
         foreach ($existing as $exist_key => $exist_value) {
             if ($models->offsetExists($exist_key)) {
-                // update
+                // update or restore soft-deleted model
+                if ($exist_value->trashed()) {
+                    $exist_value->restore();
+                }
                 $exist_value->fill($models->get($exist_key)->getAttributes())->save();
             } else {
                 // delete

LibreNMS/Interfaces/Polling/WirelessAccessPointPolling.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace LibreNMS\Interfaces\Polling;
+
+interface WirelessAccessPointPolling
+{
+    public function pollWirelessAccessPoints();
+}

LibreNMS/Interfaces/Polling/WirelessCountersPolling.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace LibreNMS\Interfaces\Polling;
+
+interface WirelessCountersPolling
+{
+    public function pollWirelessCounters();
+}

LibreNMS/Modules/Wireless.php

@@ -0,0 +1,131 @@
+<?php
+/**
+ * Wireless.php
+ *
+ * -Description-
+ *
+ * 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  2021 Otto Reinikainen
+ * @author     Otto Reinikainen <otto@ottorei.fi>
+ */
+
+namespace LibreNMS\Modules;
+
+use App\Observers\ModuleModelObserver;
+use Illuminate\Support\Collection;
+use LibreNMS\DB\SyncsModels;
+use LibreNMS\Device\WirelessSensor;
+use LibreNMS\Interfaces\Module;
+use LibreNMS\Interfaces\Polling\WirelessAccessPointPolling;
+use LibreNMS\OS;
+use LibreNMS\RRD\RrdDefinition;
+
+class Wireless implements Module
+{
+    use SyncsModels;
+
+    /**
+     * Discover this module. Heavier processes can be run here
+     * Run infrequently (default 4 times a day)
+     *
+     * @param  OS  $os
+     */
+    public function discover(OS $os)
+    {
+        // Discover wireless sensors
+        WirelessSensor::runDiscovery($os);
+    }
+
+    /**
+     * Poll data for this module and update the DB / RRD.
+     * Try to keep this efficient and only run if discovery has indicated there is a reason to run.
+     * Run frequently (default every 5 minutes)
+     *
+     * @param  OS  $os
+     */
+    public function poll(OS $os)
+    {
+        echo "\nPoll Wireless sensors: ";
+        WirelessSensor::poll($os);
+
+        if ($os instanceof WirelessAccessPointPolling) {
+            echo "\nPoll Wireless Access Points: ";
+            $access_points = new Collection;
+
+            // Get APs from controller. Uniquely identify by CompositeKey (apmac+radionumber)
+            // Each logical unit has it's own record
+            $access_points = $os->pollWirelessAccessPoints()->keyBy(function ($item) {
+                return $item->getCompositeKey();
+            });
+
+            // Sync models. In a situation where controller is changed, update existing APs
+            // TODO: Test restoring soft deleted models
+            ModuleModelObserver::observe('\App\Models\AccessPoint');
+            $this->syncModels($os->getDevice(), 'accessPoints', $access_points);
+
+            // Update RRD-files for AccessPoints and calculate total counters for the controller
+            foreach ($access_points as $ap) {
+                $rrd_name = [$os->getAccessPointDatastorePrefix(),  $ap->name . $ap->radionum];
+
+                $rrd_def = RrdDefinition::make()
+                    ->addDataset('channel', 'GAUGE', 0, 200)
+                    ->addDataset('txpow', 'GAUGE', 0, 200)
+                    ->addDataset('radioutil', 'GAUGE', 0, 100)
+                    ->addDataset('nummonclients', 'GAUGE', 0, 500)
+                    ->addDataset('nummonbssid', 'GAUGE', 0, 200)
+                    ->addDataset('numasoclients', 'GAUGE', 0, 500)
+                    ->addDataset('interference', 'GAUGE', 0, 2000);
+
+                $fields = [
+                    'channel'         => $ap->channel,
+                    'txpow'           => $ap->txpow,
+                    'radioutil'       => $ap->radioutil,
+                    'nummonclients'   => $ap->nummonclients,
+                    'nummonbssid'     => $ap->nummonbssid,
+                    'numasoclients'   => $ap->numasoclients,
+                    'interference'    => $ap->interference,
+                ];
+
+                $tags = [
+                    'name' => $ap->name,
+                    'radionum' => $ap->radionum,
+                    'rrd_name' => $rrd_name,
+                    'rrd_def' => $rrd_def,
+                ];
+
+                data_update($os->getDeviceArray(), $os->getDatastoreMeasurementName(), $tags, $fields);
+            }
+
+            echo PHP_EOL;
+        }
+    }
+
+    /**
+     * Remove all DB data for this module.
+     * This will be run when the module is disabled.
+     *
+     * @param  OS  $os
+     */
+    public function cleanup(OS $os)
+    {
+        // Delete all AccessPoints from the controller
+        $os->getDevice()->accessPoints()->delete();
+
+        // Delete all WirelessSensors from the device
+        $os->getDevice()->wirelessSensors()->delete();
+    }
+}

LibreNMS/OS/Arubaos.php

@@ -25,7 +25,9 @@
 
 namespace LibreNMS\OS;
 
+use App\Models\AccessPoint;
 use App\Models\Device;
+use Illuminate\Support\Collection;
 use LibreNMS\Device\WirelessSensor;
 use LibreNMS\Interfaces\Discovery\OSDiscovery;
 use LibreNMS\Interfaces\Discovery\Sensors\WirelessApCountDiscovery;
@@ -35,6 +37,7 @@
 use LibreNMS\Interfaces\Discovery\Sensors\WirelessPowerDiscovery;
 use LibreNMS\Interfaces\Discovery\Sensors\WirelessUtilizationDiscovery;
 use LibreNMS\Interfaces\Polling\Sensors\WirelessFrequencyPolling;
+use LibreNMS\Interfaces\Polling\WirelessAccessPointPolling;
 use LibreNMS\OS;
 
 class Arubaos extends OS implements
@@ -45,7 +48,8 @@ class Arubaos extends OS implements
     WirelessFrequencyPolling,
     WirelessNoiseFloorDiscovery,
     WirelessPowerDiscovery,
-    WirelessUtilizationDiscovery
+    WirelessUtilizationDiscovery,
+    WirelessAccessPointPolling
 {
     public function discoverOS(Device $device): void
     {
@@ -214,4 +218,59 @@ public function pollWirelessFrequency(array $sensors)
     {
         return $this->pollWirelessChannelAsFrequency($sensors, [$this, 'decodeChannel']);
     }
+
+    public function getDatastoreMeasurementName()
+    {
+        // Datastore measurement name
+        return 'aruba';
+    }
+
+    public function getWirelessControllerDatastorePrefix()
+    {
+        // Prefix used to name RRD-files for AccessPoints
+        return 'aruba-controller';
+    }
+
+    public function getAccessPointDatastorePrefix()
+    {
+        // Prefix used to name RRD-files for AccessPoints
+        return 'arubaap';
+    }
+
+    /**
+     * Poll wireless access points data from the controller
+     * Return collection of AccessPoints
+     */
+    public function pollWirelessAccessPoints()
+    {
+        $access_points = new Collection;
+        $wlsxWlanRadioTable = snmpwalk_group($this->getDeviceArray(), 'WLSX-WLAN-MIB::wlsxWlanRadioTable', '1');
+        $wlsxWlanAPChStatsTable = snmpwalk_group($this->getDeviceArray(), 'WLSX-WLAN-MIB::wlsxWlanAPChStatsTable', '1');
+
+        // Loop through the polled data. Array format: $table[mac-of-ap][oid][radio number]
+        foreach ($wlsxWlanRadioTable as $ap => $val1) {
+            foreach ($wlsxWlanRadioTable[$ap]['wlanAPRadioAPName'] as $radio_id => $val2) {
+                $attributes = [
+                    'device_id' => $this->getDeviceId(),
+                    'name' => $wlsxWlanRadioTable[$ap]['wlanAPRadioAPName'][$radio_id],
+                    'radio_number' => $radio_id,
+                    'type' => $wlsxWlanRadioTable[$ap]['wlanAPRadioType'][$radio_id],
+                    'mac_addr' => $ap,
+                    'channel' => $wlsxWlanRadioTable[$ap]['wlanAPRadioChannel'][$radio_id],
+                    'txpow' => $wlsxWlanRadioTable[$ap]['wlanAPRadioUtilization'][$radio_id] / 2,
+                    'radioutil' => $wlsxWlanRadioTable[$ap]['wlanAPRadioUtilization'][$radio_id],
+                    'numasoclients' => $wlsxWlanRadioTable[$ap]['wlanAPRadioNumAssociatedClients'][$radio_id],
+                    'nummonclients' => $wlsxWlanRadioTable[$ap]['wlanAPRadioNumMonitoredClients'][$radio_id],
+                    'numactbssid' => $wlsxWlanRadioTable[$ap]['wlanAPRadioNumActiveBSSIDs'][$radio_id],
+                    'nummonbssid' => $wlsxWlanRadioTable[$ap]['wlanAPRadioNumMonitoredBSSIDs'][$radio_id],
+                    'interference' => $wlsxWlanAPChStatsTable[$ap]['wlanAPChInterferenceIndex'][$radio_id],
+                ];
+
+                // Create AccessPoint models
+                $access_points->push(new AccessPoint($attributes));
+            }
+        }
+        // Return the collection of AccessPoint models
+        return $access_points;
+    }
 }

app/Models/AccessPoint.php

@@ -2,8 +2,36 @@
 
 namespace App\Models;
 
-class AccessPoint extends DeviceRelatedModel
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\SoftDeletes;
+use LibreNMS\Interfaces\Models\Keyable;
+
+class AccessPoint extends DeviceRelatedModel implements Keyable
 {
-    protected $primaryKey = 'accesspoint_id';
+    use HasFactory;
+    use SoftDeletes;
+
+    public $primaryKey = 'accesspoint_id';
     public $timestamps = false;
+
+    protected $fillable = [
+        'device_id',
+        'name',
+        'radio_number',
+        'type',
+        'mac_addr',
+        'channel',
+        'txpow',
+        'radioutil',
+        'numasoclients',
+        'nummonclients',
+        'numactbssid',
+        'nummonbssid',
+        'interference',
+    ];
+
+    public function getCompositeKey()
+    {
+        return "$this->device_id-$this->mac_addr-$this->radio_number";
+    }
 }

app/Models/Device.php

@@ -553,7 +553,7 @@ public function scopeNotInServiceTemplate($query, $serviceTemplate)
 
     public function accessPoints(): HasMany
     {
-        return $this->hasMany(AccessPoint::class, 'device_id');
+        return $this->hasMany(\App\Models\AccessPoint::class, 'device_id');
     }
 
     public function alerts(): HasMany

database/migrations/2021_10_09_1830_alter_access_points_table.php

@@ -0,0 +1,34 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class AlterAccessPointsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::table('access_points', function (Blueprint $table) {
+            $table->dropColumn('deleted');
+            $table->softDeletes();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::table('access_points', function (Blueprint $table) {
+            $table->dropSoftDeletes();
+            $table->boolean('deleted')->default(0)->index();
+        });
+    }
+}

includes/discovery/wireless.inc.php

@@ -23,6 +23,9 @@
  * @author     Tony Murray <murraytony@gmail.com>
  */
 
-use LibreNMS\Device\WirelessSensor;
+use LibreNMS\OS;
 
-WirelessSensor::runDiscovery($os);
+if (! $os instanceof OS) {
+    $os = OS::make($device);
+}
+(new \LibreNMS\Modules\Wireless())->discover($os);