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

Примечание

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

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

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

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

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

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

Добавление, изменение, включение, отключение и удаление легковесных подчиненных центров сертификации IPA с использованием API IPA.

Параметры

Параметр	Комментарии
ipa_host string	IP-адрес или имя хоста сервера IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `IPA_HOST`. Если и переменная окружения `IPA_HOST`, и значение не указаны в задаче, то будет использоваться DNS для попытки обнаружения сервера FreeIPA. Необходимая запись в 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"`
state string	Состояние, которое необходимо обеспечить. Состояния «disable» и «enable» доступны для версии FreeIPA 4.4.2 и выше. Варианты: `"absent"` `"disabled"` `"enabled"` `"present"` ← (по умолчанию)
subca_desc string	Описание подчиненного центра сертификации.
subca_name псевдонимы: name string / обязательно	Имя подчиненного центра сертификации, которым необходимо управлять.
subca_subject string / обязательно	Тема подчиненного центра сертификации. Например, ‘CN=SampleSubCA1,O=testrelm.test’.
validate_certs boolean	Это применимо только если `ipa_prot` равно `https`. Если установлено значение `false`, сертификаты SSL проверяться не будут. Это следует устанавливать в значение `false` только на лично контролируемых сайтах, использующих самозаверяющие сертификаты. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: Ensure IPA Sub CA is present
  community.general.ipa_subca:
    ipa_host: spider.example.com
    ipa_pass: Passw0rd!
    state: present
    subca_name: AnsibleSubCA1
    subca_subject: 'CN=AnsibleSubCA1,O=example.com'
    subca_desc: Ansible Sub CA

- name: Ensure that IPA Sub CA is removed
  community.general.ipa_subca:
    ipa_host: spider.example.com
    ipa_pass: Passw0rd!
    state: absent
    subca_name: AnsibleSubCA1

- name: Ensure that IPA Sub CA is disabled
  community.general.ipa_subca:
    ipa_host: spider.example.com
    ipa_pass: Passw0rd!
    state: disable
    subca_name: AnsibleSubCA1

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

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

Ключ	Описание
subca словарь	Запись IPA Sub CA, возвращаемая API IPA. Возвращается: всегда

Авторы

Abhijeet Kasurde (@Akasurde)

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

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