/ home / community / community.zabbix / 2.3.1 / module / zabbix_user_role

community.zabbix.zabbix_user_role (2.3.1) — module

Adds or removes zabbix roles

Authors: Martin van Es (@mrvanes)

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 adds or removes zabbix roles

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

# 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

Inputs

    
name:
    description:
    - Name of the role to be processed
    required: true
    type: str

type:
    choices:
    - User
    - Admin
    - Super Admin
    default: User
    description:
    - User type.
    required: false
    type: str

rules:
    default: {}
    description:
    - Rules set as defined in https://www.zabbix.com/documentation/current/en/manual/api/reference/role/object#role-rules
    required: false
    type: dict

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the user_role.
    - On C(present), it will create if user_role does not exist or update the user_role
      if the associated data is different.
    - On C(absent) will remove a user_role if it exists.
    required: false
    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

changed:
  description: The consequence of the action
  returned: always
  sample: false
  type: bool
msg:
  description: The result of the action
  returned: always
  sample: No action
  type: str