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

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
cn aliases: name string / required	Имя хранилища. Не может быть изменено, так как является уникальным идентификатором.
description string	Описание.
ipa_host string	IP-адрес или имя хоста сервера IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `IPA_HOST`. Если и переменная среды `IPA_HOST` и значение не указаны в задаче, то будет использоваться DNS для попытки обнаружения сервера FreeIPA. Необходимая запись в FreeIPA - это запись `ipa-ca`. Если недоступны ни DNS-запись, ни переменная среды `IPA_HOST`, ни значение в задаче, то будет использовано значение по умолчанию. Default: `"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` и значение не указаны в задаче, то будет установлено значение по умолчанию. Default: `443`
ipa_prot string	Протокол, используемый сервером IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `IPA_PROT`. Если и переменная среды `IPA_PROT` и значение не указаны в задаче, то будет установлено значение по умолчанию. Choices: `"http"` `"https"` ← (default)
ipa_timeout integer	Указывает таймаут бездействия (в секундах) для соединения. Для массовых операций может потребоваться увеличить это значение, чтобы избежать тайм-аута со стороны сервера IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `IPA_TIMEOUT`. Если и переменная среды `IPA_TIMEOUT` и значение не указаны в задаче, то будет установлено значение по умолчанию. Default: `10`
ipa_user string	Административная учетная запись, используемая на сервере IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `IPA_USER`. Если и переменная среды `IPA_USER` и значение не указаны в задаче, то будет установлено значение по умолчанию. Default: `"admin"`
ipavaultpublickey aliases: vault_public_key string	Открытый ключ.
ipavaultsalt aliases: vault_salt string	Соль хранилища.
ipavaulttype aliases: vault_type string	Типы хранилищ основаны на уровне безопасности. Choices: `"asymmetric"` `"standard"` `"symmetric"` ← (default)
replace boolean	Принудительно заменить существующее хранилище на сервере IPA. Choices: `false` ← (default) `true`
service string	Любая служба может владеть одним или несколькими хранилищами служб. Взаимоисключающе с user.
state string	Состояние, которое необходимо обеспечить. Choices: `"absent"` `"present"` ← (default)
username aliases: user list / elements=string	Любой пользователь может владеть одним или несколькими хранилищами пользователей. Взаимоисключающе с service.
validate_certs boolean	Проверять сертификаты сервера IPA. Choices: `false` `true` ← (default)

Атрибуты

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

Примеры

- 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 Возвращаемое значение: всегда

Авторы

Хуан Мануэль Парилья (@jparrill)

Ссылки на сборку

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