diff --git a/windows/win_get_url.py b/windows/win_get_url.py index 1492cb44f05..041eb563d00 100644 --- a/windows/win_get_url.py +++ b/windows/win_get_url.py @@ -47,7 +47,10 @@ options: description: - If C(yes), will always download the file. If C(no), will only download the file if it does not exist or the remote file has been - modified more recently than the local file. + 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. version_added: "2.0" required: false choices: [ "yes", "no" ] @@ -87,25 +90,37 @@ options: EXAMPLES = r''' # Downloading a JPEG and saving it to a file with the ansible command. # Note the "dest" is quoted rather instead of escaping the backslashes -$ ansible -i hosts -c winrm -m win_get_url -a "url=http://www.example.com/earthrise.jpg dest='C:\Users\Administrator\earthrise.jpg'" all +$ ansible -i hosts -c winrm -m win_get_url -a "url=http://www.example.com/earthrise.jpg dest='C:\\Users\\Administrator\\earthrise.jpg'" all # Playbook example -- name: Download earthrise.jpg to 'C:\Users\RandomUser\earthrise.jpg' +- name: Download earthrise.jpg to 'C:\\Users\\RandomUser\\earthrise.jpg' win_get_url: url: 'http://www.example.com/earthrise.jpg' - dest: 'C:\Users\RandomUser\earthrise.jpg' + dest: 'C:\\Users\\RandomUser\\earthrise.jpg' -- name: Download earthrise.jpg to 'C:\Users\RandomUser\earthrise.jpg' only if modified +- name: Download earthrise.jpg to 'C:\\Users\\RandomUser\\earthrise.jpg' only if modified win_get_url: url: 'http://www.example.com/earthrise.jpg' - dest: 'C:\Users\RandomUser\earthrise.jpg' + dest: 'C:\\Users\\RandomUser\\earthrise.jpg' force: no -- name: Download earthrise.jpg to 'C:\Users\RandomUser\earthrise.jpg' through a proxy server. +- name: Download earthrise.jpg to 'C:\\Users\\RandomUser\\earthrise.jpg' through a proxy server. win_get_url: url: 'http://www.example.com/earthrise.jpg' - dest: 'C:\Users\RandomUser\earthrise.jpg' + dest: 'C:\\Users\\RandomUser\\earthrise.jpg' proxy_url: 'http://10.0.0.1:8080' proxy_username: 'username' proxy_password: 'password' ''' +RETURN = ''' +url: + description: requested url + returned: always + type: string + sample: 'http://www.example.com/earthrise.jpg' +dest: + description: destination file/path + returned: always + type: string + sample: 'C:\\Users\\RandomUser\\earthrise.jpg' +'''