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

Примечание

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

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

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

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

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

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

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

Получение информации о настройках

Требования

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

requests

Параметры

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

Атрибуты

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

Примеры

- 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 dictionary	Сведения о найденной настройке Возвращается: при успешном выполнении, если передан параметр name
settings list / элементы=dictionary	Список всех найденных настроек и сведений о них Возвращается: при успешном выполнении, если передан параметр search

Авторы

Eric Helms (@ehelms)

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

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