(abc*, doc frags): style adjustments (#9534)

This commit is contained in:
Alexei Znamensky 2025-01-07 09:50:53 +13:00 committed by GitHub
commit aac7199087
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
28 changed files with 215 additions and 209 deletions

View file

@ -21,8 +21,8 @@ notes:
- E(CLC_V2_API_USERNAME), the account login ID for the Centurylink Cloud.
- E(CLC_V2_API_PASSWORD), the account password for the Centurylink Cloud.
- Alternatively, the module accepts the API token and account alias. The API token can be generated using the CLC account
login and password using the HTTP API call @ https://api.ctl.io/v2/authentication/login
- E(CLC_V2_API_TOKEN), the API token generated from https://api.ctl.io/v2/authentication/login
login and password using the HTTP API call @ U(https://api.ctl.io/v2/authentication/login).
- E(CLC_V2_API_TOKEN), the API token generated from U(https://api.ctl.io/v2/authentication/login).
- E(CLC_ACCT_ALIAS), the account alias associated with the Centurylink Cloud.
- Users can set E(CLC_V2_API_URL) to specify an endpoint for pointing to a different CLC environment.
"""

View file

@ -14,9 +14,10 @@ class ModuleDocFragment(object):
# Standard LDAP documentation fragment
DOCUMENTATION = r"""
notes:
- The default authentication settings will attempt to use a SASL EXTERNAL bind over a UNIX domain socket. This works well with the default Ubuntu
install for example, which includes a C(cn=peercred,cn=external,cn=auth) ACL rule allowing root to modify the server configuration. If you need
to use a simple bind to access your server, pass the credentials in O(bind_dn) and O(bind_pw).
- The default authentication settings will attempt to use a SASL EXTERNAL bind over a UNIX domain socket. This works well
with the default Ubuntu install for example, which includes a C(cn=peercred,cn=external,cn=auth) ACL rule allowing root
to modify the server configuration. If you need to use a simple bind to access your server, pass the credentials in O(bind_dn)
and O(bind_pw).
options:
bind_dn:
description:

View file

@ -40,9 +40,10 @@ options:
type: str
api_user_key_file:
description:
- Full path and filename of the private key (in PEM format). If not set, then the value of the E(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 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.
- Full path and filename of the private key (in PEM format). If not set, then the value of the E(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 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:

View file

@ -12,8 +12,8 @@ class ModuleDocFragment(object):
options:
force_create:
description: Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation,
and does not create the resource if it already exists. Setting this option to V(true), forcefully creates a copy of the
resource, even if it already exists. This option is mutually exclusive with O(key_by).
and does not create the resource if it already exists. Setting this option to V(true), forcefully creates a copy of
the resource, even if it already exists. This option is mutually exclusive with O(key_by).
default: false
type: bool
key_by:

View file

@ -31,7 +31,8 @@ options:
utm_token:
description:
- The token used to identify at the REST-API.
- See U(https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en), Chapter 2.4.2.
- See U(https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en), Chapter
2.4.2.
type: str
required: true
utm_protocol: