Модуль vmware.vmware_rest.appliance_networking_proxy — настройка прокси-сервера для указанного протокола

Примечание

Этот модуль входит в коллекцию vmware.vmware_rest (версия 4.10.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install vmware.vmware_rest. Для работы с этим модулем требуются дополнительные компоненты. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: vmware.vmware_rest.appliance_networking_proxy.

Добавлено в vmware.vmware_rest 2.0.0

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

УСТАРЕЛО

Удалено в:: версии 5.0.0
Причина:: Этот модуль перенесён в новую коллекцию vmware.vmware
Альтернатива:: Вместо него используйте vmware.vmware.vcsa_settings.

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

Настраивает прокси-сервер для указанного протокола. Эта операция задаёт переменные среды для использования прокси. Чтобы изменения конфигурации вступили в силу, необходимо выйти из системы или перезапустить службу.

Требования

На узле, где выполняется этот модуль, должны быть установлены следующие компоненты.

vSphere 7.0.3 или более поздней версии
python >= 3.6
aiohttp

Параметры

Параметр	Комментарии
config словарь	Конфигурация прокси для указанного протокола. Обязательный параметр при state=[‘test’] Допустимые атрибуты: - `server` (str): URL прокси-сервера ([‘test’]) Этот ключ обязателен при [‘test’]. - `port` (int): Порт для подключения к прокси-серверу. В вызове ‘get’ указывает порт, используемый для подключения к прокси-серверу. В вызове ‘set’ задаёт порт для подключения к прокси-серверу. Значение -1 указывает на порт по умолчанию. ([‘test’]) Этот ключ обязателен при [‘test’]. - `username` (str): Имя пользователя прокси-сервера. Задаётся, только если для прокси требуется имя пользователя. ([‘test’]) - `password` (str): Пароль прокси-сервера. Задаётся, только если для прокси требуется пароль. ([‘test’]) - `enabled` (bool): В результатах операций #get и #list это поле указывает, включено ли использование прокси для определённого протокола. В качестве входных данных для операций test и set это поле задаёт, следует ли включить использование прокси для определённого протокола. ([‘test’]) Этот ключ обязателен при [‘test’].
enabled логическое значение	В результатах операций #get и #list это поле указывает, включено ли использование прокси для определённого протокола. В качестве входных данных для операций test и set это поле задаёт, следует ли включить использование прокси для определённого протокола. Обязательный параметр при state=[‘set’] Варианты: `false` `true`
host строка	Имя узла, адрес IPv4 или IPv6. Обязательный параметр при state=[‘test’]
password строка	Пароль прокси-сервера. Задаётся, только если для прокси требуется пароль.
port целое число	Порт для подключения к прокси-серверу. В вызове ‘get’ указывает порт, используемый для подключения к прокси-серверу. В вызове ‘set’ задаёт порт для подключения к прокси-серверу. Значение -1 указывает на порт по умолчанию. Обязательный параметр при state=[‘set’]
protocol строка / обязательный	Протокол, для которого необходимо задать прокси. Этот параметр обязателен.
server строка	URL прокси-сервера. Обязательный параметр при state=[‘set’]
session_timeout число с плавающей точкой добавлено в vmware.vmware_rest 2.1.0	Параметры времени ожидания для сеанса клиента. Максимальное время в секундах для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с.
state строка	Варианты: `"absent"` `"set"` ← (по умолчанию) `"test"`
username строка	Имя пользователя прокси-сервера. Задаётся, только если для прокси требуется имя пользователя.
vcenter_hostname строка / обязательный	Имя узла или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
vcenter_password строка / обязательный	Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PASSWORD`.
vcenter_rest_log_file строка	С помощью этого необязательного параметра можно указать расположение файла журнала. Этот файл будет использоваться для записи взаимодействия по HTTP REST. Файл будет сохранён на узле, на котором выполняется модуль. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_REST_LOG_FILE`.
vcenter_username строка / обязательный	Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`.
vcenter_validate_certs логическое значение	Разрешает подключение, если SSL-сертификаты недействительны. Установите значение `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Проверено на vSphere 7.0.3

Примеры

- name: Set the HTTP proxy configuration
  vmware.vmware_rest.appliance_networking_proxy:
    enabled: true
    server: http://datastore.test
    port: 3128
    protocol: http
  register: result

- name: Delete the HTTP proxy configuration
  vmware.vmware_rest.appliance_networking_proxy:
    protocol: http
    state: absent
  register: result

Возвращаемые значения

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

Ключ	Описание
value словарь	Удаление конфигурации HTTP-прокси Возвращается: При успешном выполнении Пример: `{}`

Статус

Этот модуль будет удалён в версии 5.0.0. [устарело]
Подробнее см. в разделе УСТАРЕЛО.

Авторы

Команда Ansible Cloud (@ansible-collections)

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

© 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/vmware/vmware_rest/appliance_networking_proxy_module.html