mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Adjust booleans in doc fragments. (#5152)
This commit is contained in:
parent
9f39294f50
commit
bcecf2dcdc
18 changed files with 30 additions and 30 deletions
|
@ -28,5 +28,5 @@ options:
|
||||||
description:
|
description:
|
||||||
- Whether or not to validate SSL certs when supplying a https endpoint.
|
- Whether or not to validate SSL certs when supplying a https endpoint.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -47,5 +47,5 @@ options:
|
||||||
- If C(false), SSL certificates will not be validated.
|
- If C(false), SSL certificates will not be validated.
|
||||||
- This should only be used on private instances of the CloudControl API that use self-signed certificates.
|
- This should only be used on private instances of the CloudControl API that use self-signed certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -21,7 +21,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Should we wait for the task to complete before moving onto the next.
|
- Should we wait for the task to complete before moving onto the next.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
wait_time:
|
wait_time:
|
||||||
description:
|
description:
|
||||||
- The maximum amount of time (in seconds) to wait for the task to complete.
|
- The maximum amount of time (in seconds) to wait for the task to complete.
|
||||||
|
|
|
@ -46,10 +46,10 @@ options:
|
||||||
version_added: '0.2.0'
|
version_added: '0.2.0'
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If set to C(no), the SSL certificates will not be validated.
|
- If set to C(false), the SSL certificates will not be validated.
|
||||||
- This should only set to C(no) used on personally controlled sites using self-signed certificates.
|
- This should only set to C(false) used on personally controlled sites using self-signed certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
ssl:
|
ssl:
|
||||||
description:
|
description:
|
||||||
- Use https instead of http to connect to InfluxDB server.
|
- Use https instead of http to connect to InfluxDB server.
|
||||||
|
|
|
@ -61,10 +61,10 @@ options:
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- This only applies if C(ipa_prot) is I(https).
|
- This only applies if C(ipa_prot) is I(https).
|
||||||
- If set to C(no), the SSL certificates will not be validated.
|
- If set to C(false), the SSL certificates will not be validated.
|
||||||
- This should only set to C(no) used on personally controlled sites using self-signed certificates.
|
- This should only set to C(false) used on personally controlled sites using self-signed certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
ipa_timeout:
|
ipa_timeout:
|
||||||
description:
|
description:
|
||||||
- Specifies idle timeout (in seconds) for the connection.
|
- Specifies idle timeout (in seconds) for the connection.
|
||||||
|
|
|
@ -61,7 +61,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Verify TLS certificates (do not disable this in production).
|
- Verify TLS certificates (do not disable this in production).
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
|
|
||||||
connection_timeout:
|
connection_timeout:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -49,13 +49,13 @@ options:
|
||||||
description:
|
description:
|
||||||
- If true, we'll use the START_TLS LDAP extension.
|
- If true, we'll use the START_TLS LDAP extension.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If set to C(no), SSL certificates will not be validated.
|
- If set to C(false), SSL certificates will not be validated.
|
||||||
- This should only be used on sites using self-signed certificates.
|
- This should only be used on sites using self-signed certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
sasl_class:
|
sasl_class:
|
||||||
description:
|
description:
|
||||||
- The class to use for SASL authentication.
|
- The class to use for SASL authentication.
|
||||||
|
|
|
@ -40,7 +40,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Whether SSL certificates should be verified for HTTPS requests. defaults to True.
|
- Whether SSL certificates should be verified for HTTPS requests. defaults to True.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
aliases: [ verify_ssl ]
|
aliases: [ verify_ssl ]
|
||||||
ca_cert:
|
ca_cert:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -63,7 +63,7 @@ options:
|
||||||
- When the ETag Validation is enabled, the request will be conditionally processed only if the current ETag
|
- When the ETag Validation is enabled, the request will be conditionally processed only if the current ETag
|
||||||
for the resource matches the ETag provided in the data.
|
for the resource matches the ETag provided in the data.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
'''
|
'''
|
||||||
|
|
||||||
FACTSPARAMS = r'''
|
FACTSPARAMS = r'''
|
||||||
|
|
|
@ -34,7 +34,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Validate SSL certs of the Online API.
|
- Validate SSL certs of the Online API.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
notes:
|
notes:
|
||||||
- Also see the API documentation on U(https://console.online.net/en/api/)
|
- Also see the API documentation on U(https://console.online.net/en/api/)
|
||||||
- If C(api_token) is not set within the module, the following
|
- If C(api_token) is not set within the module, the following
|
||||||
|
|
|
@ -36,7 +36,7 @@ options:
|
||||||
- Whether to validate the SSL certificates or not.
|
- Whether to validate the SSL certificates or not.
|
||||||
- This parameter is ignored if PYTHONHTTPSVERIFY environment variable is used.
|
- This parameter is ignored if PYTHONHTTPSVERIFY environment variable is used.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
wait_timeout:
|
wait_timeout:
|
||||||
description:
|
description:
|
||||||
- Time to wait for the desired state to be reached before timeout, in seconds.
|
- Time to wait for the desired state to be reached before timeout, in seconds.
|
||||||
|
|
|
@ -71,11 +71,11 @@ options:
|
||||||
default: ssh
|
default: ssh
|
||||||
use_ssl:
|
use_ssl:
|
||||||
description:
|
description:
|
||||||
- Configures the I(transport) to use SSL if set to C(yes) only when the
|
- Configures the I(transport) to use SSL if set to C(true) only when the
|
||||||
I(transport) argument is configured as rest. If the transport
|
I(transport) argument is configured as rest. If the transport
|
||||||
argument is not I(rest), this value is ignored.
|
argument is not I(rest), this value is ignored.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
provider:
|
provider:
|
||||||
description:
|
description:
|
||||||
- Convenience method that allows all I(openswitch) arguments to be passed as
|
- Convenience method that allows all I(openswitch) arguments to be passed as
|
||||||
|
|
|
@ -12,15 +12,15 @@ class ModuleDocFragment(object):
|
||||||
options:
|
options:
|
||||||
wait:
|
wait:
|
||||||
description: Whether to wait for create or delete operation to complete.
|
description: Whether to wait for create or delete operation to complete.
|
||||||
default: yes
|
default: true
|
||||||
type: bool
|
type: bool
|
||||||
wait_timeout:
|
wait_timeout:
|
||||||
description: Time, in seconds, to wait when I(wait=yes).
|
description: Time, in seconds, to wait when I(wait=true).
|
||||||
default: 1200
|
default: 1200
|
||||||
type: int
|
type: int
|
||||||
wait_until:
|
wait_until:
|
||||||
description: The lifecycle state to wait for the resource to transition into when I(wait=yes). By default,
|
description: The lifecycle state to wait for the resource to transition into when I(wait=true). By default,
|
||||||
when I(wait=yes), we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/
|
when I(wait=true), we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/
|
||||||
RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/
|
RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/
|
||||||
TERMINATED lifecycle state during delete operation.
|
TERMINATED lifecycle state during delete operation.
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -38,10 +38,10 @@ options:
|
||||||
version_added: 1.3.0
|
version_added: 1.3.0
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If C(no), SSL certificates will not be validated.
|
- If C(false), SSL certificates will not be validated.
|
||||||
- This should only be used on personally controlled sites using self-signed certificates.
|
- This should only be used on personally controlled sites using self-signed certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
requirements: [ "proxmoxer", "requests" ]
|
requirements: [ "proxmoxer", "requests" ]
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
|
@ -40,7 +40,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Validate SSL certs of the Scaleway API.
|
- Validate SSL certs of the Scaleway API.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
notes:
|
notes:
|
||||||
- Also see the API documentation on U(https://developer.scaleway.com/)
|
- Also see the API documentation on U(https://developer.scaleway.com/)
|
||||||
- If C(api_token) is not set within the module, the following
|
- If C(api_token) is not set within the module, the following
|
||||||
|
|
|
@ -43,7 +43,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Whether the REST interface's ssl certificate should be verified or not.
|
- Whether the REST interface's ssl certificate should be verified or not.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- The desired state of the object.
|
- The desired state of the object.
|
||||||
|
|
|
@ -40,10 +40,10 @@ options:
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted.
|
- Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted.
|
||||||
- If set to C(yes), please make sure Python >= 2.7.9 is installed on the given machine.
|
- If set to C(true), please make sure Python >= 2.7.9 is installed on the given machine.
|
||||||
required: false
|
required: false
|
||||||
type: bool
|
type: bool
|
||||||
default: 'no'
|
default: false
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- Vexata VX100 storage array with VXOS >= v3.5.0 on storage array
|
- Vexata VX100 storage array with VXOS >= v3.5.0 on storage array
|
||||||
|
|
|
@ -37,5 +37,5 @@ options:
|
||||||
- Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted.
|
- Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted.
|
||||||
- If the value is not specified in the task, the value of environment variable C(XENSERVER_VALIDATE_CERTS) will be used instead.
|
- If the value is not specified in the task, the value of environment variable C(XENSERVER_VALIDATE_CERTS) will be used instead.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
'''
|
'''
|
||||||
|
|
Loading…
Reference in a new issue