ansible.windows.win_get_url – Загрузка файла из HTTP, HTTPS или FTP на узел

Примечание

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

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

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

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

Описание

Загружает файлы из HTTP, HTTPS или FTP на удаленный сервер.
Удаленный сервер должен иметь прямой доступ к удаленному ресурсу.
Для узлов, отличных от Windows, используйте модуль ansible.builtin.get_url вместо этого.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
checksum строка		Если для этого параметра указан checksum, после загрузки файла на целевой компьютер будет рассчитан хэш-код, чтобы обеспечить целостность и подтвердить успешность передачи. Этот параметр нельзя использовать вместе с checksum_url.
checksum_algorithm строка	Варианты: md5 sha1 ← sha256 sha384 sha512	Указывает алгоритм хэширования, используемый при расчете хэш-кода удаленного и целевого файла.
checksum_url строка		Указывает URL, содержащий значения хэш-кода для ресурса по адресу url. Как и `checksum`, это используется для проверки целостности удаленной передачи. Этот параметр нельзя использовать вместе с checksum.
client_cert строка		Путь к клиенту сертификату (.pfx), используемому для аутентификации X509. Этот путь может быть либо путём к `pfx` на файловой системе, либо путём к сертификату в PowerShell `Cert:\CurrentUser\My\<thumbprint>`. Подключение WinRM должно быть аутентифицировано с помощью `CredSSP` или `become` используется в задаче, если файл сертификата не защищён паролем. Другие типы аутентификации могут установить client_cert_password, если сертификат защищен паролем.
client_cert_password строка		Пароль к client_cert, если сертификат защищен паролем.
dest путь / обязательно		Место сохранения файла по указанному URL. Убедитесь, что указано имя файла и расширение.
follow_redirects строка	Варианты: all none safe ←	Следовать ли перенаправлениям. `all` будет следовать всем перенаправлениям. `none` не будет следовать ни одному перенаправлению. `safe` будет следовать только «безопасным» перенаправлениям, где «безопасный» означает, что клиент выполняет только `GET` или `HEAD` по адресу перенаправления. При переходе на перенаправленный URL заголовок `Authorization` и любые установленные учётные данные будут удалены и не перенаправлены.
force булево	Варианты: no yes ←	Если `yes`, файл будет скачиваться каждый раз и заменяться, если содержимое изменится. Если `no`, файл будет скачиваться только в том случае, если он не существует или удалённый файл был изменён позже, чем локальный файл. Это работает, отправляя запрос http HEAD, чтобы получить время последнего изменения запрошенного ресурса, поэтому для этого требуется, чтобы удалённый веб-сервер поддерживал запросы HEAD.
force_basic_auth булево	Варианты: no ← yes	По умолчанию заголовок аутентификации отправляется только тогда, когда веб-сервис отвечает на первоначальный запрос кодом состояния 401. Поскольку некоторые службы с базовой аутентификацией не отправляют должным образом 401, вход в систему будет провален. Этот параметр принудительно отправляет заголовок базовой аутентификации при первоначальном запросе.
headers словарь		Дополнительные заголовки для установки в запросе. Это должен быть словарь, где ключ — имя заголовка, а значение — значение для этого заголовка.
http_agent строка	По умолчанию: "ansible-httpget"	Заголовок, используемый для идентификации, как правило, отображается в журнале веб-сервера. В запросе HTTP устанавливается как `User-Agent`.
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 строка		Имя пользователя для аутентификации прокси.
url строка / обязательно		Полный URL файла для загрузки.
url_method строка		Метод 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 не будут проверены. Это следует использовать только на сайтах, контролируемых лично, использующих самозаверяющие сертификаты.

Примечания

Примечание

Если ваш URL содержит экранированный символ косой черты (%2F), этот модуль преобразует его в реальную косую черту. Это результат поведения класса System.Uri, как описано в документации.

См. также

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

Примеры

- name: Download earthrise.jpg to specified path
  ansible.windows.win_get_url:
    url: http://www.example.com/earthrise.jpg
    dest: C:\Users\RandomUser\earthrise.jpg

- name: Download earthrise.jpg to specified path only if modified
  ansible.windows.win_get_url:
    url: http://www.example.com/earthrise.jpg
    dest: C:\Users\RandomUser\earthrise.jpg
    force: no

- name: Download earthrise.jpg to specified path through a proxy server.
  ansible.windows.win_get_url:
    url: http://www.example.com/earthrise.jpg
    dest: C:\Users\RandomUser\earthrise.jpg
    proxy_url: http://10.0.0.1:8080
    proxy_username: username
    proxy_password: password

- name: Download file from FTP with authentication
  ansible.windows.win_get_url:
    url: ftp://server/file.txt
    dest: '%TEMP%\ftp-file.txt'
    url_username: ftp-user
    url_password: ftp-password

- name: Download src with sha256 checksum url
  ansible.windows.win_get_url:
    url: http://www.example.com/earthrise.jpg
    dest: C:\temp\earthrise.jpg
    checksum_url: http://www.example.com/sha256sum.txt
    checksum_algorithm: sha256
    force: True

- name: Download src with sha256 checksum url
  ansible.windows.win_get_url:
    url: http://www.example.com/earthrise.jpg
    dest: C:\temp\earthrise.jpg
    checksum: a97e6837f60cec6da4491bab387296bbcd72bdba
    checksum_algorithm: sha1
    force: True

Значения возврата

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

Ключ	Возвращаемое значение	Описание
checksum_dest string	успех и файл был загружен в указанную директорию	<алгоритм> контрольная сумма файла после загрузки Пример: 6e642bb8dd5c2e027bf21dd923337cbb4214f827
checksum_src string	force=yes или файл в указанной директории не существовал	<алгоритм> контрольная сумма удаленного ресурса Пример: 6e642bb8dd5c2e027bf21dd923337cbb4214f827
dest string	всегда	путь к целевому файлу Пример: C:\Users\RandomUser\earthrise.jpg
elapsed float	всегда	Время в секундах между началом опроса и завершением модуля. Пример: 2.1406487
msg string	всегда	Сообщение об ошибке или сообщение об HTTP-статусе от веб-сервера Пример: OK
size integer	успех	размер целевого файла Пример: 1220
status_code integer	всегда	HTTP-код состояния Пример: 200
url string	всегда	запрошенный URL Пример: http://www.example.com/earthrise.jpg

Авторы

Paul Durivage (@angstwad)
Takeshi Kuramochi (@tksarah)

© 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_get_url_module.html