centreonapi.webservice package

Subpackages

• centreonapi.webservice.configuration package
  • Submodules
  • centreonapi.webservice.configuration.command module
  • centreonapi.webservice.configuration.common module
  • centreonapi.webservice.configuration.contact module
  • centreonapi.webservice.configuration.downtime module
  • centreonapi.webservice.configuration.host module
  • centreonapi.webservice.configuration.hostgroups module
  • centreonapi.webservice.configuration.poller module
  • centreonapi.webservice.configuration.resourcecfg module
  • centreonapi.webservice.configuration.service module
  • Module contents

Module contents

class centreonapi.webservice.Webservice

Bases: object

Class for call Centreon Web Rest webservices

auth()

Authenticate to the webservices

call_clapi(action=None, obj=None, values=None)

Call an endpoint of Centreon Web for clapi wrapper

Parameters:

• action (String) – The clapi action
• obj (String) – The clapi object
• values (mixed) – The values for the call

Returns:

The response of call

Return type:

dict

centreon_realtime(action=None, obj=None, values=None)

static getInstance(url=None, username=None, password=None, check_ssl=True)

Get an unique instance of the webservices

Parameters:

• url (String) – The Centreon Web URL
• username (String) – The username for connect to Centreon Web webservices
• password (String) – The password for connect to Centreon Web webservices

isLoaded()

Test if webservices configuration is loaded

Returns:If the webservices configuration is loaded Return type:Boolean

load(url, username, password, check_ssl=True)

Load configuration for webservices

Parameters:

• url (String) – The Centreon Web URL
• username (String) – The username for connect to Centreon Web webservices
• password (String) – The password for connect to Centreon Web webservices