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, будет использован WebClient Microsoft для обработки аутентификации. |
| 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:\Пользователи\СлучайныйПользователь\восход_земли.jpg |
| msg строка | всегда | Сообщение об ошибке или сообщение об HTTP-статусе с веб-сервера Пример: OK |
| status_code целое число | всегда | HTTP-код состояния Пример: 200 |
| url строка | всегда | запрашиваемый URL Пример: http://www.example.com/восход_земли.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.7/modules/win_get_url_module.html
