theforeman.foreman.setting модуль — Управление настройками

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: theforeman.foreman.setting.

Новое в theforeman.foreman 1.0.0

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

Описание

Управление настройками

Псевдонимы: foreman_setting

Требования

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

requests

Параметры

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

Атрибуты

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

Примечания

Примечание

Чтобы получить список возможных настроек для вашей установки, используйте модуль theforeman.foreman.setting_info или команду hammer settings list, и найдите атрибут name.
Веб-интерфейс по умолчанию отображает атрибут full_name, который нельзя использовать с этим модулем.

Примеры

- name: "Set a Setting"
  theforeman.foreman.setting:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "http_proxy"
    value: "http://localhost:8088"

- name: "Reset a Setting"
  theforeman.foreman.setting:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "http_proxy"

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

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

Ключ	Описание
entity словарь	Конечное состояние затронутых сущностей, сгруппированных по их типу. Возвращается: успех
settings список / элементы=словарь	Список настроек. Возвращается: успех
foreman_setting словарь	Созданное/обновлённое состояние настройки (устарело) Возвращается: успех

Авторы

Matthias M Dellweg (@mdellweg) ATIX AG

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

© 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_module.html