win_get_url - Загрузка файла из HTTP, HTTPS или FTP в узел
Новая в версии 1.7.
Описание
- Загрузка файлов из HTTP, HTTPS или FTP на удаленный сервер. Удаленный сервер должен иметь прямой доступ к удаленному ресурсу.
- Для платформ, отличных от Windows, используйте модуль get_url.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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) | Имя пользователя для аутентификации прокси. | |
| skip_certificate_validation |
| Этот параметр устарел начиная с версии 2.4, пожалуйста, используйте validate_certs вместо этого.Если yes, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с самоподписанными сертификатами. |
| timeout (добавлен в 2.4) | По умолчанию: 10 | Таймаут в секундах для запроса URL. |
| url обязательно | Полный URL файла для загрузки. | |
| url_password | Пароль для Basic аутентификации. псевдонимы: password | |
| url_username | Имя пользователя для Basic аутентификации. псевдонимы: username | |
| use_proxy (добавлен в 2.4) |
| Если no, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах. |
| validate_certs (добавлен в 2.4) |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с самоподписанными сертификатами.Если skip_certificate_validation было установлено, оно переопределяет этот параметр. |
Примеры
- 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| dest строка | всегда | путь/файл назначения Пример: C:\Users\RandomUser\earthrise.jpg |
| msg строка | всегда | Сообщение об ошибке или сообщение об HTTP статусе с веб-сервера Пример: OK |
| status_code целое число | всегда | HTTP код состояния Пример: 200 |
| url строка | всегда | запрошенный URL Пример: http://www.example.com/earthrise.jpg |
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики гарантируют отсутствие несовместимых изменений интерфейса.
Поддержка
Дополнительную информацию о поддержке этого модуля 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.5/modules/win_get_url_module.html
