ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-02 14:40:19 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Clean up module documentation (#36909)

Browse source 
* Clean up module documentation

This PR includes:
- Removal of `default: None` (and variations)
- Removal of `required: false`
- Fixing booleans and `type: bool` where required

* Fix remaining (new) validation issues
This commit is contained in:
Dag Wieers 2018-03-15 22:15:24 +01:00 • committed by GitHub
parent 58eb2e849d
commit cdd21e2170
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
624 changed files with 1458 additions and 9114 deletions
Download patch file Download diff file Expand all files Collapse all files

11
lib/ansible/utils/module_docs_fragments/a10.py
View file

@ -28,35 +28,30 @@ options:
description:
- Hostname or IP of the A10 Networks device.
required: true
default: null
username:
description:
- An account with administrator privileges.
required: true
aliases: ['user', 'admin']
default: null
password:
description:
- Password for the C(username) account.
required: true
aliases: ['pass', 'pwd']
default: null
write_config:
description:
- If C(yes), any changes will cause a write of the running configuration
to non-volatile memory. This will save I(all) configuration changes,
including those that may have been made manually or through other modules,
so care should be taken when specifying C(yes).
required: false
version_added: 2.2
default: "no"
choices: ["yes", "no"]
type: bool
default: 'no'
validate_certs:
description:
- If C(no), SSL certificates will not be validated. This should only be used
on personally controlled devices using self-signed certificates.
required: false
version_added: 2.2
type: bool
default: 'yes'
choices: ['yes', 'no']
"""

4
lib/ansible/utils/module_docs_fragments/aci.py
View file

@ -18,8 +18,9 @@ options:
port:
description:
- Port number to be used for REST connection.
- The default value depends on parameter `use_ssl`.
type: int
default: 443 (for https), 80 (for http)
default: 443 (https), 80 (http)
username:
description:
- The username to use for authentication.
@ -41,7 +42,6 @@ options:
description:
- The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.
- It defaults to the C(private_key) basename, without extension.
default: private_key basename
aliases: [ cert_name ]
output_level:
description:

2
lib/ansible/utils/module_docs_fragments/aireos.py
View file

@ -25,7 +25,6 @@ options:
provider:
description:
- A dict object containing connection details.
default: null
suboptions:
host:
description:
@ -50,7 +49,6 @@ options:
the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
default: null
timeout:
description:
- Specifies the timeout in seconds for communicating with the network device

2
lib/ansible/utils/module_docs_fragments/aruba.py
View file

@ -25,7 +25,6 @@ options:
provider:
description:
- A dict object containing connection details.
default: null
suboptions:
host:
description:
@ -50,7 +49,6 @@ options:
the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
default: null
timeout:
description:
- Specifies the timeout in seconds for communicating with the network device

12
lib/ansible/utils/module_docs_fragments/asa.py
View file

@ -34,13 +34,12 @@ options:
attempt to execute all commands in non-privileged mode. If the value
is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead.
default: no
choices: ['yes', 'no']
type: bool
default: 'no'
context:
description:
- Specifies which context to target if you are running in the ASA in
multiple context mode. Defaults to the current context you login to.
default: null
provider:
description:
- B(Deprecated)
@ -48,7 +47,6 @@ options:
- For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols).
- HORIZONTALLINE
- A dict object containing connection details.
default: null
suboptions:
host:
description:
@ -72,7 +70,6 @@ options:
the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
default: null
ssh_keyfile:
description:
- Specifies the SSH key to use to authenticate the connection to
@ -87,15 +84,14 @@ options:
attempt to execute all commands in non-privileged mode. If the value
is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead.
default: no
choices: ['yes', 'no']
type: bool
default: 'no'
auth_pass:
description:
- Specifies the password to use if required to enter privileged mode
on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
default: none
timeout:
description:
- Specifies idle timeout in seconds for the connection, in seconds. Useful

10
lib/ansible/utils/module_docs_fragments/auth_basic.py
View file

@ -20,23 +20,17 @@ class ModuleDocFragment(object):
DOCUMENTATION = """
options:
api_url:
required: false
default: null
description:
- The resolvable endpoint for the API
api_username:
required: false
default: null
description:
- The username to use for authentication against the API
api_password:
required: false
default: null
description:
- The password to use for authentication against the API
validate_certs:
required: false
default: yes
description:
- Whether or not to validate SSL certs when supplying a https endpoint.
type: bool
default: 'yes'
"""

16
lib/ansible/utils/module_docs_fragments/aws.py
View file

@ -26,42 +26,28 @@ options:
- Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints).
Ignored for modules where region is required. Must be specified for all other modules if region is not used.
If not set then the value of the EC2_URL environment variable, if any, is used.
required: false
default: null
aliases: []
aws_secret_key:
description:
- AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
required: false
default: null
aliases: [ 'ec2_secret_key', 'secret_key' ]
aws_access_key:
description:
- AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
required: false
default: null
aliases: [ 'ec2_access_key', 'access_key' ]
security_token:
description:
- AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
required: false
default: null
aliases: [ 'access_token' ]
version_added: "1.6"
validate_certs:
description:
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
required: false
default: "yes"
type: bool
aliases: []
default: 'yes'
version_added: "1.5"
profile:
description:
- Uses a boto profile. Only works with boto >= 2.24.0.
required: false
default: null
aliases: []
version_added: "1.6"
requirements:
- "python >= 2.6"

15
lib/ansible/utils/module_docs_fragments/azure.py
View file

@ -28,39 +28,25 @@ options:
description:
- Active Directory username. Use when authenticating with an Active Directory user rather than service
principal.
required: false
default: null
password:
description:
- Active Directory user password. Use when authenticating with an Active Directory user rather than service
principal.
required: false
default: null
profile:
description:
- Security profile found in ~/.azure/credentials file.
required: false
default: null
subscription_id:
description:
- Your Azure subscription Id.
required: false
default: null
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal.
required: false
default: null
secret:
description:
- Azure client secret. Use when authenticating with a Service Principal.
required: false
default: null
tenant:
description:
- Azure tenant ID. Use when authenticating with a Service Principal.
required: false
default: null
cloud_environment:
description:
- For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud),
@ -74,7 +60,6 @@ options:
when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be
set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable.
choices: [validate, ignore]
default: null
version_added: 2.5
auth_source:
description:

6
lib/ansible/utils/module_docs_fragments/azure_tags.py
View file

@ -28,12 +28,10 @@ options:
- >
Dictionary of string:string pairs to assign as metadata to the object.
Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.
required: false
default: null
append_tags:
description:
- Use to control if tags field is canonical or just appends to existing tags.
When canonical, any tags not found in the tags parameter will be removed from the object's metadata.
default: True
required: false
type: bool
default: 'yes'
'''

6
lib/ansible/utils/module_docs_fragments/ce.py
View file

@ -24,7 +24,6 @@ options:
provider:
description:
- A dict object containing connection details.
default: null
suboptions:
host:
description:
@ -38,7 +37,6 @@ options:
device. This value applies to either I(cli) or I(netconf). The port
value will default to the appropriate transport common port if
none is provided in the task. (cli=22, netconf=22).
required: false
default: 0 (use common port)
username:
description:
@ -46,22 +44,18 @@ options:
the remote device. This value is used to authenticate the CLI login.
If the value is not specified in the task, the value of environment
variable C(ANSIBLE_NET_USERNAME) will be used instead.
required: false
password:
description:
- Specifies the password to use to authenticate the connection to
the remote device. This is a common argument used for cli
transports. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
required: false
default: null
ssh_keyfile:
description:
- Specifies the SSH key to use to authenticate the connection to
the remote device. This argument is used for the I(cli)
transport. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
required: false
transport:
description:
- Configures the transport connection to use when connecting to the

7
lib/ansible/utils/module_docs_fragments/cnos.py
View file

@ -29,7 +29,6 @@ options:
Usually the location is the results folder, but you can
choose another location based on your write permission.
required: true
default: Null
version_added: 2.3
host:
description:
@ -40,7 +39,6 @@ options:
an abstraction of the group of network elements that need to be
configured.
required: true
default: Null
version_added: 2.3
username:
description:
@ -51,7 +49,6 @@ options:
variable. This parameter is optional. If it is not specified, no
default value will be used.
required: true
default: Null
version_added: 2.3
password:
description:
@ -62,7 +59,6 @@ options:
variable. This parameter is optional. If it is not specified, no
default value will be used.
required: true
default: Null
version_added: 2.3
enablePassword:
description:
@ -72,8 +68,6 @@ options:
should come from the inventory file, you can also specify it as a
variable. This parameter is optional. If it is not specified,
no default value will be used.
required: false
default: Null
version_added: 2.3
deviceType:
description:
@ -81,7 +75,6 @@ options:
The choices NE1072T,NE1032,NE1032T,NE10032,
NE2572 are added since version 2.4
required: Yes
default: null
choices: [g8272_cnos,g8296_cnos,g8332_cnos,NE1072T,NE1032,
NE1032T,NE10032,NE2572]
version_added: 2.3

2
lib/ansible/utils/module_docs_fragments/dellos10.py
View file

@ -27,7 +27,6 @@ options:
provider:
description:
- A dict object containing connection details.
default: null
suboptions:
host:
description:
@ -50,7 +49,6 @@ options:
- Password to authenticate the SSH session to the remote device. If the
value is not specified in the task, the value of environment variable
C(ANSIBLE_NET_PASSWORD) will be used instead.
default: null
ssh_keyfile:
description:
- Path to an ssh key used to authenticate the SSH session to the remote

2
lib/ansible/utils/module_docs_fragments/dellos6.py
View file

@ -27,7 +27,6 @@ options:
provider:
description:
- A dict object containing connection details.
default: null
suboptions:
host:
description:
@ -50,7 +49,6 @@ options:
- Password to authenticate the SSH session to the remote device. If the
value is not specified in the task, the value of environment variable
C(ANSIBLE_NET_PASSWORD) will be used instead.
default: null
ssh_keyfile:
description:
- Path to an ssh key used to authenticate the SSH session to the remote

2
lib/ansible/utils/module_docs_fragments/dellos9.py
View file

@ -27,7 +27,6 @@ options:
provider:
description:
- A dict object containing connection details.
default: null
suboptions:
host:
description:
@ -50,7 +49,6 @@ options:
- Password to authenticate the SSH session to the remote device. If the
value is not specified in the task, the value of environment variable
C(ANSIBLE_NET_PASSWORD) will be used instead.
default: null
ssh_keyfile:
description:
- Path to an ssh key used to authenticate the SSH session to the remote

13
lib/ansible/utils/module_docs_fragments/docker.py
View file

@ -26,7 +26,6 @@ options:
- "The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the
TCP connection string. For example, 'tcp://192.0.2.23:2376'. If TLS is used to encrypt the connection,
the module will automatically replace 'tcp' in the connection URL with 'https'."
required: false
default: "unix://var/run/docker.sock"
aliases:
- docker_url
@ -34,55 +33,43 @@ options:
description:
- When verifying the authenticity of the Docker Host server, provide the expected name of the server.
default: localhost
required: false
api_version:
description:
- The version of the Docker API running on the Docker Host. Defaults to the latest version of the API
supported by docker-py.
required: false
default: default provided by docker-py
aliases:
- docker_api_version
timeout:
description:
- The maximum amount of time in seconds to wait on a response from the API.
required: false
default: 60
cacert_path:
description:
- Use a CA certificate when performing server verification by providing the path to a CA certificate file.
required: false
default: null
aliases:
- tls_ca_cert
cert_path:
description:
- Path to the client's TLS certificate file.
required: false
default: null
aliases:
- tls_client_cert
key_path:
description:
- Path to the client's TLS key file.
required: false
default: null
aliases:
- tls_client_key
ssl_version:
description:
- Provide a valid SSL version number. Default value determined by docker-py, currently 1.0.
required: false
default: "1.0"
tls:
description:
- Secure the connection to the API by using TLS without verifying the authenticity of the Docker host
server.
default: false
tls_verify:
description:
- Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server.
default: false
notes:
- Connect to the Docker daemon by providing parameters with each task or by defining environment variables.

12
lib/ansible/utils/module_docs_fragments/enos.py
View file

@ -23,19 +23,17 @@ options:
attempt to execute all commands in non-privileged mode. If the value
is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead.
default: no
choices: ['yes', 'no']
type: bool
default: 'no'
auth_pass:
description:
- Specifies the password to use if required to enter privileged mode
on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
default: none
provider:
description:
- A dict object containing connection details.
default: null
suboptions:
host:
description:
@ -59,7 +57,6 @@ options:
the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
default: null
timeout:
description:
- Specifies the timeout in seconds for communicating with the network device
@ -80,13 +77,12 @@ options:
attempt to execute all commands in non-privileged mode. If the value
is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead.
default: no
choices: ['yes', 'no']
type: bool
default: 'no'
auth_pass:
description:
- Specifies the password to use if required to enter privileged mode
on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
default: none
'''

20
lib/ansible/utils/module_docs_fragments/eos.py
View file

@ -34,8 +34,8 @@ options:
attempt to execute all commands in non-privileged mode. If the value
is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead.
default: no
choices: ['yes', 'no']
type: bool
default: 'no'
auth_pass:
description:
- B(Deprecated)
@ -47,7 +47,6 @@ options:
on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
default: none
provider:
description:
- B(Deprecated)
@ -56,7 +55,6 @@ options:
- For more information please see the L(EOS Platform Options guide, ../network/user_guide/platform_eos.html).
- HORIZONTALLINE
- A dict object containing connection details.
default: null
suboptions:
host:
description:
@ -84,7 +82,6 @@ options:
the remote device. This is a common argument used for either I(cli)
or I(eapi) transports. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
default: null
timeout:
description:
- Specifies the timeout in seconds for communicating with the network device
@ -104,15 +101,14 @@ options:
attempt to execute all commands in non-privileged mode. If the value
is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead.
default: no
choices: ['yes', 'no']
type: bool
default: 'no'
auth_pass:
description:
- Specifies the password to use if required to enter privileged mode
on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
default: none
transport:
description:
- Configures the transport connection to use when connecting to the
@ -127,19 +123,19 @@ options:
- Configures the I(transport) to use SSL if set to true only when the
C(transport=eapi). If the transport
argument is not eapi, this value is ignored.
default: yes
choices: ['yes', 'no']
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. If the transport
argument is not eapi, this value is ignored.
choices: ['yes', 'no']
type: bool
use_proxy:
description:
- If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored.
type: bool
default: 'yes'
choices: ['yes', 'no']
version_added: "2.5"
notes:

5
lib/ansible/utils/module_docs_fragments/f5.py
View file

@ -50,13 +50,12 @@ options:
on personally controlled sites using self-signed certificates.
You can omit this option if the environment variable
C(F5_VALIDATE_CERTS) is set.
default: yes
type: bool
default: 'yes'
version_added: 2.0
provider:
description:
- A dict object containing connection details.
default: null
version_added: 2.5
suboptions:
password:
@ -88,8 +87,8 @@ options:
on personally controlled sites using self-signed certificates.
You can omit this option if the environment variable
C(F5_VALIDATE_CERTS) is set.
default: yes
type: bool
default: 'yes'
timeout:
description:
- Specifies the timeout in seconds for communicating with the network device

20
lib/ansible/utils/module_docs_fragments/files.py
View file

@ -22,46 +22,33 @@ class ModuleDocFragment(object):
DOCUMENTATION = """
options:
mode:
required: false
default: null
description:
- Mode the file or directory should be. For those used to I(/usr/bin/chmod) remember that modes are actually octal numbers (like C(0644) or C(01777)).
Leaving off the leading zero will likely have unexpected results.
As of version 1.8, the mode may be specified as a symbolic mode (for example, C(u+rwx) or C(u=rw,g=r,o=r)).
owner:
required: false
default: null
description:
- Name of the user that should own the file/directory, as would be fed to I(chown).
group:
required: false
default: null
description:
- Name of the group that should own the file/directory, as would be fed to I(chown).
seuser:
required: false
default: null
description:
- User part of SELinux file context. Will default to system policy, if
applicable. If set to C(_default), it will use the C(user) portion of the
policy if available.
serole:
required: false
default: null
description:
- Role part of SELinux file context, C(_default) feature works as for I(seuser).
setype:
required: false
default: null
description:
- Type part of SELinux file context, C(_default) feature works as for I(seuser).
selevel:
required: false
default: "s0"
description:
- Level part of the SELinux file context. This is the MLS/MCS attribute,
sometimes known as the C(range). C(_default) feature works as for
I(seuser).
default: "s0"
unsafe_writes:
description:
- Normally this module uses atomic operations to prevent data corruption or inconsistent reads from the target files,
@ -70,15 +57,12 @@ options:
- This boolean option allows ansible to fall back to unsafe methods of updating files for those cases in which you do
not have any other choice. Be aware that this is subject to race conditions and can lead to data corruption.
type: bool
required: false
default: false
default: 'no'
version_added: "2.2"
attributes:
description:
- Attributes the file or directory should have. To get supported flags look at the man page for I(chattr) on the target system.
This string should contain the attributes in the same order as the one displayed by I(lsattr).
required: false
default: None
aliases: ['attr']
version_added: "2.3"
"""

1
lib/ansible/utils/module_docs_fragments/gcp.py
View file

@ -15,7 +15,6 @@ options:
project:
description:
- The Google Cloud Platform project to use.
default: null
auth_kind:
description:
- The type of credential used.

4
lib/ansible/utils/module_docs_fragments/influxdb.py
View file

@ -37,12 +37,10 @@ options:
ssl:
description:
- Use https instead of http to connect to InfluxDB server.
default: False
version_added: "2.5"
timeout:
description:
- Number of seconds Requests will wait for client to establish a connection.
default: None
version_added: "2.5"
retries:
description:
@ -53,7 +51,6 @@ options:
use_udp:
description:
- Use UDP to connect to InfluxDB server.
default: False
version_added: "2.5"
udp_port:
description:
@ -63,6 +60,5 @@ options:
proxies:
description:
- HTTP(S) proxy to use for Requests to connect to InfluxDB server.
default: None
version_added: "2.5"
'''

12
lib/ansible/utils/module_docs_fragments/ios.py
View file

@ -33,8 +33,8 @@ options:
attempt to execute all commands in non-privileged mode. If the value
is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead.
default: no
choices: ['yes', 'no']
type: bool
default: 'no'
auth_pass:
description:
- B(Deprecated)
@ -45,7 +45,6 @@ options:
on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
default: none
provider:
description:
- B(Deprecated)
@ -53,7 +52,6 @@ options:
- For more information please see the L(IOS Platform Options guide, ../network/user_guide/platform_ios.html).
- HORIZONTALLINE
- A dict object containing connection details.
default: null
suboptions:
host:
description:
@ -77,7 +75,6 @@ options:
the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
default: null
timeout:
description:
- Specifies the timeout in seconds for communicating with the network device
@ -98,15 +95,14 @@ options:
attempt to execute all commands in non-privileged mode. If the value
is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead.
default: no
choices: ['yes', 'no']
type: bool
default: 'no'
auth_pass:
description:
- Specifies the password to use if required to enter privileged mode
on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
default: none
notes:
- For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
- For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.

2
lib/ansible/utils/module_docs_fragments/iosxr.py
View file

@ -29,7 +29,6 @@ options:
- For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols).
- HORIZONTALLINE
- A dict object containing connection details.
default: null
suboptions:
host:
description:
@ -53,7 +52,6 @@ options:
the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
default: null
timeout:
description:
- Specifies the timeout in seconds for communicating with the network device

11
lib/ansible/utils/module_docs_fragments/ironware.py
View file

@ -29,12 +29,11 @@ options:
attempt to execute all commands in non-privileged mode. If the value
is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead.
default: no
choices: ['yes', 'no']
type: bool
default: 'no'
provider:
description:
- A dict object containing connection details.
default: null
suboptions:
host:
description:
@ -58,7 +57,6 @@ options:
the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
default: null
ssh_keyfile:
description:
- Specifies the SSH key to use to authenticate the connection to
@ -73,15 +71,14 @@ options:
attempt to execute all commands in non-privileged mode. If the value
is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead.
default: no
choices: ['yes', 'no']
type: bool
default: 'no'
auth_pass:
description:
- Specifies the password to use if required to enter privileged mode
on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
default: none
timeout:
description:
- Specifies idle timeout in seconds for the connection, in seconds. Useful

2
lib/ansible/utils/module_docs_fragments/junos.py
View file

@ -29,7 +29,6 @@ options:
- For more information please see the L(Junos OS Platform Options guide, ../network/user_guide/platform_junos.html).
- HORIZONTALLINE
- A dict object containing connection details.
default: null
suboptions:
host:
description:
@ -56,7 +55,6 @@ options:
the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
default: null
timeout:
description:
- Specifies the timeout in seconds for communicating with the network device

8
lib/ansible/utils/module_docs_fragments/manageiq.py
View file

@ -17,25 +17,19 @@ options:
description:
- ManageIQ environment url. C(MIQ_URL) env var if set. otherwise, it is required to pass it.
username:
required: false
description:
- ManageIQ username. C(MIQ_USERNAME) env var if set. otherwise, required if no token is passed in.
password:
required: false
description:
- ManageIQ password. C(MIQ_PASSWORD) env var if set. otherwise, required if no token is passed in.
token:
required: false
description:
- ManageIQ token. C(MIQ_TOKEN) env var if set. otherwise, required if no username or password is passed in.
verify_ssl:
required: false
default: true
description:
- Whether SSL certificates should be verified for HTTPS requests. defaults to True.
default: true
ca_bundle_path:
required: false
default: null
description:
- The path to a CA bundle file or directory with certificates. defaults to None.

16
lib/ansible/utils/module_docs_fragments/mysql.py
View file

@ -25,55 +25,39 @@ options:
login_user:
description:
- The username used to authenticate with.
required: false
default: null
login_password:
description:
- The password used to authenticate with.
required: false
default: null
login_host:
description:
- Host running the database.
required: false
default: localhost
login_port:
description:
- Port of the MySQL server. Requires I(login_host) be defined as other then localhost if login_port is used.
required: false
default: 3306
login_unix_socket:
description:
- The path to a Unix domain socket for local connections.
required: false
default: null
connect_timeout:
description:
- The connection timeout when connecting to the MySQL server.
required: false
default: 30
version_added: "2.1"
config_file:
description:
- Specify a config file from which user and password are to be read.
required: false
default: '~/.my.cnf'
version_added: "2.0"
ssl_ca:
required: false
default: null
version_added: "2.0"
description:
- The path to a Certificate Authority (CA) certificate. This option, if used, must specify the same certificate as used by the server.
ssl_cert:
required: false
default: null
version_added: "2.0"
description:
- The path to a client public key certificate.
ssl_key:
required: false
default: null
version_added: "2.0"
description:
- The path to the client private key.

10
lib/ansible/utils/module_docs_fragments/nios.py
View file

@ -25,7 +25,6 @@ options:
provider:
description:
- A dict object containing connection details.
default: null
suboptions:
host:
description:
@ -46,20 +45,18 @@ options:
the remote instance of NIOS.
- Value can also be specified using C(INFOBLOX_PASSWORD) environment
variable.
default: null
ssl_verify:
description:
- Boolean value to enable or disable verifying SSL certificates
- Value can also be specified using C(INFOBLOX_SSL_VERIFY) environment
variable.
required: false
default: false
type: bool
default: 'no'
http_request_timeout:
description:
- The amount of time before to wait before receiving a response
- Value can also be specified using C(INFOBLOX_HTTP_REQUEST_TIMEOUT) environment
variable.
required: false
default: 10
max_retries:
description:
@ -67,14 +64,12 @@ options:
is declared usable
- Value can also be specified using C(INFOBLOX_MAX_RETRIES) environment
variable.
required: false
default: 3
wapi_version:
description:
- Specifies the version of WAPI to use
- Value can also be specified using C(INFOBLOX_WAP_VERSION) environment
variable.
required: false
default: 1.4
max_results:
description:
@ -83,7 +78,6 @@ options:
number of returned objects would exceed the setting.
- Value can also be specified using C(INFOBLOX_MAX_RESULTS) environment
variable.
required: false
default: 1000
notes:
- "This module must be run locally, which can be achieved by specifying C(connection: local)."

17
lib/ansible/utils/module_docs_fragments/nxos.py
View file

@ -30,7 +30,6 @@ options:
- For more information please see the L(NXOS Platform Options guide, ../network/user_guide/platform_nxos.html).
- HORIZONTALLINE
- A dict object containing connection details.
default: null
suboptions:
host:
description:
@ -44,7 +43,6 @@ options:
device. This value applies to either I(cli) or I(nxapi). The port
value will default to the appropriate transport common port if
none is provided in the task. (cli=22, http=80, https=443).
required: false
default: 0 (use common port)
username:
description:
@ -53,22 +51,18 @@ options:
either the CLI login or the nxapi authentication depending on which
transport is used. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
required: false
password:
description:
- Specifies the password to use to authenticate the connection to
the remote device. This is a common argument used for either I(cli)
or I(nxapi) transports. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
required: false
default: null
timeout:
description:
- Specifies the timeout in seconds for communicating with the network device
for either connecting or sending commands. If the timeout is
exceeded before the operation is completed, the module will error.
NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).
require: false
default: 10
version_added: 2.3
ssh_keyfile:
@ -77,7 +71,6 @@ options:
the remote device. This argument is only used for the I(cli)
transport. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
required: false
transport:
description:
- Configures the transport connection to use when connecting to the
@ -89,21 +82,19 @@ options:
description:
- Configures the I(transport) to use SSL if set to true only when the
C(transport=nxapi), otherwise this value is ignored.
required: false
default: no
choices: ['yes', 'no']
type: bool
default: 'no'
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. If the transport
argument is not nxapi, this value is ignored.
choices: ['yes', 'no']
default: null
type: bool
use_proxy:
description:
- If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored.
type: bool
default: 'yes'
choices: ['yes', 'no']
version_added: "2.5"
notes:

7
lib/ansible/utils/module_docs_fragments/onyx.py
View file

@ -23,7 +23,6 @@ options:
provider:
description:
- A dict object containing connection details.
default: null
suboptions:
host:
description:
@ -47,7 +46,6 @@ options:
the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
default: null
timeout:
description:
- Specifies the timeout in seconds for communicating with the network device
@ -68,13 +66,12 @@ options:
attempt to execute all commands in non-privileged mode. If the value
is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead.
default: no
choices: ['yes', 'no']
type: bool
default: 'no'
auth_pass:
description:
- Specifies the password to use if required to enter privileged mode
on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
default: none
"""

14
lib/ansible/utils/module_docs_fragments/openswitch.py
View file

@ -36,7 +36,6 @@ options:
value will default to the appropriate transport common port if
none is provided in the task. (cli=22, http=80, https=443). Note
this argument does not affect the SSH transport.
required: false
default: 0 (use common port)
username:
description:
@ -46,7 +45,6 @@ options:
transport is used. Note this argument does not affect the SSH
transport. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
required: false
password:
description:
- Specifies the password to use to authenticate the connection to
@ -54,14 +52,11 @@ options:
or I(rest) transports. Note this argument does not affect the SSH
transport. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
required: false
default: null
timeout:
description:
- Specifies the timeout in seconds for communicating with the network device
for either connecting or sending commands. If the timeout is
exceeded before the operation is completed, the module will error.
require: false
default: 10
ssh_keyfile:
description:
@ -69,7 +64,6 @@ options:
the remote device. This argument is only used for the I(cli)
transports. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
required: false
transport:
description:
- Configures the transport connection to use when connecting to the
@ -83,16 +77,12 @@ options:
- Configures the I(transport) to use SSL if set to true only when the
I(transport) argument is configured as rest. If the transport
argument is not I(rest), this value is ignored.
required: false
default: yes
choices: ['yes', 'no']
type: bool
default: 'yes'
provider:
description:
- Convenience method that allows all I(openswitch) arguments to be passed as
a dict object. All constraints (required, choices, etc) must be
met either by individual arguments or values in this dict.
required: false
default: null
"""

11
lib/ansible/utils/module_docs_fragments/postgres.py
View file

@ -21,34 +21,25 @@ options:
login_user:
description:
- The username used to authenticate with
required: false
default: postgres
login_password:
description:
- The password used to authenticate with
required: false
default: null
login_host:
description:
- Host running the database
required: false
default: null
login_unix_socket:
description:
- Path to a Unix domain socket for local connections
required: false
default: null
port:
description:
- Database port to connect to.
required: false
default: 5432
ssl_mode:
description:
- Determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the server.
- See https://www.postgresql.org/docs/current/static/libpq-ssl.html for more information on the modes.
- Default of C(prefer) matches libpq default.
required: false
default: prefer
choices: [disable, allow, prefer, require, verify-ca, verify-full]
version_added: '2.3'
@ -56,8 +47,6 @@ options:
description:
- Specifies the name of a file containing SSL certificate authority (CA) certificate(s).
- If the file exists, the server's certificate will be verified to be signed by one of these authorities.
required: false
default: null
version_added: '2.3'
notes:
- The default authentication assumes that you are either logging in as or sudo'ing to the C(postgres) account on the host.

6
lib/ansible/utils/module_docs_fragments/proxysql.py
View file

@ -10,11 +10,9 @@ options:
login_user:
description:
- The username used to authenticate to ProxySQL admin interface.
default: None
login_password:
description:
- The password used to authenticate to ProxySQL admin interface.
default: None
login_host:
description:
- The host used to connect to ProxySQL admin interface.
@ -39,10 +37,10 @@ options:
description:
- Save config to sqlite db on disk to persist the configuration.
type: bool
default: True
default: 'yes'
load_to_runtime:
description:
- Dynamically load config to runtime memory.
type: bool
default: True
default: 'yes'
'''

2
lib/ansible/utils/module_docs_fragments/rackspace.py
View file

@ -30,7 +30,6 @@ options:
description:
- File to find the Rackspace credentials in. Ignored if I(api_key) and
I(username) are provided.
default: null
aliases:
- creds_file
env:
@ -79,7 +78,6 @@ options:
description:
- File to find the Rackspace credentials in. Ignored if I(api_key) and
I(username) are provided.
default: null
aliases:
- creds_file
env:

2
lib/ansible/utils/module_docs_fragments/sros.py
View file

@ -25,7 +25,6 @@ options:
provider:
description:
- A dict object containing connection details.
default: null
suboptions:
host:
description:
@ -50,7 +49,6 @@ options:
the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
default: null
timeout:
description:
- Specifies the timeout in seconds for communicating with the network device

12
lib/ansible/utils/module_docs_fragments/tower.py
View file

@ -25,29 +25,21 @@ options:
tower_host:
description:
- URL to your Tower instance.
required: False
default: null
tower_username:
description:
- Username for your Tower instance.
required: False
default: null
tower_password:
description:
- Password for your Tower instance.
required: False
default: null
tower_verify_ssl:
description:
- Dis/allow insecure connections to Tower. If C(no), SSL certificates will not be validated.
This should only be used on personally controlled sites using self-signed certificates.
required: False
default: True
type: bool
default: 'yes'
tower_config_file:
description:
- Path to the Tower config file. See notes.
required: False
default: null
requirements:

2
lib/ansible/utils/module_docs_fragments/validate.py
View file

@ -22,10 +22,8 @@ class ModuleDocFragment(object):
DOCUMENTATION = '''
options:
validate:
required: false
description:
- The validation command to run before copying into place. The path to the file to
validate is passed in via '%s' which must be present as in the example below.
The command is passed securely so shell features like expansion and pipes won't work.
default: None
'''

18
lib/ansible/utils/module_docs_fragments/vca.py
View file

@ -23,60 +23,44 @@ options:
username:
description:
- The vca username or email address, if not set the environment variable C(VCA_USER) is checked for the username.
required: false
default: None
aliases: ['user']
password:
description:
- The vca password, if not set the environment variable C(VCA_PASS) is checked for the password.
required: false
default: None
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).
required: false
default: None
instance_id:
description:
- The instance id in a vchs environment to be used for creating the vapp.
required: false
default: None
host:
description:
- The authentication host to be used when service type is vcd.
required: false
default: None
api_version:
description:
- The api version to be used with the vca.
required: false
default: "5.7"
service_type:
description:
- The type of service we are authenticating against.
required: false
default: vca
choices: [ "vca", "vchs", "vcd" ]
state:
description:
- If the object should be added or removed.
required: false
default: present
choices: [ "present", "absent" ]
verify_certs:
description:
- If the certificates of the authentication is to be verified.
type: bool
default: True
default: 'yes'
vdc_name:
description:
- The name of the vdc where the gateway is located.
required: false
default: None
gateway_name:
description:
- The name of the gateway of the vdc where the rule should be added.
required: false
default: gateway
"""

2
lib/ansible/utils/module_docs_fragments/vyos.py
View file

@ -29,7 +29,6 @@ options:
- For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols).
- HORIZONTALLINE
- A dict object containing connection details.
default: null
suboptions:
host:
description:
@ -54,7 +53,6 @@ options:
the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
default: null
timeout:
description:
- Specifies the timeout in seconds for communicating with the network device

9
lib/ansible/utils/module_docs_fragments/zabbix.py
View file

@ -38,24 +38,19 @@ options:
http_login_user:
description:
- Basic Auth login
required: false
default: None
version_added: "2.1"
http_login_password:
description:
- Basic Auth password
required: false
default: None
version_added: "2.1"
timeout:
description:
- The timeout of API request (seconds).
default: 10
validate_certs:
required: false
description:
- If set to False, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
default: true
choices: ['true', 'false']
type: bool
default: 'yes'
version_added: "2.5"
'''