def _request(self, method, url_path, payload=None, stream=False):
'''
make the request and return the body
:param method: the HTTP method
:type method: string
:param url_path: the requested url path
:type url_path: string
:param payload: the payload to send
:type payload: dictionary
:returns: the response as json
:rtype: dictionary
'''
request_url = urljoin(self.manager.url, url_path)
LOG.debug("Request URL: %s", request_url)
# create session
session = self._create_session(method)
# create arguments for the request
request_args = {
'url': request_url,
'timeout': self.manager.timeout,
}
if payload:
request_args['json'] = payload
if self.manager.ca_certificate:
request_args['verify'] = self.manager.ca_certificate
else:
request_args['verify'] = False
if stream:
request_args['stream'] = True
# do the request
response = session.post(**request_args)
if not stream:
session.close()
# # for debugging
# from pprint import pprint
# pprint(request_url)
# pprint(payload)
# pprint(response)
if not 200 <= response.status_code <= 299:
raise Icinga2ApiException(
'Request "{}" failed with status {}: {}'.format(
response.url,
response.status_code,
response.text,
))
if stream:
return response
else:
return response.json()
def process_check_result(self,
object_type,
name,
exit_status,
plugin_output,
performance_data=None,
check_command=None,
check_source=None):
'''
Process a check result for a host or a service.
:param object_type: Host or Service
:type object_type: string
:param name: name of the object
:type name: string
:param exit_status: services: 0=OK, 1=WARNING, 2=CRITICAL, 3=UNKNOWN;
hosts: 0=OK, 1=CRITICAL
:type filter: integer
:param plugin_output: plugins main ouput
:type plugin_output: string
:param check_command: check command path followed by its arguments
:type check_command: list
:param check_source: name of the command_endpoint
:type check_source: string
:returns: the response as json
:rtype: dictionary
expample 1:
process_check_result('Service',
'myhost.domain!ping4',
'exit_status': 2,
'plugin_output': 'PING CRITICAL - Packet loss = 100%',
'performance_data': [
'rta=5000.000000ms;3000.000000;5000.000000;0.000000',
'pl=100%;80;100;0'],
'check_source': 'python client'})
'''
if object_type not in ['Host', 'Service']:
raise Icinga2ApiException(
'object_type needs to be "Host" or "Service".')
url = '{}/{}'.format(self.base_url_path, 'process-check-result')
payload = {
'{}'.format(object_type.lower()): name,
'exit_status': exit_status,
'plugin_output': plugin_output,
}
if performance_data:
payload['performance_data'] = performance_data
if check_command:
payload['check_command'] = check_command
if check_source:
payload['check_source'] = check_source
return self._request('POST', url, payload)
def __init__(self,
url=None,
username=None,
password=None,
timeout=None,
certificate=None,
key=None,
ca_certificate=None,
config_file=None):
'''
initialize object
'''
config_from_file = ClientConfigFile(config_file)
if config_file:
config_from_file.parse()
self.url = url or \
config_from_file.url
self.username = username or \
config_from_file.username
self.password = password or \
config_from_file.password
self.timeout = timeout or \
config_from_file.timeout
self.certificate = certificate or \
config_from_file.certificate
self.key = key or \
config_from_file.key
self.ca_certificate = ca_certificate or \
config_from_file.ca_certificate
self.objects = Objects(self)
self.actions = Actions(self)
self.events = Events(self)
self.status = Status(self)
self.config = Config(self)
self.version = icinga2api.__version__
if not self.url:
raise Icinga2ApiException('No "url" defined.')
if not self.username and not self.password and not self.certificate:
raise Icinga2ApiException(
'Neither username/password nor certificate defined.')
def _convert_object_type(object_type=None):
'''
check if the object_type is a valid Icinga 2 object type
'''
type_conv = {
'ApiListener': 'apilisteners',
'ApiUser': '******',
'CheckCommand': 'checkcommands',
'Arguments': 'argumentss',
'CheckerComponent': 'checkercomponents',
'CheckResultReader': 'checkresultreaders',
'Comment': 'comments',
'CompatLogger': 'compatloggers',
'Dependency': 'dependencys',
'Downtime': 'downtimes',
'Endpoint': 'endpoints',
'EventCommand': 'eventcommands',
'ExternalCommandListener': 'externalcommandlisteners',
'FileLogger': 'fileloggers',
'GelfWriter': 'gelfwriters',
'GraphiteWriter': 'graphitewriters',
'Host': 'hosts',
'HostGroup': 'hostgroups',
'IcingaApplication': 'icingaapplications',
'IdoMySqlConnection': 'idomysqlconnections',
'IdoPgSqlConnection': 'idopgsqlconnections',
'LiveStatusListener': 'livestatuslisteners',
'Notification': 'notifications',
'NotificationCommand': 'notificationcommands',
'NotificationComponent': 'notificationcomponents',
'OpenTsdbWriter': 'opentsdbwriters',
'PerfdataWriter': 'perfdatawriters',
'ScheduledDowntime': 'scheduleddowntimes',
'Service': 'services',
'ServiceGroup': 'servicegroups',
'StatusDataWriter': 'statusdatawriters',
'SyslogLogger': 'syslogloggers',
'TimePeriod': 'timeperiods',
'User': '******',
'UserGroup': 'usergroups',
'Zone': 'zones',
}
if object_type not in type_conv:
raise Icinga2ApiException(
'Icinga 2 object type "{}" does not exist.'.format(
object_type))
return type_conv[object_type]
def remove_downtime(self,
object_type,
name=None,
filters=None,
filter_vars=None):
'''
Remove the downtime using its name or filters.
example 1:
remove_downtime('Downtime',
'localhost!ping4!localhost-1458148978-14')
example 2:
remove_downtime('Service',
filters='service.name=="ping4"')
:param object_type: Host, Service or Downtime
:type object_type: string
:param name: name of the downtime
:type name: string
:param filters: filters matched object(s)
:type filters: string
:param filter_vars: variables used in the filters expression
:type filter_vars: dict
:returns: the response as json
:rtype: dictionary
'''
if not name and not filters:
raise Icinga2ApiException("name and filters is empty or none")
url = '{}/{}'.format(self.base_url_path, 'remove-downtime')
payload = {'type': object_type}
if name:
payload[object_type.lower()] = name
if filters:
payload['filter'] = filters
if filter_vars:
payload['filter_vars'] = filter_vars
return self._request('POST', url, payload)