win_get_url - Загрузка файла по указанному URL
Новая версия с 1.7.
Описание
- Загрузка файла по URL и сохранение его локально.
- Для платформ, отличных от Windows, используйте модуль get_url.
Параметры
| параметр | обязательный | по умолчанию | допустимые значения | комментарии |
|---|---|---|---|---|
| dest | да | Место сохранения файла по URL. Убедитесь, что указано имя файла и расширение. | ||
| force (добавлен в 2.0)
| нет | да |
| Если yes, файл всегда будет загружен. Если no, файл будет загружен только в случае его отсутствия или если удаленный файл был изменён позже, чем локальный.Для этого используется запрос http HEAD для получения времени последнего изменения запрошенного ресурса, поэтому для этого требуется поддержка запросов HEAD у удалённого веб-сервера. |
| 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 | нет | Пароль для базовой аутентификации. псевдонимы: password | ||
| url_username | нет | Имя пользователя для базовой аутентификации. псевдонимы: 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| dest | путь/файл назначения | всегда | строка | C:\Users\RandomUser\earthrise.jpg |
| msg | Сообщение об ошибке или сообщение об HTTP-статусе от веб-сервера | всегда | строка | OK |
| status_code | код HTTP-статуса | всегда | целое число | 200 |
| url | запрошенный URL | всегда | строка | http://www.example.com/earthrise.jpg |
Примечания
Примечание
- Для платформ, отличных от Windows, используйте модуль get_url.
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики гарантируют отсутствие несовместимых изменений интерфейса.
Информация о поддержке
Дополнительную информацию о поддержке этого модуля Red Hat можно найти в knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>.
Для помощи в разработке модулей, если вам это интересно, пожалуйста, ознакомьтесь с Справочной информацией по сообществу и участию, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/win_get_url_module.html
