/ home / community / community.zabbix / 2.3.1 / module / zabbix_user_info

community.zabbix.zabbix_user_info (2.3.1) — module

Gather information about Zabbix user

Authors: sky-joker (@sky-joker)

Install collection

Install with ansible-galaxy collection install community.zabbix:==2.3.1

Add to requirements.yml

  collections:
    - name: community.zabbix
      version: 2.3.1

Description

This module allows you to search for Zabbix user entries.

Requirements

python >= 3.9

Usage examples

Scanned by Steampunk Spotter

# If you want to use Username and Password to be authenticated by Zabbix Server
- name: Set credentials to access Zabbix Server API
  ansible.builtin.set_fact:
    ansible_user: Admin
    ansible_httpapi_pass: zabbix

Scanned by Steampunk Spotter

# 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
  ansible.builtin.set_fact:
    ansible_zabbix_auth_key: 8ec0d52432c15c91fcafe9888500cf9a607f44091ab554dbee860f6b44fac895

Scanned by Steampunk Spotter

- name: Get zabbix user info
  # set task level variables as we change ansible_connection plugin here
  vars:
    ansible_network_os: community.zabbix.zabbix
    ansible_connection: httpapi
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_zabbix_url_path: "zabbixeu"  # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_user_info:
    username: example

Inputs

    
username:
    description:
    - User name.
    - sername is the unique identifier used and cannot be updated using this module.
    required: true
    type: str

http_login_user:
    description:
    - Basic Auth login
    required: false
    type: str

http_login_password:
    description:
    - Basic Auth password
    required: false
    type: str

Outputs

zabbix_user:
  description: example
  returned: always
  sample:
    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: example@example.com
      severity: '63'
      userid: '660'
    name: user
    refresh: 30s
    rows_per_page: '50'
    surname: example
    theme: default
    type: '1'
    url: ''
    userid: '660'
    username: example
    users_status: '0'
    usrgrps:
    - debug_mode: '0'
      gui_access: '0'
      name: Guests
      users_status: '0'
      usrgrpid: '8'
  type: dict