community.zabbix.zabbix_user_info – Gather information about Zabbix user

Note

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

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

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

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

This module allows you to search for Zabbix user 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
alias string / required		Name of the user alias in Zabbix.
http_login_password string		Basic Auth password
http_login_user string		Basic Auth login
login_password string / required		Zabbix user password.
login_user string / required		Zabbix user name.
server_url string / required		URL of Zabbix server, with protocol (http or https). `url` is an alias for `server_url`. aliases: url
timeout integer	Default: 10	The timeout of API request (seconds).
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: Get zabbix user info
  community.zabbix.zabbix_user_info:
    server_url: "http://zabbix.example.com/zabbix/"
    login_user: admin
    login_password: secret
    alias: example

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
zabbix_user dictionary	always	example Sample: {'alias': 'example', 'attempt_clock': '0', 'attempt_failed': '0', 'attempt_ip': , 'autologin': '0', 'autologout': '0', 'debug_mode': '0', 'gui_access': '0', 'lang': 'en_GB', 'medias': [{'active': '0', 'mediaid': '668', 'mediatypeid': '1', 'period': '1-7,00:00-24:00', 'sendto': '[email protected]', 'severity': '63', 'userid': '660'}], 'name': 'user', 'refresh': '30s', 'rows_per_page': '50', 'surname': 'example', 'theme': 'default', 'type': '1', 'url': , 'userid': '660', 'users_status': '0', 'usrgrps': [{'debug_mode': '0', 'gui_access': '0', 'name': 'Guests', 'users_status': '0', 'usrgrpid': '8'}]}

Authors

sky-joker (@sky-joker)

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