zabbix_add_host

Add hosts to Zabbix server instances with certificate validation enabled.

When should I consider using this role?

If you have deployed certificates to your Zabbix clients and want to make use of certification validation and don't want to dive too deep into certificates and Zabbix.

If you only want to add hosts to the Zabbix server, please make use of these excellent modules instead:

• community.zabbix.zabbix_host
• zabbix.zabbix.zabbix_host

This role's purpose is to ease the entrance level of certificate validation with Zabbix. Expert Zabbix and Ansible users have surely figured this out already 🙂

Requirements

This role requires following collections (specified via collections/requirements.yml):

• zabbix.zabbix
• community.crypto

Note: To make use of Red Hat certified collections, you need to be a Red Hat subscriber with a subscription that provides Red Hat Ansible Automation Platform, which includes access to the certified collections. If you don't own any subscriptions that provides this access, you can make use of Red Hat's Developer Subscription which is provided at no cost by Red Hat.

Role Variables

variable	default	required	description
zba_api_host	unset	true	host name of the Zabbix server instance serving the API
zba_api_user	unset	true	user to authenticate with to the Zabbix API
zba_api_password	unset	true	password of the user connecting to the Zabbix API
zba_api_port	443	false	port of the Zabbix server API
zba_api_use_ssl	true	false	whether to connect to the Zabbix API via SSL
zba_api_validate_certs	true	false	whether to validate certificates when connecting to the API
zba_installation_disable_plugins	[]	false	list of package manager plugins to disable when installing dependencies
zba_no_cert	false	false	whether to not deploy certification validation (usually not needed to be set)
zba_cert_path	unset	false	path to the certificate to extract issuer and subject from
zba_api_url	unset	false	use when Zabbix is served via a non-default path, e.g. /zbx
zba_http_login	unset	false	HTTP basic authentication user name
zba_http_password	unset	false	HTTP basic authentication password

Note on zba_no_cert: I merely introduced this variable for myself, as I don't want to make use of two different roles, as I have some devices, which I cannot set up with certificate validation.

Additionally, all variables of the module zabbix.zabbix.zabbix_host can be used (see example below).

This role will pass all variables currently (as of 2023-10-18) known for zabbix.zabbix.zabbix_host to the module.

Note: To use community.crypto, python3-cryptography needs to be installed on the managed nodes. You can override the list of required packages via _zba_required_packages or place a file into vars/ for your operating system (see RedHat.yml or Debian.yml).

Below is the code that loads these specific vars (in tasks/main.yml) to give you an idea how your file needs to be named:

- name: 'Load OS dependent variables'
  ansible.builtin.include_vars: "{{ lookup('first_found', params) }}"
  vars:
    params:
      files:
        - >-
          {{
            ansible_distribution ~ '-' ~
            ansible_distribution_major_version ~ '.yml'
          }}
        - '{{ ansible_os_family }}_{{ ansible_distribution_major_version }}.yml'
        - '{{ ansible_distribution }}.yml'
        - '{{ ansible_os_family }}.yml'
        - 'main.yml'  # fallback, vars/main.yml is always loaded by Ansible
      paths:
        - '{{ role_path }}/vars'
        - '{{ playbook_dir }}/vars'

Dependencies

None

Example Playbook

---
- name: 'Add hosts to a Zabbix instance'
  hosts: 'all'
  become: false
  gather_facts: false
  roles:
    - role: 'zabbix_add_host'
  vars:
    zba_api_host: 'zabbix.example.com'
    zba_api_user: !vault |
          $ANSIBLE_VAULT;1.1;AES256
    zba_api_password: !vault |
          $ANSIBLE_VAULT;1.1;AES256
          [..]
    zba_api_port: 443
    zba_api_use_ssl: true
    zba_api_validate_certs: true
    zba_cert_path: '/etc/zabbix/zabbix_agentd.d/certs/zbx.agent.cert.pem'
    zba_api_url: '/zbx'
    zba_http_login: !vault |
          $ANSIBLE_VAULT;1.1;AES256
    zba_http_password: !vault |
          $ANSIBLE_VAULT;1.1;AES256
    # variables for the module zabbix.zabbix.zabbix_host
    description: '{{ hostvars[inventory_hostname].ansible_fqdn }}'
    host: '{{ hostvars[inventory_hostname].ansible_fqdn }}'
    name: '{{ hostvars[inventory_hostname].ansible_fqdn }}'
    state: 'present'
    status: 'enabled'
    tls_accept: 'cert'
    tls_connect: 'cert'
    hostgroups:
      - 'Linux servers'
    macros:
      - macro: '{$NET.IF.IFNAME.NOT_MATCHES}'
        value: >-
          (^Software Loopback Interface|^NULL[0-9.]*$|^[Ll]o[0-9.]*$|
          ^[Ss]ystem$|^Nu[0-9.]*$|^veth[0-9a-z]+$|docker[0-9]+|
          br-[a-z0-9]{12}|cni-podman[0-9]+)
        description: >-
          Filter out loopbacks, nulls, docker veth links and docker0 bridge
          by default, as well as podman network interfaces
        type: 'text'

      - macro: '{$VFS.FS.FSNAME.NOT_MATCHES}'
        value: >-
          ^(/dev|/sys|/run|/proc|.+/shm$|/var/lib/containers/storage/overlay)
        description: >-
          Filter out mount-points that do not need monitoring or are not
          capable of being monitored
        type: 'text'
    templates:
      - 'Template App SSH Service'
      - 'Template Module ICMP Ping'
      - 'Template OS Linux by Zabbix agent active'
    interfaces:
      - type: 'agent'
        useip: true
        dns: '{{ hostvars[inventory_hostname].ansible_fqdn }}'
        ip: '{{ hostvars[inventory_hostname].ansible_default_ipv4.address }}'
    inventory_mode: 'manual
...

License

GPL-2.0-or-later