win_uri – Взаимодействие с веб-сервисами

Новая версия с 2.1.

Описание
Параметры
См. также
Примеры
Возвращаемые значения
Статус

Описание

Взаимодействие с FTP, HTTP и HTTPS веб-сервисами.
Поддерживает механизмы аутентификации HTTP Digest, Basic и WSSE.
Для платформ, отличных от Windows, используйте модуль uri.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
body raw		Тело HTTP запроса/ответа веб-сервису.
client_cert путь добавлен в 2.4		Указывает клиентский сертификат (.pfx), используемый для защищенного веб-запроса. Подключение WinRM должно быть аутентифицировано с `CredSSP`, если файл сертификата не защищен паролем. Другие типы аутентификации могут установить client_cert_password, если сертификат защищен паролем.
client_cert_password строка добавлен в 2.5		Пароль для файла клиентского сертификата (.pfx), используемого для защищенного веб-запроса.
content_type строка		Устанавливает заголовок "Content-Type".
creates путь добавлен в 2.4		Имя файла. Если файл уже существует, этот шаг будет пропущен.
dest путь добавлен в 2.3		Выводит тело ответа в файл.
follow_redirects строка добавлен в 2.4	Варианты: all none safe ←	Следует ли модулю `win_uri` перенаправлять запросы. `all` будет перенаправлять все запросы. `none` не будет перенаправлять никакие запросы. `safe` будет перенаправлять только "безопасные" перенаправления, где "безопасное" означает, что клиент выполняет только `GET` или `HEAD` на перенаправляемый URI.
force_basic_auth булево добавлен в 2.5	Варианты: no ← yes	По умолчанию информация об аутентификации отправляется только тогда, когда веб-сервис отвечает на начальный запрос кодом состояния 401. Поскольку некоторые сервисы Basic аутентификации не отправляют код 401 должным образом, попытки входа могут быть неудачными. Этот параметр заставляет отправлять заголовок Basic аутентификации при первоначальном запросе.
headers словарь		Дополнительные заголовки для запроса, см. примеры для получения подробностей о настройке.
maximum_redirection целое число добавлен в 2.4	По умолчанию: 50	Указывает, сколько раз `win_uri` перенаправит подключение к альтернативному URI, прежде чем подключение завершится ошибкой. Если `maximum_redirection` установлено в 0 (ноль) или `follow_redirects` установлено в `none`, или установлено в `safe`, когда не выполняется `GET` или `HEAD`, это предотвращает все перенаправления.
method строка	По умолчанию: "GET"	Метод HTTP запроса или ответа.
password строка добавлен в 2.4		Пароль для аутентификации.
removes путь добавлен в 2.4		Имя файла. Если файл не существует, этот шаг будет пропущен.
return_content булево добавлен в 2.4	Варианты: no ← yes	Возвращать ли тело ответа как ключ "content" в словаре результата. Если указанный тип Content-type равен "application/json", то JSON также загружается в ключ `json` в словаре результатов.
status_code список добавлен в 2.4	По умолчанию: [200]	Действительный числовой код HTTP состояния, указывающий на успешность запроса. Также может быть списком кодов состояний, разделённых запятыми.
timeout целое число добавлен в 2.4	По умолчанию: 30	Указывает, сколько времени запрос может ожидать, прежде чем он истечёт (в секундах). Значение 0 (ноль) указывает неопределённый таймаут. Запрос DNS может занимать до 15 секунд для возврата или истечения времени ожидания. Если ваш запрос содержит имя хоста, которое требует разрешения, и вы установите `timeout`, значение больше нуля, но меньше 15 секунд, ваш запрос может истечь через 15 секунд или более.
url строка / обязательно		Поддерживает FTP, HTTP или HTTPS URL в формате (ftp\|http\|https)://host.domain:port/path.
user строка добавлен в 2.4		Имя пользователя для аутентификации.
validate_certs булево добавлен в 2.4	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это должно быть установлено только на сайтах под личным контролем, использующих самозаверенные сертификаты.

См. также

uri – Взаимодействие с веб-сервисами: Официальная документация модуля uri.
win_get_url – Загрузка файла из HTTP, HTTPS или FTP в узел: Официальная документация модуля win_get_url.

Примеры

- name: Perform a GET and Store Output
  win_uri:
    url: http://example.com/endpoint
  register: http_output

# Set a HOST header to hit an internal webserver:
- name: Hit a Specific Host on the Server
  win_uri:
    url: http://example.com/
    method: GET
    headers:
      host: www.somesite.com

- name: Perform a HEAD on an Endpoint
  win_uri:
    url: http://www.example.com/
    method: HEAD

- name: POST a Body to an Endpoint
  win_uri:
    url: http://www.somesite.com/
    method: POST
    body: "{ 'some': 'json' }"

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

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

Ключ	Возвращаемое значение	Описание
content строка	успех и return_content равно True	Необработанное содержимое HTTP-ответа. Пример: {"foo": "bar"}
content_length целое число	успех	Размер ответа в байтах. Пример: 54447
elapsed число с плавающей точкой	всегда	Количество секунд, затраченное на загрузку. Пример: 23.2
json словарь	успех и Content-Type равен "application/json" или "application/javascript", и return_content равно True	Структура JSON, возвращённая в content как словарь. Пример: {'this-is-dependent': 'on the actual return content'}
status_code целое число	успех	HTTP-код состояния ответа. Пример: 200
status_description строка	успех	Краткое описание состояния. Пример: OK
url строка	всегда	Целевой URL. Пример: https://www.ansible.com

Статус

Данный модуль не гарантирует обратную совместимость. [превью]
Данный модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Corwin Brown (@blakfeld)
Dag Wieers (@dagwieers)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/win_uri_module.html