модуль theforeman.foreman.hostgroup_info — получение информации о группах узлов

Примечание

Этот модуль входит в коллекцию theforeman.foreman (версия 5.11.0).

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

Для установки используйте: ansible-galaxy collection install theforeman.foreman. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: theforeman.foreman.hostgroup_info.

Добавлено в theforeman.foreman 3.9.0

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

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

Получение информации о группах узлов

Требования

Следующие требования необходимы на узле, на котором выполняется этот модуль.

requests

Параметры

Параметр	Комментарии
ca_path путь	Файл в формате PEM, содержащий сертификат CA для проверки. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `FOREMAN_CA_PATH`.
location строка	Метка расположения, по которому следует ограничить поиск.
name строка	Имя ресурса, сведения о котором необходимо получить. Взаимоисключающий параметр с search.
oauth1_consumer_key строка	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret строка	Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `FOREMAN_OAUTH1_CONSUMER_SECRET`.
organization строка	Имя организации, по которой следует ограничить поиск.
password строка	Пароль пользователя, подключающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `FOREMAN_PASSWORD`.
search строка	Используемый поисковый запрос Если значение равно None и параметр name не задан, возвращаются все ресурсы. Взаимоисключающий параметр с name.
server_url строка / обязательный	URL сервера Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `FOREMAN_SERVER_URL`.
use_gssapi логическое значение	Использовать GSSAPI для аутентификации; обычно это применяется для Kerberos или Kerberos через аутентификацию Negotiate. Требуется установить библиотеку Python requests-gssapi. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `FOREMAN_USE_GSSAPI`. Варианты: `false` ← (по умолчанию) `true`
username строка	Имя пользователя, подключающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `FOREMAN_USERNAME`.
validate_certs логическое значение	Проверять ли TLS-сертификаты сервера Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Модуль можно запустить в режиме check_mode; он вернёт прогноз статуса изменений, не изменяя сущность
diff_mode	Поддержка: полная	В режиме diff будут возвращены сведения об изменениях (или о возможных изменениях в режиме check_mode)

Примеры

- name: "Show a hostgroup"
  theforeman.foreman.hostgroup_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "Default Hostgroup"

- name: "Show all hostgroups with 'name ~ Default'"
  theforeman.foreman.hostgroup_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    search: "name ~ Default"

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

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

Ключ	Описание
hostgroup словарь	Сведения о найденной группе узлов Возвращается: при успехе, если был передан параметр name
hostgroups список / элементы=словарь	Список всех найденных групп узлов и сведения о них Возвращается: при успехе, если был передан параметр search

Авторы

Louis Tiches (@TheRedGreek)

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

© 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/theforeman/foreman/hostgroup_info_module.html