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. Поскольку некоторые службы базовой аутентификации не отправляют должным образом код 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 (ноль) указывает на неограниченное время ожидания. Запрос доменного имени может занимать до 15 секунд или истечь. Если ваш запрос содержит имя хоста, для которого требуется разрешение, и вы установили timeout на значение больше нуля, но меньше 15 секунд, ваш запрос может ждать 15 секунд или больше, прежде чем истечёт время ожидания. |
| url - / обязательно | Поддерживает URL-адреса FTP, HTTP или HTTPS в формате (ftp|http|https)://host.domain:port/path. | |
| user - добавлено в 2.4 | Имя пользователя для аутентификации. | |
| validate_certs логическое добавлено в 2.4 |
| Если no, SSL сертификаты не будут проверены. Это нужно только для сайтов, которыми вы управляете, и используете самозаверенные сертификаты. |
Примечания
Примечание
- Для платформ, отличных от 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 |
Статус
- Данный модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/win_uri_module.html
