Модуль community.zabbix.zabbix_mfa — создание, обновление и удаление метода MFA Zabbix

Примечание

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

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

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

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

Добавлено в community.zabbix 3.1.0

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

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

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

Требования

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

python >= 3.11

Параметры

Параметр	Комментарии
api_hostname string	Имя хоста API, предоставленное службой аутентификации Duo. Обязательно, если `method_type=duo_universal_prompt`.
client_secret string	Секрет клиента, предоставленный службой аутентификации Duo. Обязательно, если `method_type=duo_universal_prompt`.
clientid string	Идентификатор клиента, предоставленный службой аутентификации Duo. Обязательно, если `method_type=duo_universal_prompt`.
code_length integer	Длина кода подтверждения. Обязательно, если `method_type=totp`. Допустимые значения: `6` `8`
hash_function string	Тип хеш-функции для генерации кодов TOTP. Обязательно, если `method_type=totp`. Допустимые значения: `"sha-1"` `"sha-256"` `"sha-512"`
http_login_password string	Пароль для базовой аутентификации
http_login_user string	Имя пользователя для базовой аутентификации
method_type string	Тип этого метода MFA Допустимые значения: `"totp"` `"duo_universal_prompt"`
name string / обязательный	Название этого метода MFA
state string	Состояние этого MFA. Допустимые значения: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Поддерживается только Zabbix >= 7.0.
Этот модуль возвращает changed=true, если method_type имеет значение duo_universal_prompt, поскольку API Zabbix не возвращает конфиденциальные данные, необходимые модулю для сравнения.

Примеры

# 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 'Zabbix TOTP' MFA method
  # 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_mfa:
    name: Zabbix TOTP
    method_type: totp
    hash_function: sha-1
    code_length: 6

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

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

Ключ	Описание
msg string	Результат операции создания Возвращается: при успешном выполнении Пример: `"Successfully created MFA method"`

Авторы

ONODERA Masaru(@masa-orca)

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

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