community.zabbix.zabbix_configuration module – Import Zabbix configuration

Note

This module is part of the community.zabbix collection (version 4.1.0).

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. You need further requirements to be able to use this module, see Requirements for details.

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

New in community.zabbix 3.4.0

Synopsis

  • This module allows you to import Zabbix configuration data.

  • If the Zabix configuration.importcompare API returns non-empty list, this module returns changed is true.

Requirements

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

  • python >= 3.11

Parameters

Parameter

Comments

content_json

json

The content of the JSON file to be imported.

Mutually exclusive with content_xml and content_yaml.

content_xml

string

The content of the XML file to be imported.

Mutually exclusive with content_json and content_yaml.

content_yaml

string

The content of the YAML file to be imported.

Mutually exclusive with content_json and content_xml.

http_login_password

string

Basic Auth password

http_login_user

string

Basic Auth login

rules

dictionary

The rules for importing the configuration.

Please refer to rules of the Zabbix configuration.import API documentation for more details.

https://www.zabbix.com/documentation/current/en/manual/api/reference/configuration/import

Examples

---
# If you want to use Username and Password to be authenticated by Zabbix Server
- name: Set credentials to access Zabbix Server API
  ansible.builtin.set_fact:
    ansible_user: Admin
    ansible_httpapi_pass: zabbix

# If you want to use API token to be authenticated by Zabbix Server
# https://www.zabbix.com/documentation/current/en/manual/web_interface/frontend_sections/administration/general#api-tokens
- name: Set API token
  ansible.builtin.set_fact:
    ansible_zabbix_auth_key: 8ec0d52432c15c91fcafe9888500cf9a607f44091ab554dbee860f6b44fac895

- name: Import Zabbix template from JSON
  # set task level variables as we change ansible_connection plugin here
  vars:
    ansible_network_os: community.zabbix.zabbix
    ansible_connection: httpapi
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_zabbix_url_path: "zabbixeu"  # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_configuration:
    content_json: "{{ lookup('file', 'zbx_export_template.json') }}"
    rules:
      templates:
        createMissing: true
        updateExisting: true
      items:
        createMissing: true
        updateExisting: true
        deleteMissing: true
      triggers:
        createMissing: true
        updateExisting: true
        deleteMissing: true
      valueMaps:
        createMissing: true
        updateExisting: false

Authors

  • ONODERA Masaru(@masa-orca)