t_systems_mms.icinga_director.icinga_service_template module – Manage service templates in Icinga2
Note
This module is part of the t_systems_mms.icinga_director collection (version 1.31.4).
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 t_systems_mms.icinga_director.
To use it in a playbook, specify: t_systems_mms.icinga_director.icinga_service_template.
New in t_systems_mms.icinga_director 1.0.0
Synopsis
Add or remove a service template 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:
|
|
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 |
|
Disabled objects will not be deployed. Choices:
|
|
Whether to actively check this object. Choices:
|
|
Whether to enable event handlers this object. Choices:
|
|
Whether flap detection is enabled on 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 |
|
Flapping upper bound in percent for a service to be considered flapping |
|
Flapping lower bound in percent for a service to be considered not flapping |
|
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: |
|
An URL pointing to an icon for this object. Try “tux.png” for icons relative to public/img/icons or “cloud” (no extension) for items from the Icinga icon font |
|
Alternative text to be shown in case above icon is missing |
|
Importable templates, add as many as you want. Please note that order matters when importing properties from multiple templates - last one wins. Default: |
|
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 of the service template. |
|
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 |
|
Whether the check commmand for this service should be executed on the Icinga agent. Choices:
|
|
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 template. Default: |
|
Whether this check is volatile. Choices:
|
Notes
Note
This module supports check mode.
Examples
- name: Create servicetemplate
t_systems_mms.icinga_director.icinga_service_template:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
enable_flapping: true
flapping_threshold_high: "30.0"
flapping_threshold_low: "25.0"
icon_image_alt: "alt text"
icon_image: "http://url1"
object_name: fooservicetemplate
use_agent: false
vars:
procs_argument: consul
procs_critical: '1:'
procs_warning: '1:'
- name: Update servicetemplate
t_systems_mms.icinga_director.icinga_service_template:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: fooservicetemplate
notes: "example note"
notes_url: "'http://url1' 'http://url2'"
append: true
- 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'"