mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update docs for controlling modules (#13147)

Browse Source 
* update docs for controlling modules

* text update

* clarify

* typo

* add missing word
This commit is contained in:
Tony Murray
2021-08-19 10:32:08 -05:00
committed by GitHub
parent 4609da6db2
commit 3c6f9fd60f
2 changed files with 25 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/Developing/os/Settings.md
View File

@@ -99,6 +99,10 @@ per-device in the webui and per os or globally in config.php. Usually,
a poller module will not work if it's corresponding discovery module
is not enabled.
You should avoid setting these to false in the OS definitions unless it has a
significant negative impact on polling. Setting modules in the definition
reduces user control of modules.
```yaml
poller_modules:
bgp-peers: true

27
doc/Support/Configuration.md
View File

@@ -504,13 +504,28 @@ $config['allow_duplicate_sysName'] = false;
## Global poller and discovery modules
Generally, it is a better to set these [per
OS](../Developing/os/Settings.md#poller-and-discovery-modules) or
device.
Enable or disable discovery or poller modules.
```php
$config['discovery_modules']['arp-table'] = true;
$config['poller_modules']['bgp-peers'] = false;
This setting has an order of precedence Device > OS > Global.
So if the module is set at a more specific level, it will override the
less specific settings.
Global:
```bash
lnms config:set discovery_modules.arp-table false
lnms config:set discovery_modules.entity-state true
lnms config:set poller_modules.entity-state true
```
Per OS:
```bash
lnms config:set os.ios.discovery_modules.arp-table false
lnms config:set os.ios.discovery_modules.entity-state true
lnms config:set os.ios.poller_modules.entity-state true
```
## SNMP Settings