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

Примечание

Этот модуль входит в коллекцию vmware.vmware_rest (версия 3.2.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

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Требования

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

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

Параметры

Параметр	Комментарии
config словарь	Настройка прокси для конкретного протокола. Требуется при state=[‘test’] Допустимые атрибуты: `server` (строка): URL прокси-сервера ([‘test’]) Этот ключ требуется при [‘test’]. `port` (целое число): Порт для подключения к прокси-серверу. В запросе ‘get’ указывает порт, подключенный к прокси-серверу. В запросе ‘set’ определяет порт для подключения к прокси-серверу. Значение -1 указывает на стандартный порт. ([‘test’]) Этот ключ требуется при [‘test’]. `username` (строка): Имя пользователя для прокси-сервера. Устанавливается только если прокси требует имя пользователя. ([‘test’]) `password` (строка): Пароль для прокси-сервера. Устанавливается только если прокси требует пароль. ([‘test’]) `enabled` (логическое значение): В результатах операций #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-адрес vCenter vSphere. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_HOST`.
vcenter_password строка / обязательно	Пароль vCenter vSphere. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PASSWORD`.
vcenter_rest_log_file строка	Вы можете использовать этот необязательный параметр для установки расположения файла журнала. Этот файл будет использоваться для записи взаимодействия HTTP REST. Файл будет храниться на хосте, на котором запущен модуль. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_REST_LOG_FILE`.
vcenter_username строка / обязательно	Имя пользователя vCenter vSphere. Если значение не указано в задаче, будет использовано значение переменной среды `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

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

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

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

Авторы

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

Ссылки на сборку

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