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

Примечание

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
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"`
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	Поддержка: отсутствует	В режиме сравнения возвращает сведения об изменениях (или об изменениях, которые могут потребоваться в `check_mode`).

Примечания

Примечание

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

Примеры

- 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 dictionary	Запись подчиненного центра сертификации IPA, возвращаемая API IPA. Возвращается: всегда

Авторы

Abhijeet Kasurde (@Akasurde)

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

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