ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-25 22:30:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

[PR #6627/011b2f8b backport][stable-7] Start using semantic markup (#6664)

Browse source 
Start using semantic markup (#6627)

* Start using semantic markup.

* Forgot some places.

* Fix typo.

* Use 'ignore:' prefix until https://github.com/ansible-community/antsibull-docs/pull/155 is out.

* Break too long line.

(cherry picked from commit 011b2f8bdc)

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot] 2023-06-10 10:53:50 +02:00 • committed by GitHub
commit bd1c1b257f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
71 changed files with 342 additions and 345 deletions
Download patch file Download diff file Expand all files Collapse all files

4
plugins/doc_fragments/alicloud.py
View file

@ -41,8 +41,8 @@ options:
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 I(alicloud_assume_role_arn), I(alicloud_assume_role_session_name),
I(alicloud_assume_role_session_expiration) and I(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:

2
plugins/doc_fragments/bitbucket.py
View file

@ -27,7 +27,7 @@ options:
description:
- The username.
- If not set the environment variable C(BITBUCKET_USERNAME) will be used.
- I(username) is an alias of I(user) since community.genreal 6.0.0. It was an alias of I(workspace) before.
- O(ignore:username) is an alias of O(user) since community.general 6.0.0. It was an alias of O(workspace) before.
type: str
version_added: 4.0.0
aliases: [ username ]

4
plugins/doc_fragments/dimensiondata.py
View file

@ -35,7 +35,7 @@ options:
description:
- The password used to authenticate to the CloudControl API.
- If not specified, will fall back to C(MCP_PASSWORD) from environment variable or C(~/.dimensiondata).
- Required if I(mcp_user) is specified.
- Required if O(mcp_user) is specified.
type: str
location:
description:
@ -44,7 +44,7 @@ options:
required: true
validate_certs:
description:
- If C(false), SSL certificates will not be validated.
- If V(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: true

4
plugins/doc_fragments/dimensiondata_wait.py
View file

@ -25,13 +25,13 @@ options:
wait_time:
description:
- The maximum amount of time (in seconds) to wait for the task to complete.
- Only applicable if I(wait=true).
- Only applicable if O(wait=true).
type: int
default: 600
wait_poll_interval:
description:
- The amount of time (in seconds) to wait between checks for task completion.
- Only applicable if I(wait=true).
- Only applicable if O(wait=true).
type: int
default: 2
'''

10
plugins/doc_fragments/influxdb.py
View file

@ -22,14 +22,14 @@ options:
username:
description:
- Username that will be used to authenticate against InfluxDB server.
- Alias C(login_username) added in Ansible 2.5.
- Alias O(ignore:login_username) added in Ansible 2.5.
type: str
default: root
aliases: [ login_username ]
password:
description:
- Password that will be used to authenticate against InfluxDB server.
- Alias C(login_password) added in Ansible 2.5.
- Alias O(ignore:login_password) added in Ansible 2.5.
type: str
default: root
aliases: [ login_password ]
@ -47,8 +47,8 @@ options:
version_added: '0.2.0'
validate_certs:
description:
- 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.
- If set to V(false), the SSL certificates will not be validated.
- This should only set to V(false) used on personally controlled sites using self-signed certificates.
type: bool
default: true
ssl:
@ -63,7 +63,7 @@ options:
retries:
description:
- Number of retries client will try before aborting.
- C(0) indicates try until success.
- V(0) indicates try until success.
- Only available when using python-influxdb >= 4.1.0
type: int
default: 3

6
plugins/doc_fragments/ipa.py
View file

@ -60,9 +60,9 @@ options:
default: https
validate_certs:
description:
- This only applies if C(ipa_prot) is I(https).
- 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.
- This only applies if O(ipa_prot) is V(https).
- If set to V(false), the SSL certificates will not be validated.
- This should only set to V(false) used on personally controlled sites using self-signed certificates.
type: bool
default: true
ipa_timeout:

4
plugins/doc_fragments/keycloak.py
View file

@ -23,7 +23,7 @@ options:
auth_client_id:
description:
- OpenID Connect I(client_id) to authenticate to the API with.
- OpenID Connect C(client_id) to authenticate to the API with.
type: str
default: admin-cli
@ -34,7 +34,7 @@ options:
auth_client_secret:
description:
- Client Secret to use in conjunction with I(auth_client_id) (if required).
- Client Secret to use in conjunction with O(auth_client_id) (if required).
type: str
auth_username:

18
plugins/doc_fragments/ldap.py
View file

@ -21,7 +21,7 @@ options:
type: str
bind_pw:
description:
- The password to use with I(bind_dn).
- The password to use with O(bind_dn).
type: str
default: ''
ca_path:
@ -40,12 +40,12 @@ options:
type: str
description:
- Set the referrals chasing behavior.
- C(anonymous) follow referrals anonymously. This is the default behavior.
- C(disabled) disable referrals chasing. This sets C(OPT_REFERRALS) to off.
- V(anonymous) follow referrals anonymously. This is the default behavior.
- V(disabled) disable referrals chasing. This sets C(OPT_REFERRALS) to off.
version_added: 2.0.0
server_uri:
description:
- The I(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.
@ -58,14 +58,13 @@ options:
default: false
validate_certs:
description:
- If set to C(false), SSL certificates will not be validated.
- If set to V(false), SSL certificates will not be validated.
- This should only be used on sites using self-signed certificates.
type: bool
default: true
sasl_class:
description:
- The class to use for SASL authentication.
- Possible choices are C(external), C(gssapi).
type: str
choices: ['external', 'gssapi']
default: external
@ -73,10 +72,9 @@ options:
xorder_discovery:
description:
- Set the behavior on how to process Xordered DNs.
- C(enable) will perform a C(ONELEVEL) search below the superior RDN to find the matching DN.
- C(disable) will always use the DN unmodified (as passed by the I(dn) parameter).
- C(auto) will only perform a search if the first RDN does not contain an index number (C({x})).
- Possible choices are C(enable), C(auto), C(disable).
- V(enable) will perform a C(ONELEVEL) search below the superior RDN to find the matching DN.
- V(disable) will always use the DN unmodified (as passed by the O(dn) parameter).
- V(auto) will only perform a search if the first RDN does not contain an index number (C({x})).
type: str
choices: ['enable', 'auto', 'disable']
default: auto

8
plugins/doc_fragments/manageiq.py
View file

@ -21,20 +21,20 @@ options:
suboptions:
url:
description:
- ManageIQ environment url. C(MIQ_URL) env var if set. otherwise, it is required to pass it.
- ManageIQ environment URL. C(MIQ_URL) environment variable if set. otherwise, it is required to pass it.
type: str
required: false
username:
description:
- ManageIQ username. C(MIQ_USERNAME) env var if set. otherwise, required if no token is passed in.
- ManageIQ username. C(MIQ_USERNAME) environment variable if set. otherwise, required if no token is passed in.
type: str
password:
description:
- ManageIQ password. C(MIQ_PASSWORD) env var if set. otherwise, required if no token is passed in.
- ManageIQ password. C(MIQ_PASSWORD) environment variable if set. otherwise, required if no token is passed in.
type: str
token:
description:
- ManageIQ token. C(MIQ_TOKEN) env var if set. otherwise, required if no username or password is passed in.
- ManageIQ token. C(MIQ_TOKEN) environment variable if set. otherwise, required if no username or password is passed in.
type: str
validate_certs:
description:

4
plugins/doc_fragments/online.py
View file

@ -37,9 +37,9 @@ options:
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
- If O(api_token) is not set within the module, the following
environment variables can be used in decreasing order of precedence
C(ONLINE_TOKEN), C(ONLINE_API_KEY), C(ONLINE_OAUTH_TOKEN), C(ONLINE_API_TOKEN)
- If one wants to use a different C(api_url) one can also set the C(ONLINE_API_URL)
- If one wants to use a different O(api_url) one can also set the C(ONLINE_API_URL)
environment variable.
'''

10
plugins/doc_fragments/opennebula.py
View file

@ -15,26 +15,26 @@ options:
api_url:
description:
- The ENDPOINT URL of the XMLRPC server.
- If not specified then the value of the ONE_URL environment variable, if any, is used.
- If not specified then the value of the C(ONE_URL) environment variable, if any, is used.
type: str
aliases:
- api_endpoint
api_username:
description:
- The name of the user for XMLRPC authentication.
- If not specified then the value of the ONE_USERNAME environment variable, if any, is used.
- If not specified then the value of the C(ONE_USERNAME) environment variable, if any, is used.
type: str
api_password:
description:
- The password or token for XMLRPC authentication.
- If not specified then the value of the ONE_PASSWORD environment variable, if any, is used.
- If not specified then the value of the C(ONE_PASSWORD) environment variable, if any, is used.
type: str
aliases:
- api_token
validate_certs:
description:
- Whether to validate the SSL certificates or not.
- This parameter is ignored if PYTHONHTTPSVERIFY environment variable is used.
- Whether to validate the TLS/SSL certificates or not.
- This parameter is ignored if C(PYTHONHTTPSVERIFY) environment variable is used.
type: bool
default: true
wait_timeout:

18
plugins/doc_fragments/openswitch.py
View file

@ -23,7 +23,7 @@ options:
port:
description:
- Specifies the port to use when building the connection to the remote
device. This value applies to either I(cli) or I(rest). The port
device. This value applies to either O(transport=cli) or O(transport=rest). The port
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.
@ -41,8 +41,8 @@ options:
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(rest) transports. Note this argument does not affect the SSH
the remote device. This is a common argument used for either O(transport=cli)
or O(transport=rest). 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.
type: str
@ -56,8 +56,8 @@ options:
ssh_keyfile:
description:
- Specifies the SSH key to use to authenticate the connection to
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
the remote device. This argument is only used for O(transport=cli).
If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
type: path
transport:
@ -71,14 +71,14 @@ options:
default: ssh
use_ssl:
description:
- 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.
- Configures the O(transport) to use SSL if set to V(true) only when the
O(transport) argument is configured as rest. If the transport
argument is not V(rest), this value is ignored.
type: bool
default: true
provider:
description:
- Convenience method that allows all I(openswitch) arguments to be passed as
- Convenience method that allows all C(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.
type: dict

26
plugins/doc_fragments/oracle.py
View file

@ -23,23 +23,23 @@ class ModuleDocFragment(object):
type: str
config_profile_name:
description:
- The profile to load from the config file referenced by C(config_file_location). If not set, then the
- The profile to load from the config file referenced by O(config_file_location). If not set, then the
value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the
"DEFAULT" profile in C(config_file_location).
"DEFAULT" profile in O(config_file_location).
default: "DEFAULT"
type: str
api_user:
description:
- The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the
value of the OCI_USER_OCID environment variable, if any, is used. This option is required if the user
is not specified through a configuration file (See C(config_file_location)). To get the user's OCID,
is not specified through a configuration file (See O(config_file_location)). To get the user's OCID,
please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
api_user_fingerprint:
description:
- Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT
environment variable, if any, is used. This option is required if the key fingerprint is not
specified through a configuration file (See C(config_file_location)). To get the key pair's
specified through a configuration file (See O(config_file_location)). To get the key pair's
fingerprint value please refer
U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
@ -47,21 +47,21 @@ class ModuleDocFragment(object):
description:
- Full path and filename of the private key (in PEM format). If not set, then the value of the
OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is
not specified through a configuration file (See C(config_file_location)). If the key is encrypted
with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided.
not specified through a configuration file (See O(config_file_location)). If the key is encrypted
with a pass-phrase, the O(api_user_key_pass_phrase) option must also be provided.
type: path
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(api_user_key_file), if it is encrypted. If not set, then
- Passphrase used by the key referenced in O(api_user_key_file), if it is encrypted. If not set, then
the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the
key passphrase is not specified through a configuration file (See C(config_file_location)).
key passphrase is not specified through a configuration file (See O(config_file_location)).
type: str
auth_type:
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key") based
authentication is performed and the API key (see I(api_user_key_file)) in your config file will be
- The type of authentication to use for making API requests. By default O(auth_type=api_key) based
authentication is performed and the API key (see O(api_user_key_file)) in your config file will be
used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE,
if any, is used. Use C(auth_type="instance_principal") to use instance principal based authentication
if any, is used. Use O(auth_type=instance_principal) to use instance principal based authentication
when running ansible playbooks within an OCI compute instance.
choices: ['api_key', 'instance_principal']
default: 'api_key'
@ -70,14 +70,14 @@ class ModuleDocFragment(object):
description:
- OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is
used. This option is required if the tenancy OCID is not specified through a configuration file
(See C(config_file_location)). To get the tenancy OCID, please refer
(See O(config_file_location)). To get the tenancy OCID, please refer
U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
region:
description:
- The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the
value of the OCI_REGION variable, if any, is used. This option is required if the region is
not specified through a configuration file (See C(config_file_location)). Please refer to
not specified through a configuration file (See O(config_file_location)). Please refer to
U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information
on OCI regions.
type: str

4
plugins/doc_fragments/oracle_creatable_resource.py
View file

@ -14,13 +14,13 @@ class ModuleDocFragment(object):
description: Whether to attempt non-idempotent creation of a resource. By default, create resource is an
idempotent operation, and doesn't create the resource if it already exists. Setting this option
to true, forcefully creates a copy of the resource, even if it already exists.This option is
mutually exclusive with I(key_by).
mutually exclusive with O(key_by).
default: false
type: bool
key_by:
description: The list of comma-separated attributes of this resource which should be used to uniquely
identify an instance of the resource. By default, all the attributes of a resource except
I(freeform_tags) are used to uniquely identify a resource.
O(freeform_tags) are used to uniquely identify a resource.
type: list
elements: str
"""

2
plugins/doc_fragments/oracle_display_name_option.py
View file

@ -11,7 +11,7 @@ class ModuleDocFragment(object):
DOCUMENTATION = """
options:
display_name:
description: Use I(display_name) along with the other options to return only resources that match the given
description: Use O(display_name) along with the other options to return only resources that match the given
display name exactly.
type: str
"""

2
plugins/doc_fragments/oracle_name_option.py
View file

@ -11,7 +11,7 @@ class ModuleDocFragment(object):
DOCUMENTATION = """
options:
name:
description: Use I(name) along with the other options to return only resources that match the given name
description: Use O(name) along with the other options to return only resources that match the given name
exactly.
type: str
"""

6
plugins/doc_fragments/oracle_wait_options.py
View file

@ -15,12 +15,12 @@ class ModuleDocFragment(object):
default: true
type: bool
wait_timeout:
description: Time, in seconds, to wait when I(wait=true).
description: Time, in seconds, to wait when O(wait=true).
default: 1200
type: int
wait_until:
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/
description: The lifecycle state to wait for the resource to transition into when O(wait=true). By default,
when O(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

2
plugins/doc_fragments/pritunl.py
View file

@ -38,7 +38,7 @@ options:
default: true
description:
- If certificates should be validated or not.
- This should never be set to C(false), except if you are very sure that
- This should never be set to V(false), except if you are very sure that
your connection to the server can not be subject to a Man In The Middle
attack.
"""

4
plugins/doc_fragments/proxmox.py
View file

@ -38,7 +38,7 @@ options:
version_added: 1.3.0
validate_certs:
description:
- If C(false), SSL certificates will not be validated.
- If V(false), SSL certificates will not be validated.
- This should only be used on personally controlled sites using self-signed certificates.
type: bool
default: false
@ -55,7 +55,7 @@ options:
node:
description:
- Proxmox VE node on which to operate.
- Only required for I(state=present).
- Only required for O(state=present).
- For every other states it will be autodiscovered.
type: str
pool:

4
plugins/doc_fragments/purestorage.py
View file

@ -34,7 +34,7 @@ options:
notes:
- This module requires the C(purity_fb) Python library
- You must set C(PUREFB_URL) and C(PUREFB_API) environment variables
if I(fb_url) and I(api_token) arguments are not passed to the module directly
if O(fb_url) and O(api_token) arguments are not passed to the module directly
requirements:
- python >= 2.7
- purity_fb >= 1.1
@ -56,7 +56,7 @@ options:
notes:
- This module requires the C(purestorage) Python library
- You must set C(PUREFA_URL) and C(PUREFA_API) environment variables
if I(fa_url) and I(api_token) arguments are not passed to the module directly
if O(fa_url) and O(api_token) arguments are not passed to the module directly
requirements:
- python >= 2.7
- purestorage

20
plugins/doc_fragments/rackspace.py
View file

@ -15,18 +15,18 @@ class ModuleDocFragment(object):
options:
api_key:
description:
- Rackspace API key, overrides I(credentials).
- Rackspace API key, overrides O(credentials).
type: str
aliases: [ password ]
credentials:
description:
- File to find the Rackspace credentials in. Ignored if I(api_key) and
I(username) are provided.
- File to find the Rackspace credentials in. Ignored if O(api_key) and
O(username) are provided.
type: path
aliases: [ creds_file ]
env:
description:
- Environment as configured in I(~/.pyrax.cfg),
- Environment as configured in C(~/.pyrax.cfg),
see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration).
type: str
region:
@ -35,7 +35,7 @@ options:
type: str
username:
description:
- Rackspace username, overrides I(credentials).
- Rackspace username, overrides O(credentials).
type: str
validate_certs:
description:
@ -61,7 +61,7 @@ options:
api_key:
type: str
description:
- Rackspace API key, overrides I(credentials).
- Rackspace API key, overrides O(credentials).
aliases: [ password ]
auth_endpoint:
type: str
@ -71,13 +71,13 @@ options:
credentials:
type: path
description:
- File to find the Rackspace credentials in. Ignored if I(api_key) and
I(username) are provided.
- File to find the Rackspace credentials in. Ignored if O(api_key) and
O(username) are provided.
aliases: [ creds_file ]
env:
type: str
description:
- Environment as configured in I(~/.pyrax.cfg),
- Environment as configured in C(~/.pyrax.cfg),
see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration).
identity_type:
type: str
@ -99,7 +99,7 @@ options:
username:
type: str
description:
- Rackspace username, overrides I(credentials).
- Rackspace username, overrides O(credentials).
validate_certs:
description:
- Whether or not to require SSL validation of API endpoints.

4
plugins/doc_fragments/redis.py
View file

@ -46,8 +46,8 @@ options:
default: true
ca_certs:
description:
- Path to root certificates file. If not set and I(tls) is
set to C(true), certifi ca-certificates will be used.
- Path to root certificates file. If not set and O(tls) is
set to V(true), certifi ca-certificates will be used.
type: str
requirements: [ "redis", "certifi" ]

4
plugins/doc_fragments/scaleway.py
View file

@ -43,9 +43,9 @@ options:
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
- If O(api_token) is not set within the module, the following
environment variables can be used in decreasing order of precedence
C(SCW_TOKEN), C(SCW_API_KEY), C(SCW_OAUTH_TOKEN) or C(SCW_API_TOKEN).
- If one wants to use a different C(api_url) one can also set the C(SCW_API_URL)
- If one wants to use a different O(api_url) one can also set the C(SCW_API_URL)
environment variable.
'''

4
plugins/doc_fragments/utm.py
View file

@ -48,8 +48,8 @@ options:
state:
description:
- The desired state of the object.
- C(present) will create or update an object
- C(absent) will delete an object if it was present
- V(present) will create or update an object
- V(absent) will delete an object if it was present
type: str
choices: [ absent, present ]
default: present

4
plugins/doc_fragments/vexata.py
View file

@ -39,8 +39,8 @@ options:
type: str
validate_certs:
description:
- Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted.
- If set to C(true), please make sure Python >= 2.7.9 is installed on the given machine.
- Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.
- If set to V(true), please make sure Python >= 2.7.9 is installed on the given machine.
required: false
type: bool
default: false

2
plugins/doc_fragments/xenserver.py
View file

@ -34,7 +34,7 @@ options:
aliases: [ pass, pwd ]
validate_certs:
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 V(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: true