mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
53bfb24ef9
* use component to discover if xDSL polling is needed use component to discover if xDSL polling is needed * Components OK, Polling in correct files, no DB for VDSL * GUI GUI_suite * per port as well * rename * interface listing * draytek_snmpsim * fix arraymerge fix names and max value * schema schema style * remove one dbFetchRows remove 2x dbFetchCell style style remove Legacy dbFetchRow tests tests eloquent more eloquent more eloquent one more gone * fix properties access eloquent_insert_update style tests tests tests tests * tests tests tests * adslLineCoding * Models * fix not nullable cols in DB from code default values typo rename typo schema fix fix vdsl fix now typo typo fix size fix size * Power values for VDSL Power values for VDSL Power values for VDSL DB * cleanup * Rrd::checkRrdExists * always enable DSL discovery style * xdsl module * cleanup and move to Module cleanup and move to Module cleanup and move to Module cleanup and move to Module * Fix display * fix polling and tenth * remove legacy poller * Style and Cosmetics Cosmetics Cleanup * Translations Translations * exists exists * add test support for xdsl * remove last component call unused * translations * remove non standard onclick event on xdsl line * Update Discovery Support.md Update Poller Support.md toner_gone * Notification for removal of lnms config:set enable_ports_adsl true * enable on devices with potential DSL interfaces * tests are working now fix teldat tests * os_schema * teldat * move to new module structure * move to new module structure * wrong dump function * wrong dump function * laravel_through_key hidden * Update notifications.rss * Update notifications.rss Co-authored-by: Tony Murray <murraytony@gmail.com>
239 lines
8.3 KiB
Markdown
239 lines
8.3 KiB
Markdown
# discovery.php
|
|
|
|
This document will explain how to use discovery.php to debug issues or
|
|
manually running to process data.
|
|
|
|
## Command options
|
|
|
|
```bash
|
|
-h <device id> | <device hostname wildcard> Poll single device
|
|
-h odd Poll odd numbered devices (same as -i 2 -n 0)
|
|
-h even Poll even numbered devices (same as -i 2 -n 1)
|
|
-h all Poll all devices
|
|
-h new Poll all devices that have not had a discovery run before
|
|
--os <os_name> Poll devices only with specified operating system
|
|
--type <type> Poll devices only with specified type
|
|
-i <instances> -n <number> Poll as instance <number> of <instances>
|
|
Instances start at 0. 0-3 for -n 4
|
|
|
|
Debugging and testing options:
|
|
-d Enable debugging output
|
|
-v Enable verbose debugging output
|
|
-m Specify module(s) to be run. Comma separate modules, submodules may be added with /
|
|
```
|
|
|
|
`-h` Use this to specify a device via either id or hostname (including
|
|
wildcard using *). You can also specify odd and even. all will run
|
|
discovery against all devices whilst new will poll only those devices
|
|
that have recently been added or have been selected for rediscovery.
|
|
|
|
`-i` This can be used to stagger the discovery process.
|
|
|
|
`-d` Enables debugging output (verbose output but with most sensitive
|
|
data masked) so that you can see what is happening during a discovery
|
|
run. This includes things like rrd updates, SQL queries and response
|
|
from snmp.
|
|
|
|
`-v` Enables verbose debugging output with all data in tact.
|
|
|
|
`-m` This enables you to specify the module you want to run for discovery.
|
|
|
|
## Discovery wrapper
|
|
|
|
We have a `discovery-wrapper.py` script which is based on
|
|
`poller-wrapper.py` by [Job Snijders](https://github.com/job). This
|
|
script is currently the default.
|
|
|
|
If you need to debug the output of discovery-wrapper.py then you can
|
|
add `-d` to the end of the command - it is NOT recommended to do this
|
|
in cron.
|
|
|
|
If you want to switch back to discovery.php then you can replace:
|
|
|
|
`33 */6 * * * librenms /opt/librenms/discovery-wrapper.py 1 >> /dev/null 2>&1`
|
|
|
|
With:
|
|
|
|
`33 */6 * * * librenms /opt/librenms/discovery.php -h all >> /dev/null 2>&1`
|
|
|
|
## Discovery config
|
|
|
|
These are the default discovery config items. You can globally disable
|
|
a module by setting it to 0. If you just want to disable it for one
|
|
device then you can do this within the WebUI -> Device -> Settings ->
|
|
Modules.
|
|
|
|
```php
|
|
$config['discovery_modules']['os'] = true;
|
|
$config['discovery_modules']['ports'] = true;
|
|
$config['discovery_modules']['ports-stack'] = true;
|
|
$config['discovery_modules']['entity-physical'] = true;
|
|
$config['discovery_modules']['entity-state'] = false;
|
|
$config['discovery_modules']['processors'] = true;
|
|
$config['discovery_modules']['mempools'] = true;
|
|
$config['discovery_modules']['cisco-vrf-lite'] = true;
|
|
$config['discovery_modules']['cisco-mac-accounting'] = false;
|
|
$config['discovery_modules']['cisco-pw'] = false;
|
|
$config['discovery_modules']['vrf'] = false;
|
|
$config['discovery_modules']['cisco-cef'] = false;
|
|
$config['discovery_modules']['slas'] = false;
|
|
$config['discovery_modules']['cisco-cbqos'] = false;
|
|
$config['discovery_modules']['cisco-otv'] = false;
|
|
$config['discovery_modules']['ipv4-addresses'] = true;
|
|
$config['discovery_modules']['ipv6-addresses'] = true;
|
|
$config['discovery_modules']['route'] = false;
|
|
$config['discovery_modules']['sensors'] = true;
|
|
$config['discovery_modules']['storage'] = true;
|
|
$config['discovery_modules']['hr-device'] = true;
|
|
$config['discovery_modules']['discovery-protocols'] = true;
|
|
$config['discovery_modules']['arp-table'] = true;
|
|
$config['discovery_modules']['discovery-arp'] = false;
|
|
$config['discovery_modules']['junose-atm-vp'] = false;
|
|
$config['discovery_modules']['bgp-peers'] = true;
|
|
$config['discovery_modules']['vlans'] = true;
|
|
$config['discovery_modules']['vmware-vminfo'] = false;
|
|
$config['discovery_modules']['libvirt-vminfo'] = false;
|
|
$config['discovery_modules']['printer-supplies'] = false;
|
|
$config['discovery_modules']['ucd-diskio'] = true;
|
|
$config['discovery_modules']['applications'] = false;
|
|
$config['discovery_modules']['services'] = true;
|
|
$config['discovery_modules']['stp'] = true;
|
|
$config['discovery_modules']['ntp'] = true;
|
|
$config['discovery_modules']['loadbalancers'] = false;
|
|
$config['discovery_modules']['mef'] = false;
|
|
$config['discovery_modules']['wireless'] = true;
|
|
$config['discovery_modules']['fdb-table'] = true;
|
|
$config['discovery_modules']['xdsl'] = false;
|
|
```
|
|
|
|
## OS based Discovery config
|
|
|
|
You can enable or disable modules for a specific OS by add
|
|
corresponding line in `config.php` OS based settings have preference
|
|
over global. Device based settings have preference over all others
|
|
|
|
Discover performance improvement can be achieved by deactivating all
|
|
modules that are not supported by specific OS.
|
|
|
|
E.g. to deactivate spanning tree but activate discovery-arp module for linux OS
|
|
|
|
```php
|
|
$config['os']['linux']['discovery_modules']['stp'] = false;
|
|
$config['os']['linux']['discovery_modules']['discovery-arp'] = true;
|
|
```
|
|
|
|
## Discovery modules
|
|
|
|
`os`: Os detection. This module will pick up the OS of the device.
|
|
|
|
`ports`: This module will detect all ports on a device excluding ones
|
|
configured to be ignored by config options.
|
|
|
|
`ports-stack`: Same as ports except for stacks.
|
|
|
|
`xdsl`: Module to collect more metrics for xDSL interfaces.
|
|
|
|
`entity-physical`: Module to pick up the devices hardware support.
|
|
|
|
`processors`: Processor support for devices.
|
|
|
|
`mempools`: Memory detection support for devices.
|
|
|
|
`cisco-vrf-lite`: VRF-Lite detection and support.
|
|
|
|
`ipv4-addresses`: IPv4 Address detection
|
|
|
|
`ipv6-addresses`: IPv6 Address detection
|
|
|
|
`route`: This module will load the routing table of the device. The default route
|
|
limit is 1000 (configurable in config.php with
|
|
```$config['routes']['max_number'] = 1000;```), with history data.
|
|
|
|
`sensors`: Sensor detection such as Temperature, Humidity, Voltages + More
|
|
|
|
`storage`: Storage detection for hard disks
|
|
|
|
`hr-device`: Processor and Memory support via HOST-RESOURCES-MIB.
|
|
|
|
`discovery-protocols`: Auto discovery module for xDP, OSPF and BGP.
|
|
|
|
`arp-table`: Detection of the ARP table for the device.
|
|
|
|
`fdb-table`: Detection of the Forwarding DataBase table for the
|
|
device, with history data.
|
|
|
|
`discovery-arp`: Auto discovery via ARP.
|
|
|
|
`junose-atm-vp`: Juniper ATM support.
|
|
|
|
`bgp-peers`: BGP detection and support.
|
|
|
|
`vlans`: VLAN detection and support.
|
|
|
|
`cisco-mac-accounting`: MAC Address account support.
|
|
|
|
`cisco-pw`: Pseudowires wires detection and support.
|
|
|
|
`vrf`: VRF detection and support.
|
|
|
|
`cisco-cef`: CEF detection and support.
|
|
|
|
`slas`: SLA detection and support.
|
|
|
|
`vmware-vminfo`: Detection of vmware guests on an ESXi host
|
|
|
|
`libvirt-vminfo`: Detection of libvirt guests.
|
|
|
|
`printer-supplies`: Toner levels support.
|
|
|
|
`ucd-diskio`: Disk I/O support.
|
|
|
|
`services`: *Nix services support.
|
|
|
|
`charge`: APC Charge detection and support.
|
|
|
|
## Running
|
|
|
|
Here are some examples of running discovery from within your install directory.
|
|
|
|
```bash
|
|
./discovery.php -h localhost
|
|
|
|
./discovery.php -h localhost -m ports
|
|
```
|
|
|
|
## Debugging
|
|
|
|
To provide debugging output you will need to run the discovery process
|
|
with the `-d` flag. You can do this either against all modules, single
|
|
or multiple modules:
|
|
|
|
All Modules
|
|
|
|
```bash
|
|
./discovery.php -h localhost -d
|
|
```
|
|
|
|
Single Module
|
|
|
|
```bash
|
|
./discovery.php -h localhost -m ports -d
|
|
```
|
|
|
|
Multiple Modules
|
|
|
|
```bash
|
|
./discovery.php -h localhost -m ports,entity-physical -d
|
|
```
|
|
|
|
Using `-d` shouldn't output much sensitive information, `-v` will so
|
|
it is then advisable to sanitise the output before pasting it
|
|
somewhere as the debug output will contain snmp details amongst other
|
|
items including port descriptions.
|
|
|
|
The output will contain:
|
|
|
|
DB Updates
|
|
|
|
SNMP Response
|