Centreon SDK Python

https://badge.fury.io/py/centreonapi.png https://travis-ci.com/guillaumewatteeux/centreon-sdk-python.svg?branch=master

Make a Python LIB for Centreon API

Forked from https://github.com/centreon/centreon-sdk-python

Install

$ pip install centreonapi

Usages

  • Connect to Centreon platform
from centreonapi.centreon import Centreon
centreon = centreon("https://centreon.mydomain.tld", "admin", "centreon")
  • List all hosts on Centreon platform
centreon.hosts.list()
>>>
{
  'Centeon-central': Centeon-central,
  'server1': myserver1
}
  • Add new host
centreon.hosts.add(
  name='server1',
  alias='DBServ',
  ip=127.0.0.1,
  template="DB-Host-Template",
  hg="DB Servers"
  )
  • Get host
_, myhost = centreon.hosts.get('server1')
myhost.name
>>>
server1
  • Macros

Get macros

_, macros = myhost.getmacro()
macros
>>>
{
  '$_HOSTMODULESTATSFILE$': $_HOSTMODULESTATSFILE$,
  '$_HOSTMYSQLPASSWORD$': $_HOSTMYSQLPASSWORD$,
  '$_HOSTMYSQLPORT$': $_HOSTMYSQLPORT$,
}

mymacro = macros.get('$_HOSTMYSQLPORT$')
mymacro.value
>>>
3306

Set Macros

myhost.setmacro('SECRETMACRO', 'pass', 1, 'secret macro pass')
  • HostTemplate on host
myhost.gettemplate()
>>>
{
  'App-Monitoring-Centreon-Central-custom': App-Monitoring-Centreon-Central-custom,
  'App-Monitoring-Centreon-Database-custom': App-Monitoring-Centreon-Database-custom,
  'App-Monitoring-Centreon-Poller-custom': App-Monitoring-Centreon-Poller-custom
}

Documentation

Complete documentation here

Features

  • TODO

Contents:

Installation

At the command line either via easy_install or pip:

$ easy_install centreonapi
$ pip install centreonapi

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv centreonapi
$ pip install centreonapi

Usage

To use Centreon SDK Python in a project:

from centreonapi.centreon import Webservice

API reference

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions
Report Bugs

Report bugs at https://github.com/guillaumewatteeux/centreon-sdk-python/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.
Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation

Centreon SDK Python could always use more documentation, whether as part of the official Centreon SDK Python docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/guillaumewatteeux/centreon-sdk-python/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!

Ready to contribute? Here’s how to set up centreonapi for local development.

  1. Fork the centreon-sdk-python repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/centreon-sdk-python.git

  3. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

  1. When you’re done making changes, check that your changes pass style and unit tests, including testing other Python versions with tox:

    $ tox

To get tox, just pip install it.

  1. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  2. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/guillaumewatteeux/centreon-sdk-python under pull requests for active pull requests or run the tox command and make sure that the tests pass for all supported Python versions.
Tips

To run a subset of tests:

$ pytest tests

Credits

Development Lead
Contributors

None yet. Why not be the first?

History

0.1.5 (2019-02-16)
  • Beta version
0.1.0 (2018-12-14)
  • First release on PyPI.

Feedback

If you have any suggestions or questions about Centreon SDK Python feel free to email me at g@15x.fr.

If you encounter any errors or problems with Centreon SDK Python, please let me know! Open an Issue at the GitHub http://github.com/guillaumewatteeux/centreonapi main repository.