Модуль theforeman.foreman.hostgroup_info — Получение информации о группе(группах) хостов

Примечание

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

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

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

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

Новая версия в theforeman.foreman 3.9.0

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

Описание

Получение информации о группе(группах) хостов

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

requests

Параметры

Параметр	Комментарии
location строка	Метка местоположения для сужения поиска.
name строка	Имя ресурса, для которого необходимо получить информацию. Взаимоисключающие с search.
organization строка	Имя организации для сужения поиска.
password строка / обязательно	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, используется значение переменной окружения `FOREMAN_PASSWORD`.
search строка	Запрос поиска. Если None, и name не задан, возвращаются все ресурсы. Взаимоисключающие с name.
server_url строка / обязательно	URL сервера Foreman. Если значение не указано в задаче, используется значение переменной окружения `FOREMAN_SERVER_URL`.
username строка / обязательно	Имя пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, используется значение переменной окружения `FOREMAN_USERNAME`.
validate_certs логическое	Нужно ли проверять сертификаты TLS сервера Foreman. Если значение не указано в задаче, используется значение переменной окружения `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

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