community.zabbix.zabbix_usergroup – Создание/удаление/обновление групп пользователей Zabbix

Примечание

Этот плагин является частью коллекции community.zabbix (версия 1.2.0).

Для его установки используйте: ansible-galaxy collection install community.zabbix.

Для использования в плейбуке укажите: community.zabbix.zabbix_usergroup.

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

Описание

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

zabbix-api >= 0.5.4

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
debug_mode строка		Варианты: disabled ← enabled	Включить или отключить режим отладки.
gui_access строка		Варианты: default ← internal LDAP disable	Метод аутентификации front-end пользователей в группе. Возможные значения: default - использовать системный метод аутентификации; internal - использовать внутреннюю аутентификацию; LDAP - использовать аутентификацию LDAP; disable - отключить доступ к front-end.
http_login_password строка			Пароль Basic Auth
http_login_user строка			Логин Basic Auth
login_password строка / обязательно			Пароль пользователя Zabbix.
login_user строка / обязательно			Имя пользователя Zabbix.
name строка / обязательно			Имя группы пользователей для создания, обновления или удаления. псевдонимы: user_group
rights список / элементы=словарь			Права, которые нужно назначить группе
	host_group строка / обязательно		Имя группы хостов, к которой необходимо добавить права.
	permission строка / обязательно	Варианты: denied read-only read-write	Уровень доступа к группе хостов.
server_url строка / обязательно			URL сервера Zabbix, с протоколом (http или https). `url` - псевдоним для `server_url`. псевдонимы: url
state строка		Варианты: present ← absent	Состояние группы пользователей. В случае `present`, модуль создаст группу, если она не существует, или обновит группу, если связанные данные отличаются. В случае `absent` модуль удалит группу, если она существует.
status строка		Варианты: enabled ← disabled	Группа пользователей включена или выключена.
tag_filters список / элементы=словарь			Права доступа на основе тегов для назначения группе.
	host_group строка / обязательно		Имя группы хостов, к которой необходимо добавить права.
	tag строка	Значение по умолчанию: ""	Имя тега.
	value строка	Значение по умолчанию: ""	Значение тега.
timeout целое число		Значение по умолчанию: 10	Таймаут запроса API (секунды).
validate_certs булево		Варианты: no yes ←	Если значение False, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с самозаверенными сертификатами.

Примечания

Примечание

Поддерживается только Zabbix >= 4.0.
Если вы используете login_password=zabbix, слово “zabbix” заменяется на “****” во всем выводе модуля, потому что login_password использует no_log. Подробнее см. эту страницу FAQ.

Примеры

# Base create user group example
- name: Create user group
  community.zabbix.zabbix_usergroup:
    server_url: "http://zabbix.example.com/zabbix/"
    login_user: admin
    login_password: secret
    name: ACME
    state: present

# Base create user group with disabled gui access
- name: Create user group with disabled gui access
  community.zabbix.zabbix_usergroup:
    server_url: "http://zabbix.example.com/zabbix/"
    login_user: admin
    login_password: secret
    name: ACME
    gui_access: disable

# Base create user group with permissions
- name: Create user group with permissions
  community.zabbix.zabbix_usergroup:
    server_url: "http://zabbix.example.com/zabbix/"
    login_user: admin
    login_password: secret
    name: ACME
    rights:
        - host_group: Webserver
          permission: read-write
        - host_group: Databaseserver
          permission: read-only
    state: present

# Base create user group with tag permissions
- name: Create user group with tag permissions
  community.zabbix.zabbix_usergroup:
    server_url: "http://zabbix.example.com/zabbix/"
    login_user: admin
    login_password: secret
    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
  community.zabbix.zabbix_usergroup:
    server_url: "http://zabbix.example.com/zabbix/"
    login_user: admin
    login_password: secret
    name: ACME
    state: absent

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
msg строка	всегда	Результат операции Пример: Группа пользователей создана: ACME, ID: 42
state строка	при успехе	Состояние группы пользователей по завершении выполнения. Пример: present
usergroup строка	при успехе	Имя группы пользователей. Пример: ACME
usrgrpid строка	при успехе	ID группы пользователей, если она была создана, изменена или удалена. Пример: 42

Авторы

Tobias Birkefeld (@tcraxs)

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