A client API for accessing the OpenNMS network monitoring platform.
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.
sudo npm install -g opennms
opennms --help
for a list of possible commandsOpenNMS.js currently supports a subset of the OpenNMS ReST API:
Future plans include adding support for other common ReST operations:
The CHANGELOG should always contain the complete list od changes between versions, and should always be accessible here.
OpenNMS.js follows semantic versioning.
OpenNMS.js 2.0 adds a few new APIs, contains a ton of refactoring and build system updates, and has a few small breaking changes.
HEAD
requests has been added to the HTTP implementationsOnmsServer
) support .equals()
for comparison noworderBy
and order
(and the alarms
CLI list command supports it)OnmsHTTPOptions
can now have multiple values -- for example a parameter with value [ 1, 2 ]
will serialize to &foo=1&foo=2
api/Log
module now only exports a single, simplified log
object; typescript-logging
was overly complicated and not really adding much in the way of value. Use .setDebug()
, .setQuiet()
, and .setSilent()
to change the logging level instead.undefined
-able) to make strict null- and type-checking validation pass.PropertiesCache
and its associated interface, ISearchPropertyAccessor
are gone. This only affects you if you have implemented custom DAOs, which is very unlikely. :)timeout
property in AbstractHTTP
(and sub-classes) has been removed. Access the AbstractHTTP.options.timeout
property directly.Client
no longer keeps a separate copy of the server object. Instead you should access the http.server
sub-property directly.OnmsAuthConfig
, OnmsEnum
, OnmsError
, OnmsHTTPOptions
, OnmsResult
, OnmsServer
, Operator
, SearchPropertyType
, ServerMetadata
, TicketerConfig
.
The OnmsHTTPOptions
and OnmsServer
objects now have builders (use .newBuilder()
to create) rather than constructors with a bunch of arguments.id
property on OnmsServer
is no longer generated, it is computed based on the contents of the server object and should be repeatably equal if the contents are equal.This release includes support for some additional flow queries, as well as a few security updates and a fix for CLI formatting.
This is a small feature release with a few changes targeted primarily to Helm (adding root cause and tags to the situation feedback API support, and support for isAcknowledged
queries on alarms).
This release contains a number of new features and a few bug fixes, including support for correlation alarms and feedback, and additional metadata for Helm 3.
This is a small release which adds support for a default timeout in GrafanaHTTP
, as well as adding X-Requested-With
headers to requests (NMS-9783).
This release adds support for telemetry (Netflow) APIs which will be introduced in OpenNMS 22.x. It also includes a number of build optimizations and updates since 1.0.
The initial official release of OpenNMS.js.
OpenNMS.js currently supports a subset of the OpenNMS ReST API:
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 testsyarn watch-test
- continuously run the testsyarn cli -- <arguments>
- run the CLI test tool (try --help
for options)OpenNMS.js issues are tracked in the OpenNMS issue tracker: https://issues.opennms.org/browse/JS
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.
Generated using TypeDoc