win_uri — Взаимодействие с веб-сервисами
Новое в версии 2.1.
Обзор
- Взаимодействует с веб-сервисами FTP, HTTP и HTTPS.
- Поддерживает механизмы аутентификации HTTP Digest, Basic и WSSE.
- Для платформ, отличных от Windows, используйте модуль uri.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| body | Тело 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) |
| Следует ли модулю win_uri перенаправлять запросы.all будет следовать всем перенаправлениям.none не будет следовать никаким перенаправлениям.safe будет следовать только «безопасным» перенаправлениям, где «безопасный» означает, что клиент выполняет только GET или HEAD на URI, на который он перенаправляется. |
| force_basic_auth (добавлен в 2.5) |
| По умолчанию информация об аутентификации отправляется только тогда, когда веб-сервис отвечает на начальный запрос кодом 401. Поскольку некоторые службы basic auth не отправляют код 401 должным образом, логины могут завершиться ошибкой. Этот параметр принудительно отправляет заголовок Basic аутентификации при первоначальном запросе. |
| headers | Дополнительные заголовки для запроса. Подробности смотрите в примерах. | |
| maximum_redirection (добавлен в 2.4) | По умолчанию: 5 | Указывает, сколько раз win_uri перенаправит соединение на альтернативный URI, прежде чем соединение прервется.Если maximum_redirection установлено в 0 (ноль) или follow_redirects установлено в none, или установлено в safe при отсутствии GET или HEAD, это предотвращает все перенаправления. |
| method |
| HTTP-метод запроса или ответа. |
| password (добавлен в 2.4) | Пароль для аутентификации. | |
| removes (добавлен в 2.4) | Имя файла. Если файл не существует, этот шаг будет пропущен. | |
| return_content (добавлен в 2.4) |
| Возвращать ли тело ответа в качестве ключа "content" в результате словаря. Если указанный тип содержимого — "application/json", то JSON дополнительно загружается в ключ json в результатах словаря. |
| status_code (добавлен в 2.4) | По умолчанию: 200 | Действительный числовой код HTTP-статуса, указывающий на успех запроса. Также может быть перечислением кодов статуса через запятую. |
| timeout (добавлен в 2.4) | По умолчанию: 30 | Устанавливает время ожидания запроса в секундах, прежде чем он завершится с ошибкой. Значение 0 (ноль) означает неограниченное время ожидания. Запрос DNS может занимать до 15 секунд. Если в запросе указано имя хоста, которое требует разрешения, и timeout установлено на значение больше нуля, но меньше 15 секунд, запрос может завершиться ошибкой через 15 секунд или более. |
| url обязательно | Поддерживает URL FTP, HTTP или HTTPS в формате (ftp|http|https)://host.domain:port/path. | |
| use_basic_parsing |
| Начиная с Ansible 2.5, этот параметр больше не действителен и не может быть изменён из значения yes. Этот параметр будет удален в Ansible 2.7.До Ansible 2.5 этот модуль полагался на 'Invoke-WebRequest', который по умолчанию использовал движок Internet Explorer для разбора веб-страницы. Есть случай, когда, если пользователь не запускал IE ранее, это приведёт к ошибке. Единственное преимущество использования парсера Internet Explorer заключается в том, что вы можете пройтись по DOM в скрипте PowerShell. Это не нужно для Ansible, поэтому мы по умолчанию отключаем 'UseBasicParsing'. Однако вы можете отключить его здесь. |
| user (добавлен в 2.4) | Имя пользователя для аутентификации. | |
| validate_certs (добавлен в 2.4) |
| Если no, сертификаты SSL не будут проверены. Это должно быть установлено в no только для сайтов под вашим контролем, использующих самозаверяемые сертификаты. |
Примечания
Примечание
- Для платформ, отличных от Windows, используйте модуль uri.
Примеры
- 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 |
| 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 |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратный.
Автор
- 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.5/modules/win_uri_module.html
