community.zabbix.zabbix_autoregister module – Update Zabbix autoregistration
Note
This module is part of the community.zabbix collection (version 1.9.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_autoregister
.
New in community.zabbix 1.6.0
Synopsis
This module allows you to modify Zabbix autoregistration.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
Parameters
Parameter |
Comments |
---|---|
Zabbix user password. If not set the environment variable This option is deprecated with the move to httpapi connection and will be removed in the next release |
|
Zabbix user name. If not set the environment variable This option is deprecated with the move to httpapi connection and will be removed in the next release |
|
URL of Zabbix server, with protocol (http or https). If not set the environment variable This option is deprecated with the move to httpapi connection and will be removed in the next release |
|
The timeout of API request (seconds). This option is deprecated with the move to httpapi connection and will be removed in the next release Default: |
|
Type of allowed incoming connections for autoregistration. Choose from |
|
TLS connection uses this PSK value. This setting requires tls_accept=tls_with_psk if current value of tls_accept is |
|
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 tls_accept=tls_with_psk if current value of tls_accept is |
|
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 This option is deprecated with the move to httpapi connection and will be removed in the next release Choices:
|
Notes
Note
Only Zabbix >= 4.4 is supported.
This module returns changed=true when any value is set in tls_psk_identity or tls_psk as Zabbix API will not return any sensitive information back for module to compare.
Please note that this module configures global Zabbix Server settings. If you want to create autoregistration action so your hosts can automatically add themselves to the monitoring have a look at community.zabbix.zabbix_action.
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
# Set following variables for Zabbix Server host in play or inventory
- name: Set connection specific variables
set_fact:
ansible_network_os: community.zabbix.zabbix
ansible_connection: httpapi
ansible_httpapi_port: 80
ansible_httpapi_use_ssl: false
ansible_httpapi_validate_certs: false
ansible_zabbix_url_path: 'zabbixeu' # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
# If you want to use Username and Password to be authenticated by Zabbix Server
- name: Set credentials to access Zabbix Server API
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
set_fact:
ansible_zabbix_auth_key: 8ec0d52432c15c91fcafe9888500cf9a607f44091ab554dbee860f6b44fac895
- name: Update autoregistration
community.zabbix.zabbix_autoregister:
server_url: "http://zabbix.example.com/zabbix/"
login_user: Admin
login_password: secret
tls_accept:
- unsecure
- tls_with_psk
tls_psk_identity: 'PSK 001'
tls_psk: "11111595725ac58dd977beef14b97461a7c1045b9a1c923453302c5473193478"
- name: Set unsecure to tls_accept
community.zabbix.zabbix_autoregister:
server_url: "http://zabbix.example.com/zabbix/"
login_user: Admin
login_password: secret
tls_accept: unsecure
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the operation Returned: success Sample: |