Spec-Zone.ru › Ansible

Модуль theforeman.foreman.http_proxy – Управление HTTP-прокси

Примечание

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

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

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

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

Новое в theforeman.foreman 1.1.0

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

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

  • Создание, обновление и удаление HTTP-прокси

Требования

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

  • requests

Параметры

Параметр

Комментарии

locations

list / elements=string

Список местоположений, к которым должен быть назначен объект

name

string / required

Имя HTTP-прокси

organizations

list / elements=string

Список организаций, к которым должен быть назначен объект

password

string / required

Пароль пользователя, обращающегося к серверу Foreman.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды FOREMAN_PASSWORD.

proxy_password

string

Пароль, используемый для аутентификации с HTTP-прокси

Когда этот параметр установлен, модуль не будет идемпотентным.

proxy_username

string

Имя пользователя, используемое для аутентификации с HTTP-прокси

server_url

string / required

URL сервера Foreman.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды FOREMAN_SERVER_URL.

state

string

Состояние объекта

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

url

string

URL HTTP-прокси

Обязательно при создании нового HTTP-прокси.

username

string / required

Имя пользователя, обращающегося к серверу Foreman.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды FOREMAN_USERNAME.

validate_certs

boolean

Проверять ли сертификаты TLS сервера Foreman.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды FOREMAN_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

Может работать в check_mode и возвращать прогноз изменённого состояния без изменения объекта

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-прокси.

Возвращается: успех

Авторы

  • Evgeni Golov (@evgeni)

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

  • Система отслеживания ошибок
  • Домашняя страница
  • Репозиторий (исходный код)

© 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/http_proxy_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API