[a-n]*.py: normalize doc_fragments (#9422)

* [a-n]*.py: normalize doc_fragments

* Update plugins/doc_fragments/ldap.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/doc_fragments/ldap.py

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
pull/9433/head
Alexei Znamensky 2024-12-28 02:30:17 +13:00 committed by GitHub
parent 2a2a9661d9
commit ed092956ba
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
20 changed files with 346 additions and 359 deletions

View File

@ -11,75 +11,73 @@ __metaclass__ = type
class ModuleDocFragment(object):
# Alicloud only documentation fragment
DOCUMENTATION = r'''
DOCUMENTATION = r"""
options:
alicloud_access_key:
description:
- Alibaba Cloud access key. If not set then the value of environment variable E(ALICLOUD_ACCESS_KEY),
E(ALICLOUD_ACCESS_KEY_ID) will be used instead.
- Alibaba Cloud access key. If not set then the value of environment variable E(ALICLOUD_ACCESS_KEY), E(ALICLOUD_ACCESS_KEY_ID)
will be used instead.
aliases: ['access_key_id', 'access_key']
type: str
alicloud_secret_key:
description:
- Alibaba Cloud secret key. If not set then the value of environment variable E(ALICLOUD_SECRET_KEY),
E(ALICLOUD_SECRET_ACCESS_KEY) will be used instead.
- Alibaba Cloud secret key. If not set then the value of environment variable E(ALICLOUD_SECRET_KEY), E(ALICLOUD_SECRET_ACCESS_KEY)
will be used instead.
aliases: ['secret_access_key', 'secret_key']
type: str
alicloud_region:
description:
- The Alibaba Cloud region to use. If not specified then the value of environment variable
E(ALICLOUD_REGION), E(ALICLOUD_REGION_ID) will be used instead.
- The Alibaba Cloud region to use. If not specified then the value of environment variable E(ALICLOUD_REGION), E(ALICLOUD_REGION_ID)
will be used instead.
aliases: ['region', 'region_id']
required: true
type: str
alicloud_security_token:
description:
- The Alibaba Cloud security token. If not specified then the value of environment variable
E(ALICLOUD_SECURITY_TOKEN) will be used instead.
- The Alibaba Cloud security token. If not specified then the value of environment variable E(ALICLOUD_SECURITY_TOKEN)
will be used instead.
aliases: ['security_token']
type: str
alicloud_assume_role:
description:
- If provided with a role ARN, Ansible will attempt to assume this role using the supplied credentials.
- The nested assume_role block supports C(alicloud_assume_role_arn), C(alicloud_assume_role_session_name),
C(alicloud_assume_role_session_expiration) and C(alicloud_assume_role_policy).
- The nested assume_role block supports C(alicloud_assume_role_arn), C(alicloud_assume_role_session_name), C(alicloud_assume_role_session_expiration)
and C(alicloud_assume_role_policy).
type: dict
aliases: ['assume_role']
alicloud_assume_role_arn:
description:
- The Alibaba Cloud C(role_arn). The ARN of the role to assume. If ARN is set to an empty string,
it does not perform role switching. It supports environment variable E(ALICLOUD_ASSUME_ROLE_ARN).
ansible will execute with provided credentials.
- The Alibaba Cloud C(role_arn). The ARN of the role to assume. If ARN is set to an empty string, it does not perform
role switching. It supports environment variable E(ALICLOUD_ASSUME_ROLE_ARN). ansible will execute with provided credentials.
aliases: ['assume_role_arn']
type: str
alicloud_assume_role_session_name:
description:
- The Alibaba Cloud session_name. The session name to use when assuming the role. If omitted,
'ansible' is passed to the AssumeRole call as session name. It supports environment variable
E(ALICLOUD_ASSUME_ROLE_SESSION_NAME).
- The Alibaba Cloud session_name. The session name to use when assuming the role. If omitted, 'ansible' is passed to
the AssumeRole call as session name. It supports environment variable E(ALICLOUD_ASSUME_ROLE_SESSION_NAME).
aliases: ['assume_role_session_name']
type: str
alicloud_assume_role_session_expiration:
description:
- The Alibaba Cloud C(session_expiration). The time after which the established session for assuming
role expires. Valid value range 900-3600 seconds. Default to 3600 (in this case Alicloud use own default
value). It supports environment variable E(ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION).
- The Alibaba Cloud C(session_expiration). The time after which the established session for assuming role expires. Valid
value range 900-3600 seconds. Default to 3600 (in this case Alicloud use own default value). It supports environment
variable E(ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION).
aliases: ['assume_role_session_expiration']
type: int
ecs_role_name:
description:
- The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control'
section of the Alibaba Cloud console.
- If you're running Ansible from an ECS instance with RAM Instance using RAM Role, Ansible will just access the
metadata U(http://100.100.100.200/latest/meta-data/ram/security-credentials/<ecs_role_name>) to obtain the STS
credential. This is a preferred approach over any other when running in ECS as you can avoid hard coding
credentials. Instead these are leased on-the-fly by Ansible which reduces the chance of leakage.
- The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section
of the Alibaba Cloud console.
- If you are running Ansible from an ECS instance with RAM Instance using RAM Role, Ansible will just access the metadata
U(http://100.100.100.200/latest/meta-data/ram/security-credentials/<ecs_role_name>) to obtain the STS credential.
This is a preferred approach over any other when running in ECS as you can avoid hard coding credentials. Instead
these are leased on-the-fly by Ansible which reduces the chance of leakage.
aliases: ['role_name']
type: str
profile:
description:
- This is the Alicloud profile name as set in the shared credentials file. It can also be sourced from the
E(ALICLOUD_PROFILE) environment variable.
- This is the Alicloud profile name as set in the shared credentials file. It can also be sourced from the E(ALICLOUD_PROFILE)
environment variable.
type: str
shared_credentials_file:
description:
@ -92,18 +90,10 @@ author:
requirements:
- "Python >= 3.6"
notes:
- If parameters are not set within the module, the following
environment variables can be used in decreasing order of precedence
E(ALICLOUD_ACCESS_KEY) or E(ALICLOUD_ACCESS_KEY_ID),
E(ALICLOUD_SECRET_KEY) or E(ALICLOUD_SECRET_ACCESS_KEY),
E(ALICLOUD_REGION) or E(ALICLOUD_REGION_ID),
E(ALICLOUD_SECURITY_TOKEN),
E(ALICLOUD_ECS_ROLE_NAME),
E(ALICLOUD_SHARED_CREDENTIALS_FILE),
E(ALICLOUD_PROFILE),
E(ALICLOUD_ASSUME_ROLE_ARN),
E(ALICLOUD_ASSUME_ROLE_SESSION_NAME),
E(ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION).
- E(ALICLOUD_REGION) or E(ALICLOUD_REGION_ID) can be typically be used to specify the
Alicloud region, when required, but this can also be configured in the footmark config file
'''
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
E(ALICLOUD_ACCESS_KEY) or E(ALICLOUD_ACCESS_KEY_ID), E(ALICLOUD_SECRET_KEY) or E(ALICLOUD_SECRET_ACCESS_KEY), E(ALICLOUD_REGION)
or E(ALICLOUD_REGION_ID), E(ALICLOUD_SECURITY_TOKEN), E(ALICLOUD_ECS_ROLE_NAME), E(ALICLOUD_SHARED_CREDENTIALS_FILE),
E(ALICLOUD_PROFILE), E(ALICLOUD_ASSUME_ROLE_ARN), E(ALICLOUD_ASSUME_ROLE_SESSION_NAME), E(ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION).
- E(ALICLOUD_REGION) or E(ALICLOUD_REGION_ID) can be typically be used to specify the Alicloud region, when required, but
this can also be configured in the footmark config file.
"""

View File

@ -11,22 +11,22 @@ __metaclass__ = type
class ModuleDocFragment(object):
# Standard documentation fragment
DOCUMENTATION = r'''
DOCUMENTATION = r"""
options: {}
attributes:
check_mode:
description: Can run in C(check_mode) and return changed status prediction without modifying target.
diff_mode:
description: Will return details on what has changed (or possibly needs changing in C(check_mode)), when in diff mode.
'''
"""
PLATFORM = r'''
PLATFORM = r"""
options: {}
attributes:
platform:
description: Target OS/families that can be operated against.
support: N/A
'''
"""
# Should be used together with the standard fragment
INFO_MODULE = r'''
@ -42,7 +42,7 @@ attributes:
- This action does not modify state.
'''
CONN = r'''
CONN = r"""
options: {}
attributes:
become:
@ -51,14 +51,14 @@ attributes:
description: Uses the target's configured connection information to execute code on it.
delegation:
description: Can be used in conjunction with C(delegate_to) and related keywords.
'''
"""
FACTS = r'''
FACTS = r"""
options: {}
attributes:
facts:
description: Action returns an C(ansible_facts) dictionary that will update existing host facts.
'''
"""
# Should be used together with the standard fragment and the FACTS fragment
FACTS_MODULE = r'''
@ -76,18 +76,18 @@ attributes:
support: full
'''
FILES = r'''
FILES = r"""
options: {}
attributes:
safe_file_operations:
description: Uses Ansible's strict file operation functions to ensure proper permissions and avoid data corruption.
'''
"""
FLOW = r'''
FLOW = r"""
options: {}
attributes:
action:
description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
async:
description: Supports being used with the C(async) keyword.
'''
"""

View File

@ -10,7 +10,7 @@ __metaclass__ = type
class ModuleDocFragment(object):
# Standard files documentation fragment
DOCUMENTATION = r'''
DOCUMENTATION = r"""
options:
api_url:
description:
@ -29,4 +29,4 @@ options:
- Whether or not to validate SSL certs when supplying a HTTPS endpoint.
type: bool
default: true
'''
"""

View File

@ -11,7 +11,7 @@ __metaclass__ = type
class ModuleDocFragment(object):
# Standard documentation fragment
DOCUMENTATION = r'''
DOCUMENTATION = r"""
options:
client_id:
description:
@ -41,4 +41,4 @@ notes:
- Bitbucket OAuth consumer key and secret can be obtained from Bitbucket profile -> Settings -> Access Management -> OAuth.
- Bitbucket App password can be created from Bitbucket profile -> Personal Settings -> App passwords.
- If both OAuth and Basic Auth credentials are passed, OAuth credentials take precedence.
'''
"""

View File

@ -15,7 +15,7 @@ class ModuleDocFragment:
options:
host:
description:
- Host of the consul agent, defaults to V(localhost).
- Host of the Consul agent.
default: localhost
type: str
port:
@ -25,18 +25,18 @@ options:
default: 8500
scheme:
description:
- The protocol scheme on which the consul agent is running.
Defaults to V(http) and can be set to V(https) for secure connections.
- The protocol scheme on which the Consul agent is running. Defaults to V(http) and can be set to V(https) for secure
connections.
default: http
type: str
validate_certs:
type: bool
description:
- Whether to verify the TLS certificate of the consul agent.
- Whether to verify the TLS certificate of the Consul agent.
default: true
ca_path:
description:
- The CA bundle to use for https connections
- The CA bundle to use for https connections.
type: str
"""

View File

@ -14,8 +14,7 @@ __metaclass__ = type
class ModuleDocFragment(object):
# Dimension Data doc fragment
DOCUMENTATION = r'''
DOCUMENTATION = r"""
options:
region:
description:
@ -48,4 +47,4 @@ options:
- This should only be used on private instances of the CloudControl API that use self-signed certificates.
type: bool
default: true
'''
"""

View File

@ -14,8 +14,7 @@ __metaclass__ = type
class ModuleDocFragment(object):
# Dimension Data ("wait-for-completion" parameters) doc fragment
DOCUMENTATION = r'''
DOCUMENTATION = r"""
options:
wait:
description:
@ -34,4 +33,4 @@ options:
- Only applicable if O(wait=true).
type: int
default: 2
'''
"""

View File

@ -8,7 +8,7 @@ __metaclass__ = type
class ModuleDocFragment(object):
DOCUMENTATION = r'''
DOCUMENTATION = r"""
options:
venv:
description:
@ -43,20 +43,19 @@ options:
notes:
- The C(django-admin) command is always executed using the C(C) locale, and the option C(--no-color) is always passed.
seealso:
- name: django-admin and manage.py in official Django documentation
description: >-
Refer to this documentation for the builtin commands and options of C(django-admin).
Please make sure that you select the right version of Django in the version selector on that page.
Refer to this documentation for the builtin commands and options of C(django-admin). Please make sure that you select
the right version of Django in the version selector on that page.
link: https://docs.djangoproject.com/en/5.0/ref/django-admin/
'''
"""
DATABASE = r'''
DATABASE = r"""
options:
database:
description:
- Specify the database to be used.
type: str
default: default
'''
"""

View File

@ -10,14 +10,14 @@ __metaclass__ = type
class ModuleDocFragment(object):
DOCUMENTATION = r'''
options:
- See respective platform section for more details
DOCUMENTATION = r"""
options: {}
# See respective platform section for more details
requirements:
- See respective platform section for more details
notes:
- Ansible modules are available for EMC VNX.
'''
"""
# Documentation fragment for VNX (emc_vnx)
EMC_VNX = r'''

View File

@ -10,7 +10,7 @@ __metaclass__ = type
class ModuleDocFragment(object):
# Standard files documentation fragment
DOCUMENTATION = r'''
DOCUMENTATION = r"""
requirements:
- requests (Python library U(https://pypi.org/project/requests/))
@ -34,4 +34,4 @@ options:
- The CA certificates bundle to use to verify GitLab server certificate.
type: str
version_added: 8.1.0
'''
"""

View File

@ -10,7 +10,7 @@ __metaclass__ = type
class ModuleDocFragment(object):
# HPE 3PAR doc fragment
DOCUMENTATION = '''
DOCUMENTATION = r"""
options:
storage_system_ip:
description:
@ -32,4 +32,4 @@ requirements:
- hpe3par_sdk >= 1.0.2. Install using C(pip install hpe3par_sdk).
- WSAPI service should be enabled on the 3PAR storage array.
notes:
'''
"""

View File

@ -10,7 +10,7 @@ __metaclass__ = type
class ModuleDocFragment(object):
# HWC doc fragment.
DOCUMENTATION = '''
DOCUMENTATION = r"""
options:
identity_endpoint:
description:
@ -49,17 +49,11 @@ options:
- The ID of resource to be managed.
type: str
notes:
- For authentication, you can set identity_endpoint using the
E(ANSIBLE_HWC_IDENTITY_ENDPOINT) environment variable.
- For authentication, you can set user using the
E(ANSIBLE_HWC_USER) environment variable.
- For authentication, you can set password using the E(ANSIBLE_HWC_PASSWORD) environment
variable.
- For authentication, you can set domain using the E(ANSIBLE_HWC_DOMAIN) environment
variable.
- For authentication, you can set project using the E(ANSIBLE_HWC_PROJECT) environment
variable.
- For authentication, you can set identity_endpoint using the E(ANSIBLE_HWC_IDENTITY_ENDPOINT) environment variable.
- For authentication, you can set user using the E(ANSIBLE_HWC_USER) environment variable.
- For authentication, you can set password using the E(ANSIBLE_HWC_PASSWORD) environment variable.
- For authentication, you can set domain using the E(ANSIBLE_HWC_DOMAIN) environment variable.
- For authentication, you can set project using the E(ANSIBLE_HWC_PROJECT) environment variable.
- For authentication, you can set region using the E(ANSIBLE_HWC_REGION) environment variable.
- Environment variables values will only be used if the playbook values are
not set.
'''
- Environment variables values will only be used if the playbook values are not set.
"""

View File

@ -12,16 +12,16 @@ __metaclass__ = type
class ModuleDocFragment(object):
# ibm_storage documentation fragment
DOCUMENTATION = r'''
DOCUMENTATION = r"""
options:
username:
description:
- Management user on the spectrum accelerate storage system.
- Management user on the Spectrum Accelerate storage system.
type: str
required: true
password:
description:
- Password for username on the spectrum accelerate storage system.
- Password for username on the Spectrum Accelerate storage system.
type: str
required: true
endpoints:
@ -30,8 +30,7 @@ options:
type: str
required: true
notes:
- This module requires pyxcli python library.
Use C(pip install pyxcli) in order to get pyxcli.
- This module requires pyxcli python library. Use C(pip install pyxcli) in order to get pyxcli.
requirements:
- pyxcli
'''
"""

View File

@ -11,7 +11,7 @@ __metaclass__ = type
class ModuleDocFragment(object):
# Parameters for influxdb modules
DOCUMENTATION = r'''
DOCUMENTATION = r"""
options:
hostname:
description:
@ -61,7 +61,7 @@ options:
description:
- Number of retries client will try before aborting.
- V(0) indicates try until success.
- Only available when using python-influxdb >= 4.1.0.
- Only available when using C(python-influxdb) >= 4.1.0.
type: int
default: 3
use_udp:
@ -79,4 +79,4 @@ options:
- HTTP(S) proxy to use for Requests to connect to InfluxDB server.
type: dict
default: {}
'''
"""

View File

@ -11,7 +11,7 @@ __metaclass__ = type
class ModuleDocFragment(object):
# Parameters for FreeIPA/IPA modules
DOCUMENTATION = r'''
DOCUMENTATION = r"""
options:
ipa_port:
description:
@ -24,9 +24,11 @@ options:
description:
- IP or hostname of IPA server.
- If the value is not specified in the task, the value of environment variable E(IPA_HOST) will be used instead.
- If both the environment variable E(IPA_HOST) and the value are not specified in the task, then DNS will be used to try to discover the FreeIPA server.
- If both the environment variable E(IPA_HOST) and the value are not specified in the task, then DNS will be used to
try to discover the FreeIPA server.
- The relevant entry needed in FreeIPA is the C(ipa-ca) entry.
- If neither the DNS entry, nor the environment E(IPA_HOST), nor the value are available in the task, then the default value will be used.
- If neither the DNS entry, nor the environment E(IPA_HOST), nor the value are available in the task, then the default
value will be used.
type: str
default: ipa.example.com
ipa_user:
@ -41,8 +43,10 @@ options:
- Password of administrative user.
- If the value is not specified in the task, the value of environment variable E(IPA_PASS) will be used instead.
- Note that if the C(urllib_gssapi) library is available, it is possible to use GSSAPI to authenticate to FreeIPA.
- If the environment variable E(KRB5CCNAME) is available, the module will use this kerberos credentials cache to authenticate to the FreeIPA server.
- If the environment variable E(KRB5_CLIENT_KTNAME) is available, and E(KRB5CCNAME) is not; the module will use this kerberos keytab to authenticate.
- If the environment variable E(KRB5CCNAME) is available, the module will use this kerberos credentials cache to authenticate
to the FreeIPA server.
- If the environment variable E(KRB5_CLIENT_KTNAME) is available, and E(KRB5CCNAME) is not; the module will use this
kerberos keytab to authenticate.
- If GSSAPI is not available, the usage of O(ipa_pass) is required.
type: str
ipa_prot:
@ -65,7 +69,8 @@ options:
- Specifies idle timeout (in seconds) for the connection.
- For bulk operations, you may want to increase this in order to avoid timeout from IPA server.
- If the value is not specified in the task, the value of environment variable E(IPA_TIMEOUT) will be used instead.
- If both the environment variable E(IPA_TIMEOUT) and the value are not specified in the task, then default value is set.
- If both the environment variable E(IPA_TIMEOUT) and the value are not specified in the task, then default value is
set.
type: int
default: 10
'''
"""

View File

@ -11,7 +11,7 @@ __metaclass__ = type
class ModuleDocFragment(object):
# Standard documentation fragment
DOCUMENTATION = r'''
DOCUMENTATION = r"""
options:
auth_keycloak_url:
description:
@ -76,7 +76,7 @@ options:
type: str
default: Ansible
version_added: 5.4.0
'''
"""
ACTIONGROUP_KEYCLOAK = r"""
options: {}

View File

@ -12,12 +12,12 @@ __metaclass__ = type
class ModuleDocFragment(object):
# Standard LDAP documentation fragment
DOCUMENTATION = r'''
DOCUMENTATION = r"""
options:
bind_dn:
description:
- A DN to bind with. If this is omitted, we'll try a SASL bind with the EXTERNAL mechanism as default.
- If this is blank, we'll use an anonymous bind.
- A DN to bind with. Try to use a SASL bind with the EXTERNAL mechanism as default when this parameter is omitted.
- Use an anonymous bind if the parameter is blank.
type: str
bind_pw:
description:
@ -57,7 +57,8 @@ options:
version_added: 2.0.0
server_uri:
description:
- The O(server_uri) parameter may be a comma- or whitespace-separated list of URIs containing only the schema, the host, and the port fields.
- The O(server_uri) parameter may be a comma- or whitespace-separated list of URIs containing only the schema, the host,
and the port fields.
- The default value lets the underlying LDAP client library look for a UNIX domain socket in its default location.
- Note that when using multiple URIs you cannot determine to which URI your client gets connected.
- For URIs containing additional fields, particularly when using commas, behavior is undefined.
@ -65,7 +66,7 @@ options:
default: ldapi:///
start_tls:
description:
- If true, we'll use the START_TLS LDAP extension.
- Use the START_TLS LDAP extension if set to V(true).
type: bool
default: false
validate_certs:
@ -91,4 +92,4 @@ options:
choices: ['enable', 'auto', 'disable']
default: auto
version_added: "6.4.0"
'''
"""

View File

@ -10,7 +10,7 @@ __metaclass__ = type
class ModuleDocFragment(object):
# Standard Pylxca documentation fragment
DOCUMENTATION = r'''
DOCUMENTATION = r"""
author:
- Naval Patel (@navalkp)
- Prashant Bhosale (@prabhosa)
@ -30,7 +30,7 @@ options:
auth_url:
description:
- lxca HTTPS full web address.
- Lxca HTTPS full web address.
type: str
required: true
@ -40,4 +40,4 @@ requirements:
notes:
- Additional detail about pylxca can be found at U(https://github.com/lenovo/pylxca).
- Playbooks using these modules can be found at U(https://github.com/lenovo/ansible.lenovo-lxca).
'''
"""

View File

@ -11,7 +11,7 @@ __metaclass__ = type
class ModuleDocFragment(object):
# Standard ManageIQ documentation fragment
DOCUMENTATION = r'''
DOCUMENTATION = r"""
options:
manageiq_connection:
description:
@ -34,7 +34,8 @@ options:
type: str
token:
description:
- ManageIQ token. E(MIQ_TOKEN) environment variable if set. Otherwise, required if no username or password is passed in.
- ManageIQ token. E(MIQ_TOKEN) environment variable if set. Otherwise, required if no username or password is passed
in.
type: str
validate_certs:
description:
@ -50,4 +51,4 @@ options:
requirements:
- 'manageiq-client U(https://github.com/ManageIQ/manageiq-api-client-python/)'
'''
"""

View File

@ -11,7 +11,7 @@ __metaclass__ = type
class ModuleDocFragment(object):
# Standard files documentation fragment
DOCUMENTATION = r'''
DOCUMENTATION = r"""
options:
host:
description:
@ -55,4 +55,4 @@ options:
description:
- ACL token for authentication.
type: str
'''
"""