community.zabbix.zabbix_user_role module – Adds or removes zabbix roles

Note

This module is part of the community.zabbix collection (version 2.2.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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis

  • This module adds or removes zabbix roles

Requirements

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

  • python >= 3.9

Parameters

Parameter

Comments

http_login_password

string

Basic Auth password

http_login_user

string

Basic Auth login

name

string / required

Name of the role to be processed

rules

dictionary

Rules set as defined in https://www.zabbix.com/documentation/current/en/manual/api/reference/role/object#role-rules

Default: {}

state

string

State of the user_role.

On present, it will create if user_role does not exist or update the user_role if the associated data is different.

On absent will remove a user_role if it exists.

Choices:

  • "present" ← (default)

  • "absent"

type

string

User type.

Choices:

  • "User" ← (default)

  • "Admin"

  • "Super Admin"

Examples

# 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

# 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

# Create user role Operators with ui elements monitoring.hosts
# disabled and monitoring.maps enabled

- name: Create Zabbix user role
  # 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_role:
    state: present
    name: Operators
    type: User
    rules:
      ui.default_access: 0
      ui:
        - name: "monitoring.hosts"
          status: 0
        - name: "monitoring.maps"
          status: 1

Return Values

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

Key

Description

changed

boolean

The consequence of the action

Returned: always

Sample: false

msg

string

The result of the action

Returned: always

Sample: "No action"

Authors

  • Martin van Es (@mrvanes)