Модуль community.general.ipa_otpconfig – Управление настройками конфигурации FreeIPA OTP

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

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

Для установки используйте: ansible-galaxy collection install community.general.

Для использования в playbook, укажите: community.general.ipa_otpconfig.

Новое в community.general 2.5.0

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

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

Изменение глобальных настроек конфигурации сервера FreeIPA в отношении OTP (одноразовые пароли).

Параметры

Параметр	Комментарии
ipa_host string	IP-адрес или имя хоста сервера IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `IPA_HOST`. Если и переменная окружения `IPA_HOST`, и значение не указаны в задаче, то для обнаружения сервера FreeIPA будет использоваться DNS. Необходимая запись в FreeIPA – это запись `ipa-ca`. Если нет ни записи DNS, ни переменной окружения `IPA_HOST`, ни значения в задаче, то будет использовано значение по умолчанию. По умолчанию: `"ipa.example.com"`
ipa_pass string	Пароль административного пользователя. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `IPA_PASS`. Обратите внимание, что если библиотека `urllib_gssapi` доступна, можно использовать GSSAPI для аутентификации в FreeIPA. Если переменная окружения `KRB5CCNAME` доступна, модуль будет использовать этот кеш учетных данных Kerberos для аутентификации на сервере FreeIPA. Если переменная окружения `KRB5_CLIENT_KTNAME` доступна, и `KRB5CCNAME` нет; модуль будет использовать этот ключ Kerberos для аутентификации. Если GSSAPI недоступен, требуется использование `ipa_pass`.
ipa_port integer	Порт сервера FreeIPA / IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `IPA_PORT`. Если и переменная окружения `IPA_PORT`, и значение не указаны в задаче, то устанавливается значение по умолчанию. По умолчанию: `443`
ipa_prot string	Протокол, используемый сервером IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `IPA_PROT`. Если и переменная окружения `IPA_PROT`, и значение не указаны в задаче, то устанавливается значение по умолчанию. Варианты: `"http"` `"https"` ← (по умолчанию)
ipa_timeout integer	Указывает время ожидания простоя (в секундах) для соединения. Для массовых операций может потребоваться увеличить это значение, чтобы избежать тайм-аута со стороны сервера IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `IPA_TIMEOUT`. Если и переменная окружения `IPA_TIMEOUT`, и значение не указаны в задаче, то устанавливается значение по умолчанию. По умолчанию: `10`
ipa_user string	Административная учетная запись, используемая на сервере IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `IPA_USER`. Если и переменная окружения `IPA_USER`, и значение не указаны в задаче, то устанавливается значение по умолчанию. По умолчанию: `"admin"`
ipatokenhotpauthwindow псевдонимы: hotpauthwindow integer	Окно аутентификации HOTP в количестве шагов.
ipatokenhotpsyncwindow псевдонимы: hotpsyncwindow integer	Окно синхронизации HOTP в шагах.
ipatokentotpauthwindow псевдонимы: totpauthwindow integer	Окно аутентификации TOTP в секундах.
ipatokentotpsyncwindow псевдонимы: totpsyncwindow integer	Окно синхронизации TOTP в секундах.
validate_certs boolean	Это применимо только если `ipa_prot` равно `https`. Если установлено в `false`, SSL-сертификаты проверяться не будут. Это следует устанавливать только в `false` используемых на лично контролируемых сайтах с самозаверяющими сертификатами. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз о внесённых изменениях без модификации целевого объекта.
diff_mode	Поддержка: отсутствует	В режиме diff возвращает подробности о внесённых изменениях (или возможных изменениях в `check_mode`).

Примеры

- name: Ensure the TOTP authentication window is set to 300 seconds
  community.general.ipa_otpconfig:
    ipatokentotpauthwindow: '300'
    ipa_host: localhost
    ipa_user: admin
    ipa_pass: supersecret

- name: Ensure the TOTP synchronization window is set to 86400 seconds
  community.general.ipa_otpconfig:
    ipatokentotpsyncwindow: '86400'
    ipa_host: localhost
    ipa_user: admin
    ipa_pass: supersecret

- name: Ensure the HOTP authentication window is set to 10 hops
  community.general.ipa_otpconfig:
    ipatokenhotpauthwindow: '10'
    ipa_host: localhost
    ipa_user: admin
    ipa_pass: supersecret

- name: Ensure the HOTP synchronization window is set to 100 hops
  community.general.ipa_otpconfig:
    ipatokenhotpsyncwindow: '100'
    ipa_host: localhost
    ipa_user: admin
    ipa_pass: supersecret

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

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

Ключ	Описание
otpconfig словарь	Настройка OTP, возвращаемая API IPA. Возвращается: всегда

Авторы

justchris1 (@justchris1)

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

© 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/general/ipa_otpconfig_module.html