community.general.ipa_service модуль – Управление службой FreeIPA

Примечание

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

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

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

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

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

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

Добавление и удаление службы IPA с использованием API IPA.

Параметры

Параметр	Комментарии
force boolean	Принудительно использовать имя участника, даже если хост отсутствует в DNS. Варианты: `false` `true`
hosts list / elements=string	Определяет список хостов ‘ManagedBy’.
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"`
krbcanonicalname псевдонимы: name string / обязательно	Участник службы. Не может быть изменен, так как является уникальным идентификатором.
skip_host_check boolean добавлено в community.general 4.7.0	Принудительно создать службу, даже если объект хоста для её управления не существует. Это используется только при создании, а не для обновления существующих служб. Варианты: `false` ← (по умолчанию) `true`
state string	Состояние, которое необходимо обеспечить. Варианты: `"absent"` `"present"` ← (по умолчанию)
validate_certs boolean	Это применимо только если `ipa_prot` равно `https`. Если установлено в `false`, SSL-сертификаты не будут проверяться. Это должно быть установлено в `false` только на лично контролируемых сайтах, использующих самозаверяющие сертификаты. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: Ensure service is present
  community.general.ipa_service:
    name: http/host01.example.com
    state: present
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure service is absent
  community.general.ipa_service:
    name: http/host01.example.com
    state: absent
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Changing Managing hosts list
  community.general.ipa_service:
    name: http/host01.example.com
    hosts:
       - host01.example.com
       - host02.example.com
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

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

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

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

Авторы

Cédric Parent (@cprh)

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

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