community.zabbix.zabbix_user – Создание/обновление/удаление пользователей Zabbix
Примечание
Этот плагин является частью коллекции community.zabbix (версия 1.2.0).
Для его установки используйте: ansible-galaxy collection install community.zabbix
Для использования в плейбуке укажите: community.zabbix.zabbix_user
Обзор
- Этот модуль позволяет создавать, изменять и удалять пользователей Zabbix.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- zabbix-api >= 0.5.4
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| after_login_url строка | Значение по умолчанию: "" | URL страницы, на которую будет перенаправлен пользователь после входа в систему. | ||
| alias строка / обязательно | Имя псевдонима пользователя в Zabbix. alias является уникальным идентификатором и не может быть обновлен с помощью этого модуля. | |||
| autologin логическое |
| Включить авторизацию при входе. Если включен autologin, нельзя включить autologout. | ||
| autologout строка | Значение по умолчанию: "0" | Срок действия сеанса пользователя в секундах. Если установлено 0, сеанс никогда не истекает. Если включен autologout, нельзя включить autologin. | ||
| http_login_password строка | Пароль для базовой аутентификации. | |||
| http_login_user строка | Имя пользователя для базовой аутентификации. | |||
| lang строка |
| Код языка пользователя. default можно использовать с версией Zabbix 5.2 или выше. | ||
| login_password строка / обязательно | Пароль пользователя Zabbix. | |||
| login_user строка / обязательно | Имя пользователя Zabbix. | |||
| name строка | Значение по умолчанию: "" | Имя пользователя. | ||
| override_passwd логическое |
| Переопределить пароль для пользователя. Пароль не будет обновлён при последующих запусках без установки этого значения в да. | ||
| passwd строка | Пароль пользователя. Требуется, если не все usrgrps настроены на использование LDAP в качестве переднего доступа. Всегда требуется для версий Zabbix ниже 4.0. | |||
| refresh строка | Значение по умолчанию: "30" | Период автоматического обновления в секундах. | ||
| role_name строка добавлен в 1.2.0 community.zabbix | Значение по умолчанию: "Роль пользователя" | Роль пользователя.
role_name требуется, если версия Zabbix 5.2 или выше. | ||
| rows_per_page строка | Значение по умолчанию: "50" | Количество строк объектов на странице. | ||
| server_url строка / обязательно | URL сервера Zabbix, с протоколом (http или https). url является псевдонимом для server_url. алиасы: url | |||
| state строка |
| Состояние пользователя. В случае present, он будет создан, если пользователь не существует, или обновлён, если связанные данные отличаются.В случае absent, пользователь будет удалён, если он существует. | ||
| surname строка | Значение по умолчанию: "" | Фамилия пользователя. | ||
| theme строка |
| Тема пользователя. | ||
| timeout целое число | Значение по умолчанию: 10 | Время ожидания запроса API (секунды). | ||
| timezone строка добавлен в 1.2.0 community.zabbix | Значение по умолчанию: "default" | Часовой пояс пользователя.
timezone можно использовать с версией Zabbix 5.2 или выше. Полный список поддерживаемых часовых поясов см. на https://www.php.net/manual/en/timezones.php | ||
| type строка |
| Тип пользователя.
type необходим, если версия Zabbix 5.0 или ниже. | ||
| user_medias список / элементы=словарь | Установить средства связи пользователя. Если не установлено, изменения в средствах связи не вносятся. | |||
| active логическое |
| Включена ли связь. | ||
| mediatype строка | Значение по умолчанию: "Электронная почта" | Имя типа оповещения. | ||
| period строка | Значение по умолчанию: "1-7,00:00-24:00" | Время отправки уведомлений в виде периода времени или макросов пользователя, разделенных точкой с запятой. Для получения дополнительной информации о поддерживаемых периодах времени, пожалуйста, обратитесь к документации. https://www.zabbix.com/documentation/4.0/manual/appendix/time_period | ||
| sendto строка / обязательно | Адрес, имя пользователя или другой идентификатор получателя. | |||
| severity словарь | Значение по умолчанию: {"average": true, "disaster": true, "high": true, "information": true, "not_classified": true, "warning": true} | Уровни триггеров для отправки уведомлений. | ||
| average логическое |
| Включить/выключить уведомления по среднему уровню. | ||
| disaster логическое |
| Включить/выключить уведомления по катастрофическому уровню. | ||
| high логическое |
| Включить/выключить уведомления по высокому уровню. | ||
| information логическое |
| Включить/выключить уведомления по информационному уровню. | ||
| not_classified логическое |
| Включить/выключить уведомления по неклассифицированному уровню. | ||
| warning логическое |
| Включить/выключить уведомления по предупреждающему уровню. | ||
| usrgrps список / элементы=строка | Группы пользователей, к которым добавить пользователя. Требуется, когда state=present. | |||
| validate_certs логическое |
| Если установлено в значение False, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых вами лично, с использованием самоподписанных сертификатов. | ||
Примечания
Примечание
- Если вы используете login_password=zabbix, слово «zabbix» заменяется «****» во всех выводах модуля, потому что login_password использует
no_log. См. эту страницу FAQ для получения дополнительной информации.
Примеры
- name: create a new zabbix user.
community.zabbix.zabbix_user:
server_url: "http://zabbix.example.com/zabbix/"
login_user: Admin
login_password: secret
alias: 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
period: 1-7,00:00-24:00
severity:
not_classified: no
information: yes
warning: yes
average: yes
high: yes
disaster: yes
active: no
type: Zabbix super admin
state: present
- name: delete existing zabbix user.
community.zabbix.zabbix_user:
server_url: "http://zabbix.example.com/zabbix/"
login_user: admin
login_password: secret
alias: example
usrgrps:
- Guests
passwd: password
user_medias:
- sendto: example@example.com
state: absent
Возвращаемые значения
Общие значения возвращаемых значений документированы здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращено | Описание |
|---|---|---|
| user_ids словарь | успех | Созданный или измененный идентификатор пользователя Пример: {'userids': ['5']} |
Авторы
- sky-joker (@sky-joker)
© 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_user_module.html
