New in version 1.7.
parameter | required | default | choices | comments |
---|---|---|---|---|
dest |
yes | The absolute path of 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 | True |
|
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. |
password |
no | Basic authentication password | ||
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 | Skip SSL certificate validation if true | ||
url |
yes | The full URL of a file to download | ||
username |
no | Basic authentication username |
- 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
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
url | requested url | always | string | http://www.example.com/earthrise.jpg |
dest | destination file/path | always | string | C:\Users\RandomUser\earthrise.jpg |
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
This module is maintained by those with core commit privileges
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.