Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

  • Этот модуль позволяет создавать, изменять и удалять пользователей Zabbix.

Требования

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

  • python >= 3.9

Параметры

Параметр

Комментарии

after_login_url

string

URL страницы, на которую перенаправляется пользователь после входа в систему.

autologin

boolean

Включить ли автоматический вход в систему.

Если включён автоматический вход, автоматический выход включить нельзя.

Варианты:

  • false
  • true

autologout

string

Время жизни сеанса пользователя в секундах. Если указать 0, срок действия сеанса не истечёт.

Если включён автоматический выход, автоматический вход включить нельзя.

current_passwd

string

Текущий пароль пользователя при переопределении его пароля.

Обязателен при переопределении пароля вошедшего в систему пользователя.

https://www.zabbix.com/documentation/6.4/en/manual/api/reference/user/update

http_login_password

string

Пароль для базовой аутентификации

http_login_user

string

Имя пользователя для базовой аутентификации

lang

string

Код языка пользователя.

Варианты:

  • "en_GB"
  • "en_US"
  • "zh_CN"
  • "cs_CZ"
  • "fr_FR"
  • "he_IL"
  • "it_IT"
  • "ko_KR"
  • "ja_JP"
  • "nb_NO"
  • "pl_PL"
  • "pt_BR"
  • "pt_PT"
  • "ru_RU"
  • "sk_SK"
  • "tr_TR"
  • "uk_UA"
  • "default"

name

string

Имя пользователя.

override_passwd

boolean

Переопределить пароль пользователя.

При последующих запусках пароль не будет обновляться, если не установить для этого параметра значение yes.

Варианты:

  • false ← (по умолчанию)
  • true

passwd

string

Пароль пользователя.

Обязателен, если ни одна из групп usrgrps не настроена на использование LDAP для доступа к интерфейсу.

refresh

string

Интервал автоматического обновления в секундах.

role_name

string

добавлено в community.zabbix 1.2.0

Роль пользователя.

При создании нового пользователя по умолчанию используется User role.

Значение по умолчанию будет удалено в версии 2.0.0.

rows_per_page

string

Количество строк объектов на странице.

state

string

Состояние пользователя.

При значении present пользователь будет создан, если он не существует, или обновлён, если связанные с ним данные отличаются.

При значении absent существующий пользователь будет удалён.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

surname

string

Фамилия пользователя.

theme

string

Тема оформления пользователя.

Варианты:

  • "default"
  • "blue-theme"
  • "dark-theme"

timezone

string

добавлено в community.zabbix 1.2.0

Часовой пояс пользователя.

Полный список поддерживаемых часовых поясов см. в https://www.php.net/manual/en/timezones.php

user_medias

list / elements=dictionary

Задать способы оповещения пользователя.

Если параметр не задан, способы оповещения не изменяются.

active

boolean

Включён ли способ оповещения.

Варианты:

  • false
  • true ← (по умолчанию)

mediatype

string

Название задаваемого типа способа оповещения.

По умолчанию: "Email"

period

string

Время отправки уведомлений, задаваемое как период времени или макросы пользователя, разделённые точкой с запятой.

Дополнительные сведения о поддерживаемых периодах времени см. в документации.

https://www.zabbix.com/documentation/current/en/manual/appendix/time_period

По умолчанию: "1-7,00:00-24:00"

sendto

any / обязательно

Адрес, имя пользователя или другой идентификатор получателя.

Если mediatype имеет значение Email, значения представлены в виде массива. Для других типов способов оповещения значение представлено в виде строки.

severity

dictionary

Уровни серьёзности триггеров, о которых следует отправлять уведомления.

По умолчанию: {"average": true, "disaster": true, "high": true, "information": true, "not_classified": true, "warning": true}

average

boolean

Включить или отключить уровень серьёзности «Средний».

Варианты:

  • false
  • true ← (по умолчанию)

disaster

boolean

Включить или отключить уровень серьёзности «Катастрофа».

Варианты:

  • false
  • true ← (по умолчанию)

high

boolean

Включить или отключить высокий уровень серьёзности.

Варианты:

  • false
  • true ← (по умолчанию)

information

boolean

Включение/отключение уровня важности «Информация».

Варианты:

  • false
  • true ← (по умолчанию)

not_classified

boolean

Включение/отключение уровня важности «Не классифицировано».

Варианты:

  • false
  • true ← (по умолчанию)

warning

boolean

Включение/отключение уровня важности «Предупреждение».

Варианты:

  • false
  • true ← (по умолчанию)

username

string / обязательный

Имя пользователя.

username — уникальный идентификатор, который нельзя изменить с помощью этого модуля.

usrgrps

list / элементы=string

Группы пользователей, в которые нужно добавить пользователя.

Обязательно, если state=present.

Примеры

# 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

- name: create a new zabbix user.
  # 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:
    username: example
    name: user name
    surname: user surname
    usrgrps:
      - Guests
      - Disabled
    passwd: password
    lang: en_GB
    theme: blue-theme
    autologin: false
    autologout: "0"
    refresh: "30"
    rows_per_page: "200"
    after_login_url: ""
    user_medias:
      - mediatype: Email
        sendto:
          - example@example.com
          - example1@example.com
        period: 1-7,00:00-24:00
        severity:
          not_classified: false
          information: true
          warning: true
          average: true
          high: true
          disaster: true
        active: false
    state: present

- name: delete existing zabbix user.
  # 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:
    username: example
    state: absent

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

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

Ключ

Описание

user_ids

dictionary

Идентификатор созданного или изменённого пользователя

Возвращается: при успешном выполнении

Пример: {"userids": ["5"]}

Авторы

  • sky-joker (@sky-joker)

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

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

© 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_user_module.html

Spec-Zone.ru

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