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. | |
| client_cert строка добавлен в 2.9 | Путь к клиенту сертификату (.pfx), используемому для проверки подлинности X509. Этот путь может быть путём к pfx в файловой системе или путём к сертификату PowerShell Cert:\CurrentUser\My\<thumbprint>.Подключение WinRM должно быть аутентифицировано с использованием CredSSP или become используется в задаче, если файл сертификата не защищён паролем.Другие типы аутентификации могут установить client_cert_password, если сертификат защищён паролем. | |
| client_cert_password строка добавлен в 2.9 | Пароль к client_cert, если сертификат защищён паролем. | |
| dest путь / обязательно | Расположение для сохранения файла по URL. Убедитесь, что вы указали имя файла и расширение. | |
| follow_redirects строка добавлен в 2.9 |
| Указывает, следует ли модулю перенаправлять запросы. all будет следовать всем перенаправлениям.none не будет следовать никаким перенаправлениям.safe будет следовать только "безопасным" перенаправлениям, где "безопасным" означает, что клиент выполняет только GET или HEAD по URI, на который он перенаправляется. |
| force булево |
| Если yes, будет загружать файл каждый раз и заменять файл, если содержимое изменится. Если no, будет загружать файл только если он не существует или удалённый файл был изменён позже, чем локальный файл.Это работает путём отправки запроса http HEAD для получения времени последнего изменения запрошенного ресурса, поэтому для этого необходимо, чтобы удалённый веб-сервер поддерживал запросы HEAD. |
| force_basic_auth булево добавлен в 2.5 |
| По умолчанию заголовок аутентификации отправляется только тогда, когда веб-сервис отвечает на начальный запрос статусом 401. Поскольку некоторые сервисы basic auth не отправляют 401 должным образом, вход в систему может не получиться. Этот параметр принудительно отправляет заголовок базовой аутентификации в первоначальном запросе. |
| headers словарь добавлен в 2.4 | Дополнительные заголовки для установки в запросе. Это должен быть словарь, где ключ - имя заголовка, а значение - значение заголовка. | |
| http_agent строка добавлен в 2.9 | Значение по умолчанию: "ansible-httpget" | Заголовок, используемый для идентификации, обычно отображается в логах веб-сервера. Это устанавливается в User-Agent заголовке HTTP-запроса. |
| maximum_redirection целое число добавлен в 2.9 | Значение по умолчанию: 50 | Указывает, сколько раз модуль будет перенаправлять соединение на альтернативный URI, прежде чем соединение завершится ошибкой. Если установлено значение 0 или follow_redirects установлено в none, или safe при отсутствии GET или HEAD, это предотвращает все перенаправления. |
| method строка добавлен в 2.9 | Этот параметр не используется с win_get_url и должен быть проигнорирован. | |
| proxy_password строка | Пароль к proxy_username. | |
| proxy_url строка | Явный прокси-сервер, используемый для запроса. По умолчанию запрос будет использовать прокси, определённый в IE, если параметр use_proxy не установлен в no. | |
| proxy_use_default_credential булево добавлен в 2.9 |
| Использует учетные данные текущего пользователя при аутентификации на прокси-сервере, защищённом NTLM, Kerberos, или Negotiate аутентификацией.Прокси, использующие Basic аутентификацию, всё равно потребуют явных учетных данных через параметры proxy_username и proxy_password.Модуль получит доступ к учетным данным пользователя только в случае использования become с паролем, подключения по SSH с паролем или подключения по WinRM с CredSSP или Kerberos with delegation аутентификацией.Если не используется become или другой метод аутентификации, упомянутый выше, доступ к учетным данным пользователя отсутствует, и аутентификация на прокси-сервере не происходит. |
| proxy_username строка | Имя пользователя для аутентификации на прокси-сервере. | |
| timeout целое число добавлен в 2.4 | Значение по умолчанию: 30 | Указывает, сколько времени запрос может находиться в ожидании перед истечением срока ожидания (в секундах). Установлено в 0 для указания бесконечного таймаута. |
| url строка / обязательно | Полный URL файла для загрузки. | |
| url_password строка | Пароль к url_username. псевдонимы: password | |
| url_username строка | Имя пользователя для аутентификации. псевдонимы: user, username | |
| use_default_credential булево добавлен в 2.9 |
| Использует учетные данные текущего пользователя при аутентификации на сервере, защищённом NTLM, Kerberos, или Negotiate аутентификацией.Сайты, использующие Basic аутентификацию, по-прежнему потребуют явных учетных данных через параметры url_username и url_password.Модуль получит доступ к учетным данным пользователя только в случае использования become с паролем, подключения по SSH с паролем или подключения по WinRM с CredSSP или Kerberos with delegation аутентификацией.Если не используется become или другой метод аутентификации, упомянутый выше, доступ к учетным данным пользователя отсутствует, и аутентификация не происходит. |
| use_proxy boolean added in 2.4 |
| If no, it will not use the proxy defined in IE for the current user. |
| validate_certs boolean added in 2.4 |
| If no, SSL certificates will not be validated.This should only be used on personally controlled sites using self-signed certificates. |
Примечания
Примечание
- If your URL includes an escaped slash character (%2F) this module will convert it to a real slash. This is a result of the behaviour of the System.Uri class as described in the documentation.
- Since Ansible 2.8, the module will skip reporting a change if the remote checksum is the same as the local local even when
force=yes. This is to better align with get_url.
См. также
См. также
- get_url – Загрузка файлов из HTTP, HTTPS или FTP на узел
- Официальная документация модуля get_url.
- uri – Взаимодействие с веб-сервисами
- Официальная документация модуля uri.
- win_uri – Взаимодействие с веб-сервисами
- Официальная документация модуля win_uri.
- win_inet_proxy – Управление настройками прокси для WinINet и Internet Explorer
- Официальная документация модуля win_inet_proxy.
Примеры
- 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 string | успех и файл dest загружен | <algorithm> контрольная сумма файла после загрузки Пример: 6e642bb8dd5c2e027bf21dd923337cbb4214f827 |
| checksum_src string | force=yes или dest не существовал | <algorithm> контрольная сумма удалённого ресурса Пример: 6e642bb8dd5c2e027bf21dd923337cbb4214f827 |
| dest string | всегда | путь к целевому файлу Пример: C:\Users\RandomUser\earthrise.jpg |
| elapsed float | всегда | Прошедшие секунды с начала опроса до завершения модуля. Пример: 2.1406487 |
| msg string | всегда | Сообщение об ошибке или сообщение со статусом HTTP от веб-сервера Пример: OK |
| size integer | успех | размер файла dest Пример: 1220 |
| status_code integer | всегда | Код состояния HTTP Пример: 200 |
| url string | всегда | запрошенный URL Пример: http://www.example.com/earthrise.jpg |
Статус
- В дальнейшем изменения интерфейса модуля будут гарантированно иметь обратную совместимость. [stableinterface]
- Этот модуль поддерживается командой Ansible Core. [core]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля Red Hat см. в статье базы знаний Red Hat Red Hat Knowledge Base article.
Авторы
- 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.9/modules/win_get_url_module.html
