W3cubDocs

/Ansible

win_get_url - Fetches a file from a given URL

New in version 1.7.

Synopsis

  • Fetches a file from a URL and saves it locally.
  • For non-Windows targets, use the get_url module instead.

Options

parameter required default choices comments
dest
 yes
The location to save the file at the URL.
Be sure to include a filename and extension as appropriate.
force
(added in 2.0)
 no yes
  • yes
  • no
If yes, will always download the file. If no, will only download the file if it does not exist or the remote file has been modified more recently than the local file.
This works by sending an http HEAD request to retrieve last modified time of the requested resource, so for this to work, the remote web server must support HEAD requests.
headers
(added in 2.4)
 no
Add custom HTTP headers to a request (as a dictionary).
proxy_password
(added in 2.0)
 no
Proxy authentication password.
proxy_url
(added in 2.0)
 no
The full URL of the proxy server to download through.
proxy_username
(added in 2.0)
 no
Proxy authentication username.
skip_certificate_validation
 no no
  • yes
  • no
This option is deprecated since v2.4, please use validate_certs instead.
If yes, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
timeout
(added in 2.4)
 no 10
Timeout in seconds for URL request.
url
 yes
The full URL of a file to download.
url_password
 no
Basic authentication password.
aliases: password
url_username
 no
Basic authentication username.
aliases: username
use_proxy
(added in 2.4)
 no yes
  • yes
  • no
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
validate_certs
(added in 2.4)
 no yes
  • yes
  • no
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
If skip_certificate_validation was set, it overrides this option.

Examples

- 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

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
dest
destination file/path
 always string C:\Users\RandomUser\earthrise.jpg
url
requested url
 always string http://www.example.com/earthrise.jpg
msg
Error message, or HTTP status message from web-server
 always string OK
status_code
HTTP status code
 always int 200

Notes

Note

  • For non-Windows targets, use the get_url module instead.

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

Maintenance Info

For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/win_get_url_module.html