centreonapi.webservice.configuration package

Submodules

centreonapi.webservice.configuration.command module

class centreonapi.webservice.configuration.command.Command(properties)[source]

Bases: centreonapi.webservice.configuration.factory.commandfactory.ObjCommand

setparam(name, value)[source]

Set specific param for a command

Parameters:
  • name – param name
  • value – param value
Returns:
class centreonapi.webservice.configuration.command.Commands[source]

Bases: centreonapi.webservice.configuration.common.CentreonDecorator, centreonapi.webservice.configuration.common.CentreonClass

Centreon Web Command object

add(cmdname, cmdtype, cmdline)[source]

Add a command

Parameters:
  • cmdname – command name
  • cmdtype – command type (check, notif, misc or discovery)
  • cmdline – System command line that will be run on execution
  • post_refresh – boolean: refresh Commands object
Returns:
delete(command)[source]

Delete a command :param command: command name :param post_refresh: boolean: refresh Commands object :return:

list(name=None)[source]

List all commands

Returns:dict: All Centreon command

centreonapi.webservice.configuration.common module

class centreonapi.webservice.configuration.common.CentreonClass[source]

Bases: object

exists(name)[source]
get(name)[source]
list()[source]
class centreonapi.webservice.configuration.common.CentreonDecorator[source]

Bases: object

static post_refresh(func)[source]

Decorator that call __refresh_list() after func unless function’s call contains ‘post_refresh=False’

eg: @post_refresh def hello(w, post_refresh=False):

…
static pre_refresh(func)[source]
class centreonapi.webservice.configuration.common.CentreonObject[source]

Bases: object

centreonapi.webservice.configuration.common.build_param(param=None, objecttype=None, attr='name')[source]
centreonapi.webservice.configuration.common.build_param2(param=None, classname=None, attr='name')[source]

centreonapi.webservice.configuration.contact module

class centreonapi.webservice.configuration.contact.Contact(properties)[source]

Bases: centreonapi.webservice.configuration.factory.contactfactory.ObjContact

class centreonapi.webservice.configuration.contact.ContactGroup(properties)[source]

Bases: centreonapi.webservice.configuration.factory.contactgroupfactory.ObjContactGroup

centreonapi.webservice.configuration.downtime module

class centreonapi.webservice.configuration.downtime.Downtime(properties)[source]

Bases: centreonapi.webservice.configuration.factory.downtimefatory.ObjDowntime

addhost(host)[source]
addhostgroup(hostgroup)[source]
addmonthlyperiod()[source]
addservice()[source]
addservicegroup()[source]
addspecificperiod()[source]
addweeklyperiod()[source]
delhost(host)[source]
delhostgroup(hostgroup)[source]
delservice()[source]
delservicegroup()[source]
listperiods()[source]
sethost()[source]
sethostgroup()[source]
setparam(name, value)[source]
setservice()[source]
setservicegroup()[source]
class centreonapi.webservice.configuration.downtime.DowntimePeriod(properties)[source]

Bases: centreonapi.webservice.configuration.common.CentreonObject

class centreonapi.webservice.configuration.downtime.Downtimes[source]

Bases: centreonapi.webservice.configuration.common.CentreonClass

add(name, description)[source]
delete(downtime)[source]
list(name=None)[source]

centreonapi.webservice.configuration.host module

class centreonapi.webservice.configuration.host.Host(properties)[source]

Bases: centreonapi.webservice.configuration.factory.hostfactory.ObjHost

addcontact(contacts)[source]
addcontactgroup(contactgroups)[source]
addhostgroup(hostgroup=None)[source]
addparent(parents)[source]
addtemplate(template=None)[source]

Add new HostTemplate on host

Parameters:template – HostTemplate, list(HosTemplate), str
Returns:
applytemplate()[source]
deletecontact(contacts)[source]
deletecontactgroup(contactgroups)[source]
deletehostgroup(hostgroup=None)[source]
deletemacro(macro)[source]

Remove macro

Parameters:macro – HostMacro
Returns:
deleteparent(parents)[source]
deletetemplate(template=None)[source]

Delete HostTemplate on host

Parameters:template – HostTemplate, list(HosTemplate), str
Returns:
disable()[source]
enable()[source]
getcontact()[source]
Returns:state (True/False), contacts or error message
getcontactgroup()[source]
gethostgroup()[source]
getmacro()[source]

Get host’s macros.

Returns:
  • bool: API call status
  • dict: all macros on hosts
getparam(name)[source]
getparams()[source]
getparent()[source]
gettemplate()[source]

Get host’s Template

Returns:
  • bool: API call status
  • dict: all templates on hosts
setcontact(contacts)[source]
setcontactgroup(contactgroups)[source]
sethostgroup(hostgroup=None)[source]
setinstance(instance)[source]
setmacro(name, value, is_password=None, description=None)[source]

Add or update macro

Parameters:
  • name – macro name
  • value – macro value
  • is_password – set to 1 if a macro password
  • description – macro description
Returns:
setparam(name, value)[source]
setparent(parents)[source]
setseverity(name)[source]
settemplate(template=None)[source]

Define HostTemplate on host

Parameters:template – HostTemplate, list(HosTemplate), str
Returns:
status()[source]
unsetseverity()[source]
class centreonapi.webservice.configuration.host.HostMacro(properties)[source]

Bases: centreonapi.webservice.configuration.factory.hostfactory.ObjHostMacro

class centreonapi.webservice.configuration.host.HostTemplate(properties)[source]

Bases: centreonapi.webservice.configuration.factory.hostfactory.ObjHostTemplate, centreonapi.webservice.configuration.host.Host

class centreonapi.webservice.configuration.host.HostTemplates[source]

Bases: centreonapi.webservice.configuration.host.Hosts

class centreonapi.webservice.configuration.host.Hosts[source]

Bases: centreonapi.webservice.configuration.common.CentreonClass

Centreon Web host object

add(name, alias, ip, instance=None, template=None, hg=None)[source]

Add new Host on Centreon platform :param name: name for host :param alias: alias (short name for example) :param ip: Ip address or DNS :param instance: Poller() or str() :param template: HostTemplate(), list() of HostTemplate(),

list() of str() or str()
Parameters:hg – HostGroup(), list() of HostGroup(), list() of str() or str()
Returns:
delete(host)[source]
list(name=None)[source]

centreonapi.webservice.configuration.hostgroups module

class centreonapi.webservice.configuration.hostgroups.HostGroup(properties)[source]

Bases: centreonapi.webservice.configuration.factory.hostgroupfactory.ObjHostGroup

class centreonapi.webservice.configuration.hostgroups.HostGroups[source]

Bases: centreonapi.webservice.configuration.common.CentreonClass

add(name, alias)[source]
delete(hg)[source]
list(name=None)[source]

centreonapi.webservice.configuration.poller module

class centreonapi.webservice.configuration.poller.Poller(properties)[source]

Bases: centreonapi.webservice.configuration.factory.pollerfactory.ObjPoller

add(*args, **kwargs)[source]
applycfg()[source]
delete(*args, **kwargs)[source]
generatecfg()[source]
gethosts()[source]
movecfg()[source]
relaod()[source]
restart()[source]
setparam(*args, **kwargs)[source]
testcfg()[source]
class centreonapi.webservice.configuration.poller.PollerHost(properties)[source]

Bases: centreonapi.webservice.configuration.common.CentreonObject

class centreonapi.webservice.configuration.poller.Pollers[source]

Bases: centreonapi.webservice.configuration.common.CentreonDecorator, centreonapi.webservice.configuration.common.CentreonClass

applycfg(pollername)[source]

Apply the configuration to a poller name

list(name=None)[source]

centreonapi.webservice.configuration.resourcecfg module

class centreonapi.webservice.configuration.resourcecfg.ResourceCFG(properties)[source]

Bases: centreonapi.webservice.configuration.factory.resourcecfgfactory.ObjResourceCfg

setparam(name, value)[source]

Set specific param for a resource CFG

Parameters:
  • name – resource name
  • value – resource value
Returns:
class centreonapi.webservice.configuration.resourcecfg.ResourceCFGs[source]

Bases: centreonapi.webservice.configuration.common.CentreonClass

Centreon Web Resource object

add(rscname, rscvalue, rscinstance, rsccomment)[source]
delete(resource)[source]
list(name=None)[source]

List all ResourceCFG

Returns:dict: All Centreon ResourceCFG

centreonapi.webservice.configuration.service module

class centreonapi.webservice.configuration.service.Service(properties)[source]

Bases: centreonapi.webservice.configuration.factory.servicefactory.ObjService

class centreonapi.webservice.configuration.service.Services[source]

Bases: centreonapi.webservice.configuration.common.CentreonClass

Centreon Web Service Object

add(hostname, servicename, template)[source]
addcontact(hostname, servicename, contact)[source]
addhost()[source]
addtrap(hostname, servicename, trap)[source]
delcontactgroup(hostname, servicename, contact)[source]
delete(service)[source]
delhost()[source]
delmacro(hostname, servicename, name)[source]
deltrap(hostname, servicename, trap)[source]
exists(name, host)[source]
get(name, host)[source]
getcontact(hostname, servicename)[source]
getcontactgrup(hostname, servicename)[source]
getmaro(hostname, servicename)[source]
gettrap(hostname, servicename)[source]
list(name=None)[source]
setcontact(hostname, servicename, contact)[source]
setcontactgroup(hostname, servicename, contact)[source]
sethost()[source]
setmacro(hostname, servicename, name, value, description)[source]
setparam(service, name, value)[source]
setseverity(hostname, servicename, name)[source]
settrap(hostname, servicename, trap)[source]
unsetseverity(hostname, servicename)[source]

Module contents