summaryrefslogtreecommitdiff
path: root/windows
diff options
context:
space:
mode:
author= <jhawkesworth@users.noreply.github.com>2016-05-27 18:53:35 +0100
committer= <jhawkesworth@users.noreply.github.com>2016-05-27 18:53:35 +0100
commit2cc212fb377fa252ac9bdbba62e3d999efa242ee (patch)
tree183f1a71e40803b1b449c6ca811ebd7abe9caae0 /windows
parent8cb463d2501602497fd92023eaf3b819853559c3 (diff)
downloadansible-modules-core-2cc212fb377fa252ac9bdbba62e3d999efa242ee.tar.gz
document how force=no works for win_get_url and add RETURN
Diffstat (limited to 'windows')
-rw-r--r--windows/win_get_url.py17
1 files changed, 16 insertions, 1 deletions
diff --git a/windows/win_get_url.py b/windows/win_get_url.py
index 1492cb44..5ce3bd52 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" ]
@@ -109,3 +112,15 @@ $ ansible -i hosts -c winrm -m win_get_url -a "url=http://www.example.com/earthr
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'
+'''