Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

Select Status


opennms (80) Versions 22.3.3

Installs and Configures opennms and provides many useful LWRPs.

cookbook 'opennms', '= 22.3.3', :supermarket
cookbook 'opennms', '= 22.3.3'
knife supermarket install opennms
knife supermarket download opennms
Quality 0%

Build Status


A Chef cookbook to manage the installation and configuration of OpenNMS Horizon.
Current version supports releases 16, 17, 18, 19, 20, 21, 22 on CentOS 6 and 7.


Starting with OpenNMS Horizon 16, the MSB of the version of the cookbook matches the latest MSB of the version of OpenNMS Horizon it supports. Support for older versions will be noted. The version of OpenNMS Horizon is selected via node attribute, defaulting to the latest supported release. The balance of the version follows semantic versioning - minor version bumps for backwards-compatible new features, third level bumps for bugfix only releases.


  • Chef 12.5.1 or later
  • CentOS 6 or 7
  • Either use Berkshelf to satisfy dependencies or manually acquire the following cookbooks:

    • hostsfile
    • build-essential
    • postgresql
    • openssl
  • In OpenNMS 17+ you will need a newer PostgreSQL than CentOS 6.x provides. Also, using Chef to install PostgreSQL makes tuning a lot easier. While you're free to install PostgreSQL in whatever manner pleases you, there is a postgres recipe that installs 9.3 from pgdg and does some basic tuning.


Running the default recipe will install OpenNMS 22.0.2-1 (or a custom version using the attribute node[:opennms][:version]) on CentOS 6 or 7 from the official repo with the default configuration. It will also execute '$ONMS_HOME/bin/runjava -s if $ONMS_HOME/etc/java.conf is not present and $ONMS_HOME/bin/install -dis if $ONMS_HOME/etc/configured is not present.

There are two primary ways to use this cookbook: as an application cookbook or library cookbook. If you simply want to tweak a few settings to the default OpenNMS configuration, you can use the default recipe of this cookbook directly and modify node attributes to suit your needs. There are also a plethora of custom resources that you can use to do more in depth customizations. If you go that route I recommend setting node['opennms']['templates'] to false (or add recipe[opennnms::notemplates] to your run list) and then using the custom resources (and maybe a few of the templates in this cookbook) to define your run list. If your node's run list contains both the template and a resource that manages the same file you'll end up with a lot of churn during the chef client run, which is a waste of time and will probably cause unnecessary restarts of the application.

Template resources for daemons that support configuration changes without a restart will automatically send the proper event to activate changes. Add appropriate notifies when you use custom resources from this cookbook for similar functionality. The test cookbook in test/fixtures/cookbooks/onms_lwrp_test has a recipe that demonstrates this for each custom resource.

Java (Optional)

While the current OpenNMS Yum repos contain a suitable JDK, you might want to check out the community java ( cookbook. Oracle likes to change license terms on a whim and their RPM might not set up things (like alternatives priorities) to your liking, so you might want to get ahead of the curve and manage installing the JDK yourself. See test/fixtures/cookbooks/oracle_java8 for a simple example method of installing Oracle Java via Chef. Note that you'll need to host the download yourself, since the last commercial Java 8 release is now an archived version and requires a login to download. If you're using test kitchen, you'll need to override the URL in a .kitchen.local.yml file to point at your (non-public) copy of the file. An example, where I'm using VirtualBox and serving it from my local workstation using apache UserDir:

  - name: centos-6.9
              url:  ''
              checksum: 'cb700cc0ac3ddc728a567c350881ce7e25118eaf7ca97ca9705d4580c506e370'
  - name: centos-7
              url:  ''
              checksum: 'cb700cc0ac3ddc728a567c350881ce7e25118eaf7ca97ca9705d4580c506e370'

If you want to install Java via RPM, you have to do a bit more work. First, you need to download the appropriate RPM(s) from Oracle and make a yum repo available to your nodes. For example, on a CentOS server with Apache httpd installed you could do:

# mkdir /var/www/html/oracle-java
# mv jdk*.rpm /var/www/html/oracle-java/
# createrepo /var/www/html/oracle-java
# chown -R apache:apache /var/www/html/oracle-java

Next, acquire the java cookbook in the link above by either cloning the repo and uploading to your Chef server or using Berkshelf or another cookbook management tool that can talk to git repos.

Set the following attributes (in a role, environement, or in a wrapper cookbook - up to you):

node['java']['oracle']['accept_oracle_download_terms'] = true
node['java']['install_flavor'] = 'oracle_rpm'
node['java']['oracle_rpm']['type'] = 'jdk'
node['java']['oracle_rpm']['package_name'] = 'jdk1.8.0_40' # match the current JDK version you've downloaded and set up a yum repo for
node['java']['alternatives_priority'] = 180040
node['java']['jdk_version'] = 8
node['java']['set_etc_environment'] = true
node['java']['oracle']['jce']['enabled'] = true

Add a yum_repository resource to a recipe in your node or role's run list, like so:

yum_repository 'oracle-java' do
  description 'mirror of oracle java RPM packages'
  baseurl 'URL_TO_YOUR_YUM_REPO'
  gpgcheck false
  action :create

Then add the 'java::default' recipe to your run list.

There are also a couple OpenNMS attributes you'll probably want to override at a minimum:


node[:opennms][:conf][:heap_size] = 1024
node[:opennms][:conf][:addl_mgr_opts] = '-XX:+UseConcMarkSweepGC -XX:MaxMetaspaceSize=512m'


Starting with version 2.0.0 there is support for handling upgrades
automatically. It is disabled by default. To enable, set
node['opennms']['upgrade'] to true. If this sounds like something you want
to do, review the upgrade recipe and library. It roughly translates to:

  • New RPM is installed.
  • Are there any files named *.rpmnew in $ONMS_HOME? If so, overwrite the existing files with them.
  • Are there any files named *.rpmsave in $ONMS_HOME? If so, remove them.

rpmsave files happen when there's a config file that you have changed that
was replaced with the new version because not replacing it would prevent
OpenNMS from working properly. But since we're using Chef, we don't care about
the old version as any changes we made to it previously will be redone with the
appropriate custom resources and templates later in the converge. Since OpenNMS won't
start with these files in place we just remove them.

Similarly, rpmnew files are created when a newer version of a file exists, but
it doesn't contain breaking changes. Just like rpmsave files, OpenNMS won't
start with these files present, and the rest of the converge will make the changes
we want anyway, so we just remove the old file.


  • opennms::default Installs and configures OpenNMS with the standard configuration modified with any node attribute values changed from their defaults.
  • opennms::notemplates Everything default does except minimal templates are used - etc/opennms.conf, etc/ and etc/log4j2.xml. Use this recipe if you intend to use any of the custom resources in this cookbook.
  • opennms::rrdtool Installs rrdtool and configures OpenNMS to use it rather than JRobin for metrics storage.
  • opennms::postgres Installs postgresql 9.3 in a somewhat tuned manner (from PGDG). You can use a newer version by changing node attributes in your role/environment/wrapper.
  • opennms::repositories Adds the public OpenNMS yum repositories to your system.

A few other recipes exist that aren't listed here. They are included by others when needed and are unlikely to be interesting for individual use.


The following recipes are deprecated. The preferred method to install these packages is by setting node[:opennms][:plugin][:nsclient] and/or node[:opennms][:plugin][:xml] to true. As of 19.0.0, the XML plugin has been merged into the core package and therefore setting that attribute to true has no effect. All these recipes do now is set those attributes at the default level.
* opennms::nsclient installs the optional nsclient data collection plugin and uses the template for etc/nsclient-datacollection-config.xml.
* opennms::xml installs the optional xml data collection plugin and uses the template for etc/xml-datacollection-config.xml.

Custom Resources

As a general rule these custom resources support a single action: create and many of them behave more like create_if_missing does in other cookbooks. In other words, updating is generally not supported. Exceptions are noted. This behavior will change in future releases (generally whenever I encounter a use case for update of that resource IRL).

The list of implemented custom resources is as follows:

Users, Groups and Roles

  • opennms_user: add a user. Uses the REST API.
  • opennms_group: add a group and populate it with users. You can even set the default SVG map and duty schedules.
  • opennms_role: add a role.
  • opennms_role_schedule: Add schedules to a role.


  • opennms_disco_specific: add a specific IP to be discovered.
  • opennms_disco_range: add a include or exclude range of IPs for discovery.
  • opennms_disco_url: add a include-url to discovery and if it's a file deploy it where specified.

Provisioning Requisitions

These custom resources use the OpenNMS REST interface. As such, OpenNMS has to be running for the resources to converge. (I used the term 'import' rather than the correct term 'requisition'. I can type 'import' a lot faster than 'requisition').

  • opennms_foreign_source: create a new foreign source optionally defining a scan interval (defaults to '1d').
  • opennms_service_detector: add a service detector to a foreign source. Supports updating and deleting.
  • opennms_policy: add a policy to a foreign source.
  • opennms_import: Defines a requisition for a foreign source. This and all import* custom resources include an option to synchronize the requisition - sync_import.
  • opennms_import_node: Add a node to a requisition including categories (array of strings) and assets (key/value hash pairs).
  • opennms_import_node_interface: Add an interface to a node in a requisition.
  • opennms_import_node_interface_service: Add a service to an interface on a node in a requisition.


  • opennms_eventconf: adds an event-file element to events in etc/eventconf.xml. Supports updating.
  • opennms_event: adds an event element to events in target eventconf file file. Not all elements from the eventconf schema are implemented, but the ones that seem to actually exist in the wild are. See resource for details and test recipes event and threshold for example usage. Supports updating and deleting existing events, so if you want to change an event in an eventconf file distributed with OpenNMS, this is the resource for you - no more merging files after an upgrade! For existing events you need to provide the file, UEI, the mask elements and the attribute(s) you want to change in your resource. If creating entirely new events, there are some attributes that are required by the eventconf schema but not enforced by the Chef resource (since they aren't required when doing an update). New in 18.2 is the ability to place new events at the top or bottom of an existing file with the 'position' attribute. Varbind filters are also now supported in masks.
  • opennms_send_event: creates an actual instance of an event using the script in $ONMS_HOME/bin. Used by the send_events recipe, which is included by default and notemplates recipes to cause config file reloads to take place when template resources make changes or an custom resource sends a notification.


  • opennms_notification_command: Create a new command in notificationCommands.xml.
  • opennms_destination_path: creates a destination path element in destinationPaths.xml. Requires at a minimum a single target which can be defined with the following custom resource.
  • opennms_target: Add a target or escalate target to a destination path (defined either in the default config or with the above custom resource).
  • opennms_notification: Create notification elements in notifications.xml. Supports updating and deleting (action :delete).

Node Service Credential Configuration

These custom resources allow you to define the credentials necessary to connect to services on monitored nodes. These are some of the few that currently implement updating and deleting. Action :create will update if changes are detected but :create_if_missing will do nothing. To determine if a resource needs to be updated or deleted, existance is determined by all definition element attributes being equal (so all resource attributes except ranges, specifics, ip_matches and position).

If an update occurs, the values contained in the new resource will be used. Note that all range, specific and ip-match elements that exist currently in the definition will be removed before the new elements are added.

Currently implemented are:

  • opennms_snmp_config_definition: add a definition element to snmp-config.xml.
  • opennms_wmi_config_definition: add a definition element to wmi-config.xml.


  • opennms_poller_package: add a package to etc/poller-configuration.xml. Note that an instance of this resource without use of an accompanying opennms_poller_service resource will result in a failure to start opennms.
  • opennms_poller_service: add a service to poller package named poller_name. Supports updating and deleting.
  • opennms_poll_outage: add a poll outage schedule that can be used by poller and collection package resources to prevent data collection and monitoring during set times.

Data Collection

  • opennms_resource_type: adds a resourceType definition to a file in etc/datacollection and an include-collection element to the default snmp-collection. This custom resource supports a very limited form of updating - if the resource type already exists but isn't included in the default snmp-collection, an include-collection element will be added. The definition of the resource type won't be updated, however.
  • opennms_system_def: add or remove pre-existing groups (/datacollection-group/group[@name]) to or from pre-existing systemDefs (/datacollection-group/systemDef/collect/includeGroup[text()]) in $ONMS_HOME/etc/datacollection/*.xml.
  • opennms_snmp_collection: adds an snmp-collection element to etc/datacollection-config.xml.
  • opennms_xml_collection: adds an xml-collection element to etc/xml-datacollection-config.xml.
  • opennms_wmi_collection: adds a wmi-collection element to etc/wmi-datacollection-config.xml.
  • opennms_jdbc_collection: adds a jdbc-collection element to etc/jdbc-datacollection-config.xml.
  • opennms_jmx_collection: adds a jmx-collection element to etc/jmx-datacollection-config.xml.
  • opennms_collection_package: adds a package element to etc/collectd-configuration.xml.
  • opennms_snmp_collection_service: adds a service element to a package in etc/collectd-configuration.xml.
  • opennms_xml_collection_service: adds a service element to a package in etc/collectd-configuration.xml. Supports update & delete.
  • opennms_wmi_collection_service: adds a service element to a package in etc/collectd-configuration.xml.
  • opennms_jdbc_collection_service: adds a service element to a package in etc/collectd-configuration.xml. Supports update & delete.
  • opennms_jmx_collection_service: adds a service element to a package in etc/collectd-configuration.xml.
  • opennms_snmp_collection_group: adds an include-collection element to an snmp-collection in etc/datacollection-config.xml and drops off the specified cookbook file into etc/datacollection.
  • opennms_jdbc_query: adds a query element to a jdbc-collection in etc/jdbc-datacollection-config.xml.
  • opennms_jmx_mbean: adds a mbean element to a jmx-collection in etc/jmx-datacollection-config.xml.
  • opennms_xml_source: adds a xml-source element to a xml-collection in etc/xml-datacollection-config.xml. Supports deleting.
  • opennms_xml_group: adds a xml-source element to a xml-source in etc/xml-datacollection-config.xml. Supports deleting.

Statistics Reports

See opennms::example_statsd for example usage of these custom resources.

  • opennms_statsd_package: create a new package optionally with a filter in statsd-configuration.xml.
  • opennms_statsd_report: add a report to a package in statsd-configuration.xml.


  • opennms_collection_graph_file: Add a cookbook file containing graph definitions (perhaps generated by the mib compiler) to $ONMS_HOME/etc/
  • opennms_collection_graph: Add a new graph definition to the main (bad idea), new or an existing graph file.
  • opennms_response_graph: Add a response graph to $ONMS_HOME/etc/ Since there's a pretty well defined pattern to these, you can define these with just the name of the data source and it'll create a graph with min, max and average response times.


See examples for all of these custom resources are in a single recipe, example_threshold.

  • opennms_threshd_package: Create a new package in threshd-configuration.xml.
  • opennms_threshold_group: Create a new threshold group in thresholds.xml.
  • opennms_threshold: Create a new threshold in the specified group in thresholds.xml. Supports updating and deleting.
  • opennms_expression: Create a new expression threshold in the specified group in thresholds.xml. Supports updating and deleting.

Web UI

There are a couple custom resources for managing the Web UI. All of these support updating.

  • opennms_avail_category: Define categories for use in the Availability box on the main page (and the Summary dashlet in Ops Board).
  • opennms_avail_view: Define the list of categories in each view sections displayed in the Availability box on the main page (and the Summary dashlet in Ops Board).
  • opennms_wallboard: Create a wallboard.
  • opennms_dashlet: Add a dashlet to a wallboard.
  • opennms_surveillance_view: Manage surveillance views used in the legacy dashboard, Ops Board, and optionally on the front page. Note: does not verify that the categories you reference exist, because there's no ReST interface (yet).

Template Overview

Most configuration files are templated and can be overridden with environment, role, or node attributes. See the default attributes file for a list of configuration items that can be changed in this manner, or keep reading for a brief overview of each template available. Default attribute values set to nil mean that the file's default value is commented out in the original file and will remain so unless set to a non-nil value.

Each template can also be overridden in a wrapper cookbook by manipulating the appropriate node attribute. For example, if you've got a pretty heavily customized collectd-configuration.xml file and you don't want to move to the custom resource/library cookbook workflow, turn your custom version into a template (append .erb to the filename and optionally add some templating logic to it) and add it to templates/default in your wrapper cookbook. Then set default[:opennms][:collectd][:cookbook] to the name of your wrapper cookbook. You could also copy all of the templates from this cookbook to your wrapper, edit them all as desired and set default[:opennms][:default_template_cookbook] to your wrapper cookbook's name.

If you want to skip some of the templates you can get the resource for each out of the resource collection and then set the action to :nothing. Example:

  sct = resources('template[/opt/opennms/etc/service-configuration.xml')
  Chef::Log.warn("Unable to find service-configuration.xml template in the resource collection!")


If you want to change the logo or default interval, count, hour or minute you can do so for either the calandar or classic report like so:

"opennms": {
"db_reports": {
"avail": {
"cal": {
"logo": "/path/to/an/other_logo.png"
"classic": {
"count": 7


Default categories can be modified by doing things like

     "opennms": {
       "categories": {
         "web": {
           "services": [

That'll leave the defaults for everything except overwrite the list of services in the web category.
The names of the categories are: 'overall', 'interfaces', 'email', 'web', 'jmx', 'dns', 'db', 'other', 'inet'.
The defaults are nil, which leaves the defaults as is. Override with false to disable.


Disable one of the three default charts by setting severity_enabled, outages_enable or inventory_enable to false in node['opennms']['chart'].


Use the node['opennms']['collectd']['threads'] attribute to change the number of threads (duh). There are also attributes for each default package. As of 1.12.5 those are: vmware3, vmware4, vmware5, example1. To modify one of those, for example, to change the IPv4 include range in the example1 package, you would do:

"opennms": {
"collectd": {
"example1": {
"ipv4_range": {
"begin": "",
"end": ""

That leaves most of the example1 package as default. Set a package's enabled attribute to false if you want to completely remove that package. You can also do that for specific services in that package. See the template for more options.


You can override some settings like:

"opennms": {
"datacollection": {
"default": {
"snmpStorageFlag": "all"

Or maybe you don't have any Dell gear:

"opennms": {
"datacollection": {
"default": {
"dell": false

You can also remove one of the default snmp-collections, or change the step and RRA definitions.


Attributes are available in node['opennms']['discovery'] to change global settings:
* threads (threads)
* packets-per-second (pps)
* initial-sleep-time (init_sleep_ms)
* restart-sleep-time (restart_sleep_ms)
* retries (retries)
* timeout (timeout)


Attributes are available in node['opennms']['eventd'] to change global settings:
* TCPAddress (tcp_address)
* TCPPort (tcp_port)
* UDPAddress (udp_address)
* UDPPort (udp_port)
* receivers (receivers)
* socketSoTimeoutRequired (sock_so_timeout_req to true or false)
* socketSoTimeoutPeriod (socket_so_timeout_period)


Attributes are available in node['opennms']['events_archiver'] to change global settings:
* archiveAge (age)
* separator (separator)


This file controls how OpenNMS sends email. This is not where you configure the mail monitor.
Attributes available in node['opennms']['javamail_props']. They follow the config file but with ruby style because the kids hate camel case I guess.
* org.opennms.core.utils.fromAddress (from_address)
* org.opennms.core.utils.mailHost (mail_host)
* ...and so on.


This is where you configure the mail monitor.
Attributes available in node['opennms']['javamail_config'. Unlike most of the templates, you can change every attribute and element in the default sendmail and receivemail elements since the defaults are useful to no one. Here's a list of the defaults which you definitely need to override if you want a mail monitor to work:

default['opennms']['javamail_config']['default_read_config_name'] = "localhost"
default['opennms']['javamail_config']['default_send_config_name'] = "localhost"
default['opennms']['javamail_config']['default_read']['attempt_interval'] = 1000
default['opennms']['javamail_config']['default_read']['delete_all_mail']  = false
default['opennms']['javamail_config']['default_read']['mail_folder']      = "INBOX"
default['opennms']['javamail_config']['default_read']['debug']            = true
default['opennms']['javamail_config']['default_read']['properties']       = {'mail.pop3.apop.enable' => false, 'mail.pop3.rsetbeforequit' => false}
default['opennms']['javamail_config']['default_read']['host']             = ""
default['opennms']['javamail_config']['default_read']['port']             = 110
default['opennms']['javamail_config']['default_read']['ssl_enable']       = false
default['opennms']['javamail_config']['default_read']['start_tls']        = false
default['opennms']['javamail_config']['default_read']['transport']        = "pop3"
default['opennms']['javamail_config']['default_read']['user']             = "opennms"
default['opennms']['javamail_config']['default_read']['password']         = "opennms"
default['opennms']['javamail_config']['default_send']['attempt_interval']   = 3000
default['opennms']['javamail_config']['default_send']['use_authentication'] = false
default['opennms']['javamail_config']['default_send']['use_jmta']           = true
default['opennms']['javamail_config']['default_send']['debug']              = true
default['opennms']['javamail_config']['default_send']['host']               = ""
default['opennms']['javamail_config']['default_send']['port']               = 25
default['opennms']['javamail_config']['default_send']['char_set']           = "us-ascii"
default['opennms']['javamail_config']['default_send']['mailer']             = "smtpsend"
default['opennms']['javamail_config']['default_send']['content_type']       = "text/plain"
default['opennms']['javamail_config']['default_send']['encoding']           = "7-bit"
default['opennms']['javamail_config']['default_send']['quit_wait']          = true
default['opennms']['javamail_config']['default_send']['ssl_enable']         = false
default['opennms']['javamail_config']['default_send']['start_tls']          = false
default['opennms']['javamail_config']['default_send']['transport']          = "smtp"
default['opennms']['javamail_config']['default_send']['to']                 = "root@localhost"
default['opennms']['javamail_config']['default_send']['from']               = "root@[localhost]"
default['opennms']['javamail_config']['default_send']['subject']            = "OpenNMS Test Message"
default['opennms']['javamail_config']['default_send']['body']               = "This is an OpenNMS test message."
default['opennms']['javamail_config']['default_send']['user']               = "opennms"
default['opennms']['javamail_config']['default_send']['password']           = "opennms"

This is useful for something I'm sure, but I don't know what. See the template or default attributes file for hints.


Similar to other datacollection-config.xml files, you can change the RRD repository, step, RRA definitions and disable default collections and their queries.


Configures the JMS Northbounder introduced in version 17.0.0. See the default attributes under the jms_nbi key for configuration options. You may also need to set some JMS related attributes under the properties key.


Similar to other datacollection-config.xml files, you can change the RRD repository, step, RRA definitions and disable default collections and their mbeans. In the JBoss collection you can specify a JMS queue and/or topic to collect stats on. See the template and default attributes for details.

etc/linkd-configuration.xml & etc/enlinkd-configuration.xml

Attributes available in node['opennms']['linkd'] that allow you change global settings like:
* threads
* initial_sleep_time
* snmp_poll_interval
* discovery_link_interval

You can also turn off various kinds of detection, like for iproutes, set any of these to false to remove them from the file:
* netscreen
* cisco
* darwin

Finally there's the package element at the end of the file that you can configure with these attributes:

default['opennms']['linkd']['package'] = "example1"
default['opennms']['linkd']['filter'] = "IPADDR != ''"
default['opennms']['linkd']['range_begin'] = ""
default['opennms']['linkd']['range_end'] = ""


This one is a little different. If you want to turn up logging for collectd, for instance, you'd set these override attributes:

default['opennms']['log4j2']['collectd'] = 'DEBUG'

The rtc username and password are populated from the values set in node['opennms']['properties']['rtc']['username'] and node['opennms']['properties']['rtc']['password']. TODO: Generate passwords during install! Other attributes available for configuration are:

default['opennms']['magic_users']['admin_users'] = "admin"
default['opennms']['magic_users']['ro_users'] = ""
default['opennms']['magic_users']['dashboard_users'] = ""
default['opennms']['magic_users']['provision_users'] = ""
default['opennms']['magic_users']['remoting_users'] = ""
default['opennms']['magic_users']['rest_users'] = "iphone"

Note that this file isn't a thing in versions >= 19.


Do you love the old SVG maps but are a contrarian when it comes to color schemes? Have we got the template for you! I guess also useful for translating labels? Check out the default attributes for details on what you can change.


Is ignorance about your broken network in fact bliss? Shut off notifd by setting node['notifd']['status'] to "off" and find out. Don't know what match-all even means? Find out by setting node['opennms']['notifd']['match_all'] to false. (It controls whether only the first matching notification is used or not). You can also disable any of the default auto-acknowledge elements with node['notifd']['auto_ack']['service_unresponsive|service_lost|interface_down|widespread_outage'].


Turn off one of the default notification commands by setting one of the attributes in node['opennms']['notification_commands'] to false:
* java_pager_email
* java_email
* xmpp_message
* xmpp_group_message
* irc_cat
* call_work_phone
* call_mobile_phone
* call_home_phone
* microblog_update
* microblog_reply
* microblog_dm


These attributes:
* enabled
* status
* rule
* destination_path
* description
* text_message
* subject
* numeric_message

can be overridden to alter any of these default notifications:

  • interface_down
  • node_down
  • node_lost_service
  • node_added
  • interface_deleted
  • high_threshold
  • low_threshold

in node['opennms']['notifications'].


Change the image format from the default png to gif or jpg (if using jrobin or you like broken images) with node['response_graph']['image_format']. Font sizes can also be changed with node['response_graph']['default_font_size'] and node['response_graph']['title_font_size'] (defaults are 7 and 10 respectively). Setting these attributes to false removes them from the file:

  • icmp
  • avail
  • dhcp
  • dns
  • http
  • http_8080
  • http_8000
  • mail
  • pop3
  • radius
  • smtp
  • ssh
  • jboss
  • snmp
  • ldap
  • strafeping
  • memcached_bytes
  • memcached_bytesrw
  • memcached_uptime
  • memcached_rusage
  • memcached_items
  • memcached_conns
  • memcached_tconns (off by default)
  • memcached_cmds
  • memcached_gets
  • memcached_evictions
  • memcached_threads
  • memcached_struct
  • ciscoping_time

If you changed the count of pings in the strafer polling package to a value higher than 20, you'll also need to define additional colors for the strafeping graph, like default['opennms']['response_graph']['strafeping_colors'][21] = ["#f5f5f5"]. If you want to add a STACK to the graph for another ping number (defaults to 1-4,10,19) add a second color to that attribute's value array, like default['opennms']['response_graph']['strafeping_colors'][21] = ["#f5f5f5","#050505"].


Tobi enthusiasts will want to set some attributes in node['opennms']['rrd'] to switch from jrobin to rrdtool:

"strategy_class": "org.opennms.netmgt.rrd.rrdtool.JniRrdStrategy",
"interface_jar": "/usr/share/java/jrrd.jar",
"jrrd": "/usr/lib/"

There's now a recipe that does this for you, named rrdtool. Probably just use that.

If you're a unique snowflake you can change a multitude of queue settings or change the jrobin backend factory, but unless you know what you're doing that's probably a mistake. Look at the template for details if you're curious.

Finally, to turn on the Google protobuf export thing described at, set these attributes accordingly:

default['opennms']['rrd']['usetcp']      = true
default['opennms']['rrd']['tcp']['host'] =
default['opennms']['rrd']['tcp']['port'] = 9100     # Hope that's a JetDirect compatible network interface!


Do you actually populate the building column in assets or site field in provisioning reqs? Change the default site status view name and/or it's definition with these attributes: node['opennms']['site_status_views']['default_view']['name'] and node['opennms']['site_status_views']['default_view']['rows'] where rows is an array of single element hashes (to maintain order) like:

"Routers": "Routers"
"Switches": "Switches"
"Servers": "Servers"


Similar to other * files, you can change the image format used in adhoc graphs by setting the attribute node['opennms']['snmp_adhoc_graph']['image_format'] to gif or jpg rather than the default png. Note that the intersection of formats supported by both jrobin and rrdtool is png, though.

etc/ &*

Similar to other * files, you can change the image format used in predefined graphs by setting the attribute node['opennms']['snmp_adhoc_graph']['image_format'] to gif or jpg rather than the default png. Note that the intersection of formats supported by both jrobin and rrdtool is png, though.
You can also set the default and title font sizes like you can in the response graphs. Since these graphs are now split up by manufacturer, you can disable graphs for a manufacturer like you can in snmp-datacollection-config.xml. This example disables Dell graphs:

      "dell_openmanage": false,
      "dell_rac": false

Note that this doesn't delete that file, it merely comments out the reports=... line(s) in the file.

You can also change the default KSC graph by setting node['snmp_graph']['default_ksc_graph'] to the name of a valid graph.

Also note that releases that use backshift instead of displaying generated images (17+) won't be affected by these changes.


You can remove either of the default packages or an individual report by setting attributes in node['opennms']['statsd']['PACKAGE_NAME']['REPORT_NAME'] to false. Packages and their reports are:

  • example1
    • top_n
  • response_time_reports
    • top_10_weekly
    • top_10_this_month
    • top_10_last_month
    • top_10_this_year


Like everything else that has packages, filters, ranges and services, you can override attributes to tune the defaults. See the template and default attributes for details. You can also configure the number of threads with node['opennms']['threshd']['threads'] (default is 5).


Change the RRD repository location or disable threshold groups with the enabled and rrd_repository attributes in node['opennms']['thresholds']['GROUP'] where group can be:

  • mib2
  • cisco
  • hrstorage
  • netsnmp
  • netsnmp_memory_linux
  • netsnmp_memory_nonlinux
  • coffee


Remove one of the default event translations ( by setting an attribute in node['opennms']['translator'] to false. They are:

  • snmp_link_down
  • snmp_link_up
  • hyperic
  • cisco_config_man
  • juniper_cfg_change


Two attributes available: port and new_suspect in node['opennms']['trapd'] that allow you to configure the port to listen for traps on (default 162) and whether or not to create newSuspect events when a trap is received from an unmanaged host (default false).


Change your admin password by setting node['opennms']['users']['admin']['password'] to whatever hashed value of your password OpenNMS uses. Uppercase MD5? In the future we'll generate one during install. You can also change the name and user_comments attributes, I guess.


Another web UI XML file, this one controls which categories are displayed in the availability box on the main landing page. Once a custom resource exists you'll be able to add sections, but until then you can disable any of the existing categories by setting one of these attributes in node['opennms']['web_console_view'] to false:

  • network_interfaces
  • web_servers
  • email_servers
  • dns_dhcp_servers
  • db_servers
  • jmx_servers
  • other_servers


Configure notifications to be sent via XMPP (aka Jabber, GTalk) with these attributes in node['opennms']['xmpp']:

  • server
  • service_name
  • port
  • tls
  • sasl
  • self_signed_certs
  • truststore_password
  • debug
  • user
  • pass


See the template and default attributes source for more details on using these templates:

  • etc/microblog-configuration.xml.erb
  • etc/
  • etc/
  • etc/nsclient-datacollection-config.xml.erb
  • etc/poller-configuration.xml.erb
  • etc/provisiond-configuration.xml.erb
  • etc/
  • etc/reportd-configuration.xml.erb
  • etc/rtc-configuration.xml.erb
  • etc/
  • etc/snmp-interface-poller-configuration.xml.erb
  • etc/
  • etc/surveillance-views.xml.erb
  • etc/syslog-northbounder-configuration.xml.erb
  • etc/syslogd-configuration.xml.erb
  • etc/vacuumd-configuration.xml.erb
  • etc/vmware-cim-datacollection-config.xml.erb
  • etc/vmware-datacollection-config.xml.erb
  • etc/wmi-datacollection-config.xml.erb
  • etc/xml-datacollection-config.xml.erb
  • etc/xmlrpcd-configuration.xml.erb


Apache 2.0

OpenNMS and OpenNMS Horizon are ™ and © The OpenNMS Group, Inc.


David Schlenk (


So far, tests consist of:

  • Style Checks using foodcritic and rubocop.
  • InSpec tests for all the custom resources.

The default rake task will run the style checks.

Use rake integration:vagrant to run the custom resource tests. You may need to increase your open file limit for test kitchen to work since there are an awful lot of suites. By default it'll run all the suites on all the supported versions, which will probably take a day or more (and rake will for sure run out of RAM before then), or you can specify specific major versions with -- -v 20,21. There's also a -r <INSTANCE_NAME> option that lets you resume testing after fixing something that failed.

Pull requests welcome!

Dependent cookbooks

hostsfile >= 0.0.0
build-essential >= 0.0.0
postgresql >= 0.0.0
openssl >= 0.0.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

Collaborator Number Metric

22.3.3 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric

22.3.3 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must contain a file

No Binaries Metric

22.3.3 failed this metric

Failure: Cookbook should not contain binaries. Found:

Testing File Metric

22.3.3 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must contain a file

Version Tag Metric

22.3.3 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must include a tag that matches this cookbook version number