win_uri - Взаимодействие с веб-сервисами
Новая версия 2.1.
Описание
- Взаимодействует с веб-сервисами FTP, HTTP и HTTPS.
- Поддерживает механизмы аутентификации HTTP Digest, Basic и WSSE.
- Для платформ, отличных от Windows, используйте модуль uri.
Параметры
| параметр | обязательный | значение по умолчанию | допустимые значения | комментарии |
|---|---|---|---|---|
| body | нет | Тело HTTP-запроса/ответа веб-сервису. | ||
| client_cert (добавлен в 2.4)
| нет | Указывает клиентский сертификат(.pfx), используемый для защищенного веб-запроса. | ||
| content_type | нет | Устанавливает заголовок "Content-Type". | ||
| creates (добавлен в 2.4)
| нет | Имя файла, при его существовании, этот шаг будет пропущен. | ||
| dest (добавлен в 2.3)
| нет | Вывести тело ответа в файл. | ||
| follow_redirects (добавлен в 2.4)
| нет | safe |
| Следовать ли модулю перенаправлениям. win_uri будет следовать всем перенаправлениям.none не будет следовать никаким перенаправлениям.safe будет следовать только "безопасным" перенаправлениям, где "безопасный" означает, что клиент выполняет только GET или HEAD для URI, на который он перенаправляется. |
| headers | нет | Ключ-значение для заголовков. Пример "Host: www.somesite.com" | ||
| maximum_redirection (добавлен в 2.4)
| нет | 5 | Указывает, сколько раз 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)
| нет | нет |
| Возвращать ли тело ответа как ключ "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. Также поддерживает URL-адреса file:/// через Invoke-WebRequest. | ||
| use_basic_parsing | нет | да |
| Этот модуль полагается на 'Invoke-WebRequest', который по умолчанию использует движок Internet Explorer для разбора веб-страницы. Существует частный случай, когда если пользователь не запускал IE раньше, это приведет к ошибке. Единственное преимущество использования парсера Internet Explorer заключается в том, что вы можете перемещаться по DOM в скрипте PowerShell. Это не нужно для Ansible, поэтому по умолчанию мы отключаем 'UseBasicParsing'. Однако вы можете отключить это здесь. |
| user (добавлен в 2.4)
| нет | Имя пользователя для аутентификации. | ||
| validate_certs (добавлен в 2.4)
| нет | да |
| Если no, сертификаты SSL не будут проверяться. Это следует устанавливать только в no на сайтах, находящихся под вашим контролем, использующих самозаверенные сертификаты. |
Примеры
- 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' }"
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие являются полями, уникальными для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| body | Содержимое тела, используемого | при указании body | строка | {"id":1} |
| content_type | Заголовок "content-type", использованный. | всегда | строка | application/json |
| headers | Заголовки ответа. | успех | словарь | {'Content-Type': 'application/json'} |
| method | Использованный HTTP-метод. | всегда | строка | GET |
| raw_content | Необработанное содержимое HTTP-ответа. | успех | строка | HTTP/1.1 200 OK\nX-XSS-Protection: 1; mode=block\nAlternate-Protocol: 443:quic,p=1\nAlt-Svc: quic="www.google.com:443"; |
| raw_content_length | Размер ответа в байтах. | успех | целое число | 54447 |
| status_code | HTTP-код состояния ответа. | успех | целое число | 200 |
| status_description | Краткое описание состояния. | успех | строка | OK |
| url | Целевой URL | всегда | строка | https://www.ansible.com |
| use_basic_parsing | Состояние флага "use_basic_parsing". | всегда | булево | True |
Примечания
Примечание
- Для платформ, отличных от Windows, используйте модуль uri.
Статус
Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантируется обратной совместимостью.
Для помощи в разработке модулей, если вы заинтересованы, пожалуйста, ознакомьтесь с Информация о сообществе и сотрудничестве, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/win_uri_module.html
