win_get_url – Загрузка файла из HTTP, HTTPS или FTP на узел
Описание
- Загружает файлы из HTTP, HTTPS или FTP на удалённый сервер.
- Удалённый сервер обязательно должен иметь прямой доступ к удалённому ресурсу.
- Для платформ, отличных от Windows, используйте модуль get_url.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| checksum строка добавлен в 2.8 | Если в этот параметр передаётся checksum, после загрузки целевого файла будет вычислен дайджест, чтобы обеспечить целостность и подтвердить успешное завершение передачи. Этот параметр нельзя задавать вместе с checksum_url. | |
| checksum_algorithm строка добавлен в 2.8 |
| Указывает алгоритм хеширования, используемый при вычислении контрольной суммы удалённого и целевого файла. |
| checksum_url строка добавлен в 2.8 | Указывает URL, содержащий значения контрольной суммы для ресурса по адресу url. Подобно checksum, это используется для проверки целостности удалённой передачи.Этот параметр нельзя задавать вместе с checksum. | |
| dest путь / обязательно | Место сохранения файла по указанному URL. Убедитесь, что включены имя файла и расширение. | |
| force булево добавлен в 2.0 |
| Если yes, файл будет загружаться каждый раз и заменяться, если содержимое изменится. Если no, файл будет загружаться только в том случае, если он не существует или удалённый файл был изменён позже, чем локальный.Это работает путём отправки запроса http HEAD для получения последней даты изменения запрошенного ресурса, поэтому для этого необходимо, чтобы удалённый веб-сервер поддерживал запросы HEAD. |
| force_basic_auth булево добавлен в 2.5 |
| Если yes, будет добавлен заголовок Basic аутентификации в начальный запрос.Если no, будет использован Microsoft's WebClient для обработки аутентификации. |
| headers словарь добавлен в 2.4 | Добавление пользовательских HTTP-заголовков в запрос (в виде словаря). | |
| proxy_password строка добавлен в 2.0 | Пароль для аутентификации прокси. | |
| proxy_url строка добавлен в 2.0 | Полный URL прокси-сервера для загрузки. | |
| proxy_username строка добавлен в 2.0 | Имя пользователя для аутентификации прокси. | |
| timeout целое число добавлен в 2.4 | По умолчанию: 10 | Таймаут в секундах для запроса URL. |
| url строка / обязательно | Полный URL файла для загрузки. | |
| url_password строка | Пароль для Basic аутентификации. алиасы: пароль | |
| url_username строка | Имя пользователя для Basic аутентификации. алиасы: имя пользователя | |
| use_proxy булево добавлен в 2.4 |
| Если no, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах. |
| validate_certs булево добавлен в 2.4 |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под личным контролем, использующих самозаверенные сертификаты.Если skip_certificate_validation задано, оно переопределяет этот параметр. |
Примечания
Примечание
- Если ваш URL содержит экранированный слеш-символ (%2F), этот модуль преобразует его в обычный слеш. Это результат поведения класса System.Uri, как описано в документации.
- Начиная с Ansible 2.8, модуль пропускает сообщение об изменении, если удалённая контрольная сумма совпадает с локальной, даже когда
force=yes. Это согласуется с модулем get_url.
См. также
См. также
- get_url – Загрузка файлов из HTTP, HTTPS или FTP на узел
- Официальная документация модуля get_url.
- uri – Взаимодействие с веб-сервисами
- Официальная документация модуля uri.
- win_uri – Взаимодействие с веб-сервисами
- Официальная документация модуля win_uri.
Примеры
- name: Download earthrise.jpg to specified path
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
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.
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
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
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
win_get_url:
url: http://www.example.com/earthrise.jpg
dest: C:\temp\earthrise.jpg
checksum: a97e6837f60cec6da4491bab387296bbcd72bdba
checksum_algorithm: sha1
force: True
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| checksum_dest строка | успех и dest загружен | <алгоритм> контрольная сумма файла после загрузки Пример: 6e642bb8dd5c2e027bf21dd923337cbb4214f827 |
| checksum_src строка | force=yes или dest не существовал | <алгоритм> контрольная сумма удаленного ресурса Пример: 6e642bb8dd5c2e027bf21dd923337cbb4214f827 |
| dest строка | всегда | целевой файл/путь Пример: C:\Users\RandomUser\earthrise.jpg |
| elapsed вещественное число | всегда | Прошедшие секунды между началом опроса и окончанием модуля. Пример: 2.1406487 |
| msg строка | всегда | Сообщение об ошибке или сообщение об HTTP-статусе от веб-сервера Пример: OK |
| size целое число | успех | размер целевого файла Пример: 1220 |
| status_code целое число | всегда | HTTP-код состояния Пример: 200 |
| url строка | всегда | запрошенный URL Пример: http://www.example.com/earthrise.jpg |
Статус
- Данный модуль гарантированно не будет иметь несовместимых изменений интерфейса в будущем. [stableinterface]
- Этот модуль поддерживается Командой ядра Ansible. [core]
Поддержка Red Hat
Дополнительную информацию о поддержке данного модуля Red Hat можно найти в этой статье базы знаний Red Hat.
Авторы
- 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.8/modules/win_get_url_module.html
