Skip to content

Python library for accessing the OpenNMS REST API

License

Notifications You must be signed in to change notification settings

mmahacek/PyONMS

Repository files navigation

package version python version license Code style: black linting: pylint type check: mypy

PyONMS

A Python library for accessing the OpenNMS REST API.

This is being developed with Python 3.11 and OpenNMS 32. It may work on older versions, but they haven't been tested yet.

Information

This currently is an early, pre-release version of this library. It is not maintained or supported by The OpenNMS Group.

Endpoints Supported

Currently supported endpoints include:

  • Alarms (read-write)
  • Business Services (read-write)
  • Enlinkd (read-only)
  • Events (read, send)
  • Foreign Sources (read-write)
  • Health (read-only)
  • Info (read-only)
  • IP Interfaces (read-only)
  • Nodes (read, metadata modify requires Horizon 32.0.6+ or Meridian 2023.1.11+)
  • RequisitionNodes (read-only)
  • Requisitions (read-write)
  • User Defined Links (read-write)

Getting Started

You can install this library by running:

pip3 install pyonms

See the project documentation for instructions on using this library.

Changelog

Changelog