role-monitoring_plugins.md

Ansible Role icinga.icinga.monitoring_plugins

This role manages the installation/removal of many well known check plugins typically used in monitoring systems.
The list is based on the section "Plugin Check Commands for Monitoring Plugins" as seen in the Icinga Template Library (ITL).

• List of available check commands

For Suse based systems you need the Ansible module zypper. Refer to the getting started section.

Variables

• icinga_monitoring_plugins_epel: boolean Decides whether to activate the epel repository. Default: false Epel needs to be available to install plugins on RHEL and derivatives.

• icinga_monitoring_plugins_crb: boolean
  Decides whether to run the equivalent of dnf --enablerepo crb ... when installing the necessary packages. Default: false
  Enabling CRB/Powertools may be necessary, depending on the plugins wanted and the repositories already enabled.

• icinga_monitoring_plugins_dependency_repos: list Decides which repositories are temporarily enabled when installing packages. Defaults to either crb or powertools.
  If the need arises, you can manually overwrite this variable to temporarily enable one or multiple repositories of your choice.
  You may specify icinga_monitoring_plugins_dependency_repos: "*" to temporarily enable every repository present.

• icinga_monitoring_plugins_remove: boolean
  Decides whether to remove packages that have not been asked for by the user. Default true
  The requested check commands are compared against the list of available check commands. Packages not required for installation are removed.

• icinga_monitoring_plugins_autoremove: boolean
  Decides whether to automatically remove unneeded dependencies. Default: false

• icinga_monitoring_plugins_check_commands: list
  Decides what check plugins will be installed. Default: undefined
  An empty list will be accepted.
  If undefined, the role will fail. Also see List of available check commands.

Check Commands

Check plugins are abreviated only using the base name (check_apt becomes apt).
They are installed using the according packages provided by the distribution.
This also means that more than the requested check commands might get installed.

To set check plugins to be installed:

icinga_monitoring_plugins_check_commands:
    - "ssmtp"
    - "disk"
    - "load"
    - "smtp"
    - "dns"
    ...

To install all available check plugins you can add the word 'all' to the list:

icinga_monitoring_plugins_check_commands:
    - "all"

Example Playbooks

Install check commands

• disk
• disk_smb
• dns
• tcp
• uptime

---

- hosts:
    - host1
  become: yes
  vars:
    icinga_monitoring_plugins_epel: true
    icinga_monitoring_plugins_crb: true
    icinga_monitoring_plugins_check_commands:
      - disk
      - disk_smb
      - dns
      - tcp
      - uptime
  roles:
    - icinga.icinga.monitoring_plugins

---

Remove all check commands known to this role. Also remove unneeded dependencies.

---

- hosts:
    - host1
  become: yes
  vars:
    icinga_monitoring_plugins_autoremove: true
    icinga_monitoring_plugins_check_commands: []
  roles:
    - icinga.icinga.monitoring_plugins