mirror of https://github.com/ansible/ansible.git
Add win_get_url module documentation
parent
9eeb4c39f7
commit
ec6a386967
@ -0,0 +1,34 @@
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: win_get_url
|
||||
version_added: "1.7"
|
||||
short_description: Fetches a file from a given URL
|
||||
description:
|
||||
- Fetches a file from a URL and saves to locally
|
||||
options:
|
||||
url:
|
||||
description:
|
||||
- The full URL of a file to download
|
||||
required: true
|
||||
default: null
|
||||
aliases: []
|
||||
dest:
|
||||
description:
|
||||
- The absolute path of the location to save the file at the URL. Be sure to include a filename and extension as appropriate.
|
||||
required: false
|
||||
default: yes
|
||||
aliases: []
|
||||
author: Paul Durivage
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# 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'
|
||||
win_get_url:
|
||||
url: 'http://www.example.com/earthrise.jpg'
|
||||
dest: 'C:\Users\RandomUser\earthrise.jpg'
|
||||
'''
|
Loading…
Reference in New Issue