модуль theforeman.foreman.http_proxy — Управление HTTP-прокси
Примечание
Этот модуль входит в коллекцию theforeman.foreman (версия 5.11.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install theforeman.foreman. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: theforeman.foreman.http_proxy.
Добавлено в theforeman.foreman 1.1.0
Краткое описание
- Создание, обновление и удаление HTTP-прокси
Требования
На узле, выполняющем этот модуль, необходимы следующие компоненты.
- requests
Параметры
Параметр | Комментарии |
|---|---|
ca_path path | Файл в формате PEM, содержащий сертификат CA для проверки. Если значение не указано в задаче, вместо него используется значение переменной окружения |
locations list / elements=string | Список местоположений, которым должна быть назначена сущность |
name string / обязательный | Имя HTTP-прокси |
oauth1_consumer_key string | Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения |
oauth1_consumer_secret string | Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения |
organizations list / elements=string | Список организаций, которым должна быть назначена сущность |
password string | Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения |
proxy_password string | Пароль для аутентификации на HTTP-прокси При установке этого параметра модуль не будет идемпотентным. |
proxy_username string | Имя пользователя для аутентификации на HTTP-прокси |
server_url string / обязательный | URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения |
state string | Состояние сущности Варианты:
|
url string | URL-адрес HTTP-прокси Обязательный параметр при создании HTTP-прокси. |
use_gssapi boolean | Использовать GSSAPI для аутентификации; обычно этот параметр применяется для Kerberos или Kerberos через аутентификацию Negotiate. Требуется установленная библиотека Python requests-gssapi. Если значение не указано в задаче, вместо него используется значение переменной окружения Варианты:
|
username string | Имя пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения |
validate_certs boolean | Проверять ли сертификаты TLS сервера Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная | Может работать в режиме check_mode и возвращать прогноз состояния changed, не изменяя сущность |
diff_mode | Поддержка: полная | В режиме diff возвращает сведения об изменениях (или возможных изменениях в режиме check_mode) |
Примеры
- name: create example.org proxy
theforeman.foreman.http_proxy:
name: "example.org"
url: "http://example.org:3128"
locations:
- "Munich"
organizations:
- "ACME"
server_url: "https://foreman.example.com"
username: "admin"
password: "changeme"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
entity dictionary | Итоговое состояние затронутых сущностей, сгруппированных по типу. Возвращается: при успехе |
|
http_proxies list / elements=dictionary |
Список HTTP-прокси. Возвращается: при успехе |
Ссылки на коллекцию
© 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/http_proxy_module.html