community.zabbix.zabbix_service – Create/update/delete Zabbix service

Note

This plugin is part of the community.zabbix collection (version 1.5.1).

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 community.zabbix.

To use it in a playbook, specify: community.zabbix.zabbix_service.

Synopsis

  • Create/update/delete Zabbix service.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

  • zabbix-api >= 0.5.4

Parameters

Parameter

Comments

algorithm

string

Algorithm used to calculate the sla

no, sla is not calculated

one_child, problem if at least one child has a problem

all_children, problem if all children have problems

Choices:

  • no

  • one_child ← (default)

  • all_children

calculate_sla

boolean

If yes, calculate the SLA value for this service, showsla in Zabbix API

Choices:

  • no ← (default)

  • yes

http_login_password

string

Basic Auth password

http_login_user

string

Basic Auth login

login_password

string / required

Zabbix user password.

If not set the environment variable ZABBIX_PASSWORD will be used.

login_user

string / required

Zabbix user name.

If not set the environment variable ZABBIX_USERNAME will be used.

name

string / required

Name of Zabbix service

parent

string

Name of Zabbix service parent

server_url

aliases: url

string / required

URL of Zabbix server, with protocol (http or https). url is an alias for server_url.

If not set the environment variable ZABBIX_SERVER will be used.

sla

float

Sla value (i.e 99.99), goodsla in Zabbix API

state

string

State: present - create/update service; absent - delete service

Choices:

  • present ← (default)

  • absent

timeout

integer

The timeout of API request (seconds).

Default: 10

trigger_host

string

Name of host linked to the service

trigger_name

string

Name of trigger linked to the service

validate_certs

boolean

If set to False, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

If not set the environment variable ZABBIX_VALIDATE_CERTS will be used.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • If you use login_password=zabbix, the word “zabbix” is replaced by “****” in all module output, because login_password uses no_log. See this FAQ for more information.

Examples

---
# Creates a new Zabbix service
- name: Manage services
  local_action:
        module: community.zabbix.zabbix_service
        server_url: "https://192.168.1.1"
        login_user: username
        login_password: password
        name: apache2 service
        sla: 99.99
        calculate_sla: yes
        algorithm: one_child
        trigger_name: apache2 service status
        trigger_host: webserver01
        state: present

Authors

  • Emmanuel Riviere (@emriver)