Модуль community.general.ipa_otptoken — Управление OTP FreeIPA

Примечание

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

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

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

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

Новое в community.general 2.5.0

Обзор
Параметры
Атрибуты
Примеры
Значения возврата

Обзор

Добавление, изменение и удаление одноразовых паролей в IPA.

Параметры

Параметр	Комментарии
algorithm string	Алгоритм хэширования токена. Примечание: Не может быть изменен после создания OTP. Варианты: `"sha1"` `"sha256"` `"sha384"` `"sha512"`
counter integer	Начальный счетчик для токена HOTP. Примечание: Не может быть изменен после создания OTP.
description string	Описание токена (только для информации).
digits integer	Количество цифр в каждом коде токена. Примечание: Не может быть изменен после создания OTP. Варианты: `6` `8`
enabled boolean	Отметить токен как активный (по умолчанию `true`). Варианты: `false` `true` ← (по умолчанию)
interval integer	Длительность действительности кода токена TOTP в секундах. Примечание: Не может быть изменен после создания 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"`
model string	Модель токена (только для информации).
newuniqueid string	Если указано, то указанный уникальный идентификатор будет изменен на это значение.
notafter string	Последняя дата/время, когда токен может быть использован. В формате `YYYYMMddHHmmss`. Например, `20200121182022` позволит использовать токен до 21 января 2020 года в 18:20:22.
notbefore string	Первая дата/время, когда токен может быть использован. В формате `YYYYMMddHHmmss`. Например, `20180121182022` позволит использовать токен начиная с 21 января 2018 года в 18:20:22.
offset integer	Разница во времени между токеном TOTP и сервером IPA. Примечание: Не может быть изменен после создания OTP.

otptype string	Тип OTP. Примечание: Не может быть изменён после создания OTP. Варианты: `"totp"` `"hotp"`
owner string	Назначенный пользователь токена.
secretkey string	Секретный ключ токена (Base64). Если OTP создан, а этот параметр не указан, IPA сгенерирует случайный секрет. Примечание: Не может быть изменён после создания OTP.
serial string	Серийный номер токена (только для информации).
state string	Состояние для обеспечения. Варианты: `"present"` ← (по умолчанию) `"absent"`
uniqueid aliases: name string / обязательный	Уникальный идентификатор токена в IPA.
validate_certs boolean	Это применимо только если `ipa_prot` равен `https`. Если установлено `false`, сертификаты SSL не будут проверены. Это должно быть установлено только в `false`, используемых на сайтах с личным контролем, использующих самозаверяющие сертификаты. Варианты: `false` `true` ← (по умолчанию)
vendor string	Имя поставщика токена (только для информации).

Атрибуты

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

Примеры

- name: Create a totp for pinky, allowing the IPA server to generate using defaults
  community.general.ipa_otptoken:
    uniqueid: Token123
    otptype: totp
    owner: pinky
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Create a 8 digit hotp for pinky with sha256 with specified validity times
  community.general.ipa_otptoken:
    uniqueid: Token123
    enabled: true
    otptype: hotp
    digits: 8
    secretkey: UMKSIER00zT2T2tWMUlTRmNlekRCbFQvWFBVZUh2dElHWGR6T3VUR3IzK2xjaFk9
    algorithm: sha256
    notbefore: 20180121182123
    notafter: 20220121182123
    owner: pinky
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Update Token123 to indicate a vendor, model, serial number (info only), and description
  community.general.ipa_otptoken:
    uniqueid: Token123
    vendor: Acme
    model: acme101
    serial: SerialNumber1
    description: Acme OTP device
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Disable Token123
  community.general.ipa_otptoken:
    uniqueid: Token123
    enabled: false
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Rename Token123 to TokenABC and enable it
  community.general.ipa_otptoken:
    uniqueid: Token123
    newuniqueid: TokenABC
    enabled: true
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

Значения возврата

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

Ключ	Описание
otptoken словарь	Токен 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_otptoken_module.html