community.zabbix.zabbix_usergroup 模块 – 创建/删除/更新 Zabbix 用户组

注意

此模块是 community.zabbix 集合（版本 3.2.0）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.zabbix。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：community.zabbix.zabbix_usergroup。

概要

• 如果用户组不存在，则创建用户组。

• 如果用户组存在并且为空，则删除现有用户组。

• 更新现有用户组。

要求

在执行此模块的主机上需要以下要求。

• python >= 3.9

参数

参数	注释
debug_mode 字符串	是否启用或禁用调试模式。 选择 "disabled" ← (默认) "enabled"
gui_access 字符串	组中用户的前端身份验证方法。 可能的值 default - 使用系统默认身份验证方法； internal - 使用内部身份验证； LDAP - 使用 LDAP 身份验证； disable - 禁用对前端的访问。 选择 "default" ← (默认) "internal" "LDAP" "disable"
hostgroup_rights 列表 / 元素=字典	要分配给用户组的主机组权限 对于 => Zabbix 6.2
host_group 字符串 / 必需	要添加权限的主机组的名称。
permission 字符串 / 必需	对主机组的访问级别。 选择 "denied" "read-only" "read-write"
http_login_password 字符串	基本身份验证密码
http_login_user 字符串	基本身份验证登录名
name 别名：user_group 字符串 / 必需	要创建、更新或删除的用户组的名称。
rights 列表 / 元素=字典	要分配给组的权限 对于 <= Zabbix 6.0
host_group 字符串 / 必需	要添加权限的主机组的名称。
permission 字符串 / 必需	对主机组的访问级别。 选择 "denied" "read-only" "read-write"
state 字符串	用户组的状态。 在 present 上，如果用户组不存在，则创建该用户组；如果相关数据不同，则更新该用户组。 在 absent 上，如果用户组存在，则删除该用户组。 选择 "present" ← (默认) "absent"
status 字符串	是否启用或禁用用户组。 选择 "enabled" ← (默认) "disabled"
tag_filters 列表 / 元素=字典	要分配给组的基于标签的权限
host_group 字符串 / 必需	要添加权限的主机组的名称。
tag 字符串	标签名称。 默认： ""
value 字符串	标签值。 默认： ""
templategroup_rights 列表 / 元素=字典	要分配给用户组的模板组权限 对于 => Zabbix 6.2
permission 字符串 / 必需	对模板组的访问级别。 选择 "denied" "read-only" "read-write"
template_group 字符串 / 必需	要添加权限的模板组的名称。
userdirectory 字符串	当 gui_access 设置为 LDAP 或系统默认值时的身份验证用户目录。 对于 => Zabbix 6.2

示例

# 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

# Base create user group example
- name: Create user group
    # 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_usergroup:
    name: ACME
    userdirectory: LDAP infra 1
    state: present

# Base create user group with selected user directory for LDAP authentication
- name: Create user group
    # 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_usergroup:
    name: ACME
    userdirectory: LDAP infra 1
    state: present

# Base create user group with disabled gui access
- name: Create user group with disabled gui access
    # 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_usergroup:
    name: ACME
    gui_access: disable

# Base create user group with permissions for Zabbix <= 6.0
- name: Create user group with permissions
    # 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_usergroup:
    name: ACME
    rights:
        - host_group: Webserver
          permission: read-write
        - host_group: Databaseserver
          permission: read-only
    state: present

# Base create user group with permissions for Zabbix => 6.2
- name: Create user group with permissions
    # 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_usergroup:
    name: ACME
    hostgroup_rights:
        - host_group: Webserver
          permission: read-write
        - host_group: Databaseserver
          permission: read-only
    templategroup_rights:
        - template_group: Linux Templates
          permission: read-write
        - template_group: Templates
          permission: read-only
    state: present

# Base create user group with tag permissions
- name: Create user group with tag permissions
    # 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_usergroup:
    name: ACME
    tag_filters:
        - host_group: Webserver
          tag: Application
          value: Java
        - host_group: Discovered hosts
          tag: Service
          value: JIRA
    state: present

# Base delete user groups example
- name: Delete user groups
    # 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_usergroup:
    name: ACME
    state: absent

返回值

常见返回值记录在此处，以下是此模块特有的字段

键	描述
msg 字符串	操作的结果 返回： 始终 示例： "用户组已创建：ACME，ID：42"
state 字符串	执行结束时的用户组状态。 返回： 成功时 示例： "present"
usergroup 字符串	用户组名称。 返回： 成功时 示例： "ACME"
usrgrpid 字符串	用户组 ID，如果创建、更改或删除。 返回： 成功时 示例： "42"

作者

• Tobias Birkefeld (@tcraxs)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）