ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Adjust booleans in doc fragments. (#5152) (#5168)

Browse source 
(cherry picked from commit bcecf2dcdc)

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot] 2022-08-24 20:46:40 +02:00 committed by GitHub
parent 5a2e7f9b1b
commit 1b2fbd72de
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
18 changed files with 30 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
plugins/doc_fragments/auth_basic.py
View file

@ -28,5 +28,5 @@ options:
description:
- Whether or not to validate SSL certs when supplying a https endpoint.
type: bool
default: yes
default: true
'''

2
plugins/doc_fragments/dimensiondata.py
View file

@ -47,5 +47,5 @@ options:
- 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.
type: bool
default: yes
default: true
'''

2
plugins/doc_fragments/dimensiondata_wait.py
View file

@ -21,7 +21,7 @@ options:
description:
- Should we wait for the task to complete before moving onto the next.
type: bool
default: no
default: false
wait_time:
description:
- The maximum amount of time (in seconds) to wait for the task to complete.

6
plugins/doc_fragments/influxdb.py
View file

@ -46,10 +46,10 @@ options:
version_added: '0.2.0'
validate_certs:
description:
- If set to C(no), the SSL certificates will not be validated.
- This should only set to C(no) used on personally controlled sites using self-signed certificates.
- If set to C(false), the SSL certificates will not be validated.
- This should only set to C(false) used on personally controlled sites using self-signed certificates.
type: bool
default: yes
default: true
ssl:
description:
- Use https instead of http to connect to InfluxDB server.

6
plugins/doc_fragments/ipa.py
View file

@ -61,10 +61,10 @@ options:
validate_certs:
description:
- This only applies if C(ipa_prot) is I(https).
- If set to C(no), the SSL certificates will not be validated.
- This should only set to C(no) used on personally controlled sites using self-signed certificates.
- If set to C(false), the SSL certificates will not be validated.
- This should only set to C(false) used on personally controlled sites using self-signed certificates.
type: bool
default: yes
default: true
ipa_timeout:
description:
- Specifies idle timeout (in seconds) for the connection.

2
plugins/doc_fragments/keycloak.py
View file

@ -61,7 +61,7 @@ options:
description:
- Verify TLS certificates (do not disable this in production).
type: bool
default: yes
default: true
connection_timeout:
description:

6
plugins/doc_fragments/ldap.py
View file

@ -49,13 +49,13 @@ options:
description:
- If true, we'll use the START_TLS LDAP extension.
type: bool
default: no
default: false
validate_certs:
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.
type: bool
default: yes
default: true
sasl_class:
description:
- The class to use for SASL authentication.

2
plugins/doc_fragments/manageiq.py
View file

@ -40,7 +40,7 @@ options:
description:
- Whether SSL certificates should be verified for HTTPS requests. defaults to True.
type: bool
default: yes
default: true
aliases: [ verify_ssl ]
ca_cert:
description:

2
plugins/doc_fragments/oneview.py
View file

@ -63,7 +63,7 @@ options:
- 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.
type: bool
default: yes
default: true
'''
FACTSPARAMS = r'''

2
plugins/doc_fragments/online.py
View file

@ -34,7 +34,7 @@ options:
description:
- Validate SSL certs of the Online API.
type: bool
default: yes
default: true
notes:
- 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

2
plugins/doc_fragments/opennebula.py
View file

@ -36,7 +36,7 @@ options:
- Whether to validate the SSL certificates or not.
- This parameter is ignored if PYTHONHTTPSVERIFY environment variable is used.
type: bool
default: yes
default: true
wait_timeout:
description:
- Time to wait for the desired state to be reached before timeout, in seconds.

4
plugins/doc_fragments/openswitch.py
View file

@ -71,11 +71,11 @@ options:
default: ssh
use_ssl:
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
argument is not I(rest), this value is ignored.
type: bool
default: yes
default: true
provider:
description:
- Convenience method that allows all I(openswitch) arguments to be passed as

8
plugins/doc_fragments/oracle_wait_options.py
View file

@ -12,15 +12,15 @@ class ModuleDocFragment(object):
options:
wait:
description: Whether to wait for create or delete operation to complete.
default: yes
default: true
type: bool
wait_timeout:
description: Time, in seconds, to wait when I(wait=yes).
description: Time, in seconds, to wait when I(wait=true).
default: 1200
type: int
wait_until:
description: The lifecycle state to wait for the resource to transition into when I(wait=yes). By default,
when I(wait=yes), we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/
description: The lifecycle state to wait for the resource to transition into when I(wait=true). By default,
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/
TERMINATED lifecycle state during delete operation.
type: str

4
plugins/doc_fragments/proxmox.py
View file

@ -38,10 +38,10 @@ options:
version_added: 1.3.0
validate_certs:
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.
type: bool
default: no
default: false
requirements: [ "proxmoxer", "requests" ]
'''

2
plugins/doc_fragments/scaleway.py
View file

@ -40,7 +40,7 @@ options:
description:
- Validate SSL certs of the Scaleway API.
type: bool
default: yes
default: true
notes:
- Also see the API documentation on U(https://developer.scaleway.com/)
- If C(api_token) is not set within the module, the following

2
plugins/doc_fragments/utm.py
View file

@ -43,7 +43,7 @@ options:
description:
- Whether the REST interface's ssl certificate should be verified or not.
type: bool
default: yes
default: true
state:
description:
- The desired state of the object.

4
plugins/doc_fragments/vexata.py
View file

@ -40,10 +40,10 @@ options:
validate_certs:
description:
- 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
type: bool
default: 'no'
default: false
requirements:
- Vexata VX100 storage array with VXOS >= v3.5.0 on storage array

2
plugins/doc_fragments/xenserver.py
View file

@ -37,5 +37,5 @@ options:
- 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.
type: bool
default: yes
default: true
'''