win_get_url - Загрузка файла из HTTP, HTTPS или FTP в узел
Новая в версии 1.7.
Описание
- Загружает файлы из HTTP, HTTPS или FTP на удаленный сервер. Удаленный сервер должен иметь прямой доступ к удаленному ресурсу.
- Для платформ, отличных от Windows, используйте модуль get_url вместо этого.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| dest обязательно | Место сохранения файла по указанному URL. Не забудьте указать имя файла и расширение, если необходимо. | |
| force bool (добавлено в 2.0) |
| Если yes, файл всегда будет загружен. Если no, файл будет загружен только в случае его отсутствия или если удаленный файл был изменён позже, чем локальный.Это работает путём отправки запроса http HEAD для получения времени последнего изменения запрошенного ресурса, поэтому для этого должен поддерживаться запрос HEAD на удалённом веб-сервере. |
| force_basic_auth bool (добавлено в 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 bool |
| Этот параметр устарел начиная с версии 2.4, пожалуйста, используйте validate_certs вместо него.Если yes, сертификаты SSL не будут проверяться. Это следует использовать только на сайтах, контролируемых лично, с самозаверяющими сертификатами. |
| timeout (добавлено в 2.4) | По умолчанию: 10 | Таймаут в секундах для запроса URL. |
| url обязательно | Полный URL файла для загрузки. | |
| url_password | Пароль базовой аутентификации. псевдонимы: password | |
| url_username | Имя пользователя базовой аутентификации. псевдонимы: username | |
| use_proxy bool (добавлено в 2.4) |
| Если no, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах. |
| validate_certs bool (добавлено в 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, что означает, что разработчики гарантируют отсутствие изменений интерфейса, несовместимых со старыми версиями.
Техническое обслуживание
Этот модуль помечен как core, что означает, что он поддерживается Ansible Core Team. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых Ansible Core Team, см. здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией 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.6/modules/win_get_url_module.html
