Модуль theforeman.foreman.global_parameter – Управление глобальными параметрами

Примечание

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

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

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

Для использования в playbook укажите: theforeman.foreman.global_parameter.

Новое в theforeman.foreman 1.0.0

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

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

Управление сущностями глобальных параметров

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

Требования

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

requests

Параметры

Параметр	Комментарии
hidden_value boolean	Должно ли значение быть скрытым в графическом интерфейсе Варианты: `false` `true`
name string / обязательно	Имя глобального параметра
parameter_type string	Тип значения Варианты: `"string"` ← (по умолчанию) `"boolean"` `"integer"` `"real"` `"array"` `"hash"` `"yaml"` `"json"`
password string / обязательно	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_PASSWORD`.
server_url string / обязательно	URL сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_SERVER_URL`.
state string	Состояние сущности `present_with_defaults` гарантирует существование сущности, но не будет обновлять существующие. Варианты: `"present"` ← (по умолчанию) `"present_with_defaults"` `"absent"`
updated_name string	Новое имя глобального параметра. Когда этот параметр установлен, модуль не будет идемпотентным.
username string / обязательно	Имя пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_USERNAME`.
validate_certs boolean	Проверять ли сертификаты TLS сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
value any	Значение глобального параметра

Атрибуты

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

Примечания

Примечание

parameter_type влияет только на Foreman >= 1.22

Примеры

- name: "Create a Global Parameter"
  theforeman.foreman.global_parameter:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "TheAnswer"
    value: "42"
    state: present_with_defaults

- name: "Update a Global Parameter"
  theforeman.foreman.global_parameter:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "TheAnswer"
    value: "43"
    state: present

- name: "Delete a Global Parameter"
  theforeman.foreman.global_parameter:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "TheAnswer"
    state: absent

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

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

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

Авторы

Bernhard Hopfenmueller (@Fobhep) ATIX AG
Matthias Dellweg (@mdellweg) ATIX AG
Manisha Singhal (@manisha15) 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/global_parameter_module.html