Модуль theforeman.foreman.host_info – Получение информации о хостах

Примечание

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

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

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

Для использования в плейбуке укажите: theforeman.foreman.host_info.

Новое в theforeman.foreman 2.0.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 host"
  theforeman.foreman.host_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "host.example.com"

- name: "Show all hosts with domain example.com"
  theforeman.foreman.host_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    search: "domain = example.com"

Значения возврата

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

Ключ	Описание
host словарь	Подробная информация о найденном хосте Возвращается: при успехе и указании name
hosts список / элементы=словарь	Список всех найденных хостов и их подробностей Возвращается: при успехе и указании search

Авторы

Evgeni Golov (@evgeni)

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

© 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/host_info_module.html