Модуль community.zabbix.zabbix_usergroup — создание, удаление и обновление групп пользователей Zabbix

Примечание

Этот модуль является частью коллекции community.zabbix (версия 4.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.zabbix. Для использования этого модуля могут потребоваться дополнительные условия; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.zabbix.zabbix_usergroup.

Краткое описание
Требования
Параметры
Примеры
Возвращаемые значения

Краткое описание

Создание групп пользователей, если они не существуют.
Удаление существующих групп пользователей, если они существуют и пусты.
Обновление существующих групп пользователей.

Требования

На узле, выполняющем этот модуль, должны быть соблюдены следующие требования.

python >= 3.9

Параметры

Параметр	Комментарии
debug_mode string	Включен или отключен режим отладки. Варианты: `"disabled"` ← (по умолчанию) `"enabled"`
gui_access string	Способ аутентификации пользователей группы в веб-интерфейсе. Возможные значения: default — использовать способ аутентификации системы по умолчанию; internal — использовать внутреннюю аутентификацию; LDAP — использовать аутентификацию LDAP; disable — отключить доступ к веб-интерфейсу. Варианты: `"default"` ← (по умолчанию) `"internal"` `"LDAP"` `"disable"`
hostgroup_rights list / элементы=dictionary	Разрешения для групп узлов сети, назначаемые группе пользователей Для версий Zabbix >= 7.0
host_group string / обязательный	Имя группы узлов сети, для которой нужно добавить разрешение.
permission string / обязательный	Уровень доступа к группе узлов сети. Варианты: `"denied"` `"read-only"` `"read-write"`
http_login_password string	Пароль для базовой аутентификации
http_login_user string	Имя пользователя для базовой аутентификации
name псевдонимы: user_group string / обязательный	Имя группы пользователей, которую нужно создать, обновить или удалить.
rights list / элементы=dictionary	Разрешения, назначаемые группе Для версий Zabbix <= 6.0
host_group string / обязательный	Имя группы узлов сети, для которой нужно добавить разрешение.
permission string / обязательный	Уровень доступа к группе узлов сети. Варианты: `"denied"` `"read-only"` `"read-write"`
state string	Состояние группы пользователей. При значении `present` группа пользователей будет создана, если она не существует, или обновлена, если связанные с ней данные отличаются. При значении `absent` группа пользователей будет удалена, если она существует. Варианты: `"present"` ← (по умолчанию) `"absent"`
status string	Включена или отключена группа пользователей. Варианты: `"enabled"` ← (по умолчанию) `"disabled"`
tag_filters list / элементы=dictionary	Разрешения на основе тегов, назначаемые группе
host_group string / обязательный	Имя группы узлов сети, для которой нужно добавить разрешение.
tag string	Имя тега. По умолчанию: `""`
value string	Значение тега. По умолчанию: `""`
templategroup_rights list / элементы=dictionary	Разрешения для групп шаблонов, назначаемые группе пользователей Для версий Zabbix >= 7.0
permission string / обязательный	Уровень доступа к группе шаблонов. Варианты: `"denied"` `"read-only"` `"read-write"`
template_group string / обязательный	Имя группы шаблонов, для которой нужно добавить разрешение.
userdirectory string	Каталог пользователей для аутентификации, если для gui_access задано значение LDAP или System default. Для версий Zabbix >= 7.0

Примеры

# 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 => 7.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
    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 string	Результат операции Возвращается: всегда Пример: `"User group created: ACME, ID: 42"`
state string	Состояние группы пользователей после завершения выполнения. Возвращается: при успешном выполнении Пример: `"present"`
usergroup string	Имя группы пользователей. Возвращается: при успешном выполнении Пример: `"ACME"`
usrgrpid string	Идентификатор группы пользователей, если она была создана, изменена или удалена. Возвращается: при успешном выполнении Пример: `"42"`

Авторы

Tobias Birkefeld (@tcraxs)

Ссылки на коллекцию

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