From 5a87f2665822d5f9b22f1e854360d12df6d45235 Mon Sep 17 00:00:00 2001 From: Fabio Alessandro Locati Date: Thu, 15 Dec 2016 23:59:07 +0100 Subject: [PATCH] Improve YAML examples - windows/win_get_url.py (#19404) --- lib/ansible/modules/windows/win_get_url.py | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/lib/ansible/modules/windows/win_get_url.py b/lib/ansible/modules/windows/win_get_url.py index 6c5d5c67c0d..16106583561 100644 --- a/lib/ansible/modules/windows/win_get_url.py +++ b/lib/ansible/modules/windows/win_get_url.py @@ -92,23 +92,18 @@ 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 - -# Playbook example -- name: Download earthrise.jpg to 'C:\\Users\\RandomUser\\earthrise.jpg' +- 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 'C:\Users\RandomUser\earthrise.jpg' only if modified +- 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 'C:\Users\RandomUser\earthrise.jpg' through a proxy server. +- 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 @@ -116,7 +111,8 @@ $ ansible -i hosts -c winrm -m win_get_url -a "url=http://www.example.com/earthr proxy_username: username proxy_password: password ''' -RETURN = ''' + +RETURN = r''' url: description: requested url returned: always @@ -126,5 +122,5 @@ dest: description: destination file/path returned: always type: string - sample: 'C:\\Users\\RandomUser\\earthrise.jpg' + sample: C:\Users\RandomUser\earthrise.jpg '''