t_systems_mms.icinga_director.icinga_service_apply – Manage service apply rules in Icinga2

Note

This plugin is part of the t_systems_mms.icinga_director collection (version 1.13.0).

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_apply.

New in version 1.0.0: of t_systems_mms.icinga_director

Synopsis

  • Add or remove a service apply rule to Icinga2 through the director API.

Parameters

Parameter Choices/Defaults Comments
apply_for
string
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.
assign_filter
string
The filter where the service apply rule will take effect.
check_command
string
added in 1.7.0 of t_systems_mms.icinga_director
Check command definition.
check_interval
string
Your regular check interval.
check_period
string
The name of a time period which determines when this object should be monitored. Not limited by default.
check_timeout
string
Check command timeout in seconds. Overrides the CheckCommand's timeout attribute.
client_cert
path
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
path
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.
display_name
string
Alternative displayed name of the service apply rule.
enable_active_checks
boolean
    Choices:
  • no
  • yes
Whether to actively check this object.
enable_event_handler
boolean
    Choices:
  • no
  • yes
Whether to enable event handlers this object.
enable_notifications
boolean
    Choices:
  • no
  • yes
Whether to send notifications for this object.
enable_passive_checks
boolean
    Choices:
  • no
  • yes
Whether to accept passive check results for this object.
enable_perfdata
boolean
    Choices:
  • no
  • yes
Whether to process performance data provided by this object.
force
boolean
    Choices:
  • no ←
  • yes
If yes do not get a cached copy.
Alias thirsty has been deprecated and will be removed in 2.13.

aliases: thirsty
force_basic_auth
boolean
    Choices:
  • no ←
  • yes
Credentials specified with url_username and url_password should be passed in HTTP Header.
groups
list / elements=string
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.
http_agent
string
Default:
"ansible-httpget"
Header to identify as, generally appears in web server logs.
imports
list / elements=string
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
string
Defines after how many check attempts a new hard state is reached.
notes
string
Additional notes for this object.
notes_url
string
An URL pointing to additional notes for this object.
Separate multiple urls like this "'http://url1' 'http://url2'".
Maximum length is 255 characters.
object_name
string / required
Name for the Icinga service apply rule.

aliases: name
retry_interval
string
Retry interval, will be applied after a state change unless the next hard state is reached.
state
string
    Choices:
  • present ←
  • absent
Apply feature state.
url
string / required
HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path
url_password
string
The password for use in HTTP basic authentication.
If the url_username parameter is not specified, the url_password parameter will not be used.
url_username
string
The username for use in HTTP basic authentication.
This parameter can be used without url_password for sites that allow empty passwords
use_gssapi
boolean
added in 2.11 of ansible.builtin
    Choices:
  • no ←
  • yes
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.
use_proxy
boolean
    Choices:
  • no
  • yes ←
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
validate_certs
boolean
    Choices:
  • no
  • yes ←
If no, SSL certificates will not be validated.
This should only be used on personally controlled sites using self-signed certificates.
vars
dictionary
Custom properties of the service apply rule.

Notes

Note

  • This module supports check mode.

Examples

- name: Add service apply rule to icinga
  t_systems_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
    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"

Authors

  • Sebastian Gumprich (@rndmh3ro)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/t_systems_mms/icinga_director/icinga_service_apply_module.html