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

Примечание

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

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

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

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

Добавлена в theforeman.foreman 2.1.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 domain"
  theforeman.foreman.domain_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "example.com"

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

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

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

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

Авторы

Eric Helms (@ehelms)

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

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