Модуль community.general.ipa_vault – управление хранилищами FreeIPA

Примечание

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

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

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

Чтобы использовать её в плейбуке, укажите: community.general.ipa_vault.

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

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

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

Параметры

Параметр	Комментарии
cn псевдонимы: name строка / обязательный	Имя хранилища. Не может быть изменено, так как является уникальным идентификатором.
description строка	Описание.
ipa_host строка	IP-адрес или имя узла сервера IPA. Если значение не указано в задаче, вместо него используется значение переменной окружения `IPA_HOST`. Если в задаче не указаны ни переменная окружения `IPA_HOST`, ни значение, для обнаружения сервера FreeIPA используется DNS. Необходимая запись в FreeIPA — это запись `ipa-ca`. Если запись DNS, переменная окружения `IPA_HOST` и значение не указаны в задаче, используется значение по умолчанию. По умолчанию: `"ipa.example.com"`
ipa_pass строка	Пароль административного пользователя. Если значение не указано в задаче, вместо него используется значение переменной окружения `IPA_PASS`. Обратите внимание: если доступна библиотека `urllib_gssapi`, для аутентификации в FreeIPA можно использовать GSSAPI. Если доступна переменная окружения `KRB5CCNAME`, модуль использует указанный в ней кэш учётных данных Kerberos для аутентификации на сервере FreeIPA. Если доступна переменная окружения `KRB5_CLIENT_KTNAME`, а `KRB5CCNAME` — нет, модуль использует указанный в ней файл keytab Kerberos для аутентификации. Если GSSAPI недоступен, необходимо использовать `ipa_pass`.
ipa_port целое число	Порт сервера FreeIPA / IPA. Если значение не указано в задаче, вместо него используется значение переменной окружения `IPA_PORT`. Если в задаче не указаны ни переменная окружения `IPA_PORT`, ни значение, устанавливается значение по умолчанию. По умолчанию: `443`
ipa_prot строка	Протокол, используемый сервером IPA. Если значение не указано в задаче, вместо него используется значение переменной окружения `IPA_PROT`. Если в задаче не указаны ни переменная окружения `IPA_PROT`, ни значение, устанавливается значение по умолчанию. Варианты: `"http"` `"https"` ← (по умолчанию)
ipa_timeout целое число	Задает время ожидания простоя соединения (в секундах). Для массовых операций это значение можно увеличить, чтобы избежать тайм-аута со стороны сервера IPA. Если значение не указано в задаче, вместо него используется значение переменной окружения `IPA_TIMEOUT`. Если в задаче не указаны ни переменная окружения `IPA_TIMEOUT`, ни значение, устанавливается значение по умолчанию. По умолчанию: `10`
ipa_user строка	Административная учётная запись, используемая на сервере IPA. Если значение не указано в задаче, вместо него используется значение переменной окружения `IPA_USER`. Если в задаче не указаны ни переменная окружения `IPA_USER`, ни значение, устанавливается значение по умолчанию. По умолчанию: `"admin"`
ipavaultpublickey псевдонимы: vault_public_key строка	Открытый ключ.
ipavaultsalt псевдонимы: vault_salt строка	Соль хранилища.
ipavaulttype псевдонимы: vault_type строка	Типы хранилищ определяются уровнем безопасности. Варианты: `"asymmetric"` `"standard"` `"symmetric"` ← (по умолчанию)
replace логическое значение	Принудительно заменить существующее хранилище на сервере IPA. Варианты: `false` ← (по умолчанию) `true`
service строка	Любая служба может владеть одним или несколькими хранилищами служб. Взаимоисключающий параметр с `user`.
state строка	Требуемое состояние. Варианты: `"absent"` `"present"` ← (по умолчанию)
username псевдонимы: user список / элементы=строка	Любой пользователь может владеть одним или несколькими пользовательскими хранилищами. Взаимоисключающий параметр с `service`.
validate_certs логическое значение	Проверять сертификаты сервера IPA. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примечания

Примечание

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

Примеры

- name: Ensure vault is present
  community.general.ipa_vault:
    name: vault01
    vault_type: standard
    user: user01
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure vault is present for Admin user
  community.general.ipa_vault:
    name: vault01
    vault_type: standard
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure vault is absent
  community.general.ipa_vault:
    name: vault01
    vault_type: standard
    user: user01
    state: absent
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Modify vault if already exists
  community.general.ipa_vault:
    name: vault01
    vault_type: standard
    description: "Vault for test"
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret
    replace: true

- name: Get vault info if already exists
  community.general.ipa_vault:
    name: vault01
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

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

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

Ключ	Описание
vault словарь	Хранилище, возвращенное API IPA. Возвращается: всегда

Авторы

Juan Manuel Parrilla (@jparrill)

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

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