OpenNMS Javascript API

A client API for accessing the OpenNMS network monitoring platform.

Using the OpenNMS.js APIs In Your Code

Information on getting started and how to use the API is in the HOWTO document.

The complete API list is available at docs.opennms.org.

Using the OpenNMS.js Command Line

install Node.js
run sudo npm install -g opennms
run opennms --help for a list of possible commands

API Coverage

OpenNMS.js currently supports a subset of the OpenNMS ReST API:

query alarms, events, and nodes (including complex queries against OpenNMS Horizon 21+ and Meridian 2017+)
acknowledge, escalate, and clear alarms
create, update, and close trouble tickets against an alarm
create, update, and delete alarm sticky memos
create, update, and delete alarm journal memos

Future plans include adding support for other common ReST operations:

creating, updating, deleting, and importing requisitions
query the measurements ReST API (RRD/Newts time-series data)
query outages and notifications

Changes

The CHANGELOG will be updated as releases occur, and should always be accessible here.

Development

To build this project, first install yarn:

npm install -g yarn

Then run yarn to fetch all dependencies:

yarn

Then you can run yarn to build or test the project:

yarn dist - run tests and lint, and build the complete tree in dist/
yarn dev - build a development version of the API in dist/opennms.js and dist/opennms.node.js
yarn build - build the development and production versions of the API in dist/
yarn docs - build the docs in dist/docs/
yarn watch - continuously build the development version in dist/opennms.js
yarn test - run the tests
yarn watch-test - continuously run the tests
yarn cli -- <arguments> - run the CLI test tool (try --help for options)

Reporting Bugs or Feature Requests

OpenNMS.js issues are tracked in the OpenNMS issue tracker: https://issues.opennms.org/browse/JS

Debugging Tests

On MAC OS X with WebStorm v2017.2 debugging tests may not work. See https://github.com/facebook/jest/issues/1652 for more details. The described solution there is to add --env jest-environment-node-debug as argument to the runtime configuration.