From bd1c1b257fc00adf0c4c1dd41159859d99d93bdc Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Sat, 10 Jun 2023 10:53:50 +0200 Subject: [PATCH] [PR #6627/011b2f8b backport][stable-7] Start using semantic markup (#6664) 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 011b2f8bdc2a042f0eb44739ff51ce425f391afa) Co-authored-by: Felix Fontein --- plugins/become/machinectl.py | 2 +- plugins/become/pfexec.py | 2 +- plugins/cache/redis.py | 6 +-- plugins/callback/cgroup_memory_recap.py | 4 +- plugins/callback/diy.py | 52 +++++++++---------- plugins/callback/opentelemetry.py | 4 +- plugins/callback/splunk.py | 4 +- plugins/callback/sumologic.py | 6 +-- plugins/doc_fragments/alicloud.py | 4 +- plugins/doc_fragments/bitbucket.py | 2 +- plugins/doc_fragments/dimensiondata.py | 4 +- plugins/doc_fragments/dimensiondata_wait.py | 4 +- plugins/doc_fragments/influxdb.py | 10 ++-- plugins/doc_fragments/ipa.py | 6 +-- plugins/doc_fragments/keycloak.py | 4 +- plugins/doc_fragments/ldap.py | 18 +++---- plugins/doc_fragments/manageiq.py | 8 +-- plugins/doc_fragments/online.py | 4 +- plugins/doc_fragments/opennebula.py | 10 ++-- plugins/doc_fragments/openswitch.py | 18 +++---- plugins/doc_fragments/oracle.py | 26 +++++----- .../oracle_creatable_resource.py | 4 +- .../oracle_display_name_option.py | 2 +- plugins/doc_fragments/oracle_name_option.py | 2 +- plugins/doc_fragments/oracle_wait_options.py | 6 +-- plugins/doc_fragments/pritunl.py | 2 +- plugins/doc_fragments/proxmox.py | 4 +- plugins/doc_fragments/purestorage.py | 4 +- plugins/doc_fragments/rackspace.py | 20 +++---- plugins/doc_fragments/redis.py | 4 +- plugins/doc_fragments/scaleway.py | 4 +- plugins/doc_fragments/utm.py | 4 +- plugins/doc_fragments/vexata.py | 4 +- plugins/doc_fragments/xenserver.py | 2 +- plugins/filter/from_csv.py | 8 +-- plugins/filter/jc.py | 6 +-- plugins/filter/lists_mergeby.py | 4 +- plugins/filter/to_days.yml | 10 ++-- plugins/filter/to_hours.yml | 10 ++-- plugins/filter/to_milliseconds.yml | 10 ++-- plugins/filter/to_minutes.yml | 10 ++-- plugins/filter/to_months.yml | 10 ++-- plugins/filter/to_seconds.yml | 10 ++-- plugins/filter/to_time_unit.yml | 10 ++-- plugins/filter/to_weeks.yml | 10 ++-- plugins/filter/to_years.yml | 10 ++-- plugins/inventory/cobbler.py | 10 ++-- plugins/inventory/icinga2.py | 2 +- plugins/inventory/lxd.py | 10 ++-- plugins/inventory/nmap.py | 14 ++--- plugins/inventory/opennebula.py | 16 +++--- plugins/inventory/proxmox.py | 38 +++++++------- plugins/inventory/scaleway.py | 2 +- plugins/inventory/xen_orchestra.py | 8 +-- plugins/lookup/bitwarden.py | 2 +- plugins/lookup/collection_version.py | 18 +++---- plugins/lookup/consul_kv.py | 13 +++-- plugins/lookup/dig.py | 18 +++---- plugins/lookup/dnstxt.py | 4 +- plugins/lookup/dsv.py | 10 ++-- plugins/lookup/etcd3.py | 18 +++---- plugins/lookup/filetree.py | 2 +- plugins/lookup/lmdb_kv.py | 2 +- plugins/lookup/merge_variables.py | 8 +-- plugins/lookup/onepassword.py | 6 +-- plugins/lookup/onepassword_raw.py | 8 +-- plugins/lookup/passwordstore.py | 38 +++++++------- plugins/lookup/random_string.py | 12 ++--- plugins/lookup/revbitspss.py | 2 +- plugins/lookup/tss.py | 14 ++--- plugins/modules/ufw.py | 44 ++++++++-------- 71 files changed, 342 insertions(+), 345 deletions(-) diff --git a/plugins/become/machinectl.py b/plugins/become/machinectl.py index 461a3f635d..53d562e598 100644 --- a/plugins/become/machinectl.py +++ b/plugins/become/machinectl.py @@ -68,7 +68,7 @@ DOCUMENTATION = ''' - section: machinectl_become_plugin key: password notes: - - When not using this plugin with user C(root), it only works correctly with a polkit rule which will alter + - When not using this plugin with user V(root), it only works correctly with a polkit rule which will alter the behaviour of machinectl. This rule must alter the prompt behaviour to ask directly for the user credentials, if the user is allowed to perform the action (take a look at the examples section). If such a rule is not present the plugin only work if it is used in context with the root user, diff --git a/plugins/become/pfexec.py b/plugins/become/pfexec.py index 392ee961f5..2468a28a94 100644 --- a/plugins/become/pfexec.py +++ b/plugins/become/pfexec.py @@ -82,7 +82,7 @@ DOCUMENTATION = ''' env: - name: ANSIBLE_PFEXEC_WRAP_EXECUTION notes: - - This plugin ignores I(become_user) as pfexec uses it's own C(exec_attr) to figure this out. + - This plugin ignores O(become_user) as pfexec uses it's own C(exec_attr) to figure this out. ''' from ansible.plugins.become import BecomeBase diff --git a/plugins/cache/redis.py b/plugins/cache/redis.py index 8c06217176..01c67fd521 100644 --- a/plugins/cache/redis.py +++ b/plugins/cache/redis.py @@ -18,9 +18,9 @@ DOCUMENTATION = ''' _uri: description: - A colon separated string of connection information for Redis. - - The format is C(host:port:db:password), for example C(localhost:6379:0:changeme). - - To use encryption in transit, prefix the connection with C(tls://), as in C(tls://localhost:6379:0:changeme). - - To use redis sentinel, use separator C(;), for example C(localhost:26379;localhost:26379;0:changeme). Requires redis>=2.9.0. + - The format is V(host:port:db:password), for example V(localhost:6379:0:changeme). + - To use encryption in transit, prefix the connection with V(tls://), as in V(tls://localhost:6379:0:changeme). + - To use redis sentinel, use separator V(;), for example V(localhost:26379;localhost:26379;0:changeme). Requires redis>=2.9.0. required: true env: - name: ANSIBLE_CACHE_PLUGIN_CONNECTION diff --git a/plugins/callback/cgroup_memory_recap.py b/plugins/callback/cgroup_memory_recap.py index ccdbcc9cf0..d3961bf0c8 100644 --- a/plugins/callback/cgroup_memory_recap.py +++ b/plugins/callback/cgroup_memory_recap.py @@ -24,7 +24,7 @@ DOCUMENTATION = ''' options: max_mem_file: required: true - description: Path to cgroups C(memory.max_usage_in_bytes) file. Example C(/sys/fs/cgroup/memory/ansible_profile/memory.max_usage_in_bytes). + description: Path to cgroups C(memory.max_usage_in_bytes) file. Example V(/sys/fs/cgroup/memory/ansible_profile/memory.max_usage_in_bytes). env: - name: CGROUP_MAX_MEM_FILE ini: @@ -32,7 +32,7 @@ DOCUMENTATION = ''' key: max_mem_file cur_mem_file: required: true - description: Path to C(memory.usage_in_bytes) file. Example C(/sys/fs/cgroup/memory/ansible_profile/memory.usage_in_bytes). + description: Path to C(memory.usage_in_bytes) file. Example V(/sys/fs/cgroup/memory/ansible_profile/memory.usage_in_bytes). env: - name: CGROUP_CUR_MEM_FILE ini: diff --git a/plugins/callback/diy.py b/plugins/callback/diy.py index 75b3f4e24b..cf9369e4b4 100644 --- a/plugins/callback/diy.py +++ b/plugins/callback/diy.py @@ -18,7 +18,7 @@ DOCUMENTATION = r''' extends_documentation_fragment: - default_callback notes: - - Uses the C(default) callback plugin output when a custom callback message(C(msg)) is not provided. + - Uses the P(ansible.builtin.default#callback) callback plugin output when a custom callback V(message(msg\)) is not provided. - Makes the callback event data available via the C(ansible_callback_diy) dictionary, which can be used in the templating context for the options. The dictionary is only available in the templating context for the options. It is not a variable that is available via the other various execution contexts, such as playbook, play, task etc. @@ -40,8 +40,8 @@ DOCUMENTATION = r''' if value C(is not None and not omit and length is greater than 0), then the option is being used with output. **Effect**: render value as template and output" - - "Valid color values: C(black), C(bright gray), C(blue), C(white), C(green), C(bright blue), C(cyan), C(bright green), C(red), C(bright cyan), - C(purple), C(bright red), C(yellow), C(bright purple), C(dark gray), C(bright yellow), C(magenta), C(bright magenta), C(normal)" + - "Valid color values: V(black), V(bright gray), V(blue), V(white), V(green), V(bright blue), V(cyan), V(bright green), V(red), V(bright cyan), + V(purple), V(bright red), V(yellow), V(bright purple), V(dark gray), V(bright yellow), V(magenta), V(bright magenta), V(normal)" seealso: - name: default – default Ansible screen output description: The official documentation on the B(default) callback plugin. @@ -62,7 +62,7 @@ DOCUMENTATION = r''' on_any_msg_color: description: - - Output color to be used for I(on_any_msg). + - Output color to be used for O(on_any_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -86,7 +86,7 @@ DOCUMENTATION = r''' runner_on_failed_msg_color: description: - - Output color to be used for I(runner_on_failed_msg). + - Output color to be used for O(runner_on_failed_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -110,7 +110,7 @@ DOCUMENTATION = r''' runner_on_ok_msg_color: description: - - Output color to be used for I(runner_on_ok_msg). + - Output color to be used for O(runner_on_ok_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -134,7 +134,7 @@ DOCUMENTATION = r''' runner_on_skipped_msg_color: description: - - Output color to be used for I(runner_on_skipped_msg). + - Output color to be used for O(runner_on_skipped_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -158,7 +158,7 @@ DOCUMENTATION = r''' runner_on_unreachable_msg_color: description: - - Output color to be used for I(runner_on_unreachable_msg). + - Output color to be used for O(runner_on_unreachable_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -182,7 +182,7 @@ DOCUMENTATION = r''' playbook_on_start_msg_color: description: - - Output color to be used for I(playbook_on_start_msg). + - Output color to be used for O(playbook_on_start_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -206,7 +206,7 @@ DOCUMENTATION = r''' playbook_on_notify_msg_color: description: - - Output color to be used for I(playbook_on_notify_msg). + - Output color to be used for O(playbook_on_notify_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -230,7 +230,7 @@ DOCUMENTATION = r''' playbook_on_no_hosts_matched_msg_color: description: - - Output color to be used for I(playbook_on_no_hosts_matched_msg). + - Output color to be used for O(playbook_on_no_hosts_matched_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -254,7 +254,7 @@ DOCUMENTATION = r''' playbook_on_no_hosts_remaining_msg_color: description: - - Output color to be used for I(playbook_on_no_hosts_remaining_msg). + - Output color to be used for O(playbook_on_no_hosts_remaining_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -278,7 +278,7 @@ DOCUMENTATION = r''' playbook_on_task_start_msg_color: description: - - Output color to be used for I(playbook_on_task_start_msg). + - Output color to be used for O(playbook_on_task_start_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -302,7 +302,7 @@ DOCUMENTATION = r''' playbook_on_handler_task_start_msg_color: description: - - Output color to be used for I(playbook_on_handler_task_start_msg). + - Output color to be used for O(playbook_on_handler_task_start_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -326,7 +326,7 @@ DOCUMENTATION = r''' playbook_on_vars_prompt_msg_color: description: - - Output color to be used for I(playbook_on_vars_prompt_msg). + - Output color to be used for O(playbook_on_vars_prompt_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -350,7 +350,7 @@ DOCUMENTATION = r''' playbook_on_play_start_msg_color: description: - - Output color to be used for I(playbook_on_play_start_msg). + - Output color to be used for O(playbook_on_play_start_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -374,7 +374,7 @@ DOCUMENTATION = r''' playbook_on_stats_msg_color: description: - - Output color to be used for I(playbook_on_stats_msg). + - Output color to be used for O(playbook_on_stats_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -398,7 +398,7 @@ DOCUMENTATION = r''' on_file_diff_msg_color: description: - - Output color to be used for I(on_file_diff_msg). + - Output color to be used for O(on_file_diff_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -422,7 +422,7 @@ DOCUMENTATION = r''' playbook_on_include_msg_color: description: - - Output color to be used for I(playbook_on_include_msg). + - Output color to be used for O(playbook_on_include_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -446,7 +446,7 @@ DOCUMENTATION = r''' runner_item_on_ok_msg_color: description: - - Output color to be used for I(runner_item_on_ok_msg). + - Output color to be used for O(runner_item_on_ok_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -470,7 +470,7 @@ DOCUMENTATION = r''' runner_item_on_failed_msg_color: description: - - Output color to be used for I(runner_item_on_failed_msg). + - Output color to be used for O(runner_item_on_failed_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -494,7 +494,7 @@ DOCUMENTATION = r''' runner_item_on_skipped_msg_color: description: - - Output color to be used for I(runner_item_on_skipped_msg). + - Output color to be used for O(runner_item_on_skipped_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -518,7 +518,7 @@ DOCUMENTATION = r''' runner_retry_msg_color: description: - - Output color to be used for I(runner_retry_msg). + - Output color to be used for O(runner_retry_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -542,7 +542,7 @@ DOCUMENTATION = r''' runner_on_start_msg_color: description: - - Output color to be used for I(runner_on_start_msg). + - Output color to be used for O(runner_on_start_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -566,7 +566,7 @@ DOCUMENTATION = r''' runner_on_no_hosts_msg_color: description: - - Output color to be used for I(runner_on_no_hosts_msg). + - Output color to be used for O(runner_on_no_hosts_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy @@ -590,7 +590,7 @@ DOCUMENTATION = r''' playbook_on_setup_msg_color: description: - - Output color to be used for I(playbook_on_setup_msg). + - Output color to be used for O(playbook_on_setup_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy diff --git a/plugins/callback/opentelemetry.py b/plugins/callback/opentelemetry.py index df2fb5cee6..492e420716 100644 --- a/plugins/callback/opentelemetry.py +++ b/plugins/callback/opentelemetry.py @@ -32,10 +32,10 @@ DOCUMENTATION = ''' enable_from_environment: type: str description: - - Whether to enable this callback only if the given environment variable exists and it is set to C(true). + - Whether to enable this callback only if the given environment variable exists and it is set to V(true). - This is handy when you use Configuration as Code and want to send distributed traces if running in the CI rather when running Ansible locally. - - For such, it evaluates the given I(enable_from_environment) value as environment variable + - For such, it evaluates the given O(enable_from_environment) value as environment variable and if set to true this plugin will be enabled. env: - name: ANSIBLE_OPENTELEMETRY_ENABLE_FROM_ENVIRONMENT diff --git a/plugins/callback/splunk.py b/plugins/callback/splunk.py index 67ad944d2e..d15547f44b 100644 --- a/plugins/callback/splunk.py +++ b/plugins/callback/splunk.py @@ -36,8 +36,8 @@ DOCUMENTATION = ''' key: authtoken validate_certs: description: Whether to validate certificates for connections to HEC. It is not recommended to set to - C(false) except when you are sure that nobody can intercept the connection - between this plugin and HEC, as setting it to C(false) allows man-in-the-middle attacks! + V(false) except when you are sure that nobody can intercept the connection + between this plugin and HEC, as setting it to V(false) allows man-in-the-middle attacks! env: - name: SPLUNK_VALIDATE_CERTS ini: diff --git a/plugins/callback/sumologic.py b/plugins/callback/sumologic.py index 998081c35b..46ab3f0f7c 100644 --- a/plugins/callback/sumologic.py +++ b/plugins/callback/sumologic.py @@ -6,7 +6,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type -DOCUMENTATION = ''' +DOCUMENTATION = r''' name: sumologic type: notification short_description: Sends task result events to Sumologic @@ -15,8 +15,8 @@ description: - This callback plugin will send task results as JSON formatted events to a Sumologic HTTP collector source. requirements: - Whitelisting this callback plugin - - 'Create a HTTP collector source in Sumologic and specify a custom timestamp format of C(yyyy-MM-dd HH:mm:ss ZZZZ) and a custom timestamp locator - of C("timestamp": "(.*)")' + - 'Create a HTTP collector source in Sumologic and specify a custom timestamp format of V(yyyy-MM-dd HH:mm:ss ZZZZ) and a custom timestamp locator + of V("timestamp": "(.*\)")' options: url: description: URL to the Sumologic HTTP collector source. diff --git a/plugins/doc_fragments/alicloud.py b/plugins/doc_fragments/alicloud.py index f464e178c7..cce24c944a 100644 --- a/plugins/doc_fragments/alicloud.py +++ b/plugins/doc_fragments/alicloud.py @@ -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: diff --git a/plugins/doc_fragments/bitbucket.py b/plugins/doc_fragments/bitbucket.py index 703bb412a1..269c8dee8d 100644 --- a/plugins/doc_fragments/bitbucket.py +++ b/plugins/doc_fragments/bitbucket.py @@ -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 ] diff --git a/plugins/doc_fragments/dimensiondata.py b/plugins/doc_fragments/dimensiondata.py index f8372431e0..24a4f483c9 100644 --- a/plugins/doc_fragments/dimensiondata.py +++ b/plugins/doc_fragments/dimensiondata.py @@ -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 diff --git a/plugins/doc_fragments/dimensiondata_wait.py b/plugins/doc_fragments/dimensiondata_wait.py index d371528396..929139df32 100644 --- a/plugins/doc_fragments/dimensiondata_wait.py +++ b/plugins/doc_fragments/dimensiondata_wait.py @@ -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 ''' diff --git a/plugins/doc_fragments/influxdb.py b/plugins/doc_fragments/influxdb.py index 6aedd5ad39..882f8f00a6 100644 --- a/plugins/doc_fragments/influxdb.py +++ b/plugins/doc_fragments/influxdb.py @@ -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 diff --git a/plugins/doc_fragments/ipa.py b/plugins/doc_fragments/ipa.py index 5051c55390..fdc63dc728 100644 --- a/plugins/doc_fragments/ipa.py +++ b/plugins/doc_fragments/ipa.py @@ -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: diff --git a/plugins/doc_fragments/keycloak.py b/plugins/doc_fragments/keycloak.py index 5d79fad7c0..b7f12c6ca2 100644 --- a/plugins/doc_fragments/keycloak.py +++ b/plugins/doc_fragments/keycloak.py @@ -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: diff --git a/plugins/doc_fragments/ldap.py b/plugins/doc_fragments/ldap.py index b321c75eb8..451b3f3e06 100644 --- a/plugins/doc_fragments/ldap.py +++ b/plugins/doc_fragments/ldap.py @@ -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 diff --git a/plugins/doc_fragments/manageiq.py b/plugins/doc_fragments/manageiq.py index 030d682385..c20a519b0d 100644 --- a/plugins/doc_fragments/manageiq.py +++ b/plugins/doc_fragments/manageiq.py @@ -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: diff --git a/plugins/doc_fragments/online.py b/plugins/doc_fragments/online.py index d7e13765b0..a8a472bca3 100644 --- a/plugins/doc_fragments/online.py +++ b/plugins/doc_fragments/online.py @@ -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. ''' diff --git a/plugins/doc_fragments/opennebula.py b/plugins/doc_fragments/opennebula.py index 0fc323271a..e034192501 100644 --- a/plugins/doc_fragments/opennebula.py +++ b/plugins/doc_fragments/opennebula.py @@ -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: diff --git a/plugins/doc_fragments/openswitch.py b/plugins/doc_fragments/openswitch.py index 9d5f0be742..e212fd1579 100644 --- a/plugins/doc_fragments/openswitch.py +++ b/plugins/doc_fragments/openswitch.py @@ -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 diff --git a/plugins/doc_fragments/oracle.py b/plugins/doc_fragments/oracle.py index 9ca4706baa..c3a93fc131 100644 --- a/plugins/doc_fragments/oracle.py +++ b/plugins/doc_fragments/oracle.py @@ -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 diff --git a/plugins/doc_fragments/oracle_creatable_resource.py b/plugins/doc_fragments/oracle_creatable_resource.py index 5293819199..9d2cc07c9f 100644 --- a/plugins/doc_fragments/oracle_creatable_resource.py +++ b/plugins/doc_fragments/oracle_creatable_resource.py @@ -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 """ diff --git a/plugins/doc_fragments/oracle_display_name_option.py b/plugins/doc_fragments/oracle_display_name_option.py index eae5f44593..b6bc0f2297 100644 --- a/plugins/doc_fragments/oracle_display_name_option.py +++ b/plugins/doc_fragments/oracle_display_name_option.py @@ -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 """ diff --git a/plugins/doc_fragments/oracle_name_option.py b/plugins/doc_fragments/oracle_name_option.py index 362071f946..523eed702f 100644 --- a/plugins/doc_fragments/oracle_name_option.py +++ b/plugins/doc_fragments/oracle_name_option.py @@ -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 """ diff --git a/plugins/doc_fragments/oracle_wait_options.py b/plugins/doc_fragments/oracle_wait_options.py index ce7ea776e2..3a857d4f77 100644 --- a/plugins/doc_fragments/oracle_wait_options.py +++ b/plugins/doc_fragments/oracle_wait_options.py @@ -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 diff --git a/plugins/doc_fragments/pritunl.py b/plugins/doc_fragments/pritunl.py index 51ab979b54..396ee0866a 100644 --- a/plugins/doc_fragments/pritunl.py +++ b/plugins/doc_fragments/pritunl.py @@ -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. """ diff --git a/plugins/doc_fragments/proxmox.py b/plugins/doc_fragments/proxmox.py index e39af4f3a6..15d6555bb4 100644 --- a/plugins/doc_fragments/proxmox.py +++ b/plugins/doc_fragments/proxmox.py @@ -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: diff --git a/plugins/doc_fragments/purestorage.py b/plugins/doc_fragments/purestorage.py index 8db8c3b3da..2411245733 100644 --- a/plugins/doc_fragments/purestorage.py +++ b/plugins/doc_fragments/purestorage.py @@ -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 diff --git a/plugins/doc_fragments/rackspace.py b/plugins/doc_fragments/rackspace.py index 6f902a2395..e68f2bfe85 100644 --- a/plugins/doc_fragments/rackspace.py +++ b/plugins/doc_fragments/rackspace.py @@ -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. diff --git a/plugins/doc_fragments/redis.py b/plugins/doc_fragments/redis.py index 2d40330519..fafb52c86c 100644 --- a/plugins/doc_fragments/redis.py +++ b/plugins/doc_fragments/redis.py @@ -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" ] diff --git a/plugins/doc_fragments/scaleway.py b/plugins/doc_fragments/scaleway.py index b08d11dbb0..34b0769092 100644 --- a/plugins/doc_fragments/scaleway.py +++ b/plugins/doc_fragments/scaleway.py @@ -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. ''' diff --git a/plugins/doc_fragments/utm.py b/plugins/doc_fragments/utm.py index 73ad805035..980a43e9bb 100644 --- a/plugins/doc_fragments/utm.py +++ b/plugins/doc_fragments/utm.py @@ -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 diff --git a/plugins/doc_fragments/vexata.py b/plugins/doc_fragments/vexata.py index ff79613eec..69349172c2 100644 --- a/plugins/doc_fragments/vexata.py +++ b/plugins/doc_fragments/vexata.py @@ -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 diff --git a/plugins/doc_fragments/xenserver.py b/plugins/doc_fragments/xenserver.py index eaee173849..2a33c91451 100644 --- a/plugins/doc_fragments/xenserver.py +++ b/plugins/doc_fragments/xenserver.py @@ -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 diff --git a/plugins/filter/from_csv.py b/plugins/filter/from_csv.py index 6472b67b1a..7af655d6f7 100644 --- a/plugins/filter/from_csv.py +++ b/plugins/filter/from_csv.py @@ -23,7 +23,7 @@ DOCUMENTATION = ''' dialect: description: - The CSV dialect to use when parsing the CSV file. - - Possible values include C(excel), C(excel-tab) or C(unix). + - Possible values include V(excel), V(excel-tab) or V(unix). type: str default: excel fieldnames: @@ -35,19 +35,19 @@ DOCUMENTATION = ''' delimiter: description: - A one-character string used to separate fields. - - When using this parameter, you change the default value used by I(dialect). + - When using this parameter, you change the default value used by O(dialect). - The default value depends on the dialect used. type: str skipinitialspace: description: - Whether to ignore any whitespaces immediately following the delimiter. - - When using this parameter, you change the default value used by I(dialect). + - When using this parameter, you change the default value used by O(dialect). - The default value depends on the dialect used. type: bool strict: description: - Whether to raise an exception on bad CSV input. - - When using this parameter, you change the default value used by I(dialect). + - When using this parameter, you change the default value used by O(dialect). - The default value depends on the dialect used. type: bool ''' diff --git a/plugins/filter/jc.py b/plugins/filter/jc.py index 3aa8d20a5f..2fe3ef9d73 100644 --- a/plugins/filter/jc.py +++ b/plugins/filter/jc.py @@ -25,17 +25,17 @@ DOCUMENTATION = ''' parser: description: - The correct parser for the input data. - - For example C(ifconfig). + - For example V(ifconfig). - "Note: use underscores instead of dashes (if any) in the parser module name." - See U(https://github.com/kellyjonbrazil/jc#parsers) for the latest list of parsers. type: string required: true quiet: - description: Set to C(false) to not suppress warnings. + description: Set to V(false) to not suppress warnings. type: boolean default: true raw: - description: Set to C(true) to return pre-processed JSON. + description: Set to V(true) to return pre-processed JSON. type: boolean default: false requirements: diff --git a/plugins/filter/lists_mergeby.py b/plugins/filter/lists_mergeby.py index 036dfe4d7c..caf183492c 100644 --- a/plugins/filter/lists_mergeby.py +++ b/plugins/filter/lists_mergeby.py @@ -12,9 +12,9 @@ DOCUMENTATION = ''' version_added: 2.0.0 author: Vladimir Botka (@vbotka) description: - - Merge two or more lists by attribute I(index). Optional parameters 'recursive' and 'list_merge' + - Merge two or more lists by attribute O(index). Optional parameters O(recursive) and O(list_merge) control the merging of the lists in values. The function merge_hash from ansible.utils.vars - is used. To learn details on how to use the parameters 'recursive' and 'list_merge' see + is used. To learn details on how to use the parameters O(recursive) and O(list_merge) see Ansible User's Guide chapter "Using filters to manipulate data" section "Combining hashes/dictionaries". positional: another_list, index diff --git a/plugins/filter/to_days.yml b/plugins/filter/to_days.yml index 19bc8faf23..b5f6424fa3 100644 --- a/plugins/filter/to_days.yml +++ b/plugins/filter/to_days.yml @@ -13,12 +13,12 @@ DOCUMENTATION: _input: description: - The time string to convert. - - Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week, - C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec) - and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s) - can be added to a unit as well, so C(seconds) is the same as C(second). + - Can use the units V(y) and V(year) for a year, V(mo) and V(month) for a month, V(w) and V(week) for a week, + V(d) and V(day) for a day, V(h) and V(hour) for a hour, V(m), V(min) and V(minute) for minutes, V(s), V(sec) + and V(second) for seconds, V(ms), V(msec), V(msecond) and V(millisecond) for milliseconds. The suffix V(s) + can be added to a unit as well, so V(seconds) is the same as V(second). - Valid strings are space separated combinations of an integer with an optional minus sign and a unit. - - Examples are C(1h), C(-5m), and C(3h -5m 6s). + - Examples are V(1h), V(-5m), and V(3h -5m 6s). type: string required: true year: diff --git a/plugins/filter/to_hours.yml b/plugins/filter/to_hours.yml index 83826a5908..353fdfc317 100644 --- a/plugins/filter/to_hours.yml +++ b/plugins/filter/to_hours.yml @@ -13,12 +13,12 @@ DOCUMENTATION: _input: description: - The time string to convert. - - Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week, - C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec) - and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s) - can be added to a unit as well, so C(seconds) is the same as C(second). + - Can use the units V(y) and V(year) for a year, V(mo) and V(month) for a month, V(w) and V(week) for a week, + V(d) and V(day) for a day, V(h) and V(hour) for a hour, V(m), V(min) and V(minute) for minutes, V(s), V(sec) + and V(second) for seconds, V(ms), V(msec), V(msecond) and V(millisecond) for milliseconds. The suffix V(s) + can be added to a unit as well, so V(seconds) is the same as V(second). - Valid strings are space separated combinations of an integer with an optional minus sign and a unit. - - Examples are C(1h), C(-5m), and C(3h -5m 6s). + - Examples are V(1h), V(-5m), and V(3h -5m 6s). type: string required: true year: diff --git a/plugins/filter/to_milliseconds.yml b/plugins/filter/to_milliseconds.yml index b6bb7e4be0..19ed02438c 100644 --- a/plugins/filter/to_milliseconds.yml +++ b/plugins/filter/to_milliseconds.yml @@ -13,12 +13,12 @@ DOCUMENTATION: _input: description: - The time string to convert. - - Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week, - C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec) - and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s) - can be added to a unit as well, so C(seconds) is the same as C(second). + - Can use the units V(y) and V(year) for a year, V(mo) and V(month) for a month, V(w) and V(week) for a week, + V(d) and V(day) for a day, V(h) and V(hour) for a hour, V(m), V(min) and V(minute) for minutes, V(s), V(sec) + and V(second) for seconds, V(ms), V(msec), V(msecond) and V(millisecond) for milliseconds. The suffix V(s) + can be added to a unit as well, so V(seconds) is the same as V(second). - Valid strings are space separated combinations of an integer with an optional minus sign and a unit. - - Examples are C(1h), C(-5m), and C(3h -5m 6s). + - Examples are V(1h), V(-5m), and V(3h -5m 6s). type: string required: true year: diff --git a/plugins/filter/to_minutes.yml b/plugins/filter/to_minutes.yml index 3b85dadc43..e8d6f763a8 100644 --- a/plugins/filter/to_minutes.yml +++ b/plugins/filter/to_minutes.yml @@ -13,12 +13,12 @@ DOCUMENTATION: _input: description: - The time string to convert. - - Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week, - C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec) - and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s) - can be added to a unit as well, so C(seconds) is the same as C(second). + - Can use the units V(y) and V(year) for a year, V(mo) and V(month) for a month, V(w) and V(week) for a week, + V(d) and V(day) for a day, V(h) and V(hour) for a hour, V(m), V(min) and V(minute) for minutes, V(s), V(sec) + and V(second) for seconds, V(ms), V(msec), V(msecond) and V(millisecond) for milliseconds. The suffix V(s) + can be added to a unit as well, so V(seconds) is the same as V(second). - Valid strings are space separated combinations of an integer with an optional minus sign and a unit. - - Examples are C(1h), C(-5m), and C(3h -5m 6s). + - Examples are V(1h), V(-5m), and V(3h -5m 6s). type: string required: true year: diff --git a/plugins/filter/to_months.yml b/plugins/filter/to_months.yml index f13cee918e..1f1cd661d8 100644 --- a/plugins/filter/to_months.yml +++ b/plugins/filter/to_months.yml @@ -13,12 +13,12 @@ DOCUMENTATION: _input: description: - The time string to convert. - - Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week, - C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec) - and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s) - can be added to a unit as well, so C(seconds) is the same as C(second). + - Can use the units V(y) and V(year) for a year, V(mo) and V(month) for a month, V(w) and V(week) for a week, + V(d) and V(day) for a day, V(h) and V(hour) for a hour, V(m), V(min) and V(minute) for minutes, V(s), V(sec) + and V(second) for seconds, V(ms), V(msec), V(msecond) and V(millisecond) for milliseconds. The suffix V(s) + can be added to a unit as well, so V(seconds) is the same as V(second). - Valid strings are space separated combinations of an integer with an optional minus sign and a unit. - - Examples are C(1h), C(-5m), and C(3h -5m 6s). + - Examples are V(1h), V(-5m), and V(3h -5m 6s). type: string required: true year: diff --git a/plugins/filter/to_seconds.yml b/plugins/filter/to_seconds.yml index d6e6c4e467..d858e062a3 100644 --- a/plugins/filter/to_seconds.yml +++ b/plugins/filter/to_seconds.yml @@ -13,12 +13,12 @@ DOCUMENTATION: _input: description: - The time string to convert. - - Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week, - C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec) - and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s) - can be added to a unit as well, so C(seconds) is the same as C(second). + - Can use the units V(y) and V(year) for a year, V(mo) and V(month) for a month, V(w) and V(week) for a week, + V(d) and V(day) for a day, V(h) and V(hour) for a hour, V(m), V(min) and V(minute) for minutes, V(s), V(sec) + and V(second) for seconds, V(ms), V(msec), V(msecond) and V(millisecond) for milliseconds. The suffix V(s) + can be added to a unit as well, so V(seconds) is the same as V(second). - Valid strings are space separated combinations of an integer with an optional minus sign and a unit. - - Examples are C(1h), C(-5m), and C(3h -5m 6s). + - Examples are V(1h), V(-5m), and V(3h -5m 6s). type: string required: true year: diff --git a/plugins/filter/to_time_unit.yml b/plugins/filter/to_time_unit.yml index c0149f0acd..bda124865c 100644 --- a/plugins/filter/to_time_unit.yml +++ b/plugins/filter/to_time_unit.yml @@ -14,12 +14,12 @@ DOCUMENTATION: _input: description: - The time string to convert. - - Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week, - C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec) - and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s) - can be added to a unit as well, so C(seconds) is the same as C(second). + - Can use the units V(y) and V(year) for a year, V(mo) and V(month) for a month, V(w) and V(week) for a week, + V(d) and V(day) for a day, V(h) and V(hour) for a hour, V(m), V(min) and V(minute) for minutes, V(s), V(sec) + and V(second) for seconds, V(ms), V(msec), V(msecond) and V(millisecond) for milliseconds. The suffix V(s) + can be added to a unit as well, so V(seconds) is the same as V(second). - Valid strings are space separated combinations of an integer with an optional minus sign and a unit. - - Examples are C(1h), C(-5m), and C(3h -5m 6s). + - Examples are V(1h), V(-5m), and V(3h -5m 6s). type: string required: true unit: diff --git a/plugins/filter/to_weeks.yml b/plugins/filter/to_weeks.yml index 499c386276..7bf31bb65c 100644 --- a/plugins/filter/to_weeks.yml +++ b/plugins/filter/to_weeks.yml @@ -13,12 +13,12 @@ DOCUMENTATION: _input: description: - The time string to convert. - - Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week, - C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec) - and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s) - can be added to a unit as well, so C(seconds) is the same as C(second). + - Can use the units V(y) and V(year) for a year, V(mo) and V(month) for a month, V(w) and V(week) for a week, + V(d) and V(day) for a day, V(h) and V(hour) for a hour, V(m), V(min) and V(minute) for minutes, V(s), V(sec) + and V(second) for seconds, V(ms), V(msec), V(msecond) and V(millisecond) for milliseconds. The suffix V(s) + can be added to a unit as well, so V(seconds) is the same as V(second). - Valid strings are space separated combinations of an integer with an optional minus sign and a unit. - - Examples are C(1h), C(-5m), and C(3h -5m 6s). + - Examples are V(1h), V(-5m), and V(3h -5m 6s). type: string required: true year: diff --git a/plugins/filter/to_years.yml b/plugins/filter/to_years.yml index 1a244a276f..33c85a3ece 100644 --- a/plugins/filter/to_years.yml +++ b/plugins/filter/to_years.yml @@ -13,12 +13,12 @@ DOCUMENTATION: _input: description: - The time string to convert. - - Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week, - C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec) - and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s) - can be added to a unit as well, so C(seconds) is the same as C(second). + - Can use the units V(y) and V(year) for a year, V(mo) and V(month) for a month, V(w) and V(week) for a week, + V(d) and V(day) for a day, V(h) and V(hour) for a hour, V(m), V(min) and V(minute) for minutes, V(s), V(sec) + and V(second) for seconds, V(ms), V(msec), V(msecond) and V(millisecond) for milliseconds. The suffix V(s) + can be added to a unit as well, so V(seconds) is the same as V(second). - Valid strings are space separated combinations of an integer with an optional minus sign and a unit. - - Examples are C(1h), C(-5m), and C(3h -5m 6s). + - Examples are V(1h), V(-5m), and V(3h -5m 6s). type: string required: true year: diff --git a/plugins/inventory/cobbler.py b/plugins/inventory/cobbler.py index 1b8382e331..a5c68e18af 100644 --- a/plugins/inventory/cobbler.py +++ b/plugins/inventory/cobbler.py @@ -18,7 +18,7 @@ DOCUMENTATION = ''' - inventory_cache options: plugin: - description: The name of this plugin, it should always be set to C(community.general.cobbler) for this plugin to recognize it as it's own. + description: The name of this plugin, it should always be set to V(community.general.cobbler) for this plugin to recognize it as it's own. required: true choices: [ 'cobbler', 'community.general.cobbler' ] url: @@ -43,7 +43,7 @@ DOCUMENTATION = ''' exclude_profiles: description: - Profiles to exclude from inventory. - - Ignored if I(include_profiles) is specified. + - Ignored if O(include_profiles) is specified. type: list default: [] elements: str @@ -51,7 +51,7 @@ DOCUMENTATION = ''' description: - Profiles to include from inventory. - If specified, all other profiles will be excluded. - - I(exclude_profiles) is ignored if I(include_profiles) is specified. + - O(exclude_profiles) is ignored if O(include_profiles) is specified. type: list default: [] elements: str @@ -60,7 +60,7 @@ DOCUMENTATION = ''' description: - What to use for the ansible inventory hostname. - By default the networking hostname is used if defined, otherwise the DNS name of the management or first non-static interface. - - If set to I(system), the cobbler system name is used. + - If set to V(system), the cobbler system name is used. type: str choices: [ 'hostname', 'system' ] default: hostname @@ -77,7 +77,7 @@ DOCUMENTATION = ''' description: Prefix to apply to cobbler groups default: cobbler_ want_facts: - description: Toggle, if C(true) the plugin will retrieve host facts from the server + description: Toggle, if V(true) the plugin will retrieve host facts from the server type: boolean default: true ''' diff --git a/plugins/inventory/icinga2.py b/plugins/inventory/icinga2.py index 70e0f57332..39c0c7e893 100644 --- a/plugins/inventory/icinga2.py +++ b/plugins/inventory/icinga2.py @@ -58,7 +58,7 @@ DOCUMENTATION = ''' description: - Allows the override of the inventory name based on different attributes. - This allows for changing the way limits are used. - - The current default, C(address), is sometimes not unique or present. We recommend to use C(name) instead. + - The current default, V(address), is sometimes not unique or present. We recommend to use V(name) instead. type: string default: address choices: ['name', 'display_name', 'address'] diff --git a/plugins/inventory/lxd.py b/plugins/inventory/lxd.py index bd0a6ce008..6b661d9f2f 100644 --- a/plugins/inventory/lxd.py +++ b/plugins/inventory/lxd.py @@ -48,7 +48,7 @@ DOCUMENTATION = r''' running this module using the following command C(lxc config set core.trust_password ) See U(https://www.stgraber.org/2016/04/18/lxd-api-direct-interaction/). - - If I(trust_password) is set, this module send a request for authentication before sending any requests. + - If O(trust_password) is set, this module send a request for authentication before sending any requests. type: str state: description: Filter the instance according to the current status. @@ -62,7 +62,7 @@ DOCUMENTATION = r''' version_added: 6.2.0 type_filter: description: - - Filter the instances by type C(virtual-machine), C(container) or C(both). + - Filter the instances by type V(virtual-machine), V(container) or V(both). - The first version of the inventory only supported containers. type: str default: container @@ -72,8 +72,8 @@ DOCUMENTATION = r''' description: - If an instance has multiple network interfaces, select which one is the prefered as pattern. - Combined with the first number that can be found e.g. 'eth' + 0. - - The option has been renamed from I(prefered_container_network_interface) to I(prefered_instance_network_interface) in community.general 3.8.0. - The old name still works as an alias. + - The option has been renamed from O(ignore:prefered_container_network_interface) to O(prefered_instance_network_interface) + in community.general 3.8.0. The old name still works as an alias. type: str default: eth aliases: @@ -81,7 +81,7 @@ DOCUMENTATION = r''' prefered_instance_network_family: description: - If an instance has multiple network interfaces, which one is the prefered by family. - - Specify C(inet) for IPv4 and C(inet6) for IPv6. + - Specify V(inet) for IPv4 and V(inet6) for IPv6. type: str default: inet choices: [ 'inet', 'inet6' ] diff --git a/plugins/inventory/nmap.py b/plugins/inventory/nmap.py index a03cf3e6fa..6e09e026a8 100644 --- a/plugins/inventory/nmap.py +++ b/plugins/inventory/nmap.py @@ -23,7 +23,7 @@ DOCUMENTATION = ''' required: true choices: ['nmap', 'community.general.nmap'] sudo: - description: Set to C(true) to execute a C(sudo nmap) plugin scan. + description: Set to V(true) to execute a C(sudo nmap) plugin scan. version_added: 4.8.0 default: false type: boolean @@ -36,7 +36,7 @@ DOCUMENTATION = ''' exclude: description: - List of addresses to exclude. - - For example C(10.2.2.15-25) or C(10.2.2.15,10.2.2.16). + - For example V(10.2.2.15-25) or V(10.2.2.15,10.2.2.16). type: list elements: string env: @@ -45,8 +45,8 @@ DOCUMENTATION = ''' port: description: - Only scan specific port or port range (C(-p)). - - For example, you could pass C(22) for a single port, C(1-65535) for a range of ports, - or C(U:53,137,T:21-25,139,8080,S:9) to check port 53 with UDP, ports 21-25 with TCP, port 9 with SCTP, and ports 137, 139, and 8080 with all. + - For example, you could pass V(22) for a single port, V(1-65535) for a range of ports, + or V(U:53,137,T:21-25,139,8080,S:9) to check port 53 with UDP, ports 21-25 with TCP, port 9 with SCTP, and ports 137, 139, and 8080 with all. type: string version_added: 6.5.0 ports: @@ -64,14 +64,14 @@ DOCUMENTATION = ''' udp_scan: description: - Scan via UDP. - - Depending on your system you might need I(sudo=true) for this to work. + - Depending on your system you might need O(sudo=true) for this to work. type: boolean default: false version_added: 6.1.0 icmp_timestamp: description: - Scan via ICMP Timestamp (C(-PP)). - - Depending on your system you might need I(sudo=true) for this to work. + - Depending on your system you might need O(sudo=true) for this to work. type: boolean default: false version_added: 6.1.0 @@ -81,7 +81,7 @@ DOCUMENTATION = ''' default: false version_added: 6.5.0 dns_resolve: - description: Whether to always (C(true)) or never (C(false)) do DNS resolution. + description: Whether to always (V(true)) or never (V(false)) do DNS resolution. type: boolean default: false version_added: 6.1.0 diff --git a/plugins/inventory/opennebula.py b/plugins/inventory/opennebula.py index 603920edc2..01c0f02485 100644 --- a/plugins/inventory/opennebula.py +++ b/plugins/inventory/opennebula.py @@ -17,9 +17,9 @@ DOCUMENTATION = r''' - constructed description: - Get inventory hosts from OpenNebula cloud. - - Uses an YAML configuration file ending with either I(opennebula.yml) or I(opennebula.yaml) + - Uses an YAML configuration file ending with either C(opennebula.yml) or C(opennebula.yaml) to set parameter values. - - Uses I(api_authfile), C(~/.one/one_auth), or C(ONE_AUTH) pointing to a OpenNebula credentials file. + - Uses O(api_authfile), C(~/.one/one_auth), or E(ONE_AUTH) pointing to a OpenNebula credentials file. options: plugin: description: Token that ensures this is a source file for the 'opennebula' plugin. @@ -31,7 +31,7 @@ DOCUMENTATION = r''' - URL of the OpenNebula RPC server. - It is recommended to use HTTPS so that the username/password are not transferred over the network unencrypted. - - If not set then the value of the C(ONE_URL) environment variable is used. + - If not set then the value of the E(ONE_URL) environment variable is used. env: - name: ONE_URL required: true @@ -39,29 +39,29 @@ DOCUMENTATION = r''' api_username: description: - Name of the user to login into the OpenNebula RPC server. If not set - then the value of the C(ONE_USERNAME) environment variable is used. + then the value of the E(ONE_USERNAME) environment variable is used. env: - name: ONE_USERNAME type: string api_password: description: - Password or a token of the user to login into OpenNebula RPC server. - - If not set, the value of the C(ONE_PASSWORD) environment variable is used. + - If not set, the value of the E(ONE_PASSWORD) environment variable is used. env: - name: ONE_PASSWORD required: false type: string api_authfile: description: - - If both I(api_username) or I(api_password) are not set, then it will try + - If both O(api_username) or O(api_password) are not set, then it will try authenticate with ONE auth file. Default path is C(~/.one/one_auth). - - Set environment variable C(ONE_AUTH) to override this path. + - Set environment variable E(ONE_AUTH) to override this path. env: - name: ONE_AUTH required: false type: string hostname: - description: Field to match the hostname. Note C(v4_first_ip) corresponds to the first IPv4 found on VM. + description: Field to match the hostname. Note V(v4_first_ip) corresponds to the first IPv4 found on VM. type: string default: v4_first_ip choices: diff --git a/plugins/inventory/proxmox.py b/plugins/inventory/proxmox.py index dc2e1febca..1389f9ee26 100644 --- a/plugins/inventory/proxmox.py +++ b/plugins/inventory/proxmox.py @@ -25,15 +25,15 @@ DOCUMENTATION = ''' - inventory_cache options: plugin: - description: The name of this plugin, it should always be set to C(community.general.proxmox) for this plugin to recognize it as it's own. + description: The name of this plugin, it should always be set to V(community.general.proxmox) for this plugin to recognize it as it's own. required: true choices: ['community.general.proxmox'] type: str url: description: - URL to Proxmox cluster. - - If the value is not specified in the inventory configuration, the value of environment variable C(PROXMOX_URL) will be used instead. - - Since community.general 4.7.0 you can also use templating to specify the value of the I(url). + - If the value is not specified in the inventory configuration, the value of environment variable E(PROXMOX_URL) will be used instead. + - Since community.general 4.7.0 you can also use templating to specify the value of the O(url). default: 'http://localhost:8006' type: str env: @@ -42,8 +42,8 @@ DOCUMENTATION = ''' user: description: - Proxmox authentication user. - - If the value is not specified in the inventory configuration, the value of environment variable C(PROXMOX_USER) will be used instead. - - Since community.general 4.7.0 you can also use templating to specify the value of the I(user). + - If the value is not specified in the inventory configuration, the value of environment variable E(PROXMOX_USER) will be used instead. + - Since community.general 4.7.0 you can also use templating to specify the value of the O(user). required: true type: str env: @@ -52,9 +52,9 @@ DOCUMENTATION = ''' password: description: - Proxmox authentication password. - - If the value is not specified in the inventory configuration, the value of environment variable C(PROXMOX_PASSWORD) will be used instead. - - Since community.general 4.7.0 you can also use templating to specify the value of the I(password). - - If you do not specify a password, you must set I(token_id) and I(token_secret) instead. + - If the value is not specified in the inventory configuration, the value of environment variable E(PROXMOX_PASSWORD) will be used instead. + - Since community.general 4.7.0 you can also use templating to specify the value of the O(password). + - If you do not specify a password, you must set O(token_id) and O(token_secret) instead. type: str env: - name: PROXMOX_PASSWORD @@ -62,8 +62,8 @@ DOCUMENTATION = ''' token_id: description: - Proxmox authentication token ID. - - If the value is not specified in the inventory configuration, the value of environment variable C(PROXMOX_TOKEN_ID) will be used instead. - - To use token authentication, you must also specify I(token_secret). If you do not specify I(token_id) and I(token_secret), + - If the value is not specified in the inventory configuration, the value of environment variable E(PROXMOX_TOKEN_ID) will be used instead. + - To use token authentication, you must also specify O(token_secret). If you do not specify O(token_id) and O(token_secret), you must set a password instead. - Make sure to grant explicit pve permissions to the token or disable 'privilege separation' to use the users' privileges instead. version_added: 4.8.0 @@ -73,8 +73,8 @@ DOCUMENTATION = ''' token_secret: description: - Proxmox authentication token secret. - - If the value is not specified in the inventory configuration, the value of environment variable C(PROXMOX_TOKEN_SECRET) will be used instead. - - To use token authentication, you must also specify I(token_id). If you do not specify I(token_id) and I(token_secret), + - If the value is not specified in the inventory configuration, the value of environment variable E(PROXMOX_TOKEN_SECRET) will be used instead. + - To use token authentication, you must also specify O(token_id). If you do not specify O(token_id) and O(token_secret), you must set a password instead. version_added: 4.8.0 type: str @@ -95,25 +95,25 @@ DOCUMENTATION = ''' want_facts: description: - Gather LXC/QEMU configuration facts. - - When I(want_facts) is set to C(true) more details about QEMU VM status are possible, besides the running and stopped states. + - When O(want_facts) is set to V(true) more details about QEMU VM status are possible, besides the running and stopped states. Currently if the VM is running and it is suspended, the status will be running and the machine will be in C(running) group, - but its actual state will be paused. See I(qemu_extended_statuses) for how to retrieve the real status. + but its actual state will be paused. See O(qemu_extended_statuses) for how to retrieve the real status. default: false type: bool qemu_extended_statuses: description: - - Requires I(want_facts) to be set to C(true) to function. This will allow you to differentiate betweend C(paused) and C(prelaunch) + - Requires O(want_facts) to be set to V(true) to function. This will allow you to differentiate betweend C(paused) and C(prelaunch) statuses of the QEMU VMs. - - This introduces multiple groups [prefixed with I(group_prefix)] C(prelaunch) and C(paused). + - This introduces multiple groups [prefixed with O(group_prefix)] C(prelaunch) and C(paused). default: false type: bool version_added: 5.1.0 want_proxmox_nodes_ansible_host: version_added: 3.0.0 description: - - Whether to set C(ansbile_host) for proxmox nodes. - - When set to C(true) (default), will use the first available interface. This can be different from what you expect. - - The default of this option changed from C(true) to C(false) in community.general 6.0.0. + - Whether to set C(ansible_host) for proxmox nodes. + - When set to V(true) (default), will use the first available interface. This can be different from what you expect. + - The default of this option changed from V(true) to V(false) in community.general 6.0.0. type: bool default: false filters: diff --git a/plugins/inventory/scaleway.py b/plugins/inventory/scaleway.py index 6aacc9f665..632f08402f 100644 --- a/plugins/inventory/scaleway.py +++ b/plugins/inventory/scaleway.py @@ -37,7 +37,7 @@ DOCUMENTATION = r''' scw_profile: description: - The config profile to use in config file. - - By default uses the one specified as C(active_profile) in the config file, or falls back to C(default) if that is not defined. + - By default uses the one specified as C(active_profile) in the config file, or falls back to V(default) if that is not defined. type: string version_added: 4.4.0 oauth_token: diff --git a/plugins/inventory/xen_orchestra.py b/plugins/inventory/xen_orchestra.py index ddbdd9bb04..3004ab3432 100644 --- a/plugins/inventory/xen_orchestra.py +++ b/plugins/inventory/xen_orchestra.py @@ -23,21 +23,21 @@ DOCUMENTATION = ''' - inventory_cache options: plugin: - description: The name of this plugin, it should always be set to C(community.general.xen_orchestra) for this plugin to recognize it as its own. + description: The name of this plugin, it should always be set to V(community.general.xen_orchestra) for this plugin to recognize it as its own. required: true choices: ['community.general.xen_orchestra'] type: str api_host: description: - API host to XOA API. - - If the value is not specified in the inventory configuration, the value of environment variable C(ANSIBLE_XO_HOST) will be used instead. + - If the value is not specified in the inventory configuration, the value of environment variable E(ANSIBLE_XO_HOST) will be used instead. type: str env: - name: ANSIBLE_XO_HOST user: description: - Xen Orchestra user. - - If the value is not specified in the inventory configuration, the value of environment variable C(ANSIBLE_XO_USER) will be used instead. + - If the value is not specified in the inventory configuration, the value of environment variable E(ANSIBLE_XO_USER) will be used instead. required: true type: str env: @@ -45,7 +45,7 @@ DOCUMENTATION = ''' password: description: - Xen Orchestra password. - - If the value is not specified in the inventory configuration, the value of environment variable C(ANSIBLE_XO_PASSWORD) will be used instead. + - If the value is not specified in the inventory configuration, the value of environment variable E(ANSIBLE_XO_PASSWORD) will be used instead. required: true type: str env: diff --git a/plugins/lookup/bitwarden.py b/plugins/lookup/bitwarden.py index 27de1afe60..489b0d5d9c 100644 --- a/plugins/lookup/bitwarden.py +++ b/plugins/lookup/bitwarden.py @@ -25,7 +25,7 @@ DOCUMENTATION = """ type: list elements: str search: - description: Field to retrieve, for example C(name) or C(id). + description: Field to retrieve, for example V(name) or V(id). type: str default: name version_added: 5.7.0 diff --git a/plugins/lookup/collection_version.py b/plugins/lookup/collection_version.py index 4d25585b81..0e2388a181 100644 --- a/plugins/lookup/collection_version.py +++ b/plugins/lookup/collection_version.py @@ -13,22 +13,22 @@ short_description: Retrieves the version of an installed collection description: - This lookup allows to query the version of an installed collection, and to determine whether a collection is installed at all. - - By default it returns C(none) for non-existing collections and C(*) for collections without a + - By default it returns V(none) for non-existing collections and V(*) for collections without a version number. The latter should only happen in development environments, or when installing a collection from git which has no version in its C(galaxy.yml). This behavior can be adjusted - by providing other values with I(result_not_found) and I(result_no_version). + by providing other values with O(result_not_found) and O(result_no_version). options: _terms: description: - The collections to look for. - - For example C(community.general). + - For example V(community.general). type: list elements: str required: true result_not_found: description: - The value to return when the collection could not be found. - - By default, C(none) is returned. + - By default, V(none) is returned. type: string default: ~ result_no_version: @@ -36,7 +36,7 @@ options: - The value to return when the collection has no version number. - This can happen for collections installed from git which do not have a version number in C(galaxy.yml). - - By default, C(*) is returned. + - By default, V(*) is returned. type: string default: '*' """ @@ -51,11 +51,11 @@ RETURN = """ _raw: description: - The version number of the collections listed as input. - - If a collection can not be found, it will return the value provided in I(result_not_found). - By default, this is C(none). + - If a collection can not be found, it will return the value provided in O(result_not_found). + By default, this is V(none). - If a collection can be found, but the version not identified, it will return the value provided in - I(result_no_version). By default, this is C(*). This can happen for collections installed - from git which do not have a version number in C(galaxy.yml). + O(result_no_version). By default, this is V(*). This can happen for collections installed + from git which do not have a version number in V(galaxy.yml). type: list elements: str """ diff --git a/plugins/lookup/consul_kv.py b/plugins/lookup/consul_kv.py index f17f1b2694..f8aadadc19 100644 --- a/plugins/lookup/consul_kv.py +++ b/plugins/lookup/consul_kv.py @@ -38,23 +38,20 @@ DOCUMENTATION = ''' default: localhost description: - The target to connect to, must be a resolvable address. - Will be determined from C(ANSIBLE_CONSUL_URL) if that is set. - - "C(ANSIBLE_CONSUL_URL) should look like this: C(https://my.consul.server:8500)" - env: - - name: ANSIBLE_CONSUL_URL + - Will be determined from E(ANSIBLE_CONSUL_URL) if that is set. ini: - section: lookup_consul key: host port: description: - The port of the target host to connect to. - - If you use C(ANSIBLE_CONSUL_URL) this value will be used from there. + - If you use E(ANSIBLE_CONSUL_URL) this value will be used from there. default: 8500 scheme: default: http description: - Whether to use http or https. - - If you use C(ANSIBLE_CONSUL_URL) this value will be used from there. + - If you use E(ANSIBLE_CONSUL_URL) this value will be used from there. validate_certs: default: true description: Whether to verify the ssl connection or not. @@ -71,7 +68,9 @@ DOCUMENTATION = ''' - section: lookup_consul key: client_cert url: - description: "The target to connect to, should look like this: C(https://my.consul.server:8500)." + description: + - The target to connect to. + - "Should look like this: V(https://my.consul.server:8500)." type: str version_added: 1.0.0 env: diff --git a/plugins/lookup/dig.py b/plugins/lookup/dig.py index fa915220b3..afeab28f44 100644 --- a/plugins/lookup/dig.py +++ b/plugins/lookup/dig.py @@ -21,7 +21,7 @@ DOCUMENTATION = ''' - In addition to (default) A record, it is also possible to specify a different record type that should be queried. This can be done by either passing-in additional parameter of format qtype=TYPE to the dig lookup, or by appending /TYPE to the FQDN being queried. - If multiple values are associated with the requested record, the results will be returned as a comma-separated list. - In such cases you may want to pass option I(wantlist=true) to the lookup call, or alternatively use C(query) instead of C(lookup), + In such cases you may want to pass option C(wantlist=true) to the lookup call, or alternatively use C(query) instead of C(lookup), which will result in the record values being returned as a list over which you can iterate later on. - By default, the lookup will rely on system-wide configured DNS servers for performing the query. It is also possible to explicitly specify DNS servers to query using the @DNS_SERVER_1,DNS_SERVER_2,...,DNS_SERVER_N notation. @@ -34,8 +34,8 @@ DOCUMENTATION = ''' qtype: description: - Record type to query. - - C(DLV) has been removed in community.general 6.0.0. - - C(CAA) has been added in community.general 6.3.0. + - V(DLV) has been removed in community.general 6.0.0. + - V(CAA) has been added in community.general 6.3.0. type: str default: 'A' choices: [A, ALL, AAAA, CAA, CNAME, DNAME, DNSKEY, DS, HINFO, LOC, MX, NAPTR, NS, NSEC3PARAM, PTR, RP, RRSIG, SOA, SPF, SRV, SSHFP, TLSA, TXT] @@ -51,17 +51,17 @@ DOCUMENTATION = ''' fail_on_error: description: - Abort execution on lookup errors. - - The default for this option will likely change to C(true) in the future. - The current default, C(false), is used for backwards compatibility, and will result in empty strings - or the string C(NXDOMAIN) in the result in case of errors. + - The default for this option will likely change to V(true) in the future. + The current default, V(false), is used for backwards compatibility, and will result in empty strings + or the string V(NXDOMAIN) in the result in case of errors. default: false type: bool version_added: 5.4.0 real_empty: description: - - Return empty result without empty strings, and return empty list instead of C(NXDOMAIN). - - The default for this option will likely change to C(true) in the future. - - This option will be forced to C(true) if multiple domains to be queried are specified. + - Return empty result without empty strings, and return empty list instead of V(NXDOMAIN). + - The default for this option will likely change to V(true) in the future. + - This option will be forced to V(true) if multiple domains to be queried are specified. default: false type: bool version_added: 6.0.0 diff --git a/plugins/lookup/dnstxt.py b/plugins/lookup/dnstxt.py index 55067dc82b..1ce511b849 100644 --- a/plugins/lookup/dnstxt.py +++ b/plugins/lookup/dnstxt.py @@ -22,8 +22,8 @@ DOCUMENTATION = ''' elements: string real_empty: description: - - Return empty result without empty strings, and return empty list instead of C(NXDOMAIN). - - The default for this option will likely change to C(true) in the future. + - Return empty result without empty strings, and return empty list instead of V(NXDOMAIN). + - The default for this option will likely change to V(true) in the future. default: false type: bool version_added: 6.0.0 diff --git a/plugins/lookup/dsv.py b/plugins/lookup/dsv.py index 91a9d99212..2dbb7db3ea 100644 --- a/plugins/lookup/dsv.py +++ b/plugins/lookup/dsv.py @@ -13,15 +13,15 @@ short_description: Get secrets from Thycotic DevOps Secrets Vault version_added: 1.0.0 description: - Uses the Thycotic DevOps Secrets Vault Python SDK to get Secrets from a - DSV I(tenant) using a I(client_id) and I(client_secret). + DSV O(tenant) using a O(client_id) and O(client_secret). requirements: - python-dsv-sdk - https://pypi.org/project/python-dsv-sdk/ options: _terms: - description: The path to the secret, e.g. C(/staging/servers/web1). + description: The path to the secret, for example V(/staging/servers/web1). required: true tenant: - description: The first format parameter in the default I(url_template). + description: The first format parameter in the default O(url_template). env: - name: DSV_TENANT ini: @@ -31,7 +31,7 @@ options: tld: default: com description: The top-level domain of the tenant; the second format - parameter in the default I(url_template). + parameter in the default O(url_template). env: - name: DSV_TLD ini: @@ -47,7 +47,7 @@ options: key: client_id required: true client_secret: - description: The client secret associated with the specific I(client_id). + description: The client secret associated with the specific O(client_id). env: - name: DSV_CLIENT_SECRET ini: diff --git a/plugins/lookup/etcd3.py b/plugins/lookup/etcd3.py index 7f0a0cf90e..2d71902c6d 100644 --- a/plugins/lookup/etcd3.py +++ b/plugins/lookup/etcd3.py @@ -32,10 +32,10 @@ DOCUMENTATION = ''' default: false endpoints: description: - - Counterpart of C(ETCDCTL_ENDPOINTS) environment variable. - Specify the etcd3 connection with and URL form eg. C(https://hostname:2379) or C(:) form. - - The C(host) part is overwritten by I(host) option, if defined. - - The C(port) part is overwritten by I(port) option, if defined. + - Counterpart of E(ETCDCTL_ENDPOINTS) environment variable. + Specify the etcd3 connection with and URL form, for example V(https://hostname:2379), or V(:) form. + - The V(host) part is overwritten by O(host) option, if defined. + - The V(port) part is overwritten by O(port) option, if defined. env: - name: ETCDCTL_ENDPOINTS default: '127.0.0.1:2379' @@ -43,12 +43,12 @@ DOCUMENTATION = ''' host: description: - etcd3 listening client host. - - Takes precedence over I(endpoints). + - Takes precedence over O(endpoints). type: str port: description: - etcd3 listening client port. - - Takes precedence over I(endpoints). + - Takes precedence over O(endpoints). type: int ca_cert: description: @@ -89,9 +89,9 @@ DOCUMENTATION = ''' type: str notes: - - I(host) and I(port) options take precedence over (endpoints) option. - - The recommended way to connect to etcd3 server is using C(ETCDCTL_ENDPOINT) - environment variable and keep I(endpoints), I(host), and I(port) unused. + - O(host) and O(port) options take precedence over (endpoints) option. + - The recommended way to connect to etcd3 server is using E(ETCDCTL_ENDPOINT) + environment variable and keep O(endpoints), O(host), and O(port) unused. seealso: - module: community.general.etcd3 - ref: ansible_collections.community.general.etcd_lookup diff --git a/plugins/lookup/filetree.py b/plugins/lookup/filetree.py index f12cc45192..2131de99a5 100644 --- a/plugins/lookup/filetree.py +++ b/plugins/lookup/filetree.py @@ -65,7 +65,7 @@ RETURN = r""" src: description: - Full path to file. - - Not returned when I(item.state) is set to C(directory). + - Not returned when RV(_raw[].state) is set to V(directory). type: path root: description: Allows filtering by original location. diff --git a/plugins/lookup/lmdb_kv.py b/plugins/lookup/lmdb_kv.py index 0950249dc8..a37cff9569 100644 --- a/plugins/lookup/lmdb_kv.py +++ b/plugins/lookup/lmdb_kv.py @@ -15,7 +15,7 @@ DOCUMENTATION = ''' description: - This lookup returns a list of results from an LMDB DB corresponding to a list of items given to it. requirements: - - lmdb (python library https://lmdb.readthedocs.io/en/release/) + - lmdb (Python library U(https://lmdb.readthedocs.io/en/release/)) options: _terms: description: List of keys to query. diff --git a/plugins/lookup/merge_variables.py b/plugins/lookup/merge_variables.py index cd5fa5b7df..dbd9401b10 100644 --- a/plugins/lookup/merge_variables.py +++ b/plugins/lookup/merge_variables.py @@ -19,7 +19,7 @@ DOCUMENTATION = """ options: _terms: description: - - Depending on the value of I(pattern_type), this is a list of prefixes, suffixes, or regular expressions + - Depending on the value of O(pattern_type), this is a list of prefixes, suffixes, or regular expressions that will be used to match all variables that should be merged. required: true type: list @@ -45,11 +45,11 @@ DOCUMENTATION = """ override: description: - Return an error, print a warning or ignore it when a key will be overwritten. - - The default behavior C(error) makes the plugin fail when a key would be overwritten. - - When C(warn) and C(ignore) are used, note that it is important to know that the variables + - The default behavior V(error) makes the plugin fail when a key would be overwritten. + - When V(warn) and V(ignore) are used, note that it is important to know that the variables are sorted by name before being merged. Keys for later variables in this order will overwrite keys of the same name for variables earlier in this order. To avoid potential confusion, - better use I(override=error) whenever possible. + better use O(override=error) whenever possible. type: str default: 'error' choices: diff --git a/plugins/lookup/onepassword.py b/plugins/lookup/onepassword.py index 0e78e4b1a0..3a939f3d95 100644 --- a/plugins/lookup/onepassword.py +++ b/plugins/lookup/onepassword.py @@ -18,7 +18,7 @@ DOCUMENTATION = ''' - C(op) 1Password command line utility. See U(https://support.1password.com/command-line/) short_description: fetch field values from 1Password description: - - C(onepassword) wraps the C(op) command line utility to fetch specific field values from 1Password. + - P(community.general.onepassword#lookup) wraps the C(op) command line utility to fetch specific field values from 1Password. options: _terms: description: identifier(s) (UUID, name, or subdomain; case-insensitive) of item(s) to retrieve. @@ -47,8 +47,8 @@ DOCUMENTATION = ''' notes: - This lookup will use an existing 1Password session if one exists. If not, and you have already performed an initial sign in (meaning C(~/.op/config), C(~/.config/op/config) or C(~/.config/.op/config) exists), then only the - C(master_password) is required. You may optionally specify C(subdomain) in this scenario, otherwise the last used subdomain will be used by C(op). - - This lookup can perform an initial login by providing C(subdomain), C(username), C(secret_key), and C(master_password). + C(master_password) 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). - Due to the B(very) sensitive nature of these credentials, it is B(highly) recommended that you only pass in the minimal credentials needed at any given time. Also, store these credentials in an Ansible Vault using a key that is equal to or greater in strength to the 1Password master password. diff --git a/plugins/lookup/onepassword_raw.py b/plugins/lookup/onepassword_raw.py index 9b87a3f619..4322d5174a 100644 --- a/plugins/lookup/onepassword_raw.py +++ b/plugins/lookup/onepassword_raw.py @@ -18,7 +18,7 @@ DOCUMENTATION = ''' - C(op) 1Password command line utility. See U(https://support.1password.com/command-line/) short_description: fetch an entire item from 1Password description: - - C(onepassword_raw) wraps C(op) command line utility to fetch an entire item from 1Password + - P(community.general.onepassword_raw#lookup) wraps C(op) command line utility to fetch an entire item from 1Password. options: _terms: description: identifier(s) (UUID, name, or domain; case-insensitive) of item(s) to retrieve. @@ -43,9 +43,9 @@ DOCUMENTATION = ''' description: Vault containing the item to retrieve (case-insensitive). If absent will search all vaults. notes: - This lookup will use an existing 1Password session if one exists. If not, and you have already - performed an initial sign in (meaning C(~/.op/config exists)), then only the C(master_password) is required. - You may optionally specify C(subdomain) in this scenario, otherwise the last used subdomain will be used by C(op). - - This lookup can perform an initial login by providing C(subdomain), C(username), C(secret_key), and C(master_password). + performed an initial sign in (meaning C(~/.op/config exists)), then only the 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). + - This lookup can perform an initial login by providing O(subdomain), O(username), O(secret_key), and O(master_password). - Due to the B(very) sensitive nature of these credentials, it is B(highly) recommended that you only pass in the minimal credentials needed at any given time. Also, store these credentials in an Ansible Vault using a key that is equal to or greater in strength to the 1Password master password. diff --git a/plugins/lookup/passwordstore.py b/plugins/lookup/passwordstore.py index 7e37a37855..4a1ff1320b 100644 --- a/plugins/lookup/passwordstore.py +++ b/plugins/lookup/passwordstore.py @@ -16,7 +16,7 @@ DOCUMENTATION = ''' - Enables Ansible to retrieve, create or update passwords from the passwordstore.org pass utility. It also retrieves YAML style keys stored as multilines in the passwordfile. - To avoid problems when accessing multiple secrets at once, add C(auto-expand-secmem) to - C(~/.gnupg/gpg-agent.conf). Where this is not possible, consider using I(lock=readwrite) instead. + C(~/.gnupg/gpg-agent.conf). Where this is not possible, consider using O(lock=readwrite) instead. options: _terms: description: query key. @@ -24,16 +24,16 @@ DOCUMENTATION = ''' directory: description: - The directory of the password store. - - If I(backend=pass), the default is C(~/.password-store) is used. - - If I(backend=gopass), then the default is the C(path) field in C(~/.config/gopass/config.yml), - falling back to C(~/.local/share/gopass/stores/root) if C(path) is not defined in the gopass config. + - If O(backend=pass), the default is V(~/.password-store) is used. + - If O(backend=gopass), then the default is the C(path) field in C(~/.config/gopass/config.yml), + falling back to V(~/.local/share/gopass/stores/root) if C(path) is not defined in the gopass config. type: path vars: - name: passwordstore env: - name: PASSWORD_STORE_DIR create: - description: Create the password if it does not already exist. Takes precedence over C(missing). + description: Create the password if it does not already exist. Takes precedence over O(missing). type: bool default: false overwrite: @@ -43,7 +43,7 @@ DOCUMENTATION = ''' umask: description: - Sets the umask for the created .gpg files. The first octed must be greater than 3 (user readable). - - Note pass' default value is C('077'). + - Note pass' default value is V('077'). env: - name: PASSWORD_STORE_UMASK version_added: 1.3.0 @@ -52,7 +52,7 @@ DOCUMENTATION = ''' type: bool default: false subkey: - description: Return a specific subkey of the password. When set to C(password), always returns the first line. + description: Return a specific subkey of the password. When set to V(password), always returns the first line. type: str default: password userpass: @@ -63,7 +63,7 @@ DOCUMENTATION = ''' type: integer default: 16 backup: - description: Used with C(overwrite=true). Backup the previous password in a subkey. + description: Used with O(overwrite=true). Backup the previous password in a subkey. type: bool default: false nosymbols: @@ -73,10 +73,10 @@ DOCUMENTATION = ''' missing: description: - List of preference about what to do if the password file is missing. - - If I(create=true), the value for this option is ignored and assumed to be C(create). - - If set to C(error), the lookup will error out if the passname does not exist. - - If set to C(create), the passname will be created with the provided length I(length) if it does not exist. - - If set to C(empty) or C(warn), will return a C(none) in case the passname does not exist. + - If O(create=true), the value for this option is ignored and assumed to be V(create). + - If set to V(error), the lookup will error out if the passname does not exist. + - If set to V(create), the passname will be created with the provided length O(length) if it does not exist. + - If set to V(empty) or V(warn), will return a V(none) in case the passname does not exist. When using C(lookup) and not C(query), this will be translated to an empty string. version_added: 3.1.0 type: str @@ -89,9 +89,9 @@ DOCUMENTATION = ''' lock: description: - How to synchronize operations. - - The default of C(write) only synchronizes write operations. - - C(readwrite) synchronizes all operations (including read). This makes sure that gpg-agent is never called in parallel. - - C(none) does not do any synchronization. + - The default of V(write) only synchronizes write operations. + - V(readwrite) synchronizes all operations (including read). This makes sure that gpg-agent is never called in parallel. + - V(none) does not do any synchronization. ini: - section: passwordstore_lookup key: lock @@ -104,8 +104,8 @@ DOCUMENTATION = ''' version_added: 4.5.0 locktimeout: description: - - Lock timeout applied when I(lock) is not C(none). - - Time with a unit suffix, C(s), C(m), C(h) for seconds, minutes, and hours, respectively. For example, C(900s) equals C(15m). + - Lock timeout applied when O(lock) is not V(none). + - Time with a unit suffix, V(s), V(m), V(h) for seconds, minutes, and hours, respectively. For example, V(900s) equals V(15m). - Correlates with C(pinentry-timeout) in C(~/.gnupg/gpg-agent.conf), see C(man gpg-agent) for details. ini: - section: passwordstore_lookup @@ -116,8 +116,8 @@ DOCUMENTATION = ''' backend: description: - Specify which backend to use. - - Defaults to C(pass), passwordstore.org's original pass utility. - - C(gopass) support is incomplete. + - Defaults to V(pass), passwordstore.org's original pass utility. + - V(gopass) support is incomplete. ini: - section: passwordstore_lookup key: backend diff --git a/plugins/lookup/random_string.py b/plugins/lookup/random_string.py index 199aa13964..89333492ad 100644 --- a/plugins/lookup/random_string.py +++ b/plugins/lookup/random_string.py @@ -42,25 +42,25 @@ DOCUMENTATION = r""" - Special characters are taken from Python standard library C(string). See L(the documentation of string.punctuation,https://docs.python.org/3/library/string.html#string.punctuation) for which characters will be used. - - The choice of special characters can be changed to setting I(override_special). + - The choice of special characters can be changed to setting O(override_special). default: true type: bool min_numeric: description: - Minimum number of numeric characters in the string. - - If set, overrides I(numbers=false). + - If set, overrides O(numbers=false). default: 0 type: int min_upper: description: - Minimum number of uppercase alphabets in the string. - - If set, overrides I(upper=false). + - If set, overrides O(upper=false). default: 0 type: int min_lower: description: - Minimum number of lowercase alphabets in the string. - - If set, overrides I(lower=false). + - If set, overrides O(lower=false). default: 0 type: int min_special: @@ -71,11 +71,11 @@ DOCUMENTATION = r""" override_special: description: - Overide a list of special characters to use in the string. - - If set I(min_special) should be set to a non-default value. + - If set O(min_special) should be set to a non-default value. type: str override_all: description: - - Override all values of I(numbers), I(upper), I(lower), and I(special) with + - Override all values of O(numbers), O(upper), O(lower), and O(special) with the given list of characters. type: str base64: diff --git a/plugins/lookup/revbitspss.py b/plugins/lookup/revbitspss.py index 552970804e..9912400b70 100644 --- a/plugins/lookup/revbitspss.py +++ b/plugins/lookup/revbitspss.py @@ -25,7 +25,7 @@ options: elements: string base_url: description: - - This will be the base URL of the server, for example C(https://server-url-here). + - This will be the base URL of the server, for example V(https://server-url-here). required: true type: string api_key: diff --git a/plugins/lookup/tss.py b/plugins/lookup/tss.py index df7d57993b..1fe87b31ec 100644 --- a/plugins/lookup/tss.py +++ b/plugins/lookup/tss.py @@ -13,8 +13,8 @@ short_description: Get secrets from Thycotic Secret Server version_added: 1.0.0 description: - Uses the Thycotic Secret Server Python SDK to get Secrets from Secret - Server using token authentication with I(username) and I(password) on - the REST API at I(base_url). + Server using token authentication with O(username) and O(password) on + the REST API at O(base_url). - When using self-signed certificates the environment variable C(REQUESTS_CA_BUNDLE) can be set to a file containing the trusted certificates (in C(.pem) format). @@ -36,7 +36,7 @@ options: fetch_attachments: description: - Boolean flag which indicates whether attached files will get downloaded or not. - - The download will only happen if I(file_download_path) has been provided. + - The download will only happen if O(file_download_path) has been provided. required: false type: bool version_added: 7.0.0 @@ -46,7 +46,7 @@ options: type: path version_added: 7.0.0 base_url: - description: The base URL of the server, e.g. C(https://localhost/SecretServer). + description: The base URL of the server, for example V(https://localhost/SecretServer). env: - name: TSS_BASE_URL ini: @@ -63,7 +63,7 @@ options: password: description: - The password associated with the supplied username. - - Required when I(token) is not provided. + - Required when O(token) is not provided. env: - name: TSS_PASSWORD ini: @@ -73,7 +73,7 @@ options: default: "" description: - The domain with which to request the OAuth2 Access Grant. - - Optional when I(token) is not provided. + - Optional when O(token) is not provided. - Requires C(python-tss-sdk) version 1.0.0 or greater. env: - name: TSS_DOMAIN @@ -85,7 +85,7 @@ options: token: description: - Existing token for Thycotic authorizer. - - If provided, I(username) and I(password) are not needed. + - If provided, O(username) and O(password) are not needed. - Requires C(python-tss-sdk) version 1.0.0 or greater. env: - name: TSS_TOKEN diff --git a/plugins/modules/ufw.py b/plugins/modules/ufw.py index 45c98fd639..5d187793bd 100644 --- a/plugins/modules/ufw.py +++ b/plugins/modules/ufw.py @@ -35,10 +35,10 @@ attributes: options: state: description: - - C(enabled) reloads firewall and enables firewall on boot. - - C(disabled) unloads firewall and disables firewall on boot. - - C(reloaded) reloads firewall. - - C(reset) disables and resets firewall to installation defaults. + - V(enabled) reloads firewall and enables firewall on boot. + - V(disabled) unloads firewall and disables firewall on boot. + - V(reloaded) reloads firewall. + - V(reset) disables and resets firewall to installation defaults. type: str choices: [ disabled, enabled, reloaded, reset ] default: @@ -50,7 +50,7 @@ options: direction: description: - Select direction for a rule or default policy command. Mutually - exclusive with I(interface_in) and I(interface_out). + exclusive with O(interface_in) and O(interface_out). type: str choices: [ in, incoming, out, outgoing, routed ] logging: @@ -62,24 +62,24 @@ options: description: - Insert the corresponding rule as rule number NUM. - Note that ufw numbers rules starting with 1. - - If I(delete=true) and a value is provided for I(insert), - then I(insert) is ignored. + - If O(delete=true) and a value is provided for O(insert), + then O(insert) is ignored. type: int insert_relative_to: description: - - Allows to interpret the index in I(insert) relative to a position. - - C(zero) interprets the rule number as an absolute index (i.e. 1 is + - Allows to interpret the index in O(insert) relative to a position. + - V(zero) interprets the rule number as an absolute index (i.e. 1 is the first rule). - - C(first-ipv4) interprets the rule number relative to the index of the + - V(first-ipv4) interprets the rule number relative to the index of the first IPv4 rule, or relative to the position where the first IPv4 rule would be if there is currently none. - - C(last-ipv4) interprets the rule number relative to the index of the + - V(last-ipv4) interprets the rule number relative to the index of the last IPv4 rule, or relative to the position where the last IPv4 rule would be if there is currently none. - - C(first-ipv6) interprets the rule number relative to the index of the + - V(first-ipv6) interprets the rule number relative to the index of the first IPv6 rule, or relative to the position where the first IPv6 rule would be if there is currently none. - - C(last-ipv6) interprets the rule number relative to the index of the + - V(last-ipv6) interprets the rule number relative to the index of the last IPv6 rule, or relative to the position where the last IPv6 rule would be if there is currently none. type: str @@ -130,32 +130,32 @@ options: delete: description: - Delete rule. - - If I(delete=true) and a value is provided for I(insert), - then I(insert) is ignored. + - If O(delete=true) and a value is provided for O(insert), + then O(insert) is ignored. type: bool default: false interface: description: - Specify interface for the rule. The direction (in or out) used - for the interface depends on the value of I(direction). See - I(interface_in) and I(interface_out) for routed rules that needs + for the interface depends on the value of O(direction). See + O(interface_in) and O(interface_out) for routed rules that needs to supply both an input and output interface. Mutually - exclusive with I(interface_in) and I(interface_out). + exclusive with O(interface_in) and O(interface_out). type: str aliases: [ if ] interface_in: description: - Specify input interface for the rule. This is mutually - exclusive with I(direction) and I(interface). However, it is - compatible with I(interface_out) for routed rules. + exclusive with O(direction) and O(interface). However, it is + compatible with O(interface_out) for routed rules. type: str aliases: [ if_in ] version_added: '0.2.0' interface_out: description: - Specify output interface for the rule. This is mutually - exclusive with I(direction) and I(interface). However, it is - compatible with I(interface_in) for routed rules. + exclusive with O(direction) and O(interface). However, it is + compatible with O(interface_in) for routed rules. type: str aliases: [ if_out ] version_added: '0.2.0'