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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в плейбуке, укажите: 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`, ни значение, для обнаружения сервера 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` — нет, модуль использует указанный в ней файл keytab 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	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или о том, что, возможно, необходимо изменить в `check_mode`).

Примечания

Примечание

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

Примеры

- 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 dictionary	Служба в формате, возвращаемом API IPA. Возвращается: всегда

Авторы

Cédric Parent (@cprh)

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

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