Модуль community.general.ipa_hostgroup – управление группами узлов FreeIPA

Примечание

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

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

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

Чтобы использовать её в плейбуке, укажите: community.general.ipa_hostgroup.

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

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

Добавление, изменение и удаление группы узлов IPA с помощью API IPA.

Параметры

Параметр	Комментарии
append логический добавлено в community.general 6.6.0	Если `true`, добавляет перечисленные `host` в `hostgroup`. Если `false`, в `hostgroup` задаётся только перечисленный `host`, а все остальные узлы удаляются. Варианты: `false` ← (по умолчанию) `true`
cn псевдонимы: name строка / обязательный	Имя группы узлов. Его нельзя изменить, поскольку оно является уникальным идентификатором.
description строка	Описание.
host список / элементы=строка	Список узлов, входящих в группу узлов. Если передан пустой список, все узлы удаляются из группы. Если параметр не указан, узлы не проверяются и не изменяются. Если параметр указан, все назначенные узлы, которые не перечислены в нём, исключаются из группы.
hostgroup список / элементы=строка	Список групп узлов, входящих в эту группу узлов. Если передан пустой список, все группы узлов удаляются из группы. Если параметр не указан, группы узлов не проверяются и не изменяются. Если параметр указан, все назначенные группы узлов, которые не перечислены в нём, исключаются из группы.
ipa_host строка	IP-адрес или имя узла сервера IPA. Если значение не указано в задаче, вместо него используется значение переменной окружения `IPA_HOST`. Если в задаче не указаны ни переменная окружения `IPA_HOST`, ни значение параметра, для обнаружения сервера FreeIPA используется DNS. В FreeIPA необходима соответствующая запись `ipa-ca`. Если в задаче недоступны ни запись DNS, ни переменная окружения `IPA_HOST`, ни значение параметра, используется значение по умолчанию. По умолчанию: `"ipa.example.com"`
ipa_pass строка	Пароль административного пользователя. Если значение не указано в задаче, вместо него используется значение переменной окружения `IPA_PASS`. Обратите внимание: если доступна библиотека `urllib_gssapi`, для аутентификации в FreeIPA можно использовать GSSAPI. Если переменная окружения `KRB5CCNAME` доступна, модуль использует указанный в ней кэш учётных данных Kerberos для аутентификации на сервере FreeIPA. Если переменная окружения `KRB5_CLIENT_KTNAME` доступна, а `KRB5CCNAME` — нет, модуль использует указанный в ней файл keytab Kerberos для аутентификации. Если GSSAPI недоступен, необходимо использовать `ipa_pass`.
ipa_port целое число	Порт сервера FreeIPA / IPA. Если значение не указано в задаче, вместо него используется значение переменной окружения `IPA_PORT`. Если в задаче не указаны ни переменная окружения `IPA_PORT`, ни значение параметра, устанавливается значение по умолчанию. По умолчанию: `443`
ipa_prot строка	Протокол, используемый сервером IPA. Если значение не указано в задаче, вместо него используется значение переменной окружения `IPA_PROT`. Если в задаче не указаны ни переменная окружения `IPA_PROT`, ни значение параметра, устанавливается значение по умолчанию. Варианты: `"http"` `"https"` ← (по умолчанию)
ipa_timeout целое число	Задаёт время ожидания простоя соединения (в секундах). Для массовых операций это значение можно увеличить, чтобы избежать тайм-аута со стороны сервера IPA. Если значение не указано в задаче, вместо него используется значение переменной окружения `IPA_TIMEOUT`. Если в задаче не указаны ни переменная окружения `IPA_TIMEOUT`, ни значение параметра, устанавливается значение по умолчанию. По умолчанию: `10`
ipa_user строка	Учётная запись администратора, используемая на сервере IPA. Если значение не указано в задаче, вместо него используется значение переменной окружения `IPA_USER`. Если в задаче не указаны ни переменная окружения `IPA_USER`, ни значение параметра, устанавливается значение по умолчанию. По умолчанию: `"admin"`
state строка	Состояние, которое необходимо обеспечить. `"absent"` и `"disabled"` дают одинаковый результат. `"present"` и `"enabled"` дают одинаковый результат. Варианты: `"absent"` `"disabled"` `"enabled"` `"present"` ← (по умолчанию)
validate_certs логический	Применяется только если `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 host-group databases is present
  community.general.ipa_hostgroup:
    name: databases
    state: present
    host:
      - db.example.com
    hostgroup:
      - mysql-server
      - oracle-server
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure host-group databases is absent
  community.general.ipa_hostgroup:
    name: databases
    state: absent
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

Возвращаемые значения

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

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

Авторы

Thomas Krahn (@Nosmoht)

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

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