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

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: theforeman.foreman.setting_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 setting"
  theforeman.foreman.setting_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "http_proxy"

- name: "Show all settings with proxy"
  theforeman.foreman.setting_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    search: "name = proxy"

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

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

Ключ	Описание
setting словарь	Подробная информация о найденной настройке Возвращается: при успехе и передаче параметра name
settings список / элементы=словарь	Список всех найденных настроек и их подробностей Возвращается: при успехе и передаче параметра 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/setting_info_module.html