Модуль community.general.ipa_hostgroup — Управление группой хостов FreeIPA

Примечание

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

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

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

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

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

Описание

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

Параметры

Параметр	Комментарии
append boolean added in community.general 6.6.0	Если `true`, добавить указанные `host` к `hostgroup`. Если `false`, только указанные `host` будут в `hostgroup`, удалив другие хосты. Варианты: `false` ← (default) `true`
cn aliases: name string / required	Имя группы хостов. Не может быть изменено, так как является уникальным идентификатором.
description string	Описание.
host list / elements=string	Список хостов, принадлежащих группе хостов. Если передан пустой список, все хосты будут удалены из группы. Если параметр опущен, хосты не будут проверяться или изменяться. Если параметр передан, все назначенные хосты, которые не переданы, будут откреплены от группы.
hostgroup list / elements=string	Список групп хостов, которые принадлежат этой группе хостов. Если передан пустой список, все группы хостов будут удалены из группы. Если параметр опущен, группы хостов не будут проверяться или изменяться. Если параметр передан, все назначенные группы хостов, которые не переданы, будут откреплены от группы.
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"` ← (default)
ipa_timeout integer	Указывает таймаут ожидания (в секундах) для соединения. Для массовых операций может потребоваться увеличение этого значения, чтобы избежать таймаута со стороны сервера IPA. Если значение не указано в задаче, будет использовано значение переменной среды `IPA_TIMEOUT`. Если и переменная среды `IPA_TIMEOUT`, и значение не указаны в задаче, будет установлено значение по умолчанию. Значение по умолчанию: `10`
ipa_user string	Административная учетная запись, используемая на сервере IPA. Если значение не указано в задаче, будет использовано значение переменной среды `IPA_USER`. Если и переменная среды `IPA_USER`, и значение не указаны в задаче, будет установлено значение по умолчанию. Значение по умолчанию: `"admin"`
state string	Состояние, которое нужно обеспечить. `"absent"` и `"disabled"` дают одинаковые результаты. `"present"` и `"enabled"` дают одинаковые результаты. Варианты: `"absent"` `"disabled"` `"enabled"` `"present"` ← (default)
validate_certs boolean	Это применимо только если `ipa_prot` равно `https`. Если установлено в `false`, SSL-сертификаты не будут проверены. Это следует устанавливать только в `false` на лично контролируемых сайтах, использующих самозаверяющие сертификаты. Варианты: `false` `true` ← (default)

Атрибуты

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

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/ipa_hostgroup_module.html