community.zabbix.zabbix_user – Создание/обновление/удаление пользователей Zabbix
Примечание
Этот плагин входит в коллекцию community.zabbix (версия 1.1.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. Псевдоним — уникальный идентификатор, который нельзя обновить с помощью этого модуля. | |||
| autologin булево |
| Включить авторизацию при входе. Если включен автовход, автовыход отключить нельзя. | ||
| autologout строка | Значение по умолчанию: "0" | Срок действия сеанса пользователя в секундах. Если установлено 0, сеанс никогда не истечет. Если включен автовыход, автовход отключить нельзя. | ||
| http_login_password строка | Пароль аутентификации Basic. | |||
| http_login_user строка | Логин аутентификации Basic. | |||
| lang строка |
| Код языка пользователя. | ||
| login_password строка / обязательно | Пароль пользователя Zabbix. | |||
| login_user строка / обязательно | Имя пользователя Zabbix. | |||
| name строка | Значение по умолчанию: "" | Имя пользователя. | ||
| override_passwd булево |
| Переопределить пароль пользователя. Пароль не будет обновлен при последующих запусках без установки этого значения в «да». | ||
| passwd строка | Пароль пользователя. Требуется, если все usrgrps настроены на использование LDAP для доступа. Всегда требуется для версий Zabbix ниже 4.0. | |||
| refresh строка | Значение по умолчанию: "30" | Автоматический период обновления в секундах. | ||
| rows_per_page строка | Значение по умолчанию: "50" | Количество строк объектов, отображаемых на странице. | ||
| server_url строка / обязательно | URL сервера Zabbix, с протоколом (http или https). url — псевдоним для server_url.псевдонимы: url | |||
| state строка |
| Состояние пользователя. В present, он создаст пользователя, если он не существует, или обновит пользователя, если связанные данные отличаются.В absent он удалит пользователя, если он существует. | ||
| surname строка | Значение по умолчанию: "" | Фамилия пользователя. | ||
| theme строка |
| Тема пользователя. | ||
| timeout целое | Значение по умолчанию: 10 | Таймаут запроса API (секунды). | ||
| type строка |
| Тип пользователя. | ||
| user_medias список / элементы=словарь | Значение по умолчанию: [] | Установить средства пользователя. | ||
| active булево |
| Включено ли средство. | ||
| mediatype строка | Значение по умолчанию: "Email" | Имя типа средства для установки. | ||
| 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 словарь | успех | ID созданного или изменённого пользователя Пример: {'userids': ['5']} |
Авторы
- sky-joker (@sky-joker)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/zabbix/zabbix_user_module.html
