From OpenNMS

Technical Information

The OpenNMS Book in English is located in GIT: git clone git://opennms.git.sourceforge.net/gitroot/opennms/opennmsbook

ssh://$USER@opennms.git.sourceforge.net/gitroot/opennms/opennmsbook

If you use Scrivener, you can open the project file directly. If you do not use Scrivener, please go into the “inbound” directory and modify the files in there.

The text format is RTF, which means that you can edit text in any RTF-capable editor. If you have text in another format, or if you have text of which you don’t know where to put, please save it in the ./inbound/ folder. There will be a recent pdf as well for your convenience (which shows the current status of the book).

Writing Style

There is a style guide written by the BBC in the git repository. It is written for news and not for a manual, but: read through it for inspiration. A lot of the statements true for news are true for this book as well. We do not aim to create an academical work, but a readable, useful book which becomes a permanent reference for the reader. This means, above all: Short sentences. Another consideration is the way in which we address the reader. “How are we doing today” is what the doctor says when we visit (mine does not, but that’s another story). Avoid the “we do this” and then “we do that” - it’s not us, it’s either the writer or the reader.

1	Howto
2	Introduction
	2.1	Introduction
	2.2	OpenNMS
	2.3	Capability Overview
	2.4	License Information
3	User
	3.1	Accessing the WebUi
	3.2	Reading SLA Category Data
	3.3	Reading Graphs
	3.4	Acknowledging Notifications
	3.5	Creating Tickets in a Ticket System
	3.6	KSC Reports
	3.7	Standard Reports
	3.8	Asset Management
	3.9	Standard Services (out of the box)
	3.10	Surveillance Views
	3.11	Mobile Access
4	Administrator
	4.1	The administrators workflow
		4.1.1	Everything is an event
		4.1.2	Set out a trap
		4.1.3	Interpret and decide
		4.1.4	Share and Alert
		4.1.5	Service Monitoring
		4.1.6	Data Collection
		4.1.7	Alarms
		4.1.8	Automations
	4.2	Data Analysis
		4.2.1	Syslog
		4.2.2	Thresholding
		4.2.3	Trap Handling
		4.2.4	Automations
		4.2.5	ScriptD
		4.2.6	Path Outages
		4.2.7	Filters
	4.3	OpenNMS Base
		4.3.1	Deployment
		4.3.2	Installing
		4.3.3	System Architecture
			4.3.3.1	Eventd
			4.3.3.2	Sizing
		4.3.4	User Management and external Authentication
			4.3.4.1	LDAP
		4.3.5	Debugging
		4.3.6	System Configuration
			4.3.6.1	Adding new Services
			4.3.6.2	Adding new Devices
			4.3.6.3	OpenNMS Configuration
			4.3.6.4	Scheduled Outages
			4.3.6.5	Managing Configuration
		4.3.7	Backup & Restore
		4.3.8	Security Considerations
		4.3.9	Houskeeping
	4.4	Provisioning
		4.4.1	One chapter per way to provision with provisiond
		4.4.2	CapsD & Discovery
		4.4.3	Surveillance Categories
	4.5	Active Polling
		4.5.1	Monitoring
		4.5.2	Passive Status Keeper
		4.5.3	DHCPD
		4.5.4	SNMP Poller
	4.6	Data Collection
		4.6.1	SNMP Datacollection
		4.6.2	HTTP Datacollection
		4.6.3	JMX Datacollection
		4.6.4	WMI Datacollection
		4.6.5	NSClient
		4.6.6	LinkD
		4.6.7	JDBC Datacollection
	4.7	Presenting Information
		4.7.1	Graphical Representation
			4.7.1.1	Maps
			4.7.1.2	Graphing
			4.7.1.3	Extending Reports
		4.7.2	Workflow Integration
			4.7.2.1	Notifications
			4.7.2.2	Alarm Management
			4.7.2.3	Ticketing Integration
			4.7.2.4	Asterisk Gateway
	4.8	Asset Management
		4.8.1	Asset Management
		4.8.2	SNMP Asset Adapter
5	Bug reporting, Information Sources
6	Popular Discussions
7	Design patterns and best practices