telekom_mms.icinga_director.icinga_service_apply module – Manage service apply rules in Icinga2
Note
This module is part of the telekom_mms.icinga_director collection (version 1.35.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install telekom_mms.icinga_director.
To use it in a playbook, specify: telekom_mms.icinga_director.icinga_service_apply.
New in telekom_mms.icinga_director 1.0.0
Synopsis
Add or remove a service apply rule to Icinga2 through the director API.
Parameters
Parameter |
Comments |
|---|---|
Do not overwrite the whole object but instead append the defined properties. Note - Appending to existing vars, imports or any other list/dict is not possible. You have to overwrite the complete list/dict. Note - Variables that are set by default will also be applied, even if not set. Choices:
|
|
Evaluates the apply for rule for all objects with the custom attribute specified. For example selecting “host.vars.custom_attr” will generate “for (config in host.vars.array_var)” where “config” will be accessible through “$config$”. Note - only custom variables of type “Array” are eligible. |
|
The filter where the service apply rule will take effect. |
|
Check command definition. |
|
Your regular check interval. |
|
The name of a time period which determines when this object should be monitored. Not limited by default. |
|
Check command timeout in seconds. Overrides the CheckCommand’s timeout attribute. |
|
PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, |
|
PEM formatted file that contains your private key to be used for SSL client authentication. If |
|
The host where the service should be executed on. |
|
Alternative displayed name of the service apply rule. |
|
Whether to actively check this object. Choices:
|
|
Whether to enable event handlers this object. Choices:
|
|
Whether to send notifications for this object. Choices:
|
|
Whether to accept passive check results for this object. Choices:
|
|
Whether to process performance data provided by this object. Choices:
|
|
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 |
|
If Choices:
|
|
Credentials specified with url_username and url_password should be passed in HTTP Header. Choices:
|
|
Service groups that should be directly assigned to this service. Servicegroups can be useful for various reasons. They are helpful to provided service-type specific view in Icinga Web 2, either for custom dashboards or as an instrument to enforce restrictions. Service groups can be directly assigned to single services or to service templates. Default: |
|
Header to identify as, generally appears in web server logs. Default: |
|
Importable templates, add as many as you want. Please note that order matters when importing properties from multiple templates - last one wins. |
|
Defines after how many check attempts a new hard state is reached. |
|
Additional notes for this object. |
|
An URL pointing to additional notes for this object. Separate multiple urls like this “’http://url1’ ‘http://url2’”. Maximum length is 255 characters. |
|
Name for the Icinga service apply rule. |
|
Retry interval, will be applied after a state change unless the next hard state is reached. |
|
Apply feature state. Choices:
|
|
HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
|
The password for use in HTTP basic authentication. If the url_username parameter is not specified, the url_password parameter will not be used. |
|
The username for use in HTTP basic authentication. This parameter can be used without url_password for sites that allow empty passwords |
|
Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library gssapi to be installed. Credentials for GSSAPI can be specified with url_username/url_password or with the GSSAPI env var NTLM authentication is Choices:
|
|
If Choices:
|
|
If This should only be used on personally controlled sites using self-signed certificates. Choices:
|
|
Custom properties of the service apply rule. Default: |
Notes
Note
This module supports check mode.
Examples
- name: Add service apply rule to icinga
telekom_mms.icinga_director.icinga_service_apply:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: "SERVICE_dummy"
assign_filter: 'host.name="foohost"'
check_command: hostalive
display_name: "dummy process"
check_interval: "10m"
check_period: "24/7"
check_timeout: "1m"
enable_active_checks: true
enable_event_handler: true
enable_notifications: true
enable_passive_checks: false
enable_perfdata: false
event_command: restart_httpd
max_check_attempts: "5"
retry_interval: "3m"
imports:
- fooservicetemplate
groups:
- fooservicegroup
vars:
http_address: "$address$"
http_port: "9080"
http_uri: "/ready"
http_string: "Ready"
http_expect: "Yes"
- name: Add service apply rule with command_endpoint
telekom_mms.icinga_director.icinga_service_apply:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: "SERVICE_dummy"
assign_filter: 'host.name="foohost"'
check_command: hostalive
display_name: "dummy process"
check_interval: "10m"
check_period: "24/7"
check_timeout: "1m"
enable_active_checks: true
enable_event_handler: true
enable_notifications: true
enable_passive_checks: false
event_command: restart_httpd
max_check_attempts: "5"
retry_interval: "3m"
command_endpoint: "fooendpoint"
imports:
- fooservicetemplate
groups:
- fooservicegroup
- name: Update service apply rule with command_endpoint
telekom_mms.icinga_director.icinga_service_apply:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: "SERVICE_dummy"
enable_perfdata: true
append: true