Note
This plugin is part of the community.zabbix collection (version 1.5.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.
To use it in a playbook, specify: community.zabbix.zabbix_proxy_info.
New in version 1.5.0: of community.zabbix
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| http_login_password string | Basic Auth password | |
| http_login_user string | Basic Auth login | |
| login_password string / required | Zabbix user password. If not set the environment variable ZABBIX_PASSWORD will be used. | |
| login_user string / required | Zabbix user name. If not set the environment variable ZABBIX_USERNAME will be used. | |
| proxy_hosts boolean |
| Also return list of hosts monitored by the proxy. |
| proxy_name string / required | Name of the Zabbix proxy. | |
| server_url string / required | URL of Zabbix server, with protocol (http or https). url is an alias for server_url.If not set the environment variable ZABBIX_SERVER will be used.aliases: url | |
| timeout integer | Default: 10 | The timeout of API request (seconds). |
| validate_certs boolean |
| 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 ZABBIX_VALIDATE_CERTS will be used. |
Note
no_log. See this FAQ for more information.- name: Get zabbix proxy info alongside the list of hosts monitored by the proxy
community.zabbix.zabbix_proxy_info:
server_url: "http://zabbix.example.com/zabbix/"
login_user: admin
login_password: secret
proxy_name: zbx01.example.com
proxy_hosts: True
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| zabbix_proxy dictionary | always | example Sample: {'auto_compress': '1', 'custom_interfaces': '0', 'description': 'ExampleProxy', 'discover': '0', 'flags': '0', 'host': 'ExampleProxy', 'hosts': [{'host': 'ExampleHost', 'hostid': '10453'}], 'interface': {'available': '0', 'details': [], 'disable_until': '0', 'dns': 'ExampleProxy.local', 'error': '', 'errors_from': '0', 'hostid': '10452', 'interfaceid': '10', 'ip': '10.1.1.2', 'main': '1', 'port': '10051', 'type': '0', 'useip': '1'}, 'ipmi_authtype': '-1', 'ipmi_password': '', 'ipmi_privilege': '2', 'ipmi_username': '', 'lastaccess': '0', 'maintenance_from': '0', 'maintenance_status': '0', 'maintenance_type': '0', 'maintenanceid': '0', 'name': '', 'proxy_address': '', 'proxy_hostid': '0', 'proxyid': '10452', 'status': '6', 'templateid': '0', 'tls_accept': '1', 'tls_connect': '1', 'tls_issuer': '', 'tls_subject': '', 'uuid': ''} |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/zabbix/zabbix_proxy_info_module.html