Get OpenNMS
Get Involved
Get to Know Us
From OpenNMS
(Difference between revisions)
m |
|||
| Line 3: | Line 3: | ||
For example, to reload the Ackd configuration: | For example, to reload the Ackd configuration: | ||
| − | $OPENNMS_HOME/bin/send-event.pl -p 'daemonName Ackd ' uei.opennms.org/internal/reloadDaemonConfig | + | $OPENNMS_HOME/bin/send-event.pl -p 'daemonName Ackd' uei.opennms.org/internal/reloadDaemonConfig |
Restart requirements have reduced over time as more forced reload events and automatic reload functionality has been implemented; see http://issues.opennms.org/browse/NMS-2388 for the status of the final push to make it all consistent under one UEI. But for now, there are several columns indicating the functionality available for different versions. In some cases the events that should be used have changed between versions; this is noted where relevant. | Restart requirements have reduced over time as more forced reload events and automatic reload functionality has been implemented; see http://issues.opennms.org/browse/NMS-2388 for the status of the final push to make it all consistent under one UEI. But for now, there are several columns indicating the functionality available for different versions. In some cases the events that should be used have changed between versions; this is noted where relevant. | ||
Revision as of 10:53, 4 May 2012
This page shows all the configuration files (in $OPENNMS_HOME/etc/) you can configure in OpenNMS. Some files require a restart of OpenNMS for manual edits to take effect; some are re-written/managed automatically by OpenNMS and the Web GUI, and others may have an associated event that can be sent (e.g. using send-event.pl) to trigger re-reading of the file. Where a "Reload event" is documented below, sending it, with the documented parameter if required, will cause the given configuration file to be reloaded from disk.
For example, to reload the Ackd configuration:
$OPENNMS_HOME/bin/send-event.pl -p 'daemonName Ackd' uei.opennms.org/internal/reloadDaemonConfig
Restart requirements have reduced over time as more forced reload events and automatic reload functionality has been implemented; see http://issues.opennms.org/browse/NMS-2388 for the status of the final push to make it all consistent under one UEI. But for now, there are several columns indicating the functionality available for different versions. In some cases the events that should be used have changed between versions; this is noted where relevant.
Note also that it is possible to restart individual daemons: see daemons for more details.underlying bits
| File | Restart Required | Reload Event | More information | ||
|---|---|---|---|---|---|
| 1.3.7+ | 1.6+ | 1.8+ | |||
| ackd-configuration.xml | N/A | N/A | No | uei.opennms.org/internal/reloadDaemonConfig (with daemonName = Ackd) | Ackd configuration |
| actiond-configuration.xml | Yes | Yes | Yes | - | Actiond configuration |
| AvailabilityReports.xsl | No | No | No | - | XSL used for formatting Availability Reports. Read every time a report is generated; no reload required |
| c3p0.properties | Yes | Yes | Yes | - | Database connection pooling configuration. Read only at startup. See Jetty#Advanced_Configuration_.281.3.7.2B_only.29 |
| capsd-configuration.xml | Yes | Yes | Yes | - | Discovery#Capabilities |
| castor.properties | Yes | Yes | N/A | - | Internal use only. Not present in 1.8+. |
| categories.xml | Yes | Yes | Yes | - | Categories |
| chart-configuration.xml | Yes | Yes | Yes | - | - |
| collectd-configuration.xml | Yes | No | No | uei.opennms.org/internal/schedOutagesChanged (required side effect) | Collectd |
| database-schema.xml | Yes | Yes | Yes | - | Internal use |
| datacollection-config.xml | Yes | Yes | Yes | - | Data_Collection_Configuration_How-To#datacollection-config.xml |
| destinationPaths.xml | No | No | No | Will automatically re-read as required, but in 1.8+ a (somewhat pointless) reload can be forced with uei.opennms.org/internal/reloadDaemonConfig (with daemonName = Scriptd). | Configuring_notifications |
| dhcpd-configuration.xml | Yes | Yes | Yes | - | ? |
| discovery-configuration.xml | Yes | No | No | uei.opennms.org/internal/discoveryConfigChange | Controls OpenNMS's auto discovery of nodes |
| eventconf.xml && events/* | Yes | No | No | Up to 1.6.9 or so: uei.opennms.org/internal/reloadEventConfig. 1.8+ uei.opennms.org/internal/eventsConfigChange, or uei.opennms.org/internal/reloadDaemonConfig (with daemonName = Eventd) | See Event Configuration |
| eventd-configuration.xml | Yes | Yes | Yes | - | eventd |
| events-archiver-configuration.xml | Yes | Yes | Yes | - | |
| events.archiver.properties | Yes | Yes | Yes | - | |
| exclude-ueis.properties (pending verification) | Yes | Yes | N/A | - | Not used as of at least 1.8.10 |
| groups.xml | No | No | No | Reloaded automatically if changes made | ? |
| http-datacollection-config.xml | Yes | Yes | Yes | - | HTTP_Collector |
| javamail-configuration.properties | No | No | No | Read every time javamail is used | |
| javamail-configuration.xml | ? | ? | ? | ? | ? |
| jcifs.properties | Yes | Yes | Yes | - | ? |
| jmx-datacollection-config.xml | Yes | Yes | Yes | - | JMX_Collector |
| ksc-performance-reports.xml | No | No | No | Used and maintained by the web interface; manual edits not required | KSC_Reports |
| linkd-configuration.xml | Yes | Yes | Yes | - | Linkd |
| log4j-controller.properties | No | No | No | Reloaded automatically when changed | |
| log4j.properties | No | No | No | Reloaded automatically when changed | |
| magic-users.properties | No | No | No | - | User |
| map.disable | Yes | Yes | Yes | - | Disables map generation |
| map.properties | Yes | Yes | Yes | - | Defines properties for maps |
| model-importer.properties | Yes | Yes | Yes | uei.opennms.org/internal/importer/reloadImport | ? |
| monitoring-locations.xml | Yes | Yes | Yes | - | Remote_Monitoring#monitoring-locations.xml |
| notifd-configuration.xml | No | No | No | Automatically reloaded when it changes | Notifd |
| notificationCommands.xml | Yes | No | No | 1.6+: Unknown. 1.8+: uei.opennms.org/internal/reloadDaemonConfig (with daemonName = Notifd) | Notifd |
| notifications.xml | No | No | No | Automatically reloaded when it changes | Notifd |
| nsclient-config.xml | Yes | Yes | Yes | - | Data_collection_from_Windows_Performance_Counters_with_NSClient++ |
| nsclient-datacollection-config.xml | Yes | Yes | Yes | - | Data_collection_from_Windows_Performance_Counters_with_NSClient++ |
| opennms-database.xml | Yes | Yes | N/A | - | Not in use from 1.8+ (or earlier?) |
| opennms-datasources.xml | Yes | Yes | Yes | - | The JDBC datasources for opennms and opennms-admin. The later is used by the installer to create the opennms database. |
| opennms.properties | Yes | Yes | Yes | Read at startup only | |
| opennms-server.xml | Yes | Yes | Yes | - | ? |
| poll-outages.xml | No | No | No | uei.opennms.org/internal/schedOutagesChanged | Configuration of scheduled polling outages |
| poller-config.properties | No | No | No | - | Maintained by the Web UI (functionality currently disabled); reloaded by the UI on every page load. |
| poller-configuration.xml | Yes | No | No | uei.opennms.org/internal/schedOutagesChanged | ? |
| PDFAvailReport.xsl (maybe) | No | No | No | - | XSL used for formatting Availability Reports. Read every time a report is generated; no reload required |
| provisiond-configuration.xml | N/A | N/A | No | uei.opennms.org/internal/reloadDaemonConfig (with daemonName = Provisiond) | Provisiond configuration |
| reportd-configuration.xml | Yes | Yes | Yes | - | |
| rrd-configuration.properties | Yes | Yes | Yes | - | |
| rtc-configuration.xml | Yes | Yes | Yes | - | |
| response-adhoc-graph.properties | No | No | No | - | Managed by the Web UI. |
| response-graph.properties | No | No | No | Re-read automatically by the Web UI as required | |
| scriptd-configuration.xml | Yes | No | No | 1.6+: uei.opennms.org/internal/reloadScriptConfig, 1.8+: uei.opennms.org/internal/reloadDaemonConfig (with daemonName = Scriptd). | Scriptd |
| service-configuration.xml | Yes | Yes | Yes | - | ? |
| site-status-views.xml | No | No | No | Re-read automatically when it changes | ? |
| snmp-adhoc-graph.properties | No | No | No | Re-read automatically when it changes | Defines the templates from which ad-hoc (on-the-fly customised) graphs are created. |
| snmp-config.xml | No | No | No | uei.opennms.org/internal/configureSNMP | On 2011/10/28, I tried this with openNMS 1.8.13 and it didn't work. Somebody told me that sending uei.opennms.org/internal/reloadSnmpPollerConfig would have work (update 2011/11/14: I just tried and it didn't work). |
| snmp-graph.properties / snmp-graph.properties.d | No | No | No | Re-read automatically by the Web UI as required | Defines graphs for displaying collected data |
| statsd-configuration.xml | Yes | Yes | No | uei.opennms.org/internal/reloadDaemonConfig (with daemonName = Statsd) | Statsd |
| surveillance-views.xml | No | No | No | - | ? |
| SVGAvailReport.xsl | No | No | No | - | XSL used for formatting Availability Reports. Read every time a report is generated; no reload required |
| syslogd-configuration.xml | Yes | No | Yes | uei.opennms.org/internal/syslogdConfigChange. Event seems to have been removed by 1.8; not entirely sure when (To be investigated) | |
| thresholds.xml | No | No | No | 1.6+ uei.opennms.org/internal/thresholdConfigChange, 1.8+ uei.opennms.org/internal/reloadDaemonConfig (with daemonName = Threshd *and* configFile thresholds.xml) | Thresholding |
| threshd-configuration.xml | Yes | Yes | No | 1.8+: uei.opennms.org/internal/reloadDaemonConfig (with daemonName = Threshd) | Thresholding |
| translator-configuration.xml | Yes | Yes | No | uei.opennms.org/internal/reloadDaemonConfig (with daemonName = Translator) | Event_Translator |
| trapd-configuration.xml | Yes | Yes | Yes | - | ? |
| users.xml | No | No | No | - | User |
| vacuumd-configuration.xml | No | No | No | 1.6+: uei.opennms.org/internal/reloadVacuumdConfig, 1.8+: uei.opennms.org/internal/reloadDaemonConfig (with daemonName = Vacuumd). | See Automations |
| viewsdisplay.xml | Yes | Yes | No | Reloaded automatically when it has changed | ? |
| vulnscand-configuration.xml | Yes | Yes | Yes | - | ? |
| webui-colors.xml | Yes | Yes | No | Read every time as required | ? |
| xmlrpcd-configuration.xml | Yes | Yes | Yes | - | ? |
| xmpp-configuration.properties | Yes | Yes | Yes | - | ? |
