Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в плейбуке укажите: 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

строка

Пароль Basic Auth

http_login_user

строка

Логин Basic Auth

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

string

Директория пользователя для аутентификации, когда 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

string

Результат операции

Возвращаемое значение: всегда

Пример: "User group created: ACME, ID: 42"

state

string

Состояние группы пользователей по окончании выполнения.

Возвращаемое значение: при успехе

Пример: "present"

usergroup

string

Имя группы пользователей.

Возвращаемое значение: при успехе

Пример: "ACME"

usrgrpid

string

ID группы пользователей, если она была создана, изменена или удалена.

Возвращаемое значение: при успехе

Пример: "42"

Авторы

  • Tobias Birkefeld (@tcraxs)

Ссылки на сборку

  • Система отслеживания задач
  • Главная страница
  • Репозиторий (источники)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API