Merge pull request #56 from mmslkr/feature/notes

Add support for notes and notes_url to all relevant objects

Author: rndmh3ro

plugins/modules/icinga_host.py

@@ -151,6 +151,18 @@
         you still have to supply a check_command in a host or host-template
     required: false
     type: str
+  notes:
+    description:
+      - Additional notes for this object
+    required: false
+    type: str
+  notes_url:
+    description:
+      - An URL pointing to additional notes for this object.
+      - Separate multiple urls like this "'http://url1' 'http://url2'".
+      - Max length 255 characters
+    required: false
+    type: str
 """
 
 EXAMPLES = """
@@ -172,6 +184,8 @@
     vars:
       dnscheck: "no"
     check_command: hostalive
+    notes: "example note"
+    notes_url: "'http://url1' 'http://url2'"
 """
 
 from ansible.module_utils.basic import AnsibleModule
@@ -204,6 +218,8 @@ def main():
         zone=dict(required=False, default=None),
         vars=dict(type="dict", default=None),
         check_command=dict(required=False),
+        notes=dict(type="str", required=False),
+        notes_url=dict(type="str", required=False),
     )
 
     # When deleting objects, only the name is necessary, so we cannot use
@@ -230,6 +246,8 @@ def main():
         "zone": module.params["zone"],
         "vars": module.params["vars"],
         "check_command": module.params["check_command"],
+        "notes": module.params["notes"],
+        "notes_url": module.params["notes_url"],
     }
 
     icinga_object = Icinga2APIObject(module=module, path="/host", data=data)

plugins/modules/icinga_host_template.py

@@ -152,6 +152,18 @@
       - Custom properties of the host
     required: false
     type: "dict"
+  notes:
+    description:
+      - Additional notes for this object
+    required: false
+    type: str
+  notes_url:
+    description:
+      - An URL pointing to additional notes for this object.
+      - Separate multiple urls like this "'http://url1' 'http://url2'".
+      - Max length 255 characters
+    required: false
+    type: str
 """
 
 EXAMPLES = """
@@ -169,6 +181,8 @@
       - "foohostgroup"
     imports:
       - ''
+    notes: "example note"
+    notes_url: "'http://url1' 'http://url2'"
 """
 
 from ansible.module_utils.basic import AnsibleModule
@@ -201,6 +215,8 @@ def main():
         address6=dict(required=False),
         zone=dict(required=False, default=None),
         vars=dict(type="dict", default=None),
+        notes=dict(type="str", required=False),
+        notes_url=dict(type="str", required=False),
     )
 
     # Define the main module
@@ -220,6 +236,8 @@ def main():
         "address6": module.params["address6"],
         "zone": module.params["zone"],
         "vars": module.params["vars"],
+        "notes": module.params["notes"],
+        "notes_url": module.params["notes_url"],
     }
 
     icinga_object = Icinga2APIObject(module=module, path="/host", data=data)

plugins/modules/icinga_service.py

@@ -172,6 +172,13 @@
       - Additional notes for this object
     required: false
     type: str
+  notes_url:
+    description:
+      - An URL pointing to additional notes for this object.
+      - Separate multiple urls like this "'http://url1' 'http://url2'".
+      - Max length 255 characters
+    required: false
+    type: str
   retry_interval:
     description:
       - Retry interval, will be applied after a state change unless the next hard state is reached
@@ -217,6 +224,8 @@
       procs_argument: consul
       procs_critical: '1:'
       procs_warning: '1:'
+    notes: "example note"
+    notes_url: "'http://url1' 'http://url2'"
 """
 
 from ansible.module_utils.basic import AnsibleModule
@@ -336,7 +345,8 @@ def main():
         groups=dict(type="list", elements="str", default=[], required=False),
         imports=dict(type="list", elements="str", default=[], required=False),
         max_check_attempts=dict(required=False),
-        notes=dict(required=False),
+        notes=dict(type="str", required=False),
+        notes_url=dict(type="str", required=False),
         retry_interval=dict(required=False),
         use_agent=dict(type="bool", required=False),
         vars=dict(type="dict", default={}, required=False),
@@ -366,6 +376,7 @@ def main():
         "imports": module.params["imports"],
         "max_check_attempts": module.params["max_check_attempts"],
         "notes": module.params["notes"],
+        "notes_url": module.params["notes_url"],
         "retry_interval": module.params["retry_interval"],
         "use_agent": module.params["use_agent"],
         "vars": module.params["vars"],

plugins/modules/icinga_service_template.py

@@ -167,6 +167,13 @@
       - Additional notes for this object
     required: false
     type: str
+  notes_url:
+    description:
+      - An URL pointing to additional notes for this object.
+      - Separate multiple urls like this "'http://url1' 'http://url2'".
+      - Max length 255 characters
+    required: false
+    type: str
   retry_interval:
     description:
       - Retry interval, will be applied after a state change unless the next hard state is reached
@@ -209,6 +216,8 @@
       procs_argument: consul
       procs_critical: '1:'
       procs_warning: '1:'
+    notes: "example note"
+    notes_url: "'http://url1' 'http://url2'"
 """
 
 from ansible.module_utils.basic import AnsibleModule
@@ -245,7 +254,8 @@ def main():
         groups=dict(type="list", elements="str", default=[], required=False),
         imports=dict(type="list", elements="str", default=[], required=False),
         max_check_attempts=dict(required=False),
-        notes=dict(required=False),
+        notes=dict(type="str", required=False),
+        notes_url=dict(type="str", required=False),
         retry_interval=dict(required=False),
         use_agent=dict(type="bool", required=False),
         vars=dict(type="dict", default={}, required=False),
@@ -274,6 +284,7 @@ def main():
         "imports": module.params["imports"],
         "max_check_attempts": module.params["max_check_attempts"],
         "notes": module.params["notes"],
+        "notes_url": module.params["notes_url"],
         "retry_interval": module.params["retry_interval"],
         "use_agent": module.params["use_agent"],
         "vars": module.params["vars"],

roles/ansible_icinga/README.md

@@ -81,6 +81,8 @@ t_systems_mms.icinga_director >= 1.2.2
 | imports                    | no       |
 | zone                       | no       |
 | vars                       | no       |
+| notes                      | no       |
+| notes_url                  | no       |
 | **icinga_host**
 | icinga_hosts               | no       | []
 | display_name               | no       |
@@ -91,6 +93,8 @@ t_systems_mms.icinga_director >= 1.2.2
 | imports                    | yes      | []
 | zone                       | no       |
 | vars                       | no       |
+| notes                      | no       |
+| notes_url                  | no       |
 | **icinga_command_template**
 | icinga_command_templates   | no       | []
 | display_name               | no       |
@@ -127,6 +131,7 @@ t_systems_mms.icinga_director >= 1.2.2
 | imports                    | no       |
 | max_check_attempts         | no       |
 | notes                      | no       |
+| notes_url                  | no       |
 | retry_interval             | no       |
 | use_agent                  | no       |
 | vars                       | no       |
@@ -148,6 +153,7 @@ t_systems_mms.icinga_director >= 1.2.2
 | imports                    | no       |
 | max_check_attempts         | no       |
 | notes                      | no       |
+| notes_url                  | no       |
 | retry_interval             | no       |
 | use_agent                  | no       |
 | vars                       | no       |

roles/ansible_icinga/tasks/icinga_host.yml

@@ -21,6 +21,8 @@
     imports: "{{ host.0.imports | default(icinga_host_imports) }}"
     zone: "{{ host.0.zone | default(omit) }}"
     vars: "{{ host.0.vars | default(omit) }}"
+    notes: "{{ host.0.notes | default(omit) }}"
+    notes_url: "{{ host.0.notes_url | default(omit) }}"
   loop: "{{ icinga_hosts|subelements('host_object') }}"
   loop_control:
     loop_var: host

roles/ansible_icinga/tasks/icinga_host_template.yml

@@ -22,6 +22,8 @@
     imports: "{{ host_template.0.imports | default(omit) }}"
     zone: "{{ host_template.0.zone | default(omit) }}"
     vars: "{{ host_template.0.vars | default(omit) }}"
+    notes: "{{ host_template.0.notes | default(omit) }}"
+    notes_url: "{{ host_template.0.notes_url | default(omit) }}"
   loop: "{{ icinga_host_templates|subelements('host_template_object') }}"
   loop_control:
     loop_var: host_template

roles/ansible_icinga/tasks/icinga_service.yml

@@ -29,6 +29,7 @@
     imports: "{{ service.0.imports | default(omit) }}"
     max_check_attempts: "{{ service.0.max_check_attempts | default(omit) }}"
     notes: "{{ service.0.notes | default(omit) }}"
+    notes_url: "{{ service.0.notes_url | default(omit) }}"
     retry_interval: "{{ service.0.retry_interval | default(omit) }}"
     use_agent: "{{ service.0.use_agent | default(omit) }}"
     vars: "{{ service.0.vars | default(omit) }}"

roles/ansible_icinga/tasks/icinga_service_template.yml

@@ -28,6 +28,7 @@
     imports: "{{ service_template.0.imports | default(omit) }}"
     max_check_attempts: "{{ service_template.0.max_check_attempts | default(omit) }}"
     notes: "{{ service_template.0.notes | default(omit) }}"
+    notes_url: "{{ service_template.0.notes_url | default(omit) }}"
     retry_interval: "{{ service_template.0.retry_interval | default(omit) }}"
     use_agent: "{{ service_template.0.use_agent | default(omit) }}"
     vars: "{{ service_template.0.vars | default(omit) }}"