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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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`, для аутентификации в FreeIPA можно использовать GSSAPI. Если доступна переменная среды `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 псевдонимы: name string / обязательный	Уникальный идентификатор токена в IPA.
validate_certs boolean	Применяется только если `ipa_prot` имеет значение `https`. Если установлено значение `false`, SSL-сертификаты не проверяются. Устанавливайте значение `false` только на сайтах под личным управлением, использующих самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)
vendor string	Название производителя токена (только для справки).

Атрибуты

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

Примечания

Примечание

Для связи с сервером FreeIPA этот модуль использует JSON-RPC поверх HTTP(S). Если требуется включить управляемый узел в область FreeIPA, можно рассмотреть коллекцию freeipa.ansible_freeipa, однако для управления развёртыванием необходим доступ к оболочке одного из узлов области.

Примеры

- 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 dictionary	Токен OTP в формате, возвращаемом API IPA. Возвращается: всегда

Авторы

justchris1 (@justchris1)

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

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