Spec-Zone.ru › Ansible

community.zabbix.zabbix_user модуль — Создание/обновление/удаление пользователей Zabbix

Примечание

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

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

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

Для использования в книге задач укажите: community.zabbix.zabbix_user.

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

Описание

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

Требования

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

  • python >= 3.9

Параметры

Параметр

Комментарии

after_login_url

строка

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

autologin

булево

Включить автологин.

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

Выбор:

  • false
  • true

autologout

строка

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

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

current_passwd

строка

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

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

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

http_login_password

строка

Пароль авторизации Basic.

http_login_user

строка

Логин авторизации Basic.

lang

строка

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

Выбор:

  • "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

строка

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

override_passwd

булево

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

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

Выбор:

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

passwd

строка

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

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

refresh

строка

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

role_name

строка

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

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

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

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

rows_per_page

строка

Количество строк объектов, отображаемых на странице.

state

строка

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

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

В absent будет удалён пользователь, если он существует.

Выбор:

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

surname

строка

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

theme

строка

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

Выбор:

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

timezone

строка

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

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

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

user_medias

список / элементы=словарь

Настройка каналов пользователя.

Если не задано, каналы не будут изменены.

active

булево

Включить канал.

Выбор:

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

mediatype

строка

Название типа канала.

По умолчанию: "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 / обязательно

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

Имя пользователя является уникальным идентификатором и не может быть обновлено с помощью данного модуля.

usrgrps

list / elements=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: no
    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: no
          information: yes
          warning: yes
          average: yes
          high: yes
          disaster: yes
        active: no
    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

Идентификатор пользователя, созданный или измененный

Возвращается: success

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

Авторы

  • sky-joker (@sky-joker)

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

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

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

Spec-Zone.ru

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