theforeman.foreman.global_parameter – Управление глобальными параметрами
Примечание
Этот плагин входит в коллекцию theforeman.foreman (версия 1.5.1).
Для его установки используйте: ansible-galaxy collection install theforeman.foreman.
Чтобы использовать его в книге задач, укажите: theforeman.foreman.global_parameter.
Новое в версии 1.0.0: модуля theforeman.foreman
Обзор
- Управление сущностями глобальных параметров
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- requests
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| hidden_value boolean |
| Скрыть значение в графическом интерфейсе? |
| name string / обязательно | Имя глобального параметра | |
| parameter_type string |
| Тип значения |
| password string / обязательно | Пароль пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, используется значение переменной среды FOREMAN_PASSWORD. | |
| server_url string / обязательно | URL-адрес сервера Foreman. Если значение не указано в задаче, используется значение переменной среды FOREMAN_SERVER_URL. | |
| state string |
| Состояние сущности present_with_defaults гарантирует существование сущности, но не будет обновлять существующие |
| updated_name string | Новое имя глобального параметра. При установке этого параметра, модуль будет не идемпотентным. | |
| username string / обязательно | Имя пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, используется значение переменной среды FOREMAN_USERNAME. | |
| validate_certs boolean |
| Проверять ли сертификаты TLS сервера Foreman? Если значение не указано в задаче, используется значение переменной среды FOREMAN_VALIDATE_CERTS. |
| value raw | Значение глобального параметра |
Примечания
Примечание
- 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 dictionary | успех | Конечное состояние затронутых сущностей, сгруппированных по типу. | |
| global_parameters list / elements=dictionary | успех | Список глобальных параметров. | |
Авторы
- Bernhard Hopfenmueller (@Fobhep) ATIX AG
- Matthias Dellweg (@mdellweg) ATIX AG
- Manisha Singhal (@manisha15) ATIX AG
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/theforeman/foreman/global_parameter_module.html