OpenNMS Administrator Reference Guide

OpenNMS.org
Published in 2001
Revision: @opennms.version@
Copyright (c) 1999, 2000, 2001, Oculan Corp.
www.opennms.org

Preface
Acknowledgments and Copyrights

Copyrights

The following copyrights are relevant to OpenNMS code or documentation:

Useful links for information

The following URLs are relevant to OpenNMS code or documentation:

1 Chapter 1
Admin Reference Overview

1.1 This document

Warning: This document is deprecated and refers to old code. A new document is being developed, but for now the best source of information can be found on Sourceforge. This document may be wrong on a number of important issues, and it will definitely waste your time.

This document covers the configuration of OpenNMS. In the following chapter we will cover each file and what it affects. Some examples will be provided, however much of the contents of each is self explanatory.

2 Chapter 2
Configuration Files

2.1 actiond-configuration.xml

Actions are external programs called based on events. This file controls the number of concurrent actions allowed as well as a time out for waiting on a return.

2.2 AvailabilityReports.xsl SVGAvailReport.xsl PDFAvailReport.xsl

These 3 files contain information for converting availability reports to PDF format.

2.3 viewsdisplay.xml

This file defines layout of categories for display in the web UI. The actual categories are defined in the views.xml file.

2.4 views.xml

This file defines view categories, and services, to include per category as well as thresholds. These values are used by various components of OpenNMS such as RTC, the availability report generator and the web UI.

2.5 capsd-configuration.xml

This file defines capabilities (services) to be checked for on nodes discovered either by the discovery daemon or via SNMP. It aslo specifies which addresses, and address ranges, that if discovered, should be managed or unmanaged. It also provides for a default state or "management-policy" that covers addresses not specifically referenced. 

		<capsd-configuration rescan-frequency="86400000"
			management-policy="unmanaged">

Finally you can set the "rescan-frequency" which controls how often devices are rescaned or rechecked for which services they provide. This number, specified in milliseconds, is used to determine how often items should get rescanned. The default value is 86400000 or 24hrs.

2.6 controller-configuration.xml

This file defines listeners for broadcast control JMS messages.

2.7 service-configuration.xml

This file defines opennms services to start. This is VM specific and controls which services are started in which VMs

2.8 create.sql database-schema.xml

The file create.sql is the template for creating OpenNMS database. It is typically used by the install.pl script during the install process. It is commented rather well. The database-schema.xml defines the same database, in xml format, and is used by the filtering system to format database queries

2.9 datacollection-config.xml

This file contains data collection information for RRDTool

2.10 notifications.xml

This file defines which events or UEIs warrant notification and a destination path for said notification. 

		<notification name="nodeAdded">
			<uei><![CDATA[http://uei.opennms.org/nodes/nodeAdded]]></uei>
			<rule><![CDATA[IPADDR IPLIKE *.*.*.*]]></rule>
			<destinationPath>Email-Network/Systems</destinationPath>
			<text-message>OpenNMS has discovered a new node named %parm[nodelabel]%.    Please be advised.</text-message>
			<subject>%parm[nodelabel]% discovered.</subject>
		</notification>

2.11 destinationPaths.xml

This file contains definitions for destination paths ie. whom to notify and by what method either pager, email or email-pager.

2.12 notificationCommands.xml

This file defines how to accomplish various contact methods defined in destinationPaths.xml. This would include the location of executable and aliases for each type of contact along with any other information needed to send information of the specific type. 

		<command type="email">
			<name>/bin/mail</name>
			<lookup>email</lookup>
			<lookup>mail</lookup>
			<comment>for sending email notifications</comment>
			<argument streamed="false">
				<substitution>-s</substitution>
				<switch>-subject</switch>
			</argument>
			<argument streamed="false">
				<switch>-email</switch>
			</argument>
			<argument streamed="true">
				<switch>-tm</switch>
			</argument>
		</command>

2.13 discovery-configuration.xml

This file defines the ranges of addresses to discover, (ping sweep) as well as time outs, number of retries, and number of threads to dedicate to discovery. This file also provides initial-sleep-time and restart-sleep-time. These values are in miliseconds and control how long after OpenNMS is started, that discovery should begin it's initial pass through the addresses, and how long to wait between each additional pass.

2.14 eventconf.xml

This file defines the Universal Event Identifiers or UEIs as well as their event masks, descriptions, log messages, and severity levels.

2.15 eventd-configuration.xml

This file defines operating parameters for eventd such as time outs and number of listener threads.

2.16 users.xml / groups.xml

These files hold information about users, and their contact information, as well as groups and membership. Information in these files is used for authentication on the web UI as well as for contact methods needed by notifications.

2.17 log4j.properties

This file defines properties for log4j. It controls log size, rotation as well as logging levels for individual category.

2.18 magic-users.properties

This file includes special users, and takes precedence over users.xml for the users that it has information about. This is used internally to control permissions for certain functions that interact with the web UI.

2.19 opennms-database.xml

This file defines database type, name, authentication and mapping template to use for OpenNMS.

2.20 opennms-mapping.xml

This file is empty but required by DTD for opennms-database.xml

2.21 opennms-jms.xml

This file defines properties for OpenJMS.

2.22 outage-configuration.xml

This file simply defines number of writer threads allowed by the outage manager

2.23 poller-configuration.xml

This file is used to define packages as well as set up the various pollers. A package includes several items such as address ranges, services, outage calendars, and down time models.

2.24 rrdtool-graph.properties

This file is used to define RRD configurations for generating reports.

2.25 rtc-configuration.xml

This file defines properties for RTC (Real Time Console) such as the rolling window used to calculate percentages of down time, web UI refresh interval and how often RTC sends updates to the web interface.

2.26 snmp-config.xml

This file is used to define community strings for addresses or address ranges, one snmp-config entry per community

2.27 trapd-configuration.xml

This file defines the SNMP trap port