mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
b44f1546a2
* Improved Modern Modules Modules now report module dependencies and can dump data for testing This should serve to the process of building a module more obvious. cleanup now only requires a device, not an os wrapped around a device Helper to create a modern module (including the legacy adapter) from a name. * return false correctly for dump and handle it. * make sure test data is in the right format. * wrong isis table name * sort * Fix style and lint issues
74 lines
2.2 KiB
PHP
74 lines
2.2 KiB
PHP
<?php
|
|
/**
|
|
* Module.php
|
|
*
|
|
* LibreNMS Discovery/Poller Module
|
|
*
|
|
* 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 <https://www.gnu.org/licenses/>.
|
|
*
|
|
* @link https://www.librenms.org
|
|
*
|
|
* @copyright 2018 Tony Murray
|
|
* @author Tony Murray <murraytony@gmail.com>
|
|
*/
|
|
|
|
namespace LibreNMS\Interfaces;
|
|
|
|
use App\Models\Device;
|
|
use LibreNMS\OS;
|
|
|
|
interface Module
|
|
{
|
|
/**
|
|
* An array of all modules this module depends on
|
|
*/
|
|
public function dependencies(): array;
|
|
|
|
/**
|
|
* Discover this module. Heavier processes can be run here
|
|
* Run infrequently (default 4 times a day)
|
|
*
|
|
* @param \LibreNMS\OS $os
|
|
*/
|
|
public function discover(OS $os): void;
|
|
|
|
/**
|
|
* 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 \LibreNMS\OS $os
|
|
*/
|
|
public function poll(OS $os): void;
|
|
|
|
/**
|
|
* Remove all DB data for this module.
|
|
* This will be run when the module is disabled.
|
|
*
|
|
* @param \App\Models\Device $device
|
|
*/
|
|
public function cleanup(Device $device): void;
|
|
|
|
/**
|
|
* Dump current module data for the given device for tests.
|
|
* Make sure to hide transient fields, such as id and date.
|
|
* You should always order the data by a non-transient column.
|
|
* Some id fields may need to be joined to tie back to non-transient data.
|
|
* Module may return false if testing is not supported or required.
|
|
*
|
|
* @return array|false
|
|
*/
|
|
public function dump(Device $device);
|
|
}
|