mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 03:41:25 -07:00
eb1214baad
Changes to the metadata format were approved here: https://github.com/ansible/proposals/issues/54 * Update documentation to the new metadata format * Changes to metadata-tool to account for new metadata * Add GPL license header * Add upgrade subcommand to upgrade metadata version * Change default metadata to the new format * Fix exclusion of non-modules from the metadata report * Fix ansible-doc for new module metadata * Exclude metadata version from ansible-doc output * Fix website docs generation for the new metadata * Update metadata schema in valiate-modules test * Update the metadata in all modules to the new version
127 lines
3.6 KiB
Python
127 lines
3.6 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# (c) 2014, Paul Durivage <paul.durivage@rackspace.com>, and others
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
# this is a windows documentation stub. actual code lives in the .ps1
|
|
# file of the same name
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.0',
|
|
'status': ['stableinterface'],
|
|
'supported_by': 'core'}
|
|
|
|
|
|
DOCUMENTATION = r'''
|
|
---
|
|
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
|
|
author:
|
|
- "Paul Durivage (@angstwad)"
|
|
- "Takeshi Kuramochi (tksarah)"
|
|
options:
|
|
url:
|
|
description:
|
|
- The full URL of a file to download
|
|
required: true
|
|
default: null
|
|
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: true
|
|
default: null
|
|
force:
|
|
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. 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" ]
|
|
default: yes
|
|
username:
|
|
description:
|
|
- Basic authentication username
|
|
required: false
|
|
default: null
|
|
password:
|
|
description:
|
|
- Basic authentication password
|
|
required: false
|
|
default: null
|
|
skip_certificate_validation:
|
|
description:
|
|
- Skip SSL certificate validation if true
|
|
required: false
|
|
default: false
|
|
proxy_url:
|
|
description:
|
|
- The full URL of the proxy server to download through.
|
|
version_added: "2.0"
|
|
required: false
|
|
proxy_username:
|
|
description:
|
|
- Proxy authentication username
|
|
version_added: "2.0"
|
|
required: false
|
|
proxy_password:
|
|
description:
|
|
- Proxy authentication password
|
|
version_added: "2.0"
|
|
required: false
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- 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
|
|
'''
|
|
|
|
RETURN = r'''
|
|
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
|
|
'''
|