Skip to content

Latest commit

 

History

History
295 lines (159 loc) · 7.85 KB

icinga_service_template.rst

File metadata and controls

295 lines (159 loc) · 7.85 KB
Raw

icinga_service_template -- Manage service templates in Icinga2

Synopsis

Add or remove a service template to Icinga2 through the director API.

Parameters

state (optional, str, present)
Apply feature state.
object_name (True, str, None)
Name of the service template.
check_command (optional, str, None)
Check command definition.
check_interval (optional, str, None)
Your regular check interval.
check_period (optional, str, None)
The name of a time period which determines when this object should be monitored. Not limited by default.
check_timeout (optional, str, None)
Check command timeout in seconds. Overrides the CheckCommand's timeout attribute.
enable_active_checks (optional, bool, None)
Whether to actively check this object.
enable_event_handler (optional, bool, None)
Whether to enable event handlers this object.
enable_flapping (optional, bool, None)
Whether flap detection is enabled on this object.
enable_notifications (optional, bool, None)
Whether to send notifications for this object.
enable_passive_checks (optional, bool, None)
Whether to accept passive check results for this object.
enable_perfdata (optional, bool, None)
Whether to process performance data provided by this object.
event_command (optional, str, None)

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_threshold_high (optional, str, None)
Flapping upper bound in percent for a service to be considered flapping
flapping_threshold_low (optional, str, None)
Flapping lower bound in percent for a service to be considered not flapping
groups (optional, list, [])

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.

icon_image (optional, str, None)

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

icon_image_alt (optional, str, None)
Alternative text to be shown in case above icon is missing
imports (optional, list, [])

Importable templates, add as many as you want.

Please note that order matters when importing properties from multiple templates - last one wins.

max_check_attempts (optional, str, None)
Defines after how many check attempts a new hard state is reached.
notes (optional, str, None)
Additional notes for this object.
notes_url (optional, str, None)

An URL pointing to additional notes for this object.

Separate multiple urls like this "'http://url1' 'http://url2'".

Maximum length is 255 characters.

retry_interval (optional, str, None)
Retry interval, will be applied after a state change unless the next hard state is reached.
use_agent (optional, bool, None)
Whether the check command for this service should be executed on the Icinga agent.
vars (optional, dict, {})
Custom properties of the service template.
volatile (optional, bool, None)
Whether this check is volatile.
disabled (optional, bool, False)
Disabled objects will not be deployed.
append (optional, bool, None)

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.

url (True, str, None)
HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path
force (optional, bool, False)
If yes do not get a cached copy.
http_agent (optional, str, ansible-httpget)
Header to identify as, generally appears in web server logs.
use_proxy (optional, bool, True)
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
validate_certs (optional, bool, True)

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.

url_username (optional, str, None)

The username for use in HTTP basic authentication.

This parameter can be used without url_password for sites that allow empty passwords

url_password (optional, str, None)

The password for use in HTTP basic authentication.

If the url_username parameter is not specified, the url_password parameter will not be used.

force_basic_auth (optional, bool, False)
Credentials specified with url_username and url_password should be passed in HTTP Header.
client_cert (optional, path, None)

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, client_key is not required.

client_key (optional, path, None)

PEM formatted file that contains your private key to be used for SSL client authentication.

If client_cert contains both the certificate and key, this option is not required.

use_gssapi (optional, bool, False)

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 KRB5CCNAME that specified a custom Kerberos credential cache.

NTLM authentication is not supported even if the GSSAPI mech for NTLM has been installed.

Notes

Note

  • This module supports check mode.

Examples

- name: Create servicetemplate
  telekom_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
  telekom_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
  telekom_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'"

Status

Authors

  • Sebastian Gumprich (@rndmh3ro)