From e968e37cdc8eb91c14032392786ea1d67485cfbe Mon Sep 17 00:00:00 2001 From: barryodonovan Date: Thu, 26 Oct 2017 11:43:09 +0100 Subject: [PATCH] docs: Updated default list of modules in poller and discovery support docs. (#7532) * updated default list of modules in poller and discovery support docs. * changed PollerSupport.md and DiscoverySupport.md to relect config.php as the correct location for local per-os module overrides * removed 'tnms-nbi' module from docs and from defaults file. Removed 'wifi' from docs. --- doc/Support/Discovery Support.md | 69 ++++++++++++++++------------- doc/Support/Poller Support.md | 75 ++++++++++++++++++-------------- includes/defaults.inc.php | 1 - 3 files changed, 81 insertions(+), 64 deletions(-) diff --git a/doc/Support/Discovery Support.md b/doc/Support/Discovery Support.md index c86b7fd461..1735702d8c 100644 --- a/doc/Support/Discovery Support.md +++ b/doc/Support/Discovery Support.md @@ -56,40 +56,49 @@ These are the default discovery config items. You can globally disable a module disable it for one device then you can do this within the WebUI -> Device -> Settings -> Modules. ```php -$config['discovery_modules']['os'] = 1; -$config['discovery_modules']['ports'] = 1; -$config['discovery_modules']['ports-stack'] = 1; -$config['discovery_modules']['entity-physical'] = 1; -$config['discovery_modules']['processors'] = 1; -$config['discovery_modules']['mempools'] = 1; -$config['discovery_modules']['cisco-vrf-lite'] = 1; -$config['discovery_modules']['ipv4-addresses'] = 1; -$config['discovery_modules']['ipv6-addresses'] = 1; -$config['discovery_modules']['route'] = 0; -$config['discovery_modules']['sensors'] = 1; -$config['discovery_modules']['storage'] = 1; -$config['discovery_modules']['hr-device'] = 1; -$config['discovery_modules']['discovery-protocols'] = 1; -$config['discovery_modules']['arp-table'] = 1; -$config['discovery_modules']['discovery-arp'] = 0; -$config['discovery_modules']['junose-atm-vp'] = 1; -$config['discovery_modules']['bgp-peers'] = 1; -$config['discovery_modules']['vlans'] = 1; -$config['discovery_modules']['cisco-mac-accounting'] = 1; -$config['discovery_modules']['cisco-pw'] = 1; -$config['discovery_modules']['cisco-vrf'] = 1; -#$config['discovery_modules']['cisco-cef'] = 1; -$config['discovery_modules']['cisco-sla'] = 1; -$config['discovery_modules']['vmware-vminfo'] = 1; -$config['discovery_modules']['libvirt-vminfo'] = 1; -$config['discovery_modules']['toner'] = 1; -$config['discovery_modules']['ucd-diskio'] = 1; -$config['discovery_modules']['services'] = 1; +$config['discovery_modules']['os'] = 1; +$config['discovery_modules']['ports'] = 1; +$config['discovery_modules']['ports-stack'] = 1; +$config['discovery_modules']['entity-physical'] = 1; +$config['discovery_modules']['processors'] = 1; +$config['discovery_modules']['mempools'] = 1; +$config['discovery_modules']['cisco-vrf-lite'] = 1; +$config['discovery_modules']['cisco-mac-accounting'] = 0; +$config['discovery_modules']['cisco-pw'] = 0; +$config['discovery_modules']['cisco-vrf'] = 0; +$config['discovery_modules']['cisco-cef'] = 0; +$config['discovery_modules']['cisco-sla'] = 0; +$config['discovery_modules']['cisco-cbqos'] = 0; +$config['discovery_modules']['cisco-otv'] = 0; +$config['discovery_modules']['ipv4-addresses'] = 1; +$config['discovery_modules']['ipv6-addresses'] = 1; +$config['discovery_modules']['route'] = 0; +$config['discovery_modules']['sensors'] = 1; +$config['discovery_modules']['storage'] = 1; +$config['discovery_modules']['hr-device'] = 1; +$config['discovery_modules']['discovery-protocols'] = 1; +$config['discovery_modules']['arp-table'] = 1; +$config['discovery_modules']['discovery-arp'] = 0; +$config['discovery_modules']['junose-atm-vp'] = 0; +$config['discovery_modules']['bgp-peers'] = 1; +$config['discovery_modules']['vlans'] = 1; +$config['discovery_modules']['vmware-vminfo'] = 0; +$config['discovery_modules']['libvirt-vminfo'] = 0; +$config['discovery_modules']['toner'] = 0; +$config['discovery_modules']['ucd-diskio'] = 1; +$config['discovery_modules']['applications'] = 0; +$config['discovery_modules']['services'] = 1; +$config['discovery_modules']['stp'] = 1; +$config['discovery_modules']['ntp'] = 1; +$config['discovery_modules']['loadbalancers'] = 0; +$config['discovery_modules']['mef'] = 0; +$config['discovery_modules']['wireless'] = 1; +$config['discovery_modules']['fdb-table'] = 1; ``` #### OS based Discovery config -You can enable or disable modules for a specific OS by add corresponding line in `includes/definitions/$os.yaml` +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. diff --git a/doc/Support/Poller Support.md b/doc/Support/Poller Support.md index 67e8eb0d4c..f28f2a80e0 100644 --- a/doc/Support/Poller Support.md +++ b/doc/Support/Poller Support.md @@ -42,43 +42,52 @@ These are the default poller config items. You can globally disable a module by disable it for one device then you can do this within the WebUI -> Settings -> Modules. ```php -$config['poller_modules']['unix-agent'] = 0; -$config['poller_modules']['os'] = 1; -$config['poller_modules']['ipmi'] = 1; -$config['poller_modules']['sensors'] = 1; -$config['poller_modules']['processors'] = 1; -$config['poller_modules']['mempools'] = 1; -$config['poller_modules']['storage'] = 1; -$config['poller_modules']['netstats'] = 1; -$config['poller_modules']['hr-mib'] = 1; -$config['poller_modules']['ucd-mib'] = 1; -$config['poller_modules']['ipSystemStats'] = 1; -$config['poller_modules']['ports'] = 1; -$config['poller_modules']['bgp-peers'] = 1; -$config['poller_modules']['junose-atm-vp'] = 1; -$config['poller_modules']['toner'] = 1; -$config['poller_modules']['ucd-diskio'] = 1; -$config['poller_modules']['wifi'] = 1; -$config['poller_modules']['ospf'] = 1; -$config['poller_modules']['cisco-ipsec-flow-monitor'] = 1; -$config['poller_modules']['cisco-remote-access-monitor'] = 1; -$config['poller_modules']['cisco-cef'] = 1; -$config['poller_modules']['cisco-sla'] = 1; -$config['poller_modules']['cisco-mac-accounting'] = 1; -$config['poller_modules']['cipsec-tunnels'] = 1; -$config['poller_modules']['cisco-ace-loadbalancer'] = 1; -$config['poller_modules']['cisco-ace-serverfarms'] = 1; -$config['poller_modules']['netscaler-vsvr'] = 1; -$config['poller_modules']['aruba-controller'] = 1; -$config['poller_modules']['entity-physical'] = 1; -$config['poller_modules']['applications'] = 1; -$config['poller_modules']['cisco-asa-firewall'] = 1; -$config['poller_modules']['mib'] = 0; +$config['poller_modules']['unix-agent'] = 0; +$config['poller_modules']['os'] = 1; +$config['poller_modules']['ipmi'] = 1; +$config['poller_modules']['sensors'] = 1; +$config['poller_modules']['processors'] = 1; +$config['poller_modules']['mempools'] = 1; +$config['poller_modules']['storage'] = 1; +$config['poller_modules']['netstats'] = 1; +$config['poller_modules']['hr-mib'] = 1; +$config['poller_modules']['ucd-mib'] = 1; +$config['poller_modules']['ipSystemStats'] = 1; +$config['poller_modules']['ports'] = 1; +$config['poller_modules']['bgp-peers'] = 1; +$config['poller_modules']['junose-atm-vp'] = 0; +$config['poller_modules']['toner'] = 0; +$config['poller_modules']['ucd-diskio'] = 1; +$config['poller_modules']['wireless'] = 1; +$config['poller_modules']['ospf'] = 1; +$config['poller_modules']['cisco-ipsec-flow-monitor'] = 0; +$config['poller_modules']['cisco-remote-access-monitor'] = 0; +$config['poller_modules']['cisco-cef'] = 0; +$config['poller_modules']['cisco-sla'] = 0; +$config['poller_modules']['cisco-mac-accounting'] = 0; +$config['poller_modules']['cipsec-tunnels'] = 0; +$config['poller_modules']['cisco-ace-loadbalancer'] = 0; +$config['poller_modules']['cisco-ace-serverfarms'] = 0; +$config['poller_modules']['cisco-asa-firewall'] = 0; +$config['poller_modules']['cisco-voice'] = 0; +$config['poller_modules']['cisco-cbqos'] = 0; +$config['poller_modules']['cisco-otv'] = 0; +$config['poller_modules']['cisco-vpdn'] = 0; +$config['poller_modules']['netscaler-vsvr'] = 0; +$config['poller_modules']['aruba-controller'] = 0; +$config['poller_modules']['entity-physical'] = 1; +$config['poller_modules']['applications'] = 1; +$config['poller_modules']['mib'] = 0; +$config['poller_modules']['stp'] = 1; +$config['poller_modules']['ntp'] = 1; +$config['poller_modules']['services'] = 1; +$config['poller_modules']['loadbalancers'] = 0; +$config['poller_modules']['mef'] = 0; ``` #### OS based Poller config -You can enable or disable modules for a specific OS by add corresponding line in `includes/definitions/$os.yaml` +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 Poller performance improvement can be achieved by deactivating all modules that are not supported by specific OS. diff --git a/includes/defaults.inc.php b/includes/defaults.inc.php index 1082aed626..c15d76145f 100644 --- a/includes/defaults.inc.php +++ b/includes/defaults.inc.php @@ -767,7 +767,6 @@ $config['poller_modules']['ntp'] = 1; $config['poller_modules']['services'] = 1; $config['poller_modules']['loadbalancers'] = 0; $config['poller_modules']['mef'] = 0; -$config['poller_modules']['tnms-nbi'] = 0; // List of discovery modules. Need to be in this array to be // considered for execution.