mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 21:00:22 -07:00
Module DOCUMENTATION should match argspec (#34895)
* Module DOCUMENTATION should match argspec Large update of many modules so that DOCUMENTATION option name and aliases match those defined in the argspec. Issues identified by https://github.com/ansible/ansible/pull/34809 In addition to many typos and missing aliases, the following notable changes were made: * Create `module_docs_fragments/url.py` for `url_argument_spec` * `dellos*_command` shouldn't have ever had `waitfor` (was incorrectly copied) * `ce_aaa_server_host.py` `s/raduis_server_type/radius_server_type/g` * `Junos_lldp` enable should be part of `state`.
This commit is contained in:
parent
c386ae9498
commit
195beebcb4
123 changed files with 406 additions and 132 deletions
|
@ -26,6 +26,7 @@ options:
|
|||
You can omit this option if the environment variable C(F5_PASSWORD)
|
||||
is set.
|
||||
required: true
|
||||
aliases: ['pass', 'pwd']
|
||||
server:
|
||||
description:
|
||||
- The BIG-IP host. You can omit this option if the environment
|
||||
|
|
|
@ -40,10 +40,12 @@ options:
|
|||
description:
|
||||
- This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required.
|
||||
For more information, please read the documentation U(https://goo.gl/BRu78Z).
|
||||
aliases: ['user']
|
||||
password:
|
||||
required: true
|
||||
description:
|
||||
- Password for the specified user.
|
||||
aliases: ['pass']
|
||||
|
||||
requirements:
|
||||
- A physical or virtual clustered Data ONTAP system. The modules were developed with Clustered Data ONTAP 8.3
|
||||
|
|
72
lib/ansible/utils/module_docs_fragments/url.py
Normal file
72
lib/ansible/utils/module_docs_fragments/url.py
Normal file
|
@ -0,0 +1,72 @@
|
|||
# (c) 2018, John Barker<gundalow@redhat.com>
|
||||
#
|
||||
# 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/>.
|
||||
|
||||
|
||||
class ModuleDocFragment(object):
|
||||
|
||||
# Standard files documentation fragment
|
||||
DOCUMENTATION = """
|
||||
options:
|
||||
url:
|
||||
description:
|
||||
- HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path
|
||||
force:
|
||||
description:
|
||||
- If C(yes) do not get a cached copy.
|
||||
aliases:
|
||||
- thirsty
|
||||
type: bool
|
||||
default: no
|
||||
http_agent:
|
||||
description:
|
||||
- Header to identify as, generally appears in web server logs.
|
||||
default: ansible-httpget
|
||||
use_proxy:
|
||||
description:
|
||||
- If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
|
||||
type: bool
|
||||
default: yes
|
||||
validate_certs:
|
||||
description:
|
||||
- If C(no), SSL certificates will not be validated. This should only be used
|
||||
on personally controlled sites using self-signed certificates.
|
||||
default: yes
|
||||
type: bool
|
||||
url_username:
|
||||
description:
|
||||
- The username for use in HTTP basic authentication.
|
||||
- This parameter can be used without I(url_password) for sites that allow empty passwords
|
||||
url_password:
|
||||
description:
|
||||
- The password for use in HTTP basic authentication.
|
||||
- If the I(url_username) parameter is not specified, the I(url_password) parameter will not be used.
|
||||
force_basic_auth:
|
||||
description:
|
||||
- Credentials specified with I(url_username) and I(url_password) should be passed in HTTP Header.
|
||||
default: no
|
||||
type: bool
|
||||
client_cert:
|
||||
description:
|
||||
- PEM formatted certificate chain file to be used for SSL client
|
||||
authentication. This file can also include the key as well, and if
|
||||
the key is included, C(client_key) is not required.
|
||||
client_key:
|
||||
description:
|
||||
- PEM formatted file that contains your private key to be used for SSL
|
||||
client authentication. If C(client_cert) contains both the certificate
|
||||
and key, this option is not required.
|
||||
"""
|
|
@ -31,7 +31,7 @@ options:
|
|||
- The vca password, if not set the environment variable C(VCA_PASS) is checked for the password.
|
||||
required: false
|
||||
default: None
|
||||
aliases: ['pass', 'pwd']
|
||||
aliases: ['pass', 'passwd']
|
||||
org:
|
||||
description:
|
||||
- The org to login to for creating vapp. This option is required when the C(service_type) is I(vdc).
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue