ansible.windows.win_get_url – Загрузка файла из HTTP, HTTPS или FTP на узел
Примечание
Этот плагин входит в состав коллекции ansible.windows (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install ansible.windows.
Для использования в плейбуке укажите: ansible.windows.win_get_url.
Описание
- Загрузка файлов из HTTP, HTTPS или FTP на удаленный сервер.
- Удаленный сервер должен иметь прямой доступ к удаленному ресурсу.
- Для целевых систем, отличных от Windows, используйте модуль ansible.builtin.get_url вместо этого.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| checksum строка | Если в этот параметр передается checksum, после загрузки файла в место назначения будет вычислен хэш-код, чтобы обеспечить его целостность и подтвердить успешность передачи. Этот параметр нельзя использовать с параметром checksum_url. | |
| checksum_algorithm строка |
| Указывает алгоритм хэширования, используемый при вычислении контрольной суммы удаленного и целевого файла. |
| checksum_url строка | Указывает URL, содержащий значения контрольной суммы для ресурса по адресу url. Аналогично checksum, это используется для проверки целостности удаленной передачи.Этот параметр нельзя использовать с параметром checksum. | |
| client_cert строка | Путь к клиенту сертификат (.pfx), используемый для X509 аутентификации. Этот путь может быть либо путем к pfx в файловой системе, либо путем к сертификату PowerShell Cert:\CurrentUser\My\<thumbprint>. Подключение WinRM должно быть аутентифицировано с помощью CredSSP или become используется в задаче, если файл сертификата не защищен паролем.Другие типы аутентификации могут установить client_cert_password, если сертификат защищен паролем. | |
| client_cert_password строка | Пароль для client_cert, если сертификат защищен паролем. | |
| dest путь / обязательно | Место сохранения файла по указанному URL. Убедитесь, что указано имя файла и расширение, если необходимо. | |
| follow_redirects строка |
| Следовать ли перенаправлениям. all будет следовать всем перенаправлениям.none не будет следовать ни одному перенаправлению.safe будет следовать только "безопасным" перенаправлениям, где "безопасный" означает, что клиент выполняет только GET или HEAD для URI, на который он перенаправляется.При слежении за перенаправленным URL заголовок Authorization и любые установленные учетные данные будут удалены и не будут перенаправлены. |
| force булево |
| Если yes, файл будет скачиваться каждый раз и заменяться, если содержимое изменится. Если no, файл будет скачиваться только в том случае, если он не существует или удаленный файл был изменен позже, чем локальный файл.Это работает путем отправки запроса http HEAD для получения времени последнего изменения запрошенного ресурса, поэтому для этого необходимо, чтобы удаленный веб-сервер поддерживал запросы HEAD. |
| force_basic_auth булево |
| По умолчанию заголовок аутентификации отправляется только тогда, когда веб-сервис отвечает на первоначальный запрос статусом 401. Поскольку некоторые службы basic auth не отправляют должным образом 401, вход в систему будет неудачным. Этот параметр принудительно отправляет заголовок Basic аутентификации при первоначальном запросе. |
| headers словарь | Дополнительные заголовки для установки в запросе. Это должен быть словарь, где ключ — имя заголовка, а значение — значение этого заголовка. | |
| http_agent строка | По умолчанию: "ansible-httpget" | Заголовок, идентифицирующий пользователя, обычно отображается в журналах веб-сервера. Это устанавливается в заголовок User-Agent HTTP-запроса. |
| maximum_redirection целое число | По умолчанию: 50 | Укажите, сколько раз модуль будет перенаправлять соединение на альтернативный URI, прежде чем соединение завершится ошибкой. Если установлено значение 0 или follow_redirects установлено в значение none, или safe при отсутствии GET или HEAD, это предотвращает все перенаправления. |
| proxy_password строка | Пароль для proxy_username. | |
| proxy_url строка | Явный прокси-сервер для использования в запросе. По умолчанию запрос будет использовать прокси-сервер IE, если не установлено значение use_proxy в no. | |
| proxy_use_default_credential булево |
| Использует учетные данные текущего пользователя при аутентификации на сервере прокси, защищенном NTLM, Kerberos, или Negotiate аутентификацией.Прокси, использующие Basic аутентификацию, по-прежнему будут требовать явных учетных данных через параметры proxy_username и proxy_password.Модуль будет иметь доступ к учетным данным пользователя только при использовании become с паролем, подключении с помощью SSH с паролем или подключении с WinRM с использованием CredSSP или Kerberos with delegation.Если не используется become или другой метод аутентификации, упомянутый выше, доступных учетных данных по умолчанию не будет, и аутентификация прокси не будет выполнена. |
| proxy_username строка | Имя пользователя для аутентификации прокси-сервера. | |
| url строка / обязательно | Полный URL файла для загрузки. | |
| url_method строка | Метод HTTP запроса. псевдонимы: method | |
| url_password строка | Пароль для url_username. Псевдоним password устарел и будет удален в следующей крупной версии после 2022-07-01.псевдонимы: password | |
| url_timeout целое число | По умолчанию: 30 | Указывает, сколько времени запрос может ожидать, прежде чем истечет время ожидания (в секундах). Установите значение 0 для задания бесконечного таймаута.псевдонимы: timeout |
| url_username строка | Имя пользователя для аутентификации. Псевдонимы user и username устарели и будут удалены в следующей крупной версии после 2022-07-01.псевдонимы: user, username | |
| use_default_credential булево |
| Использует учетные данные текущего пользователя при аутентификации на сервере, защищенном NTLM, Kerberos, или Negotiate аутентификацией.Для сайтов, использующих Basic аутентификацию, все равно потребуются явные учетные данные через параметры url_username и url_password.Модуль будет иметь доступ к учетным данным пользователя только при использовании become с паролем, подключении с помощью SSH с паролем или подключении с WinRM с использованием CredSSP или Kerberos with delegation.Если не используется become или другой метод аутентификации, указанный выше, доступных учетных данных по умолчанию не будет, и аутентификация не будет выполнена. |
| use_proxy булево |
| Если no, прокси, определенный в IE для текущего пользователя, не будет использован. |
| validate_certs булево |
| Если no, сертификаты SSL не будут проверяться.Это следует использовать только на сайтах, контролируемых лично, использующих самозаверенные сертификаты. |
Примечания
Примечание
- Если в вашем URL присутствует экранированный символ косой черты (%2F), этот модуль преобразует его в реальный символ косой черты. Это результат поведения класса System.Uri, как описано в документации.
См. также
См. также
- ansible.builtin.get_url
-
Официальная документация модуля ansible.builtin.get_url.
- ansible.builtin.uri
-
Официальная документация модуля ansible.builtin.uri.
- ansible.windows.win_uri
-
Официальная документация модуля ansible.windows.win_uri.
- community.windows.win_inet_proxy
-
Официальная документация модуля community.windows.win_inet_proxy.
Примеры
- name: Download earthrise.jpg to specified path
ansible.windows.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
ansible.windows.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.
ansible.windows.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
ansible.windows.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
ansible.windows.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
ansible.windows.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 | успех и файл был загружен в место назначения | контрольная сумма (<алгоритм>) файла после загрузки Пример: 6e642bb8dd5c2e027bf21dd923337cbb4214f827 |
| checksum_src string | force=yes или файл назначения не существовал | контрольная сумма (<алгоритм>) удалённого ресурса Пример: 6e642bb8dd5c2e027bf21dd923337cbb4214f827 |
| dest string | всегда | файл/путь назначения Пример: C:\Users\RandomUser\earthrise.jpg |
| elapsed float | всегда | Прошедшие секунды между началом опроса и окончанием работы модуля. Пример: 2.1406487 |
| msg string | всегда | Сообщение об ошибке или сообщение об HTTP статусе от веб-сервера Пример: OK |
| size integer | успех | размер файла назначения Пример: 1220 |
| status_code integer | всегда | HTTP код состояния Пример: 200 |
| url string | всегда | запрошенный URL Пример: http://www.example.com/earthrise.jpg |
Авторы
- Paul Durivage (@angstwad)
- Takeshi Kuramochi (@tksarah)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/windows/win_get_url_module.html
