Documentation

zabbix_proxy - Zabbix proxy creates/deletes/gets/updates

New in version 2.5.

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.3

Parameters

Parameter Choices/Defaults Comments
description
Description of the proxy..
http_login_password
(added in 2.1)
Default:
None
Basic Auth password
http_login_user
(added in 2.1)
Default:
None
Basic Auth login
interface Default:
{}
Dictionary with params for the interface when proxy is in passive mode
Available values are: dns, ip, main, port, type and useip.
Please review the interface documentation for more information on the supported properties
login_password
required
Zabbix user password.
login_user
required
Zabbix user name.
proxy_name
required
Name of the proxy in Zabbix.
server_url
required
Url of Zabbix server, with protocol (http or https). url is an alias for server_url.

aliases: url
state
    Choices:
  • 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
    Choices:
  • active ←
  • passive
Type of proxy. (4 - active, 5 - passive)
timeout Default:
10
The timeout of API request(seconds).
tls_accept
    Choices:
  • no_encryption ←
  • PSK
  • certificate
Connections from proxy.
tls_connect
    Choices:
  • no_encryption ←
  • PSK
  • certificate
Connections to proxy.
tls_issuer
Certificate issuer.
tls_psk
The preshared key, at least 32 hex digits. Required if either tls_connect or tls_accept has PSK enabled.
tls_psk_identity
PSK identity. Required if either tls_connect or tls_accept has PSK enabled.
tls_subject
Certificate subject.
validate_certs
(added in 2.5)
    Choices:
  • true
  • false
Default:
yes
If set to False, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Examples

- name: Create a new proxy or update an existing proxies info
  local_action:
    module: zabbix_proxy
    server_url: http://monitor.example.com
    login_user: username
    login_password: password
    proxy_name: ExampleProxy
    description: ExampleProxy
    status: active
    state: present
    interface:
        type: 0
        main: 1
        useip: 1
        ip: 10.xx.xx.xx
        dns: ""
        port: 10050

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Alen Komic

Hint

If you notice any issues in this documentation you can edit this document to improve it.