/ home / community / community.zabbix / 2.3.1 / module / zabbix_autoregister

community.zabbix.zabbix_autoregister (2.3.1) — module

Update Zabbix autoregistration

| "added in version" 1.6.0 of community.zabbix"

Authors: ONODERA Masaru(@masa-orca)

Install collection

Install with ansible-galaxy collection install community.zabbix:==2.3.1

Add to requirements.yml

  collections:
    - name: community.zabbix
      version: 2.3.1

Description

This module allows you to modify Zabbix autoregistration.

Requirements

python >= 3.9

Usage examples

Scanned by Steampunk Spotter

# 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

Scanned by Steampunk Spotter

# 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

Scanned by Steampunk Spotter

- name: Update autoregistration
  # 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_autoregister:
    tls_accept:
      - unsecure
      - tls_with_psk
    tls_psk_identity: "PSK 001"
    tls_psk: "11111595725ac58dd977beef14b97461a7c1045b9a1c923453302c5473193478"

Scanned by Steampunk Spotter

- name: Set unsecure to tls_accept
  # 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_autoregister:
    tls_accept: unsecure

Inputs

    
tls_psk:
    description:
    - TLS connection uses this PSK value.
    - This setting requires I(tls_accept=tls_with_psk) if current value of I(tls_accept)
      is C(unsecure).
    type: str

tls_accept:
    description:
    - Type of allowed incoming connections for autoregistration.
    - Choose from C(unsecure), C(tls_with_psk) or both.
    elements: str
    required: true
    type: list

http_login_user:
    description:
    - Basic Auth login
    required: false
    type: str

tls_psk_identity:
    description:
    - TLS connection uses this PSK identity string.
    - The PSK identity string will be transmitted unencrypted over the network. Therefore,
      you should not put any sensitive information here.
    - This setting requires I(tls_accept=tls_with_psk) if current value of I(tls_accept)
      is C(unsecure).
    type: str

http_login_password:
    description:
    - Basic Auth password
    required: false
    type: str

Outputs

msg:
  description: The result of the operation
  returned: success
  sample: Successfully updated global autoregistration setting
  type: str