Add event commands to modules that support this feature (#101)

* added event command for host_template and service_template

* added event commands to icinga_service_template.yml and icinga_host_template.yml

* added examples for event_command

* deleted "groups" from icinga_host_template

* Update plugins/modules/icinga_service_template.py

Co-authored-by: Sebastian Gumprich <rndmh3ro@users.noreply.github.com>

* removing ':' from description

* added output after executing update_examples_and_tests.sh

* executed update_examples_and_tests.sh and updated files

* executed update_examples_and_tests.sh and updated assert_info_found.yml

* added yamllint to assert_info_found.yml

* deleted yamllint comment in test folder and added tests/ to the ignore section in .yamllint

* moved tests/ to line-length ignore

Co-authored-by: Daniel Uhlmann <Daniel.Uhlmann@telekom.de>
Co-authored-by: Sebastian Gumprich <rndmh3ro@users.noreply.github.com>

Author: 3 people

.yamllint

@@ -17,3 +17,4 @@ rules:
     ignore: |
       hacking/
       roles/ansible_icinga/tasks
+      tests/

examples/icinga_command.yml

@@ -65,3 +65,19 @@
     url_password: "{{ icinga_pass }}"
     command: "/opt/centreon-plugins/centreon_plugins_2.pl"
     object_name: centreon-plugins_2
+- name: Create event command
+  t_systems_mms.icinga_director.icinga_command:
+    state: present
+    url: "{{ icinga_url }}"
+    url_username: "{{ icinga_user }}"
+    url_password: "{{ icinga_pass }}"
+    command: "/opt/scripts/restart_httpd"
+    object_name: "restart_httpd"
+    arguments:
+      '-s':
+        value: $service.state$
+      '-t':
+        value: $service.state_type$
+      '-a':
+        set_if: $service.check_attempt$
+        value: $restart_service$

examples/icinga_service_template.yml

@@ -13,3 +13,14 @@
       procs_warning: '1:'
     notes: "example note"
     notes_url: "'http://url1' 'http://url2'"
+- name: Create servicetemplate with event command
+  t_systems_mms.icinga_director.icinga_service_template:
+    state: present
+    url: "{{ icinga_url }}"
+    url_username: "{{ icinga_user }}"
+    url_password: "{{ icinga_pass }}"
+    object_name: apache_check_servicetemplate
+    use_agent: false
+    event_command: restart_httpd
+    notes: "example note"
+    notes_url: "'http://url1' 'http://url2'"

hacking/assert_info_found.yml

@@ -1,4 +1,5 @@
 ---
 - assert:
     that:
-      - '(result.objects | length) == 1 or (result.objects | length) == 2'
+      # yamllint disable-line rule:line-length
+      - '(result.objects | length) == 1 or (result.objects | length) == 2 or (result.objects | length) == 3'

plugins/modules/icinga_command.py

@@ -161,6 +161,23 @@
     url_password: "{{ icinga_pass }}"
     command: "/opt/centreon-plugins/centreon_plugins_2.pl"
     object_name: centreon-plugins_2
+
+- name: Create event command
+  t_systems_mms.icinga_director.icinga_command:
+    state: present
+    url: "{{ icinga_url }}"
+    url_username: "{{ icinga_user }}"
+    url_password: "{{ icinga_pass }}"
+    command: "/opt/scripts/restart_httpd"
+    object_name: "restart_httpd"
+    arguments:
+      '-s':
+        value: $service.state$
+      '-t':
+        value: $service.state_type$
+      '-a':
+        set_if: $service.check_attempt$
+        value: $restart_service$
 """
 
 RETURN = r""" # """

plugins/modules/icinga_host_template.py

@@ -77,6 +77,13 @@
       - The name of the check command.
       - Though this is not required to be defined in the director, you still have to supply a check_command in a host or host-template.
     type: str
+  event_command:
+    description:
+      - Event command for host which gets called on every check execution if one of these conditions matches
+      - The host is in a soft state
+      - The host state changes into a hard state
+      - The host state recovers from a soft or hard state to OK/Up
+    type: str
   check_interval:
     description:
       - Your regular check interval.
@@ -190,6 +197,7 @@ def main():
         has_agent=dict(type="bool", choices=[True, False]),
         master_should_connect=dict(type="bool", choices=[True, False]),
         accept_config=dict(type="bool", choices=[True, False]),
+        event_command=dict(type="str", required=False),
     )
 
     # Define the main module
@@ -215,6 +223,7 @@ def main():
         "has_agent": module.params["has_agent"],
         "master_should_connect": module.params["master_should_connect"],
         "accept_config": module.params["accept_config"],
+        "event_command": module.params["event_command"],
     }
 
     icinga_object = Icinga2APIObject(module=module, path="/host", data=data)

plugins/modules/icinga_service_template.py

@@ -83,6 +83,13 @@
     description:
       - Whether to process performance data provided by this object.
     type: "bool"
+  event_command:
+    description:
+      - Event command for service which gets called on every check execution if one of these conditions matches
+      - The service is in a soft state
+      - The service state changes into a hard state
+      - The service state recovers from a soft or hard state to OK/Up
+    type: "str"
   groups:
     description:
       - Service groups that should be directly assigned to this service.
@@ -155,6 +162,18 @@
       procs_warning: '1:'
     notes: "example note"
     notes_url: "'http://url1' 'http://url2'"
+
+- name: Create servicetemplate with event command
+  t_systems_mms.icinga_director.icinga_service_template:
+    state: present
+    url: "{{ icinga_url }}"
+    url_username: "{{ icinga_user }}"
+    url_password: "{{ icinga_pass }}"
+    object_name: apache_check_servicetemplate
+    use_agent: false
+    event_command: restart_httpd
+    notes: "example note"
+    notes_url: "'http://url1' 'http://url2'"
 """
 
 RETURN = r""" # """
@@ -187,6 +206,7 @@ def main():
         enable_notifications=dict(type="bool", required=False),
         enable_passive_checks=dict(type="bool", required=False),
         enable_perfdata=dict(type="bool", required=False),
+        event_command=dict(type="str", required=False),
         groups=dict(type="list", elements="str", default=[], required=False),
         imports=dict(type="list", elements="str", default=[], required=False),
         max_check_attempts=dict(required=False),
@@ -216,6 +236,7 @@ def main():
         "enable_notifications": module.params["enable_notifications"],
         "enable_passive_checks": module.params["enable_passive_checks"],
         "enable_perfdata": module.params["enable_perfdata"],
+        "event_command": module.params["event_command"],
         "groups": module.params["groups"],
         "imports": module.params["imports"],
         "max_check_attempts": module.params["max_check_attempts"],

roles/ansible_icinga/tasks/icinga_host_template.yml

@@ -28,6 +28,7 @@
     has_agent: "{{ host_template.0.has_agent | default(omit) }}"
     master_should_connect: "{{ host_template.0.master_should_connect | default(omit) }}"
     accept_config: "{{ host_template.0.accept_config | default(omit) }}"
+    event_command: "{{ host_template.0.event_command | default(omit) }}"
   loop: "{{ icinga_host_templates|subelements('host_template_object') }}"
   loop_control:
     loop_var: host_template

roles/ansible_icinga/tasks/icinga_service_template.yml

@@ -33,6 +33,7 @@
     use_agent: "{{ service_template.0.use_agent | default(omit) }}"
     vars: "{{ service_template.0.vars | default(omit) }}"
     volatile: "{{ service_template.0.volatile | default(omit) }}"
+    event_command: "{{ service_template.0.event_command | default(omit) }}"
   loop: "{{ icinga_service_templates|subelements('service_template_object') }}"
   loop_control:
     loop_var: service_template

tests/integration/targets/icinga/roles/icinga/tasks/absent_icinga_command.yml

@@ -61,3 +61,18 @@
     url_username: "{{ icinga_user }}"
     url_password: "{{ icinga_pass }}"
     object_name: centreon-plugins_2
+- name: Create event command
+  t_systems_mms.icinga_director.icinga_command:
+    state: absent
+    url: "{{ icinga_url }}"
+    url_username: "{{ icinga_user }}"
+    url_password: "{{ icinga_pass }}"
+    object_name: "restart_httpd"
+    arguments:
+      '-s':
+        value: $service.state$
+      '-t':
+        value: $service.state_type$
+      '-a':
+        set_if: $service.check_attempt$
+        value: $restart_service$