zabbix: new module zabbix_host_events_info (#56162)

lib/ansible/modules/monitoring/zabbix/zabbix_host_events_info.py

@@ -0,0 +1,337 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# (c) stephane.travassac@fr.clara.net
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+
+from __future__ import (absolute_import, division, print_function)
+
+__metaclass__ = type
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+RETURN = '''
+---
+triggers_ok:
+    description: Host Zabbix Triggers in OK state
+    returned: On success
+    type: complex
+    contains:
+          comments:
+            description: Additional description of the trigger
+            type: str
+          description:
+            description: Name of the trigger
+            type: str
+          error:
+            description: Error text if there have been any problems when updating the state of the trigger
+            type: str
+          expression:
+            description: Reduced trigger expression
+            type: str
+          flags:
+            description: Origin of the trigger
+            type: int
+          lastchange:
+            description: Time when the trigger last changed its state (timestamp)
+            type: int
+          priority:
+            description: Severity of the trigger
+            type: int
+          state:
+            description: State of the trigger
+            type: int
+          status:
+            description: Whether the trigger is enabled or disabled
+            type: int
+          templateid:
+            description: ID of the parent template trigger
+            type: int
+          triggerid:
+            description: ID of the trigger
+            type: int
+          type:
+            description: Whether the trigger can generate multiple problem events
+            type: int
+          url:
+            description: URL associated with the trigger
+            type: str
+          value:
+            description: Whether the trigger is in OK or problem state
+            type: int
+triggers_problem:
+    description: Host Zabbix Triggers in problem state. See trigger and event objects in API documentation of your zabbix version for more
+    returned: On success
+    type: complex
+    contains:
+          comments:
+            description: Additional description of the trigger
+            type: str
+          description:
+            description: Name of the trigger
+            type: str
+          error:
+            description: Error text if there have been any problems when updating the state of the trigger
+            type: str
+          expression:
+            description: Reduced trigger expression
+            type: str
+          flags:
+            description: Origin of the trigger
+            type: int
+          last_event:
+            description: last event informations
+            type: complex
+            contains:
+                acknowledged:
+                    description: If set to true return only acknowledged events
+                    type: int
+                acknowledges:
+                    description: acknowledges informations
+                    type: complex
+                    contains:
+                        alias:
+                            description: Account who acknowledge
+                            type: str
+                        clock:
+                            description: Time when the event was created (timestamp)
+                            type: int
+                        message:
+                            description: Text of the acknowledgement message
+                            type: str
+                clock:
+                    description: Time when the event was created (timestamp)
+                    type: int
+                eventid:
+                    description: ID of the event
+                    type: int
+                value:
+                    description: State of the related object
+                    type: int
+          lastchange:
+            description: Time when the trigger last changed its state (timestamp)
+            type: int
+          priority:
+            description: Severity of the trigger
+            type: int
+          state:
+            description: State of the trigger
+            type: int
+          status:
+            description: Whether the trigger is enabled or disabled
+            type: int
+          templateid:
+            description: ID of the parent template trigger
+            type: int
+          triggerid:
+            description: ID of the trigger
+            type: int
+          type:
+            description: Whether the trigger can generate multiple problem events
+            type: int
+          url:
+            description: URL associated with the trigger
+            type: str
+          value:
+            description: Whether the trigger is in OK or problem state
+            type: int
+'''
+
+DOCUMENTATION = '''
+---
+module: zabbix_host_events_info
+short_description: Get all triggers about a Zabbix host
+description:
+   - This module allows you to see if a Zabbix host have no active alert to make actions on it.
+     For this case use module Ansible 'fail' to exclude host in trouble.
+   - Length of "triggers_ok" allow if template's triggers exist for Zabbix Host
+version_added: "2.10"
+author:
+    - "Stéphane Travassac (@stravassac)"
+requirements:
+    - "python >= 2.7"
+    - "zabbix-api >= 0.5.3"
+options:
+    host_identifier:
+        description:
+            - Identifier of Zabbix Host
+        required: true
+        type: str
+    host_id_type:
+        description:
+            - Type of host_identifier
+        choices:
+            - hostname
+            - visible_name
+            - hostid
+        required: false
+        default: hostname
+        type: str
+    trigger_severity:
+        description:
+            - Zabbix severity for search filter
+        default: average
+        required: false
+        choices:
+            - not_classified
+            - information
+            - warning
+            - average
+            - high
+            - disaster
+        type: str
+extends_documentation_fragment:
+    - zabbix
+'''
+
+EXAMPLES = '''
+- name: exclude machine if alert active on it
+  zabbix_host_events_info:
+      server_url: "{{ zabbix_url }}"
+      login_user: "{{ lookup('env','ZABBIX_USER') }}"
+      login_password: "{{ lookup('env','ZABBIX_PASSWORD') }}"
+      host_identifier: "{{inventory_hostname}}"
+      host_id_type: "hostname"
+      timeout: 120
+  register: zbx_host
+  delegate_to: localhost
+- fail:
+    msg: "machine alert in zabbix"
+  when: zbx_host['triggers_problem']|length > 0
+'''
+
+from ansible.module_utils.basic import AnsibleModule, missing_required_lib
+import atexit
+import traceback
+
+try:
+    from zabbix_api import ZabbixAPI
+
+    HAS_ZABBIX_API = True
+except ImportError:
+    ZBX_IMP_ERR = traceback.format_exc()
+    HAS_ZABBIX_API = False
+
+
+class Host(object):
+    def __init__(self, module, zbx):
+        self._module = module
+        self._zapi = zbx
+
+    def get_host(self, host_identifier, host_inventory, search_key):
+        """ Get host by hostname|visible_name|hostid """
+        host = self._zapi.host.get(
+            {'output': 'extend', 'selectParentTemplates': ['name'], 'filter': {search_key: host_identifier},
+             'selectInventory': host_inventory})
+        if len(host) < 1:
+            self._module.fail_json(msg="Host not found: %s" % host_identifier)
+        else:
+            return host[0]
+
+    def get_triggers_by_host_id_in_problem_state(self, host_id, trigger_severity):
+        """ Get triggers in problem state from a hostid"""
+        # https://www.zabbix.com/documentation/3.4/manual/api/reference/trigger/get
+        output = ['triggerids', 'description', 'priority']
+        output = 'extend'
+        triggers_list = self._zapi.trigger.get({'output': output, 'hostids': host_id,
+                                                'min_severity': trigger_severity})
+        return triggers_list
+
+    def get_last_event_by_trigger_id(self, triggers_id):
+        """ Get the last event from triggerid"""
+        output = ['eventid', 'clock', 'acknowledged', 'value']
+        select_acknowledges = ['clock', 'alias', 'message']
+        event = self._zapi.event.get({'output': output, 'objectids': triggers_id,
+                                      'select_acknowledges': select_acknowledges, "limit": 1, "sortfield": "clock",
+                                      "sortorder": "DESC"})
+        return event[0]
+
+
+def main():
+    module = AnsibleModule(
+        argument_spec=dict(
+            server_url=dict(type='str', required=True, aliases=['url']),
+            login_user=dict(type='str', required=True),
+            login_password=dict(type='str', required=True, no_log=True),
+            http_login_user=dict(type='str', required=False, default=None),
+            http_login_password=dict(type='str', required=False, default=None, no_log=True),
+            host_identifier=dict(type='str', required=True),
+            host_id_type=dict(
+                default='hostname',
+                type='str',
+                choices=['hostname', 'visible_name', 'hostid']),
+            trigger_severity=dict(
+                type='str',
+                required=False,
+                default='average',
+                choices=['not_classified', 'information', 'warning', 'average', 'high', 'disaster']),
+            validate_certs=dict(type='bool', required=False, default=True),
+            timeout=dict(type='int', default=10),
+
+        ),
+        supports_check_mode=True
+    )
+
+    if not HAS_ZABBIX_API:
+        module.fail_json(msg=missing_required_lib('zabbix-api', url='https://pypi.org/project/zabbix-api/'),
+                         exception=ZBX_IMP_ERR)
+
+    trigger_severity_map = {'not_classified': 0, 'information': 1, 'warning': 2, 'average': 3, 'high': 4, 'disaster': 5}
+    server_url = module.params['server_url']
+    login_user = module.params['login_user']
+    login_password = module.params['login_password']
+    http_login_user = module.params['http_login_user']
+    http_login_password = module.params['http_login_password']
+    validate_certs = module.params['validate_certs']
+    host_id = module.params['host_identifier']
+    host_id_type = module.params['host_id_type']
+    trigger_severity = trigger_severity_map[module.params['trigger_severity']]
+    timeout = module.params['timeout']
+
+    host_inventory = 'hostid'
+    zbx = None
+    # login to zabbix
+    try:
+        zbx = ZabbixAPI(server_url, timeout=timeout, user=http_login_user, passwd=http_login_password,
+                        validate_certs=validate_certs)
+        zbx.login(login_user, login_password)
+        atexit.register(zbx.logout)
+    except Exception as e:
+        module.fail_json(msg="Failed to connect to Zabbix server: %s" % e)
+
+    host = Host(module, zbx)
+
+    if host_id_type == 'hostname':
+        zabbix_host = host.get_host(host_id, host_inventory, 'host')
+        host_id = zabbix_host['hostid']
+
+    elif host_id_type == 'visible_name':
+        zabbix_host = host.get_host(host_id, host_inventory, 'name')
+        host_id = zabbix_host['hostid']
+
+    elif host_id_type == 'hostid':
+        ''' check hostid exist'''
+        zabbix_host = host.get_host(host_id, host_inventory, 'hostid')
+
+    triggers = host.get_triggers_by_host_id_in_problem_state(host_id, trigger_severity)
+
+    triggers_ok = []
+    triggers_problem = []
+    for trigger in triggers:
+        # tGet last event for trigger with problem value = 1
+        # https://www.zabbix.com/documentation/3.4/manual/api/reference/trigger/object
+        if int(trigger['value']) == 1:
+            event = host.get_last_event_by_trigger_id(trigger['triggerid'])
+            trigger['last_event'] = event
+            triggers_problem.append(trigger)
+        else:
+            triggers_ok.append(trigger)
+
+    module.exit_json(ok=True, triggers_ok=triggers_ok, triggers_problem=triggers_problem)
+
+
+if __name__ == '__main__':
+    main()