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

Примечание

Этот модуль входит в коллекцию theforeman.foreman (версия 5.11.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

Параметры

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

Атрибуты

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

Примечания

Примечание

Чтобы получить список доступных для вашей установки настроек, используйте модуль 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/theforeman/foreman/setting_module.html