a-c-m
/
community.general
mirror of https://github.com/ansible-collections/community.general.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[PR #9423/0afd3386 backport][stable-9] [m-z]*.py: normalize doc_fragments (#9429) 

[m-z]*.py: normalize doc_fragments (#9423)

(cherry picked from commit 0afd3386d1)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
pull/9438/head
patchback[bot] 2024-12-27 14:52:32 +01:00 committed by GitHub
parent 4dd76284e9
commit 0bc4970953
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
22 changed files with 395 additions and 436 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
plugins/doc_fragments/onepassword.py
View File

@ -9,7 +9,7 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
DOCUMENTATION = r''' DOCUMENTATION = r"""
requirements: requirements:
- See U(https://support.1password.com/command-line/) - See U(https://support.1password.com/command-line/)
options: options:
@ -18,7 +18,8 @@ options:
aliases: ['vault_password'] aliases: ['vault_password']
type: str type: str
section: section:
description: Item section containing the field to retrieve (case-insensitive). If absent will return first match from any section. description: Item section containing the field to retrieve (case-insensitive). If absent will return first match from
any section.
domain: domain:
description: Domain of 1Password. description: Domain of 1Password.
default: '1password.com' default: '1password.com'
@ -55,25 +56,25 @@ options:
env: env:
- name: OP_CONNECT_TOKEN - name: OP_CONNECT_TOKEN
version_added: 8.1.0 version_added: 8.1.0
''' """
LOOKUP = r''' LOOKUP = r"""
options: options:
service_account_token: service_account_token:
env: env:
- name: OP_SERVICE_ACCOUNT_TOKEN - name: OP_SERVICE_ACCOUNT_TOKEN
version_added: 8.2.0 version_added: 8.2.0
notes: notes:
- This lookup will use an existing 1Password session if one exists. If not, and you have already - This lookup will use an existing 1Password session if one exists. If not, and you have already performed an initial sign
performed an initial sign in (meaning C(~/.op/config), C(~/.config/op/config) or C(~/.config/.op/config) exists), then only the in (meaning C(~/.op/config), C(~/.config/op/config) or C(~/.config/.op/config) exists), then only the O(master_password)
O(master_password) is required. You may optionally specify O(subdomain) in this scenario, otherwise the last used subdomain will be used by C(op). is required. You may optionally specify O(subdomain) in this scenario, otherwise the last used subdomain will be used
by C(op).
- This lookup can perform an initial login by providing O(subdomain), O(username), O(secret_key), and O(master_password). - This lookup can perform an initial login by providing O(subdomain), O(username), O(secret_key), and O(master_password).
- Can target a specific account by providing the O(account_id). - Can target a specific account by providing the O(account_id).
- Due to the B(very) sensitive nature of these credentials, it is B(highly) recommended that you only pass in the minimal credentials - Due to the B(very) sensitive nature of these credentials, it is B(highly) recommended that you only pass in the minimal
needed at any given time. Also, store these credentials in an Ansible Vault using a key that is equal to or greater in strength credentials needed at any given time. Also, store these credentials in an Ansible Vault using a key that is equal to or
to the 1Password master password. greater in strength to the 1Password master password.
- This lookup stores potentially sensitive data from 1Password as Ansible facts. - This lookup stores potentially sensitive data from 1Password as Ansible facts. Facts are subject to caching if enabled,
Facts are subject to caching if enabled, which means this data could be stored in clear text which means this data could be stored in clear text on disk or in a database.
on disk or in a database.
- Tested with C(op) version 2.7.2. - Tested with C(op) version 2.7.2.
''' """

111
plugins/doc_fragments/oneview.py
View File

@ -11,70 +11,67 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
# OneView doc fragment # OneView doc fragment
DOCUMENTATION = r''' DOCUMENTATION = r"""
options: options:
config: config:
description: description:
- Path to a JSON configuration file containing the OneView client configuration. - Path to a JSON configuration file containing the OneView client configuration. The configuration file is optional
The configuration file is optional and when used should be present in the host running the ansible commands. and when used should be present in the host running the ansible commands. If the file path is not provided, the configuration
If the file path is not provided, the configuration will be loaded from environment variables. will be loaded from environment variables. For links to example configuration files or how to use the environment
For links to example configuration files or how to use the environment variables verify the notes section. variables verify the notes section.
type: path type: path
api_version: api_version:
description: description:
- OneView API Version. - OneView API Version.
type: int type: int
image_streamer_hostname: image_streamer_hostname:
description: description:
- IP address or hostname for the HPE Image Streamer REST API. - IP address or hostname for the HPE Image Streamer REST API.
type: str type: str
hostname: hostname:
description: description:
- IP address or hostname for the appliance. - IP address or hostname for the appliance.
type: str type: str
username: username:
description: description:
- Username for API authentication. - Username for API authentication.
type: str type: str
password: password:
description: description:
- Password for API authentication. - Password for API authentication.
type: str type: str
requirements: requirements:
- Python >= 2.7.9 - Python >= 2.7.9
notes: notes:
- "A sample configuration file for the config parameter can be found at: - 'A sample configuration file for the config parameter can be found at:
U(https://github.com/HewlettPackard/oneview-ansible/blob/master/examples/oneview_config-rename.json)" U(https://github.com/HewlettPackard/oneview-ansible/blob/master/examples/oneview_config-rename.json).'
- "Check how to use environment variables for configuration at: - 'Check how to use environment variables for configuration at: U(https://github.com/HewlettPackard/oneview-ansible#environment-variables).'
U(https://github.com/HewlettPackard/oneview-ansible#environment-variables)" - 'Additional Playbooks for the HPE OneView Ansible modules can be found at: U(https://github.com/HewlettPackard/oneview-ansible/tree/master/examples).'
- "Additional Playbooks for the HPE OneView Ansible modules can be found at: - 'The OneView API version used will directly affect returned and expected fields in resources. Information on setting the
U(https://github.com/HewlettPackard/oneview-ansible/tree/master/examples)" desired API version and can be found at: U(https://github.com/HewlettPackard/oneview-ansible#setting-your-oneview-version).'
- "The OneView API version used will directly affect returned and expected fields in resources. """
Information on setting the desired API version and can be found at:
U(https://github.com/HewlettPackard/oneview-ansible#setting-your-oneview-version)"
'''
VALIDATEETAG = r''' VALIDATEETAG = r"""
options: options:
validate_etag: validate_etag:
description: description:
- 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
for the resource matches the ETag provided in the data. resource matches the ETag provided in the data.
type: bool type: bool
default: true default: true
''' """
FACTSPARAMS = r''' FACTSPARAMS = r"""
options: options:
params: params:
description: description:
- List of parameters to delimit, filter and sort the list of resources. - List of parameters to delimit, filter and sort the list of resources.
- "Parameter keys allowed are:" - 'Parameter keys allowed are:'
- "C(start): The first item to return, using 0-based indexing." - 'V(start): The first item to return, using 0-based indexing.'
- "C(count): The number of resources to return." - 'V(count): The number of resources to return.'
- "C(filter): A general filter/query string to narrow the list of items returned." - 'V(filter): A general filter/query string to narrow the list of items returned.'
- "C(sort): The sort order of the returned data set." - 'V(sort): The sort order of the returned data set.'
type: dict type: dict
''' """

16
plugins/doc_fragments/online.py
View File

@ -10,26 +10,26 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard documentation fragment # Standard documentation fragment
DOCUMENTATION = r''' DOCUMENTATION = r"""
options: options:
api_token: api_token:
description: description:
- Online OAuth token. - Online OAuth token.
type: str type: str
required: true required: true
aliases: [ oauth_token ] aliases: [oauth_token]
api_url: api_url:
description: description:
- Online API URL. - Online API URL.
type: str type: str
default: 'https://api.online.net' default: 'https://api.online.net'
aliases: [ base_url ] aliases: [base_url]
api_timeout: api_timeout:
description: description:
- HTTP timeout to Online API in seconds. - HTTP timeout to Online API in seconds.
type: int type: int
default: 30 default: 30
aliases: [ timeout ] aliases: [timeout]
validate_certs: validate_certs:
description: description:
- Validate SSL certs of the Online API. - Validate SSL certs of the Online API.
@ -37,9 +37,7 @@ options:
default: true 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 O(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
environment variables can be used in decreasing order of precedence
E(ONLINE_TOKEN), E(ONLINE_API_KEY), E(ONLINE_OAUTH_TOKEN), E(ONLINE_API_TOKEN). E(ONLINE_TOKEN), E(ONLINE_API_KEY), E(ONLINE_OAUTH_TOKEN), E(ONLINE_API_TOKEN).
- If one wants to use a different O(api_url) one can also set the E(ONLINE_API_URL) - If one wants to use a different O(api_url) one can also set the E(ONLINE_API_URL) environment variable.
environment variable. """
'''

64
plugins/doc_fragments/opennebula.py
View File

@ -10,36 +10,36 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
# OpenNebula common documentation # OpenNebula common documentation
DOCUMENTATION = r''' DOCUMENTATION = r"""
options: options:
api_url: api_url:
description: description:
- The ENDPOINT URL of the XMLRPC server. - The ENDPOINT URL of the XMLRPC server.
- If not specified then the value of the E(ONE_URL) environment variable, if any, is used. - If not specified then the value of the E(ONE_URL) environment variable, if any, is used.
type: str type: str
aliases: aliases:
- api_endpoint - api_endpoint
api_username: api_username:
description: description:
- The name of the user for XMLRPC authentication. - The name of the user for XMLRPC authentication.
- If not specified then the value of the E(ONE_USERNAME) environment variable, if any, is used. - If not specified then the value of the E(ONE_USERNAME) environment variable, if any, is used.
type: str type: str
api_password: api_password:
description: description:
- The password or token for XMLRPC authentication. - The password or token for XMLRPC authentication.
- If not specified then the value of the E(ONE_PASSWORD) environment variable, if any, is used. - If not specified then the value of the E(ONE_PASSWORD) environment variable, if any, is used.
type: str type: str
aliases: aliases:
- api_token - api_token
validate_certs: validate_certs:
description: description:
- Whether to validate the TLS/SSL certificates or not. - Whether to validate the TLS/SSL certificates or not.
- This parameter is ignored if E(PYTHONHTTPSVERIFY) environment variable is used. - This parameter is ignored if E(PYTHONHTTPSVERIFY) environment variable is used.
type: bool type: bool
default: true 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.
type: int type: int
default: 300 default: 300
''' """

65
plugins/doc_fragments/openswitch.py
View File

@ -11,75 +11,62 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = r''' DOCUMENTATION = r"""
options: options:
host: host:
description: description:
- Specifies the DNS host name or address for connecting to the remote - Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value
device over the specified transport. The value of host is used as of host is used as the destination address for the transport. Note this argument does not affect the SSH argument.
the destination address for the transport. Note this argument
does not affect the SSH argument.
type: str type: str
port: port:
description: description:
- Specifies the port to use when building the connection to the remote - Specifies the port to use when building the connection to the remote device. This value applies to either O(transport=cli)
device. This value applies to either O(transport=cli) or O(transport=rest). The port or O(transport=rest). The port value will default to the appropriate transport common port if none is provided in
value will default to the appropriate transport common port if the task. (cli=22, http=80, https=443). Note this argument does not affect the SSH transport.
none is provided in the task. (cli=22, http=80, https=443). Note
this argument does not affect the SSH transport.
type: int type: int
default: 0 (use common port) default: 0 (use common port)
username: username:
description: description:
- Configures the username to use to authenticate the connection to - Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate
the remote device. This value is used to authenticate either the CLI login or the eAPI authentication depending on which transport is used. Note this argument does not
either the CLI login or the eAPI authentication depending on which affect the SSH transport. If the value is not specified in the task, the value of environment variable E(ANSIBLE_NET_USERNAME)
transport is used. Note this argument does not affect the SSH will be used instead.
transport. If the value is not specified in the task, the value of
environment variable E(ANSIBLE_NET_USERNAME) will be used instead.
type: str type: str
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to the remote device. This is a common argument used
the remote device. This is a common argument used for either O(transport=cli) for either O(transport=cli) or O(transport=rest). Note this argument does not affect the SSH transport. If the value
or O(transport=rest). Note this argument does not affect the SSH is not specified in the task, the value of environment variable E(ANSIBLE_NET_PASSWORD) will be used instead.
transport. If the value is not specified in the task, the value of
environment variable E(ANSIBLE_NET_PASSWORD) will be used instead.
type: str type: str
timeout: timeout:
description: description:
- Specifies the timeout in seconds for communicating with the network device - Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands.
for either connecting or sending commands. If the timeout is If the timeout is exceeded before the operation is completed, the module will error.
exceeded before the operation is completed, the module will error.
type: int type: int
default: 10 default: 10
ssh_keyfile: ssh_keyfile:
description: description:
- Specifies the SSH key to use to authenticate the connection to - Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for O(transport=cli).
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 E(ANSIBLE_NET_SSH_KEYFILE) will be used
If the value is not specified in the task, the value of instead.
environment variable E(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
type: path type: path
transport: transport:
description: description:
- Configures the transport connection to use when connecting to the - Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity
remote device. The transport argument supports connectivity to the to the device over SSH (V(ssh)), CLI (V(cli)), or REST (V(rest)).
device over SSH (V(ssh)), CLI (V(cli)), or REST (V(rest)).
required: true required: true
type: str type: str
choices: [ cli, rest, ssh ] choices: [cli, rest, ssh]
default: ssh default: ssh
use_ssl: use_ssl:
description: description:
- Configures the O(transport) to use SSL if set to V(true) only when the - Configures the O(transport) to use SSL if set to V(true) only when the O(transport) argument is configured as rest.
O(transport) argument is configured as rest. If the transport If the transport argument is not V(rest), this value is ignored.
argument is not V(rest), this value is ignored.
type: bool type: bool
default: true default: true
provider: provider:
description: description:
- Convenience method that allows all C(openswitch) arguments to be passed as - Convenience method that allows all C(openswitch) arguments to be passed as a dict object. All constraints (required,
a dict object. All constraints (required, choices, etc) must be choices, and so on) must be met either by individual arguments or values in this dict.
met either by individual arguments or values in this dict.
type: dict type: dict
''' """

138
plugins/doc_fragments/oracle.py
View File

@ -8,76 +8,68 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
DOCUMENTATION = """ DOCUMENTATION = r"""
requirements: requirements:
- Python SDK for Oracle Cloud Infrastructure U(https://oracle-cloud-infrastructure-python-sdk.readthedocs.io) - Python SDK for Oracle Cloud Infrastructure U(https://oracle-cloud-infrastructure-python-sdk.readthedocs.io)
notes: notes:
- For OCI Python SDK configuration, please refer to - For OCI Python SDK configuration, please refer to U(https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html).
U(https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html). options:
options: config_file_location:
config_file_location: description:
description: - Path to configuration file. If not set then the value of the E(OCI_CONFIG_FILE) environment variable, if any, is used.
- Path to configuration file. If not set then the value of the E(OCI_CONFIG_FILE) environment variable, Otherwise, defaults to C(~/.oci/config).
if any, is used. Otherwise, defaults to C(~/.oci/config). type: str
type: str config_profile_name:
config_profile_name: description:
description: - The profile to load from the config file referenced by O(config_file_location). If not set, then the value of the
- The profile to load from the config file referenced by O(config_file_location). If not set, then the E(OCI_CONFIG_PROFILE) environment variable, if any, is used. Otherwise, defaults to the C(DEFAULT) profile in O(config_file_location).
value of the E(OCI_CONFIG_PROFILE) environment variable, if any, is used. Otherwise, defaults to the default: "DEFAULT"
C(DEFAULT) profile in O(config_file_location). type: str
default: "DEFAULT" api_user:
type: str description:
api_user: - The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the E(OCI_USER_OCID) environment
description: variable, if any, is used. This option is required if the user is not specified through a configuration file (See
- The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the 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).
value of the E(OCI_USER_OCID) environment variable, if any, is used. This option is required if the user type: str
is not specified through a configuration file (See O(config_file_location)). To get the user's OCID, api_user_fingerprint:
please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). description:
type: str - Fingerprint for the key pair being used. If not set, then the value of the E(OCI_USER_FINGERPRINT) environment variable,
api_user_fingerprint: if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See
description: O(config_file_location)). To get the key pair's fingerprint value please refer to
- Fingerprint for the key pair being used. If not set, then the value of the E(OCI_USER_FINGERPRINT) U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
environment variable, if any, is used. This option is required if the key fingerprint is not type: str
specified through a configuration file (See O(config_file_location)). To get the key pair's api_user_key_file:
fingerprint value please refer description:
U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). - 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,
type: str if any, is used. This option is required if the private key is not specified through a configuration file (See O(config_file_location)).
api_user_key_file: If the key is encrypted with a pass-phrase, the O(api_user_key_pass_phrase) option must also be provided.
description: type: path
- Full path and filename of the private key (in PEM format). If not set, then the value of the api_user_key_pass_phrase:
OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is description:
not specified through a configuration file (See O(config_file_location)). If the key is encrypted - Passphrase used by the key referenced in O(api_user_key_file), if it is encrypted. If not set, then the value of the
with a pass-phrase, the O(api_user_key_pass_phrase) option must also be provided. E(OCI_USER_KEY_PASS_PHRASE) variable, if any, is used. This option is required if the key passphrase is not specified
type: path through a configuration file (See O(config_file_location)).
api_user_key_pass_phrase: type: str
description: auth_type:
- Passphrase used by the key referenced in O(api_user_key_file), if it is encrypted. If not set, then description:
the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the - The type of authentication to use for making API requests. By default O(auth_type=api_key) based authentication is
key passphrase is not specified through a configuration file (See O(config_file_location)). performed and the API key (see O(api_user_key_file)) in your config file will be used. If this 'auth_type' module
type: str option is not specified, the value of the E(OCI_ANSIBLE_AUTH_TYPE), if any, is used. Use O(auth_type=instance_principal)
auth_type: to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
description: choices: ['api_key', 'instance_principal']
- The type of authentication to use for making API requests. By default O(auth_type=api_key) based default: 'api_key'
authentication is performed and the API key (see O(api_user_key_file)) in your config file will be type: str
used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, tenancy:
if any, is used. Use O(auth_type=instance_principal) to use instance principal based authentication description:
when running ansible playbooks within an OCI compute instance. - OCID of your tenancy. If not set, then the value of the E(OCI_TENANCY) variable, if any, is used. This option is required
choices: ['api_key', 'instance_principal'] if the tenancy OCID is not specified through a configuration file (See O(config_file_location)). To get the tenancy
default: 'api_key' OCID, please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str type: str
tenancy: region:
description: description:
- OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is - The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the E(OCI_REGION)
used. This option is required if the tenancy OCID is not specified through a configuration file variable, if any, is used. This option is required if the region is not specified through a configuration file (See
(See O(config_file_location)). To get the tenancy OCID, please refer to O(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). for more information on OCI regions.
type: str 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 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
"""

31
plugins/doc_fragments/oracle_creatable_resource.py
View File

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

14
plugins/doc_fragments/oracle_display_name_option.py
View File

@ -8,10 +8,10 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
DOCUMENTATION = """ DOCUMENTATION = r"""
options: options:
display_name: display_name:
description: Use O(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
display name exactly. exactly.
type: str type: str
""" """

13
plugins/doc_fragments/oracle_name_option.py
View File

@ -8,10 +8,9 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
DOCUMENTATION = """ DOCUMENTATION = r"""
options: options:
name: name:
description: Use O(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.
exactly. type: str
type: str """
"""

24
plugins/doc_fragments/oracle_tags.py
View File

@ -8,16 +8,14 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
DOCUMENTATION = """ DOCUMENTATION = r"""
options: options:
defined_tags: defined_tags:
description: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more description: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see
information, see U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). type: dict
type: dict freeform_tags:
freeform_tags: description: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
description: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, For more information, see U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
type, or namespace. For more information, see type: dict
U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). """
type: dict
"""

33
plugins/doc_fragments/oracle_wait_options.py
View File

@ -8,20 +8,19 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
DOCUMENTATION = """ DOCUMENTATION = r"""
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: true default: true
type: bool type: bool
wait_timeout: wait_timeout:
description: Time, in seconds, to wait when O(wait=true). description: Time, in seconds, to wait when O(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 O(wait=true). By default, description: The lifecycle state to wait for the resource to transition into when O(wait=true). By default, when O(wait=true),
when O(wait=true), we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during
RUNNING applicable lifecycle state during create operation and to get into DELETED/DETACHED/ create operation and to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.
TERMINATED lifecycle state during delete operation. type: str
type: str """
"""

28
plugins/doc_fragments/pipx.py
View File

@ -9,34 +9,32 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
DOCUMENTATION = r''' DOCUMENTATION = r"""
options: options:
global: global:
description: description:
- The module will pass the C(--global) argument to C(pipx), to execute actions in global scope. - The module will pass the C(--global) argument to C(pipx), to execute actions in global scope.
- The C(--global) is only available in C(pipx>=1.6.0), so make sure to have a compatible version when using this option. - The C(--global) is only available in C(pipx>=1.6.0), so make sure to have a compatible version when using this option.
Moreover, a nasty bug with C(--global) was fixed in C(pipx==1.7.0), so it is strongly recommended you used that version or newer. Moreover, a nasty bug with C(--global) was fixed in C(pipx==1.7.0), so it is strongly recommended you used that version
or newer.
type: bool type: bool
default: false default: false
executable: executable:
description: description:
- Path to the C(pipx) installed in the system. - Path to the C(pipx) installed in the system.
- > - If not specified, the module will use C(python -m pipx) to run the tool, using the same Python interpreter as ansible
If not specified, the module will use C(python -m pipx) to run the tool, itself.
using the same Python interpreter as ansible itself.
type: path type: path
notes: notes:
- This module requires C(pipx) version 0.16.2.1 or above. From community.general 11.0.0 onwards, the module will require C(pipx>=1.7.0). - This module requires C(pipx) version 0.16.2.1 or above. From community.general 11.0.0 onwards, the module will require
- Please note that C(pipx) requires Python 3.6 or above. C(pipx>=1.7.0).
- This module does not install the C(pipx) python package, however that can be easily done with the module M(ansible.builtin.pip). - Please note that C(pipx) requires Python 3.6 or above.
- This module does not require C(pipx) to be in the shell C(PATH), but it must be loadable by Python as a module. - This module does not install the C(pipx) python package, however that can be easily done with the module M(ansible.builtin.pip).
- > - This module does not require C(pipx) to be in the shell C(PATH), but it must be loadable by Python as a module.
This module will honor C(pipx) environment variables such as but not limited to E(PIPX_HOME) and E(PIPX_BIN_DIR) - This module will honor C(pipx) environment variables such as but not limited to E(PIPX_HOME) and E(PIPX_BIN_DIR) passed
passed using the R(environment Ansible keyword, playbooks_environment). using the R(environment Ansible keyword, playbooks_environment).
seealso: seealso:
- name: C(pipx) command manual page - name: C(pipx) command manual page
description: Manual page for the command. description: Manual page for the command.
link: https://pipx.pypa.io/latest/docs/ link: https://pipx.pypa.io/latest/docs/
"""
'''

52
plugins/doc_fragments/pritunl.py
View File

@ -13,32 +13,28 @@ class ModuleDocFragment(object):
DOCUMENTATION = r""" DOCUMENTATION = r"""
options: options:
pritunl_url: pritunl_url:
type: str type: str
required: true required: true
description: description:
- URL and port of the Pritunl server on which the API is enabled. - URL and port of the Pritunl server on which the API is enabled.
pritunl_api_token:
pritunl_api_token: type: str
type: str required: true
required: true description:
description: - API Token of a Pritunl admin user.
- API Token of a Pritunl admin user. - It needs to be enabled in Administrators > USERNAME > Enable Token Authentication.
- It needs to be enabled in Administrators > USERNAME > Enable Token Authentication. pritunl_api_secret:
type: str
pritunl_api_secret: required: true
type: str description:
required: true - API Secret found in Administrators > USERNAME > API Secret.
description: validate_certs:
- API Secret found in Administrators > USERNAME > API Secret. type: bool
required: false
validate_certs: default: true
type: bool description:
required: false - If certificates should be validated or not.
default: true - This should never be set to V(false), except if you are very sure that your connection to the server can not be subject
description: to a Man In The Middle attack.
- If certificates should be validated or not.
- 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.
""" """

10
plugins/doc_fragments/proxmox.py
View File

@ -9,7 +9,7 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Common parameters for Proxmox VE modules # Common parameters for Proxmox VE modules
DOCUMENTATION = r''' DOCUMENTATION = r"""
options: options:
api_host: api_host:
description: description:
@ -51,10 +51,10 @@ options:
- 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: false default: false
requirements: [ "proxmoxer", "requests" ] requirements: ["proxmoxer", "requests"]
''' """
SELECTION = r''' SELECTION = r"""
options: options:
vmid: vmid:
description: description:
@ -71,7 +71,7 @@ options:
description: description:
- Add the new VM to the specified pool. - Add the new VM to the specified pool.
type: str type: str
''' """
ACTIONGROUP_PROXMOX = r""" ACTIONGROUP_PROXMOX = r"""
options: {} options: {}

26
plugins/doc_fragments/purestorage.py
View File

@ -11,17 +11,17 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard Pure Storage documentation fragment # Standard Pure Storage documentation fragment
DOCUMENTATION = r''' DOCUMENTATION = r"""
options: options: {}
- See separate platform section for more details # See separate platform section for more details
requirements: requirements:
- See separate platform section for more details - See separate platform section for more details
notes: notes:
- Ansible modules are available for the following Pure Storage products: FlashArray, FlashBlade - 'Ansible modules are available for the following Pure Storage products: FlashArray, FlashBlade.'
''' """
# Documentation fragment for FlashBlade # Documentation fragment for FlashBlade
FB = r''' FB = r"""
options: options:
fb_url: fb_url:
description: description:
@ -33,14 +33,14 @@ options:
type: str type: str
notes: notes:
- This module requires the C(purity_fb) Python library. - This module requires the C(purity_fb) Python library.
- You must set E(PUREFB_URL) and E(PUREFB_API) environment variables - You must set E(PUREFB_URL) and E(PUREFB_API) environment variables if O(fb_url) and O(api_token) arguments are not passed
if O(fb_url) and O(api_token) arguments are not passed to the module directly. to the module directly.
requirements: requirements:
- purity_fb >= 1.1 - purity_fb >= 1.1
''' """
# Documentation fragment for FlashArray # Documentation fragment for FlashArray
FA = r''' FA = r"""
options: options:
fa_url: fa_url:
description: description:
@ -54,8 +54,8 @@ options:
required: true required: true
notes: notes:
- This module requires the C(purestorage) Python library. - This module requires the C(purestorage) Python library.
- You must set E(PUREFA_URL) and E(PUREFA_API) environment variables - You must set E(PUREFA_URL) and E(PUREFA_API) environment variables if O(fa_url) and O(api_token) arguments are not passed
if O(fa_url) and O(api_token) arguments are not passed to the module directly. to the module directly.
requirements: requirements:
- purestorage - purestorage
''' """

17
plugins/doc_fragments/redis.py
View File

@ -10,7 +10,7 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Common parameters for Redis modules # Common parameters for Redis modules
DOCUMENTATION = r''' DOCUMENTATION = r"""
options: options:
login_host: login_host:
description: description:
@ -40,14 +40,12 @@ options:
validate_certs: validate_certs:
description: description:
- Specify whether or not to validate TLS certificates. - Specify whether or not to validate TLS certificates.
- This should only be turned off for personally controlled sites or with - This should only be turned off for personally controlled sites or with C(localhost) as target.
C(localhost) as target.
type: bool type: bool
default: true default: true
ca_certs: ca_certs:
description: description:
- Path to root certificates file. If not set and O(tls) is - Path to root certificates file. If not set and O(tls) is set to V(true), certifi ca-certificates will be used.
set to V(true), certifi ca-certificates will be used.
type: str type: str
client_cert_file: client_cert_file:
description: description:
@ -59,10 +57,9 @@ options:
- Path to the client private key file. - Path to the client private key file.
type: str type: str
version_added: 9.3.0 version_added: 9.3.0
requirements: [ "redis", "certifi" ] requirements: ["redis", "certifi"]
notes: notes:
- Requires the C(redis) Python package on the remote host. You can - Requires the C(redis) Python package on the remote host. You can install it with pip (C(pip install redis)) or with a
install it with pip (C(pip install redis)) or with a package manager. package manager. Information on the library can be found at U(https://github.com/andymccurdy/redis-py).
Information on the library can be found at U(https://github.com/andymccurdy/redis-py). """
'''

4
plugins/doc_fragments/rundeck.py
View File

@ -11,7 +11,7 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = r''' DOCUMENTATION = r"""
options: options:
url: url:
type: str type: str
@ -29,4 +29,4 @@ options:
description: description:
- Rundeck User API Token. - Rundeck User API Token.
required: true required: true
''' """

18
plugins/doc_fragments/scaleway.py
View File

@ -11,29 +11,29 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard documentation fragment # Standard documentation fragment
DOCUMENTATION = r''' DOCUMENTATION = r"""
options: options:
api_token: api_token:
description: description:
- Scaleway OAuth token. - Scaleway OAuth token.
type: str type: str
required: true required: true
aliases: [ oauth_token ] aliases: [oauth_token]
api_url: api_url:
description: description:
- Scaleway API URL. - Scaleway API URL.
type: str type: str
default: https://api.scaleway.com default: https://api.scaleway.com
aliases: [ base_url ] aliases: [base_url]
api_timeout: api_timeout:
description: description:
- HTTP timeout to Scaleway API in seconds. - HTTP timeout to Scaleway API in seconds.
type: int type: int
default: 30 default: 30
aliases: [ timeout ] aliases: [timeout]
query_parameters: query_parameters:
description: description:
- List of parameters passed to the query string. - List of parameters passed to the query string.
type: dict type: dict
default: {} default: {}
validate_certs: validate_certs:
@ -43,9 +43,7 @@ options:
default: true 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 O(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
environment variables can be used in decreasing order of precedence
E(SCW_TOKEN), E(SCW_API_KEY), E(SCW_OAUTH_TOKEN) or E(SCW_API_TOKEN). E(SCW_TOKEN), E(SCW_API_KEY), E(SCW_OAUTH_TOKEN) or E(SCW_API_TOKEN).
- If one wants to use a different O(api_url) one can also set the E(SCW_API_URL) - If one wants to use a different O(api_url) one can also set the E(SCW_API_URL) environment variable.
environment variable. """
'''

10
plugins/doc_fragments/scaleway_waitable_resource.py
View File

@ -11,23 +11,23 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard documentation fragment # Standard documentation fragment
DOCUMENTATION = r''' DOCUMENTATION = r"""
options: options:
wait: wait:
description: description:
- Wait for the resource to reach its desired state before returning. - Wait for the resource to reach its desired state before returning.
type: bool type: bool
default: true default: true
wait_timeout: wait_timeout:
type: int type: int
description: description:
- Time to wait for the resource to reach the expected state. - Time to wait for the resource to reach the expected state.
required: false required: false
default: 300 default: 300
wait_sleep_time: wait_sleep_time:
type: int type: int
description: description:
- Time to wait before every attempt to check the state of the resource. - Time to wait before every attempt to check the state of the resource.
required: false required: false
default: 3 default: 3
''' """

89
plugins/doc_fragments/utm.py
View File

@ -9,49 +9,48 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
DOCUMENTATION = r''' DOCUMENTATION = r"""
options: options:
headers: headers:
description: description:
- A dictionary of additional headers to be sent to POST and PUT requests. - A dictionary of additional headers to be sent to POST and PUT requests.
- Is needed for some modules. - Is needed for some modules.
type: dict type: dict
required: false required: false
default: {} default: {}
utm_host: utm_host:
description: description:
- The REST Endpoint of the Sophos UTM. - The REST Endpoint of the Sophos UTM.
type: str type: str
required: true required: true
utm_port: utm_port:
description: description:
- The port of the REST interface. - The port of the REST interface.
type: int type: int
default: 4444 default: 4444
utm_token: utm_token:
description: description:
- "The token used to identify at the REST-API. See - The token used to identify at the REST-API.
U(https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en), - See U(https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en), Chapter 2.4.2.
Chapter 2.4.2." type: str
type: str required: true
required: true utm_protocol:
utm_protocol: description:
description: - The protocol of the REST Endpoint.
- The protocol of the REST Endpoint. choices: [http, https]
choices: [ http, https ] type: str
type: str default: https
default: https validate_certs:
validate_certs: 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: true
default: true state:
state: description:
description: - The desired state of the object.
- The desired state of the object. - V(present) will create or update an object.
- V(present) will create or update an object. - V(absent) will delete an object if it was present.
- V(absent) will delete an object if it was present. type: str
type: str choices: [absent, present]
choices: [ absent, present ] default: present
default: present """
'''

12
plugins/doc_fragments/vexata.py
View File

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

27
plugins/doc_fragments/xenserver.py
View File

@ -10,32 +10,33 @@ __metaclass__ = type
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Common parameters for XenServer modules # Common parameters for XenServer modules
DOCUMENTATION = r''' DOCUMENTATION = r"""
options: options:
hostname: hostname:
description: description:
- The hostname or IP address of the XenServer host or XenServer pool master. - The hostname or IP address of the XenServer host or XenServer pool master.
- If the value is not specified in the task, the value of environment variable E(XENSERVER_HOST) will be used instead. - If the value is not specified in the task, the value of environment variable E(XENSERVER_HOST) will be used instead.
type: str type: str
default: localhost default: localhost
aliases: [ host, pool ] aliases: [host, pool]
username: username:
description: description:
- The username to use for connecting to XenServer. - The username to use for connecting to XenServer.
- If the value is not specified in the task, the value of environment variable E(XENSERVER_USER) will be used instead. - If the value is not specified in the task, the value of environment variable E(XENSERVER_USER) will be used instead.
type: str type: str
default: root default: root
aliases: [ admin, user ] aliases: [admin, user]
password: password:
description: description:
- The password to use for connecting to XenServer. - The password to use for connecting to XenServer.
- If the value is not specified in the task, the value of environment variable E(XENSERVER_PASSWORD) will be used instead. - If the value is not specified in the task, the value of environment variable E(XENSERVER_PASSWORD) will be used instead.
type: str type: str
aliases: [ pass, pwd ] aliases: [pass, pwd]
validate_certs: validate_certs:
description: description:
- Allows connection when SSL certificates are not valid. Set to V(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 E(XENSERVER_VALIDATE_CERTS) will be used instead. - If the value is not specified in the task, the value of environment variable E(XENSERVER_VALIDATE_CERTS) will be used
instead.
type: bool type: bool
default: true default: true
''' """