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

Примечание

Этот плагин входит в состав коллекции ansible.windows (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install ansible.windows.

Для использования в плейбуке укажите: ansible.windows.win_uri.

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
body raw		Тело HTTP запроса/ответа веб-сервису.
client_cert строка		Путь к клиенту сертификату (.pfx), используемому для аутентификации X509. Этот путь может быть путем к `pfx` в файловой системе или путем к сертификату PowerShell `Cert:\CurrentUser\My\<thumbprint>`. Подключение WinRM должно быть аутентифицировано с использованием `CredSSP` или `become` используется в задаче, если файл сертификата не защищен паролем. Другие типы аутентификации могут задавать client_cert_password, если сертификат защищен паролем.
client_cert_password строка		Пароль для client_cert, если сертификат защищен паролем.
content_type строка		Устанавливает заголовок "Content-Type".
creates путь		Имя файла. Если файл уже существует, этот шаг будет пропущен.
dest путь		Вывести тело ответа в файл.
follow_redirects строка	Варианты: all none safe ←	Следовать ли перенаправлениям. `all` будет следовать всем перенаправлениям. `none` не будет следовать никаким перенаправлениям. `safe` будет следовать только «безопасным» перенаправлениям, где «безопасным» означает, что клиент выполняет только `GET` или `HEAD` по URI, на который он перенаправляется. При переходе по перенаправленному URL-адресу заголовок `Authorization` и любые установленные учетные данные будут удалены и не будут перенаправлены.
force_basic_auth логическое	Варианты: no ← yes	По умолчанию заголовок аутентификации отправляется только при получении веб-сервисом ответа с кодом состояния 401 при первоначальном запросе. Поскольку некоторые веб-сервисы с аутентификацией Basic не отправляют код 401 должным образом, вход в систему будет не удаваться. Этот параметр принудительно отправляет заголовок аутентификации Basic при первоначальном запросе.
headers словарь		Дополнительные заголовки для установки в запросе. Это должен быть словарь, где ключ — это имя заголовка, а значение — значение для этого заголовка.
http_agent строка	По умолчанию: "ansible-httpget"	Заголовок для идентификации, обычно отображается в журналах веб-сервера. Это устанавливается в `User-Agent` заголовок HTTP запроса.
maximum_redirection целое число	По умолчанию: 50	Укажите, сколько раз модуль будет перенаправлять соединение на альтернативный URI, прежде чем соединение прервется. Если установлено на `0` или follow_redirects установлено на `none`, или `safe` при отсутствии `GET` или `HEAD`, это предотвращает все перенаправления.
proxy_password строка		Пароль для proxy_username.
proxy_url строка		Явный прокси-сервер для использования в запросе. По умолчанию запрос будет использовать прокси-сервер, определенный в IE, если параметр use_proxy не установлен на `no`.
proxy_use_default_credential логическое	Варианты: no ← yes	Использует учетные данные текущего пользователя при аутентификации на хосте прокси-сервера, защищенном с использованием `NTLM`, `Kerberos`, или `Negotiate` аутентификации. Прокси-серверы, использующие аутентификацию `Basic`, все равно потребуют явных учетных данных с помощью параметров proxy_username и proxy_password. Модуль будет иметь доступ к учетным данным пользователя только в случае использования `become` с паролем, подключения с помощью SSH с паролем или подключения с помощью WinRM с использованием `CredSSP` или `Kerberos with delegation`. Если не используется `become` или другой метод аутентификации, не указанный выше, учетные данные по умолчанию недоступны, и аутентификация прокси не произойдет.
proxy_username строка		Имя пользователя для аутентификации прокси-сервера.
removes путь		Имя файла. Если файл не существует, этот шаг будет пропущен.
return_content логическое	Варианты: no ← yes	Возвращать ли тело ответа в качестве ключа «content» в результатах словаря. Если указанный тип содержимого (Content-type) — «application/json», то JSON дополнительно загружается в ключ, названный `json` в результатах словаря.
status_code список / элементы=целое число	По умолчанию: [200]	Действительный числовой код состояния HTTP, обозначающий успешность запроса. Также может быть запятой список кодов состояния.
url строка / обязательно		Поддерживает URL-адреса FTP, HTTP или HTTPS в формате (ftp\|http\|https)://host.domain:port/path.
url_method строка	По умолчанию: "GET"	Метод HTTP запроса. псевдонимы: метод
url_password строка		Пароль для url_username. Псевдоним password устарел и будет удален в следующей версии после `2022-07-01`. псевдонимы: password
url_timeout целое число	По умолчанию: 30	Указывает, сколько времени запрос может оставаться в очереди, прежде чем истечет срок ожидания (в секундах). Установите на `0` для задания бесконечного таймаута. псевдонимы: timeout
url_username строка		Имя пользователя для аутентификации. Псевдонимы user и username устарели и будут удалены в следующей версии после `2022-07-01`. псевдонимы: user, username
use_default_credential логическое	Варианты: no ← yes	Использует учетные данные текущего пользователя при аутентификации на сервере, защищенном с использованием `NTLM`, `Kerberos`, или `Negotiate` аутентификации. Сайты, использующие `Basic` аутентификацию, все равно потребуют явных учетных данных с помощью параметров url_username и url_password. Модуль будет иметь доступ к учетным данным пользователя только при использовании `become` с паролем, подключении с помощью SSH с паролем или подключении с помощью WinRM с использованием `CredSSP` или `Kerberos with delegation`. Если не используется `become` или другой метод аутентификации, не указанный выше, учетные данные по умолчанию недоступны, и аутентификация не произойдет.
use_proxy логическое	Варианты: no yes ←	Если `no`, прокси, определенный в IE для текущего пользователя, не будет использоваться.
validate_certs логическое	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под личным контролем, использующих самоподписанные сертификаты.

См. также

ansible.builtin.uri: Официальная документация по модулю ansible.builtin.uri.
ansible.windows.win_get_url: Официальная документация по модулю ansible.windows.win_get_url.
community.windows.win_inet_proxy: Официальная документация по модулю community.windows.win_inet_proxy.

Примеры

- name: Perform a GET and Store Output
  ansible.windows.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
  ansible.windows.win_uri:
    url: http://example.com/
    method: GET
    headers:
      host: www.somesite.com

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

- name: POST a Body to an Endpoint
  ansible.windows.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

Авторы

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.10/collections/ansible/windows/win_uri_module.html