community.zabbix.zabbix_proxy – Create/delete/get/update Zabbix proxies

Note

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

To install it use: ansible-galaxy collection install community.zabbix.

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

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis

This module allows you to create, modify, get and delete Zabbix proxy entries.

Requirements

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

python >= 2.6
zabbix-api >= 0.5.4

Parameters

Parameter		Choices/Defaults	Comments
ca_cert string			Certificate issuer. aliases: tls_issuer
description string			Description of the proxy.
http_login_password string			Basic Auth password
http_login_user string			Basic Auth login
interface dictionary		Default: {}	Dictionary with params for the interface when proxy is in passive mode. For more information, review proxy interface documentation at https://www.zabbix.com/documentation/4.0/manual/api/reference/proxy/object#proxy_interface.
	dns string	Default: ""	DNS name of the proxy interface. Required if useip=0.
	ip string	Default: ""	IP address used by proxy interface. Required if useip=1.
	main integer	Default: 0	Whether the interface is used as default. This suboption is currently ignored for Zabbix proxy. This suboption is deprecated since Ansible 2.10 and will eventually be removed in 2.14.
	port string	Default: "10051"	Port used by proxy interface.
	type integer	Default: 0	Interface type to add. This suboption is currently ignored for Zabbix proxy. This suboption is deprecated since Ansible 2.10 and will eventually be removed in 2.14.
	useip integer	0 1 Default: 0	Connect to proxy interface with IP address instead of DNS name. 0 (don't use ip), 1 (use ip).
login_password string / required			Zabbix user password.
login_user string / required			Zabbix user name.
proxy_address string			Comma-delimited list of IP/CIDR addresses or DNS names to accept active proxy requests from. Requires status=active. Works only with >= Zabbix 4.0. ( remove option for <= 4.0 )
proxy_name string / required			Name of the proxy in Zabbix.
server_url string / required			URL of Zabbix server, with protocol (http or https). `url` is an alias for `server_url`. aliases: url
state string		present ← absent	State of the proxy. On `present`, it will create if proxy does not exist or update the proxy if the associated data is different. On `absent` will remove a proxy if it exists.
status string		active ← passive	Type of proxy. (4 - active, 5 - passive)
timeout integer		Default: 10	The timeout of API request (seconds).
tls_accept string		no_encryption ← PSK certificate	Connections from proxy.
tls_connect string		no_encryption ← PSK certificate	Connections to proxy.
tls_psk string			The preshared key, at least 32 hex digits. Required if either tls_connect or tls_accept has PSK enabled.
tls_psk_identity string			PSK identity. Required if either tls_connect or tls_accept has PSK enabled.
tls_subject string			Certificate subject.
validate_certs boolean		no yes ←	If set to False, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

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

- name: Create or update a proxy with proxy type active
  local_action:
    module: community.zabbix.zabbix_proxy
    server_url: http://monitor.example.com
    login_user: username
    login_password: password
    proxy_name: ExampleProxy
    description: ExampleProxy
    status: active
    state: present
    proxy_address: ExampleProxy.local

- name: Create a new passive proxy using only it's IP
  local_action:
    module: community.zabbix.zabbix_proxy
    server_url: http://monitor.example.com
    login_user: username
    login_password: password
    proxy_name: ExampleProxy
    description: ExampleProxy
    status: passive
    state: present
    interface:
      useip: 1
      ip: 10.1.1.2
      port: 10051

- name: Create a new passive proxy using only it's DNS
  local_action:
    module: community.zabbix.zabbix_proxy
    server_url: http://monitor.example.com
    login_user: username
    login_password: password
    proxy_name: ExampleProxy
    description: ExampleProxy
    status: passive
    state: present
    interface:
      dns: proxy.example.com
      port: 10051

Authors

Alen Komic (@akomic)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/zabbix/zabbix_proxy_module.html