diff --git a/plugins/lookup/tss.py b/plugins/lookup/tss.py
index 1fe87b31ec..581c4b704f 100644
--- a/plugins/lookup/tss.py
+++ b/plugins/lookup/tss.py
@@ -16,7 +16,7 @@ description:
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
+ E(REQUESTS_CA_BUNDLE) can be set to a file containing the trusted certificates
(in C(.pem) format).
- For example, C(export REQUESTS_CA_BUNDLE='/etc/ssl/certs/ca-bundle.trust.crt').
requirements:
diff --git a/plugins/modules/airbrake_deployment.py b/plugins/modules/airbrake_deployment.py
index 42ac037e1e..bad1b2c9d4 100644
--- a/plugins/modules/airbrake_deployment.py
+++ b/plugins/modules/airbrake_deployment.py
@@ -72,7 +72,7 @@ options:
type: str
validate_certs:
description:
- - If C(false), SSL certificates for the target url will not be validated. This should only be used
+ - If V(false), SSL certificates for the target url will not be validated. This should only be used
on personally controlled sites using self-signed certificates.
required: false
default: true
diff --git a/plugins/modules/aix_devices.py b/plugins/modules/aix_devices.py
index ef4ed49612..a0f3cf48d9 100644
--- a/plugins/modules/aix_devices.py
+++ b/plugins/modules/aix_devices.py
@@ -31,7 +31,7 @@ options:
device:
description:
- The name of the device.
- - C(all) is valid to rescan C(available) all devices (AIX cfgmgr command).
+ - V(all) is valid to rescan C(available) all devices (AIX cfgmgr command).
type: str
force:
description:
@@ -46,9 +46,9 @@ options:
state:
description:
- Controls the device state.
- - C(available) (alias C(present)) rescan a specific device or all devices (when C(device) is not specified).
- - C(removed) (alias C(absent) removes a device.
- - C(defined) changes device to Defined state.
+ - V(available) (alias V(present)) rescan a specific device or all devices (when O(device) is not specified).
+ - V(removed) (alias V(absent) removes a device.
+ - V(defined) changes device to Defined state.
type: str
choices: [ available, defined, removed ]
default: available
diff --git a/plugins/modules/aix_filesystem.py b/plugins/modules/aix_filesystem.py
index b1f363a937..d0d6ccb444 100644
--- a/plugins/modules/aix_filesystem.py
+++ b/plugins/modules/aix_filesystem.py
@@ -58,7 +58,7 @@ options:
default: jfs2
permissions:
description:
- - Set file system permissions. C(rw) (read-write) or C(ro) (read-only).
+ - Set file system permissions. V(rw) (read-write) or V(ro) (read-only).
type: str
choices: [ ro, rw ]
default: rw
@@ -77,13 +77,13 @@ options:
type: str
rm_mount_point:
description:
- - Removes the mount point directory when used with state C(absent).
+ - Removes the mount point directory when used with state V(absent).
type: bool
default: false
size:
description:
- Specifies the file system size.
- - For already C(present) it will be resized.
+ - For already V(present) it will be resized.
- 512-byte blocks, Megabytes or Gigabytes. If the value has M specified
it will be in Megabytes. If the value has G specified it will be in
Gigabytes.
@@ -96,10 +96,10 @@ options:
state:
description:
- Controls the file system state.
- - C(present) check if file system exists, creates or resize.
- - C(absent) removes existing file system if already C(unmounted).
- - C(mounted) checks if the file system is mounted or mount the file system.
- - C(unmounted) check if the file system is unmounted or unmount the file system.
+ - V(present) check if file system exists, creates or resize.
+ - V(absent) removes existing file system if already V(unmounted).
+ - V(mounted) checks if the file system is mounted or mount the file system.
+ - V(unmounted) check if the file system is unmounted or unmount the file system.
type: str
choices: [ absent, mounted, present, unmounted ]
default: present
@@ -108,7 +108,7 @@ options:
- Specifies an existing volume group (VG).
type: str
notes:
- - For more C(attributes), please check "crfs" AIX manual.
+ - For more O(attributes), please check "crfs" AIX manual.
'''
EXAMPLES = r'''
diff --git a/plugins/modules/aix_lvg.py b/plugins/modules/aix_lvg.py
index d89c43de4b..2892a68ad9 100644
--- a/plugins/modules/aix_lvg.py
+++ b/plugins/modules/aix_lvg.py
@@ -36,13 +36,13 @@ options:
pvs:
description:
- List of comma-separated devices to use as physical devices in this volume group.
- - Required when creating or extending (C(present) state) the volume group.
- - If not informed reducing (C(absent) state) the volume group will be removed.
+ - Required when creating or extending (V(present) state) the volume group.
+ - If not informed reducing (V(absent) state) the volume group will be removed.
type: list
elements: str
state:
description:
- - Control if the volume group exists and volume group AIX state varyonvg C(varyon) or varyoffvg C(varyoff).
+ - Control if the volume group exists and volume group AIX state varyonvg V(varyon) or varyoffvg V(varyoff).
type: str
choices: [ absent, present, varyoff, varyon ]
default: present
diff --git a/plugins/modules/aix_lvol.py b/plugins/modules/aix_lvol.py
index 0a4a6eff53..1e7b425687 100644
--- a/plugins/modules/aix_lvol.py
+++ b/plugins/modules/aix_lvol.py
@@ -53,15 +53,15 @@ options:
policy:
description:
- Sets the interphysical volume allocation policy.
- - C(maximum) allocates logical partitions across the maximum number of physical volumes.
- - C(minimum) allocates logical partitions across the minimum number of physical volumes.
+ - V(maximum) allocates logical partitions across the maximum number of physical volumes.
+ - V(minimum) allocates logical partitions across the minimum number of physical volumes.
type: str
choices: [ maximum, minimum ]
default: maximum
state:
description:
- - Control if the logical volume exists. If C(present) and the
- volume does not already exist then the C(size) option is required.
+ - Control if the logical volume exists. If V(present) and the
+ volume does not already exist then the O(size) option is required.
type: str
choices: [ absent, present ]
default: present
@@ -72,7 +72,7 @@ options:
default: ''
pvs:
description:
- - A list of physical volumes e.g. C(hdisk1,hdisk2).
+ - A list of physical volumes, for example V(hdisk1,hdisk2).
type: list
elements: str
default: []
diff --git a/plugins/modules/archive.py b/plugins/modules/archive.py
index e6128be6ef..666b826633 100644
--- a/plugins/modules/archive.py
+++ b/plugins/modules/archive.py
@@ -144,16 +144,16 @@ EXAMPLES = r'''
RETURN = r'''
state:
description:
- The state of the input C(path).
+ The state of the input O(path).
type: str
returned: always
dest_state:
description:
- The state of the O(dest) file.
- - C(absent) when the file does not exist.
- - C(archive) when the file is an archive.
- - C(compress) when the file is compressed, but not an archive.
- - C(incomplete) when the file is an archive, but some files under O(path) were not found.
+ - V(absent) when the file does not exist.
+ - V(archive) when the file is an archive.
+ - V(compress) when the file is compressed, but not an archive.
+ - V(incomplete) when the file is an archive, but some files under O(path) were not found.
type: str
returned: success
version_added: 3.4.0
diff --git a/plugins/modules/atomic_host.py b/plugins/modules/atomic_host.py
index bb44c44896..929c3fc11e 100644
--- a/plugins/modules/atomic_host.py
+++ b/plugins/modules/atomic_host.py
@@ -33,7 +33,7 @@ options:
revision:
description:
- The version number of the atomic host to be deployed.
- - Providing C(latest) will upgrade to the latest available version.
+ - Providing V(latest) will upgrade to the latest available version.
default: 'latest'
aliases: [ version ]
type: str
diff --git a/plugins/modules/atomic_image.py b/plugins/modules/atomic_image.py
index 65aec1e9d5..6e385af36c 100644
--- a/plugins/modules/atomic_image.py
+++ b/plugins/modules/atomic_image.py
@@ -43,7 +43,7 @@ options:
state:
description:
- The state of the container image.
- - The state C(latest) will ensure container image is upgraded to the latest version and forcefully restart container, if running.
+ - The state V(latest) will ensure container image is upgraded to the latest version and forcefully restart container, if running.
choices: [ 'absent', 'latest', 'present' ]
default: 'latest'
type: str
diff --git a/plugins/modules/bigpanda.py b/plugins/modules/bigpanda.py
index bab200bc44..fe6cbf99ee 100644
--- a/plugins/modules/bigpanda.py
+++ b/plugins/modules/bigpanda.py
@@ -75,7 +75,7 @@ options:
default: https://api.bigpanda.io
validate_certs:
description:
- - If C(false), SSL certificates for the target url will not be validated. This should only be used
+ - If V(false), SSL certificates for the target url will not be validated. This should only be used
on personally controlled sites using self-signed certificates.
required: false
default: true
diff --git a/plugins/modules/bundler.py b/plugins/modules/bundler.py
index 682dd334ac..59f10800c1 100644
--- a/plugins/modules/bundler.py
+++ b/plugins/modules/bundler.py
@@ -30,7 +30,7 @@ options:
state:
type: str
description:
- - The desired state of the Gem bundle. C(latest) updates gems to the most recent, acceptable version
+ - The desired state of the Gem bundle. V(latest) updates gems to the most recent, acceptable version
choices: [present, latest]
default: present
chdir:
@@ -44,19 +44,19 @@ options:
elements: str
description:
- A list of Gemfile groups to exclude during operations. This only
- applies when state is C(present). Bundler considers this
+ applies when O(state=present). Bundler considers this
a 'remembered' property for the Gemfile and will automatically exclude
- groups in future operations even if C(exclude_groups) is not set
+ groups in future operations even if O(exclude_groups) is not set
clean:
description:
- - Only applies if state is C(present). If set removes any gems on the
+ - Only applies if O(state=present). If set removes any gems on the
target host that are not in the gemfile
type: bool
default: false
gemfile:
type: path
description:
- - Only applies if state is C(present). The path to the gemfile to use to install gems.
+ - Only applies if O(state=present). The path to the gemfile to use to install gems.
- If not specified it will default to the Gemfile in current directory
local:
description:
@@ -65,31 +65,31 @@ options:
default: false
deployment_mode:
description:
- - Only applies if state is C(present). If set it will install gems in
+ - Only applies if O(state=present). If set it will install gems in
./vendor/bundle instead of the default location. Requires a Gemfile.lock
file to have been created prior
type: bool
default: false
user_install:
description:
- - Only applies if state is C(present). Installs gems in the local user's cache or for all users
+ - Only applies if O(state=present). Installs gems in the local user's cache or for all users
type: bool
default: true
gem_path:
type: path
description:
- - Only applies if state is C(present). Specifies the directory to
- install the gems into. If C(chdir) is set then this path is relative to
- C(chdir)
+ - Only applies if O(state=present). Specifies the directory to
+ install the gems into. If O(chdir) is set then this path is relative to
+ O(chdir)
- If not specified the default RubyGems gem paths will be used.
binstub_directory:
type: path
description:
- - Only applies if state is C(present). Specifies the directory to
+ - Only applies if O(state=present). Specifies the directory to
install any gem bins files to. When executed the bin files will run
within the context of the Gemfile and fail if any required gem
- dependencies are not installed. If C(chdir) is set then this path is
- relative to C(chdir)
+ dependencies are not installed. If O(chdir) is set then this path is
+ relative to O(chdir)
extra_args:
type: str
description:
diff --git a/plugins/modules/capabilities.py b/plugins/modules/capabilities.py
index 9b72ac6ea1..a0b6d52223 100644
--- a/plugins/modules/capabilities.py
+++ b/plugins/modules/capabilities.py
@@ -30,7 +30,7 @@ options:
aliases: [ key ]
capability:
description:
- - Desired capability to set (with operator and flags, if state is C(present)) or remove (if state is C(absent))
+ - Desired capability to set (with operator and flags, if O(state=present)) or remove (if O(state=absent))
type: str
required: true
aliases: [ cap ]
diff --git a/plugins/modules/catapult.py b/plugins/modules/catapult.py
index a3bbef6c42..acd8398512 100644
--- a/plugins/modules/catapult.py
+++ b/plugins/modules/catapult.py
@@ -28,13 +28,13 @@ options:
src:
type: str
description:
- - One of your catapult telephone numbers the message should come from (must be in E.164 format, like C(+19195551212)).
+ - One of your catapult telephone numbers the message should come from (must be in E.164 format, like V(+19195551212)).
required: true
dest:
type: list
elements: str
description:
- - The phone number or numbers the message should be sent to (must be in E.164 format, like C(+19195551212)).
+ - The phone number or numbers the message should be sent to (must be in E.164 format, like V(+19195551212)).
required: true
msg:
type: str
diff --git a/plugins/modules/cisco_webex.py b/plugins/modules/cisco_webex.py
index 2e5cb50ea0..caa77f576d 100644
--- a/plugins/modules/cisco_webex.py
+++ b/plugins/modules/cisco_webex.py
@@ -17,7 +17,7 @@ description:
- Send a message to a Cisco Webex Teams Room or Individual with options to control the formatting.
author: Drew Rusell (@drew-russell)
notes:
- - The C(recipient_id) type must be valid for the supplied C(recipient_id).
+ - The O(recipient_type) must be valid for the supplied O(recipient_id).
- Full API documentation can be found at U(https://developer.webex.com/docs/api/basics).
extends_documentation_fragment:
@@ -40,7 +40,7 @@ options:
recipient_id:
description:
- - The unique identifier associated with the supplied C(recipient_type).
+ - The unique identifier associated with the supplied O(recipient_type).
required: true
type: str
diff --git a/plugins/modules/clc_firewall_policy.py b/plugins/modules/clc_firewall_policy.py
index c832571d33..b30037c6fe 100644
--- a/plugins/modules/clc_firewall_policy.py
+++ b/plugins/modules/clc_firewall_policy.py
@@ -49,7 +49,7 @@ options:
description:
- The list of ports associated with the policy.
TCP and UDP can take in single ports or port ranges.
- - "Example: C(['any', 'icmp', 'TCP/123', 'UDP/123', 'TCP/123-456', 'UDP/123-456'])."
+ - "Example: V(['any', 'icmp', 'TCP/123', 'UDP/123', 'TCP/123-456', 'UDP/123-456'])."
type: list
elements: str
firewall_policy_id:
diff --git a/plugins/modules/cobbler_sync.py b/plugins/modules/cobbler_sync.py
index d7acf4be6a..4ec87c96c7 100644
--- a/plugins/modules/cobbler_sync.py
+++ b/plugins/modules/cobbler_sync.py
@@ -30,7 +30,7 @@ options:
port:
description:
- Port number to be used for REST connection.
- - The default value depends on parameter C(use_ssl).
+ - The default value depends on parameter O(use_ssl).
type: int
username:
description:
@@ -43,13 +43,13 @@ options:
type: str
use_ssl:
description:
- - If C(false), an HTTP connection will be used instead of the default HTTPS connection.
+ - If V(false), an HTTP connection will be used instead of the default HTTPS connection.
type: bool
default: true
validate_certs:
description:
- - If C(false), SSL certificates will not be validated.
- - This should only set to C(false) when used on personally controlled sites using self-signed certificates.
+ - If V(false), SSL certificates will not be validated.
+ - This should only set to V(false) when used on personally controlled sites using self-signed certificates.
type: bool
default: true
author:
diff --git a/plugins/modules/composer.py b/plugins/modules/composer.py
index b04b2bfdd6..fc22256736 100644
--- a/plugins/modules/composer.py
+++ b/plugins/modules/composer.py
@@ -107,7 +107,7 @@ options:
composer_executable:
type: path
description:
- - Path to composer executable on the remote host, if composer is not in C(PATH) or a custom composer is needed.
+ - Path to composer executable on the remote host, if composer is not in E(PATH) or a custom composer is needed.
version_added: 3.2.0
requirements:
- php
diff --git a/plugins/modules/copr.py b/plugins/modules/copr.py
index 1311de849d..f60a7b6e66 100644
--- a/plugins/modules/copr.py
+++ b/plugins/modules/copr.py
@@ -42,14 +42,14 @@ options:
type: str
state:
description:
- - Whether to set this project as C(enabled), C(disabled) or C(absent).
+ - Whether to set this project as V(enabled), V(disabled), or V(absent).
default: enabled
type: str
choices: [absent, enabled, disabled]
chroot:
description:
- The name of the chroot that you want to enable/disable/remove in the project,
- for example C(epel-7-x86_64). Default chroot is determined by the operating system,
+ for example V(epel-7-x86_64). Default chroot is determined by the operating system,
version of the operating system, and architecture on which the module is run.
type: str
"""
diff --git a/plugins/modules/datadog_downtime.py b/plugins/modules/datadog_downtime.py
index 6e506eb850..b3e71469b6 100644
--- a/plugins/modules/datadog_downtime.py
+++ b/plugins/modules/datadog_downtime.py
@@ -38,7 +38,7 @@ options:
api_host:
description:
- The URL to the Datadog API.
- - This value can also be set with the C(DATADOG_HOST) environment variable.
+ - This value can also be set with the E(DATADOG_HOST) environment variable.
required: false
default: https://api.datadoghq.com
type: str
@@ -57,7 +57,7 @@ options:
id:
description:
- The identifier of the downtime.
- - If empty, a new downtime gets created, otherwise it is either updated or deleted depending of the C(state).
+ - If empty, a new downtime gets created, otherwise it is either updated or deleted depending of the O(state).
- To keep your playbook idempotent, you should save the identifier in a file and read it in a lookup.
type: int
monitor_tags:
@@ -99,7 +99,7 @@ options:
- For example, to have a recurring event on the first day of each month,
select a type of rrule and set the C(FREQ) to C(MONTHLY) and C(BYMONTHDAY) to C(1).
- Most common rrule options from the iCalendar Spec are supported.
- - Attributes specifying the duration in C(RRULE) are not supported (e.g. C(DTSTART), C(DTEND), C(DURATION)).
+ - Attributes specifying the duration in C(RRULE) are not supported (for example C(DTSTART), C(DTEND), C(DURATION)).
type: str
"""
diff --git a/plugins/modules/datadog_event.py b/plugins/modules/datadog_event.py
index b8161eca64..6008b565b3 100644
--- a/plugins/modules/datadog_event.py
+++ b/plugins/modules/datadog_event.py
@@ -82,7 +82,7 @@ options:
description: ["An arbitrary string to use for aggregation."]
validate_certs:
description:
- - If C(false), SSL certificates will not be validated. This should only be used
+ - 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: true
diff --git a/plugins/modules/django_manage.py b/plugins/modules/django_manage.py
index e2de1db3e2..114ec0353e 100644
--- a/plugins/modules/django_manage.py
+++ b/plugins/modules/django_manage.py
@@ -62,7 +62,7 @@ options:
description:
- A directory to add to the Python path. Typically used to include the settings module if it is located
external to the application directory.
- - This would be equivalent to adding O(pythonpath)'s value to the C(PYTHONPATH) environment variable.
+ - This would be equivalent to adding O(pythonpath)'s value to the E(PYTHONPATH) environment variable.
type: path
required: false
aliases: [python_path]
diff --git a/plugins/modules/dnsimple.py b/plugins/modules/dnsimple.py
index 363b645f80..0df743e28d 100644
--- a/plugins/modules/dnsimple.py
+++ b/plugins/modules/dnsimple.py
@@ -26,7 +26,7 @@ attributes:
options:
account_email:
description:
- - Account email. If omitted, the environment variables C(DNSIMPLE_EMAIL) and C(DNSIMPLE_API_TOKEN) will be looked for.
+ - Account email. If omitted, the environment variables E(DNSIMPLE_EMAIL) and E(DNSIMPLE_API_TOKEN) will be looked for.
- "If those aren't found, a C(.dnsimple) file will be looked for, see: U(https://github.com/mikemaccana/dnsimple-python#getting-started)."
- "C(.dnsimple) config files are only supported in dnsimple-python<2.0.0"
type: str
diff --git a/plugins/modules/dnsmadeeasy.py b/plugins/modules/dnsmadeeasy.py
index 44587ca39c..6aad4b571d 100644
--- a/plugins/modules/dnsmadeeasy.py
+++ b/plugins/modules/dnsmadeeasy.py
@@ -87,14 +87,14 @@ options:
validate_certs:
description:
- - If C(false), SSL certificates will not be validated. This should only be used
+ - 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: true
monitor:
description:
- - If C(true), add or change the monitor. This is applicable only for A records.
+ - If V(true), add or change the monitor. This is applicable only for A records.
type: bool
default: false
@@ -133,7 +133,7 @@ options:
contactList:
description:
- Name or id of the contact list that the monitor will notify.
- - The default C('') means the Account Owner.
+ - The default V('') means the Account Owner.
type: str
httpFqdn:
@@ -153,7 +153,7 @@ options:
failover:
description:
- - If C(true), add or change the failover. This is applicable only for A records.
+ - If V(true), add or change the failover. This is applicable only for A records.
type: bool
default: false
diff --git a/plugins/modules/emc_vnx_sg_member.py b/plugins/modules/emc_vnx_sg_member.py
index 487b6feefa..b06cd01de3 100644
--- a/plugins/modules/emc_vnx_sg_member.py
+++ b/plugins/modules/emc_vnx_sg_member.py
@@ -46,8 +46,8 @@ options:
state:
description:
- Indicates the desired lunid state.
- - C(present) ensures specified lunid is present in the Storage Group.
- - C(absent) ensures specified lunid is absent from Storage Group.
+ - V(present) ensures specified lunid is present in the Storage Group.
+ - V(absent) ensures specified lunid is absent from Storage Group.
default: present
choices: [ "present", "absent"]
type: str
diff --git a/plugins/modules/flowdock.py b/plugins/modules/flowdock.py
index c78716ba40..346a26c936 100644
--- a/plugins/modules/flowdock.py
+++ b/plugins/modules/flowdock.py
@@ -87,7 +87,7 @@ options:
required: false
validate_certs:
description:
- - If C(false), SSL certificates will not be validated. This should only be used
+ - If V(false), SSL certificates will not be validated. This should only be used
on personally controlled sites using self-signed certificates.
required: false
default: true
diff --git a/plugins/modules/gem.py b/plugins/modules/gem.py
index 4bc99d39ef..f51e3350da 100644
--- a/plugins/modules/gem.py
+++ b/plugins/modules/gem.py
@@ -31,7 +31,7 @@ options:
state:
type: str
description:
- - The desired state of the gem. C(latest) ensures that the latest version is installed.
+ - The desired state of the gem. V(latest) ensures that the latest version is installed.
required: false
choices: [present, absent, latest]
default: present
@@ -80,7 +80,7 @@ options:
default: true
description:
- Avoid loading any C(.gemrc) file. Ignored for RubyGems prior to 2.5.2.
- - The default changed from C(false) to C(true) in community.general 6.0.0.
+ - The default changed from V(false) to V(true) in community.general 6.0.0.
version_added: 3.3.0
env_shebang:
description:
diff --git a/plugins/modules/github_release.py b/plugins/modules/github_release.py
index 3ddd6c8820..f555a1ccf0 100644
--- a/plugins/modules/github_release.py
+++ b/plugins/modules/github_release.py
@@ -25,7 +25,7 @@ attributes:
options:
token:
description:
- - GitHub Personal Access Token for authenticating. Mutually exclusive with C(password).
+ - GitHub Personal Access Token for authenticating. Mutually exclusive with O(password).
type: str
user:
description:
@@ -34,7 +34,7 @@ options:
required: true
password:
description:
- - The GitHub account password for the user. Mutually exclusive with C(token).
+ - The GitHub account password for the user. Mutually exclusive with O(token).
type: str
repo:
description:
@@ -49,7 +49,7 @@ options:
choices: [ 'latest_release', 'create_release' ]
tag:
description:
- - Tag name when creating a release. Required when using action is set to C(create_release).
+ - Tag name when creating a release. Required when using O(action=create_release).
type: str
target:
description:
diff --git a/plugins/modules/github_webhook.py b/plugins/modules/github_webhook.py
index d47b7a82fa..11b115750b 100644
--- a/plugins/modules/github_webhook.py
+++ b/plugins/modules/github_webhook.py
@@ -61,7 +61,7 @@ options:
- >
A list of GitHub events the hook is triggered for. Events are listed at
U(https://developer.github.com/v3/activity/events/types/). Required
- unless C(state) is C(absent)
+ unless O(state=absent)
required: false
type: list
elements: str
diff --git a/plugins/modules/gitlab_deploy_key.py b/plugins/modules/gitlab_deploy_key.py
index 27cb01f87e..4d12fcc9f8 100644
--- a/plugins/modules/gitlab_deploy_key.py
+++ b/plugins/modules/gitlab_deploy_key.py
@@ -56,8 +56,8 @@ options:
default: false
state:
description:
- - When C(present) the deploy key added to the project if it doesn't exist.
- - When C(absent) it will be removed from the project if it exists.
+ - When V(present) the deploy key added to the project if it doesn't exist.
+ - When V(absent) it will be removed from the project if it exists.
default: present
type: str
choices: [ "present", "absent" ]
diff --git a/plugins/modules/gitlab_hook.py b/plugins/modules/gitlab_hook.py
index adf90eb7bc..8cd0916398 100644
--- a/plugins/modules/gitlab_hook.py
+++ b/plugins/modules/gitlab_hook.py
@@ -47,8 +47,8 @@ options:
type: str
state:
description:
- - When C(present) the hook will be updated to match the input or created if it doesn't exist.
- - When C(absent) hook will be deleted if it exists.
+ - When V(present) the hook will be updated to match the input or created if it doesn't exist.
+ - When V(absent) hook will be deleted if it exists.
default: present
type: str
choices: [ "present", "absent" ]
diff --git a/plugins/modules/gitlab_merge_request.py b/plugins/modules/gitlab_merge_request.py
index 6cdeca6466..79213b7e56 100644
--- a/plugins/modules/gitlab_merge_request.py
+++ b/plugins/modules/gitlab_merge_request.py
@@ -95,12 +95,12 @@ options:
default: opened
assignee_ids:
description:
- - Comma separated list of assignees usernames omitting C(@) character.
+ - Comma separated list of assignees usernames omitting V(@) character.
- Set to empty string to unassign all assignees.
type: str
reviewer_ids:
description:
- - Comma separated list of reviewers usernames omitting C(@) character.
+ - Comma separated list of reviewers usernames omitting V(@) character.
- Set to empty string to unassign all reviewers.
type: str
'''
diff --git a/plugins/modules/gitlab_protected_branch.py b/plugins/modules/gitlab_protected_branch.py
index fea374cbfd..63599f4b45 100644
--- a/plugins/modules/gitlab_protected_branch.py
+++ b/plugins/modules/gitlab_protected_branch.py
@@ -44,7 +44,7 @@ options:
name:
description:
- The name of the branch that needs to be protected.
- - Can make use a wildcard character for like C(production/*) or just have C(main) or C(develop) as value.
+ - Can make use a wildcard character for like V(production/*) or just have V(main) or V(develop) as value.
required: true
type: str
merge_access_levels:
diff --git a/plugins/modules/grove.py b/plugins/modules/grove.py
index d1a5f3126a..b50546b4da 100644
--- a/plugins/modules/grove.py
+++ b/plugins/modules/grove.py
@@ -53,7 +53,7 @@ options:
required: false
validate_certs:
description:
- - If C(false), SSL certificates will not be validated. This should only be used
+ - If V(false), SSL certificates will not be validated. This should only be used
on personally controlled sites using self-signed certificates.
default: true
type: bool
diff --git a/plugins/modules/hg.py b/plugins/modules/hg.py
index dbbd504b4e..87f15e50e8 100644
--- a/plugins/modules/hg.py
+++ b/plugins/modules/hg.py
@@ -44,7 +44,7 @@ options:
force:
description:
- Discards uncommitted changes. Runs C(hg update -C). Prior to
- 1.9, the default was C(true).
+ Ansible 1.9, the default was V(true).
type: bool
default: false
purge:
@@ -54,12 +54,12 @@ options:
default: false
update:
description:
- - If C(false), do not retrieve new revisions from the origin repository
+ - If V(false), do not retrieve new revisions from the origin repository
type: bool
default: true
clone:
description:
- - If C(false), do not clone the repository if it does not exist locally.
+ - If V(false), do not clone the repository if it does not exist locally.
type: bool
default: true
executable:
diff --git a/plugins/modules/hipchat.py b/plugins/modules/hipchat.py
index 11b5fb7358..83e253679c 100644
--- a/plugins/modules/hipchat.py
+++ b/plugins/modules/hipchat.py
@@ -64,7 +64,7 @@ options:
default: true
validate_certs:
description:
- - If C(false), SSL certificates will not be validated. This should only be used
+ - 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: true
diff --git a/plugins/modules/honeybadger_deployment.py b/plugins/modules/honeybadger_deployment.py
index 820e4538e8..cf52745ac7 100644
--- a/plugins/modules/honeybadger_deployment.py
+++ b/plugins/modules/honeybadger_deployment.py
@@ -52,7 +52,7 @@ options:
default: "https://api.honeybadger.io/v1/deploys"
validate_certs:
description:
- - If C(false), SSL certificates for the target url will not be validated. This should only be used
+ - If V(false), SSL certificates for the target url will not be validated. This should only be used
on personally controlled sites using self-signed certificates.
type: bool
default: true
diff --git a/plugins/modules/hpilo_info.py b/plugins/modules/hpilo_info.py
index cef6597e48..80ffa430ae 100644
--- a/plugins/modules/hpilo_info.py
+++ b/plugins/modules/hpilo_info.py
@@ -125,7 +125,7 @@ hw_uuid:
host_power_status:
description:
- Power status of host.
- - Will be one of C(ON), C(OFF) and C(UNKNOWN).
+ - Will be one of V(ON), V(OFF) and V(UNKNOWN).
returned: always
type: str
sample: "ON"
diff --git a/plugins/modules/hwc_ecs_instance.py b/plugins/modules/hwc_ecs_instance.py
index 434db242f2..9ba95dc96d 100644
--- a/plugins/modules/hwc_ecs_instance.py
+++ b/plugins/modules/hwc_ecs_instance.py
@@ -73,8 +73,8 @@ options:
name:
description:
- Specifies the ECS name. Value requirements consists of 1 to 64
- characters, including letters, digits, underscores C(_), hyphens
- (-), periods (.).
+ characters, including letters, digits, underscores (V(_)), hyphens
+ (V(-)), periods (V(.)).
type: str
required: true
nics:
@@ -306,8 +306,8 @@ RETURN = '''
name:
description:
- Specifies the ECS name. Value requirements "Consists of 1 to 64
- characters, including letters, digits, underscores C(_), hyphens
- (-), periods (.)".
+ characters, including letters, digits, underscores (V(_)), hyphens
+ (V(-)), periods (V(.)).".
type: str
returned: success
nics:
diff --git a/plugins/modules/hwc_smn_topic.py b/plugins/modules/hwc_smn_topic.py
index 88207d3f93..bb983fba71 100644
--- a/plugins/modules/hwc_smn_topic.py
+++ b/plugins/modules/hwc_smn_topic.py
@@ -45,7 +45,7 @@ options:
description:
- Name of the topic to be created. The topic name is a string of 1
to 256 characters. It must contain upper- or lower-case letters,
- digits, hyphens (-), and underscores C(_), and must start with a
+ digits, hyphens (V(-)), and underscores (V(_)), and must start with a
letter or digit.
type: str
required: true
@@ -85,7 +85,7 @@ name:
description:
- Name of the topic to be created. The topic name is a string of 1
to 256 characters. It must contain upper- or lower-case letters,
- digits, hyphens (-), and underscores C(_), and must start with a
+ digits, hyphens (V(-)), and underscores (V(_)), and must start with a
letter or digit.
returned: success
type: str
diff --git a/plugins/modules/hwc_vpc_eip.py b/plugins/modules/hwc_vpc_eip.py
index 9fc0361b30..5c44319409 100644
--- a/plugins/modules/hwc_vpc_eip.py
+++ b/plugins/modules/hwc_vpc_eip.py
@@ -75,7 +75,7 @@ options:
description:
- Specifies the bandwidth name. The value is a string of 1
to 64 characters that can contain letters, digits,
- underscores C(_), hyphens (-), and periods (.).
+ underscores (V(_)), hyphens (V(-)), and periods (V(.)).
type: str
required: true
size:
@@ -187,7 +187,7 @@ RETURN = '''
description:
- Specifies the bandwidth name. The value is a string of 1
to 64 characters that can contain letters, digits,
- underscores C(_), hyphens (-), and periods (.).
+ underscores (V(_)), hyphens (V(-)), and periods (V(.)).
type: str
returned: success
size:
diff --git a/plugins/modules/hwc_vpc_subnet.py b/plugins/modules/hwc_vpc_subnet.py
index 7fb107f534..7ba7473301 100644
--- a/plugins/modules/hwc_vpc_subnet.py
+++ b/plugins/modules/hwc_vpc_subnet.py
@@ -66,8 +66,8 @@ options:
name:
description:
- Specifies the subnet name. The value is a string of 1 to 64
- characters that can contain letters, digits, underscores C(_),
- hyphens (-), and periods (.).
+ characters that can contain letters, digits, underscores (V(_)),
+ hyphens (V(-)), and periods (V(.)).
type: str
required: true
vpc_id:
@@ -137,8 +137,8 @@ RETURN = '''
name:
description:
- Specifies the subnet name. The value is a string of 1 to 64
- characters that can contain letters, digits, underscores C(_),
- hyphens (-), and periods (.).
+ characters that can contain letters, digits, underscores (V(_)),
+ hyphens (V(-)), and periods (V(.)).
type: str
returned: success
vpc_id:
diff --git a/plugins/modules/icinga2_feature.py b/plugins/modules/icinga2_feature.py
index 6e6bc54161..0c79f6cba9 100644
--- a/plugins/modules/icinga2_feature.py
+++ b/plugins/modules/icinga2_feature.py
@@ -37,10 +37,10 @@ options:
state:
type: str
description:
- - If set to C(present) and feature is disabled, then feature is enabled.
- - If set to C(present) and feature is already enabled, then nothing is changed.
- - If set to C(absent) and feature is enabled, then feature is disabled.
- - If set to C(absent) and feature is already disabled, then nothing is changed.
+ - If set to V(present) and feature is disabled, then feature is enabled.
+ - If set to V(present) and feature is already enabled, then nothing is changed.
+ - If set to V(absent) and feature is enabled, then feature is disabled.
+ - If set to V(absent) and feature is already disabled, then nothing is changed.
choices: [ "present", "absent" ]
default: present
'''
diff --git a/plugins/modules/idrac_redfish_info.py b/plugins/modules/idrac_redfish_info.py
index aece616641..7ea08fb900 100644
--- a/plugins/modules/idrac_redfish_info.py
+++ b/plugins/modules/idrac_redfish_info.py
@@ -35,7 +35,7 @@ options:
required: true
description:
- List of commands to execute on iDRAC.
- - C(GetManagerAttributes) returns the list of dicts containing iDRAC,
+ - V(GetManagerAttributes) returns the list of dicts containing iDRAC,
LifecycleController and System attributes.
type: list
elements: str
diff --git a/plugins/modules/imc_rest.py b/plugins/modules/imc_rest.py
index 4bbaad23af..87d0a4d785 100644
--- a/plugins/modules/imc_rest.py
+++ b/plugins/modules/imc_rest.py
@@ -51,16 +51,16 @@ options:
description:
- Name of the absolute path of the filename that includes the body
of the http request being sent to the Cisco IMC REST API.
- - Parameter C(path) is mutual exclusive with parameter C(content).
+ - Parameter O(path) is mutual exclusive with parameter O(content).
aliases: [ 'src', 'config_file' ]
type: path
content:
description:
- - When used instead of C(path), sets the content of the API requests directly.
+ - When used instead of O(path), sets the content of the API requests directly.
- This may be convenient to template simple requests, for anything complex use the M(ansible.builtin.template) module.
- You can collate multiple IMC XML fragments and they will be processed sequentially in a single stream,
the Cisco IMC output is subsequently merged.
- - Parameter C(content) is mutual exclusive with parameter C(path).
+ - Parameter O(content) is mutual exclusive with parameter O(path).
type: str
protocol:
description:
@@ -72,14 +72,14 @@ options:
description:
- The socket level timeout in seconds.
- This is the time that every single connection (every fragment) can spend.
- If this C(timeout) is reached, the module will fail with a
+ If this O(timeout) is reached, the module will fail with a
C(Connection failure) indicating that C(The read operation timed out).
default: 60
type: int
validate_certs:
description:
- - If C(false), SSL certificates will not be validated.
- - This should only set to C(false) used on personally controlled sites using self-signed certificates.
+ - If V(false), 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
notes:
@@ -88,7 +88,7 @@ notes:
- Any configConfMo change requested has a return status of 'modified', even if there was no actual change
from the previous configuration. As a result, this module will always report a change on subsequent runs.
In case this behaviour is fixed in a future update to Cisco IMC, this module will automatically adapt.
-- If you get a C(Connection failure) related to C(The read operation timed out) increase the C(timeout)
+- If you get a C(Connection failure) related to C(The read operation timed out) increase the O(timeout)
parameter. Some XML fragments can take longer than the default timeout.
- More information about the IMC REST API is available from
U(http://www.cisco.com/c/en/us/td/docs/unified_computing/ucs/c/sw/api/3_0/b_Cisco_IMC_api_301.html)
diff --git a/plugins/modules/imgadm.py b/plugins/modules/imgadm.py
index 6e4b810982..6ebf06c46f 100644
--- a/plugins/modules/imgadm.py
+++ b/plugins/modules/imgadm.py
@@ -44,9 +44,9 @@ options:
required: true
choices: [ present, absent, deleted, imported, updated, vacuumed ]
description:
- - State the object operated on should be in. C(imported) is an alias for
- for C(present) and C(deleted) for C(absent). When set to C(vacuumed)
- and C(uuid) to C(*), it will remove all unused images.
+ - State the object operated on should be in. V(imported) is an alias for
+ for V(present) and V(deleted) for V(absent). When set to V(vacuumed)
+ and O(uuid=*), it will remove all unused images.
type: str
type:
@@ -60,7 +60,7 @@ options:
uuid:
required: false
description:
- - Image UUID. Can either be a full UUID or C(*) for all images.
+ - Image UUID. Can either be a full UUID or V(*) for all images.
type: str
requirements:
diff --git a/plugins/modules/installp.py b/plugins/modules/installp.py
index 41064363db..5380dc674c 100644
--- a/plugins/modules/installp.py
+++ b/plugins/modules/installp.py
@@ -32,7 +32,7 @@ options:
name:
description:
- One or more packages to install or remove.
- - Use C(all) to install all packages available on informed C(repository_path).
+ - Use V(all) to install all packages available on informed O(repository_path).
type: list
elements: str
required: true
diff --git a/plugins/modules/ipa_host.py b/plugins/modules/ipa_host.py
index d561401d4d..a5ab897a97 100644
--- a/plugins/modules/ipa_host.py
+++ b/plugins/modules/ipa_host.py
@@ -80,7 +80,7 @@ options:
type: str
update_dns:
description:
- - If set C("True") with state as C("absent"), then removes DNS records of the host managed by FreeIPA DNS.
+ - If set V(true) with O(state=absent), then removes DNS records of the host managed by FreeIPA DNS.
- This option has no effect for states other than "absent".
type: bool
random_password:
diff --git a/plugins/modules/ipa_otptoken.py b/plugins/modules/ipa_otptoken.py
index f25ab6023f..22c21b61a6 100644
--- a/plugins/modules/ipa_otptoken.py
+++ b/plugins/modules/ipa_otptoken.py
@@ -48,7 +48,7 @@ options:
description: Assigned user of the token.
type: str
enabled:
- description: Mark the token as enabled (default C(true)).
+ description: Mark the token as enabled (default V(true)).
default: true
type: bool
notbefore:
diff --git a/plugins/modules/ipa_sudorule.py b/plugins/modules/ipa_sudorule.py
index 59b4eb19e2..fddd84c58f 100644
--- a/plugins/modules/ipa_sudorule.py
+++ b/plugins/modules/ipa_sudorule.py
@@ -56,14 +56,14 @@ options:
- List of hosts assigned to the rule.
- If an empty list is passed all hosts will be removed from the rule.
- If option is omitted hosts will not be checked or changed.
- - Option C(hostcategory) must be omitted to assign hosts.
+ - Option O(hostcategory) must be omitted to assign hosts.
type: list
elements: str
hostcategory:
description:
- Host category the rule applies to.
- - If 'all' is passed one must omit C(host) and C(hostgroup).
- - Option C(host) and C(hostgroup) must be omitted to assign 'all'.
+ - If V(all) is passed one must omit O(host) and O(hostgroup).
+ - Option O(host) and O(hostgroup) must be omitted to assign V(all).
choices: ['all']
type: str
hostgroup:
@@ -71,7 +71,7 @@ options:
- List of host groups assigned to the rule.
- If an empty list is passed all host groups will be removed from the rule.
- If option is omitted host groups will not be checked or changed.
- - Option C(hostcategory) must be omitted to assign host groups.
+ - Option O(hostcategory) must be omitted to assign host groups.
type: list
elements: str
runasextusers:
diff --git a/plugins/modules/ipbase_info.py b/plugins/modules/ipbase_info.py
index 4eeb70c957..0af5b682b1 100644
--- a/plugins/modules/ipbase_info.py
+++ b/plugins/modules/ipbase_info.py
@@ -32,7 +32,7 @@ options:
type: str
hostname:
description:
- - "If the hostname parameter is set to C(true), the API response will contain the hostname of the IP."
+ - "If the O(hostname) parameter is set to V(true), the API response will contain the hostname of the IP."
required: false
type: bool
default: false
diff --git a/plugins/modules/ipify_facts.py b/plugins/modules/ipify_facts.py
index ab96d7e949..ff17d7e543 100644
--- a/plugins/modules/ipify_facts.py
+++ b/plugins/modules/ipify_facts.py
@@ -35,7 +35,7 @@ options:
default: 10
validate_certs:
description:
- - When set to C(NO), SSL certificates will not be validated.
+ - When set to V(false), SSL certificates will not be validated.
type: bool
default: true
notes:
diff --git a/plugins/modules/iso_create.py b/plugins/modules/iso_create.py
index 4b51be96d2..e93271df9d 100644
--- a/plugins/modules/iso_create.py
+++ b/plugins/modules/iso_create.py
@@ -35,7 +35,7 @@ options:
src_files:
description:
- This is a list of absolute paths of source files or folders which will be contained in the new generated ISO file.
- - Will fail if specified file or folder in C(src_files) does not exist on local machine.
+ - Will fail if specified file or folder in O(src_files) does not exist on local machine.
- 'Note: With all ISO9660 levels from 1 to 3, all file names are restricted to uppercase letters, numbers and
underscores (_). File names are limited to 31 characters, directory nesting is limited to 8 levels, and path
names are limited to 255 characters.'
@@ -51,9 +51,9 @@ options:
interchange_level:
description:
- The ISO9660 interchange level to use, it dictates the rules on the names of files.
- - Levels and valid values C(1), C(2), C(3), C(4) are supported.
- - The default value is level C(1), which is the most conservative, level C(3) is recommended.
- - ISO9660 file names at interchange level C(1) cannot have more than 8 characters or 3 characters in the extension.
+ - Levels and valid values V(1), V(2), V(3), V(4) are supported.
+ - The default value is level V(1), which is the most conservative, level V(3) is recommended.
+ - ISO9660 file names at interchange level V(1) cannot have more than 8 characters or 3 characters in the extension.
type: int
default: 1
choices: [1, 2, 3, 4]
@@ -64,23 +64,23 @@ options:
rock_ridge:
description:
- Whether to make this ISO have the Rock Ridge extensions or not.
- - Valid values are C(1.09), C(1.10) or C(1.12), means adding the specified Rock Ridge version to the ISO.
- - If unsure, set C(1.09) to ensure maximum compatibility.
+ - Valid values are V(1.09), V(1.10) or V(1.12), means adding the specified Rock Ridge version to the ISO.
+ - If unsure, set V(1.09) to ensure maximum compatibility.
- If not specified, then not add Rock Ridge extension to the ISO.
type: str
choices: ['1.09', '1.10', '1.12']
joliet:
description:
- - Support levels and valid values are C(1), C(2), or C(3).
- - Level C(3) is by far the most common.
+ - Support levels and valid values are V(1), V(2), or V(3).
+ - Level V(3) is by far the most common.
- If not specified, then no Joliet support is added.
type: int
choices: [1, 2, 3]
udf:
description:
- Whether to add UDF support to this ISO.
- - If set to C(True), then version 2.60 of the UDF spec is used.
- - If not specified or set to C(False), then no UDF support is added.
+ - If set to V(true), then version 2.60 of the UDF spec is used.
+ - If not specified or set to V(false), then no UDF support is added.
type: bool
default: false
'''
diff --git a/plugins/modules/java_cert.py b/plugins/modules/java_cert.py
index a188b16c38..3f3e5aa014 100644
--- a/plugins/modules/java_cert.py
+++ b/plugins/modules/java_cert.py
@@ -27,7 +27,7 @@ options:
cert_url:
description:
- Basic URL to fetch SSL certificate from.
- - Exactly one of C(cert_url), C(cert_path) or C(pkcs12_path) is required to load certificate.
+ - Exactly one of O(cert_url), O(cert_path), or O(pkcs12_path) is required to load certificate.
type: str
cert_port:
description:
@@ -38,7 +38,7 @@ options:
cert_path:
description:
- Local path to load certificate from.
- - Exactly one of C(cert_url), C(cert_path) or C(pkcs12_path) is required to load certificate.
+ - Exactly one of O(cert_url), O(cert_path), or O(pkcs12_path) is required to load certificate.
type: path
cert_alias:
description:
@@ -54,10 +54,10 @@ options:
pkcs12_path:
description:
- Local path to load PKCS12 keystore from.
- - Unlike C(cert_url) and C(cert_path), the PKCS12 keystore embeds the private key matching
+ - Unlike O(cert_url) and O(cert_path), the PKCS12 keystore embeds the private key matching
the certificate, and is used to import both the certificate and its private key into the
java keystore.
- - Exactly one of C(cert_url), C(cert_path) or C(pkcs12_path) is required to load certificate.
+ - Exactly one of O(cert_url), O(cert_path), or O(pkcs12_path) is required to load certificate.
type: path
pkcs12_password:
description:
diff --git a/plugins/modules/jenkins_build.py b/plugins/modules/jenkins_build.py
index 4f95202244..bca2a02b4a 100644
--- a/plugins/modules/jenkins_build.py
+++ b/plugins/modules/jenkins_build.py
@@ -48,7 +48,7 @@ options:
state:
description:
- Attribute that specifies if the build is to be created, deleted or stopped.
- - The C(stopped) state has been added in community.general 3.3.0.
+ - The V(stopped) state has been added in community.general 3.3.0.
default: present
choices: ['present', 'absent', 'stopped']
type: str
diff --git a/plugins/modules/jenkins_script.py b/plugins/modules/jenkins_script.py
index 7f83ebcdbd..ab8660e28d 100644
--- a/plugins/modules/jenkins_script.py
+++ b/plugins/modules/jenkins_script.py
@@ -42,8 +42,8 @@ options:
default: http://localhost:8080
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
+ - 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 as it avoids verifying the source site.
type: bool
default: true
diff --git a/plugins/modules/kibana_plugin.py b/plugins/modules/kibana_plugin.py
index a52eda2fdd..f6744b3960 100644
--- a/plugins/modules/kibana_plugin.py
+++ b/plugins/modules/kibana_plugin.py
@@ -60,7 +60,7 @@ options:
version:
description:
- Version of the plugin to be installed.
- - If plugin exists with previous version, plugin will NOT be updated unless C(force) is set to yes.
+ - If plugin exists with previous version, plugin will B(not) be updated unless O(force) is set to V(true).
type: str
force:
description:
diff --git a/plugins/modules/launchd.py b/plugins/modules/launchd.py
index 13a8ce0862..e5942ea7cf 100644
--- a/plugins/modules/launchd.py
+++ b/plugins/modules/launchd.py
@@ -32,14 +32,14 @@ options:
required: true
state:
description:
- - C(started)/C(stopped) are idempotent actions that will not run
+ - V(started)/V(stopped) are idempotent actions that will not run
commands unless necessary.
- - Launchd does not support C(restarted) nor C(reloaded) natively.
+ - Launchd does not support V(restarted) nor V(reloaded) natively.
These will trigger a stop/start (restarted) or an unload/load
(reloaded).
- - C(restarted) unloads and loads the service before start to ensure
+ - V(restarted) unloads and loads the service before start to ensure
that the latest job definition (plist) is used.
- - C(reloaded) unloads and loads the service to ensure that the latest
+ - V(reloaded) unloads and loads the service to ensure that the latest
job definition (plist) is used. Whether a service is started or
stopped depends on the content of the definition file.
type: str
@@ -54,7 +54,7 @@ options:
- Whether the service should not be restarted automatically by launchd.
- Services might have the 'KeepAlive' attribute set to true in a launchd configuration.
In case this is set to true, stopping a service will cause that launchd starts the service again.
- - Set this option to C(true) to let this module change the 'KeepAlive' attribute to false.
+ - Set this option to V(true) to let this module change the 'KeepAlive' attribute to V(false).
type: bool
default: false
notes:
diff --git a/plugins/modules/linode.py b/plugins/modules/linode.py
index 404e7a393f..e3782691a5 100644
--- a/plugins/modules/linode.py
+++ b/plugins/modules/linode.py
@@ -31,7 +31,7 @@ options:
api_key:
description:
- Linode API key.
- - C(LINODE_API_KEY) env variable can be used instead.
+ - E(LINODE_API_KEY) environment variable can be used instead.
type: str
required: true
name:
@@ -124,7 +124,7 @@ options:
private_ip:
description:
- Add private IPv4 address when Linode is created.
- - Default is C(false).
+ - Default is V(false).
type: bool
ssh_pub_key:
description:
@@ -149,7 +149,7 @@ options:
type: int
wait:
description:
- - wait for the instance to be in state C(running) before returning
+ - wait for the instance to be in state V(running) before returning
type: bool
default: true
wait_timeout:
diff --git a/plugins/modules/linode_v4.py b/plugins/modules/linode_v4.py
index f213af125e..384423888c 100644
--- a/plugins/modules/linode_v4.py
+++ b/plugins/modules/linode_v4.py
@@ -62,7 +62,7 @@ options:
type: str
private_ip:
description:
- - If C(true), the created Linode will have private networking enabled and
+ - If V(true), the created Linode will have private networking enabled and
assigned a private IPv4 address.
type: bool
default: false
@@ -95,7 +95,7 @@ options:
access_token:
description:
- The Linode API v4 access token. It may also be specified by exposing
- the C(LINODE_ACCESS_TOKEN) environment variable. See
+ the E(LINODE_ACCESS_TOKEN) environment variable. See
U(https://www.linode.com/docs/api#access-and-authentication).
required: true
type: str
diff --git a/plugins/modules/lvol.py b/plugins/modules/lvol.py
index d193a4e837..8445348a58 100644
--- a/plugins/modules/lvol.py
+++ b/plugins/modules/lvol.py
@@ -45,14 +45,14 @@ options:
Float values must begin with a digit.
- When resizing, apart from specifying an absolute size you may, according to
lvextend(8)|lvreduce(8) C(--size), specify the amount to extend the logical volume with
- the prefix C(+) or the amount to reduce the logical volume by with prefix C(-).
- - Resizing using C(+) or C(-) was not supported prior to community.general 3.0.0.
- - Please note that when using C(+) or C(-), the module is B(not idempotent).
+ the prefix V(+) or the amount to reduce the logical volume by with prefix V(-).
+ - Resizing using V(+) or V(-) was not supported prior to community.general 3.0.0.
+ - Please note that when using V(+) or V(-), the module is B(not idempotent).
state:
type: str
description:
- - Control if the logical volume exists. If C(present) and the
- volume does not already exist then the C(size) option is required.
+ - Control if the logical volume exists. If V(present) and the
+ volume does not already exist then the O(size) option is required.
choices: [ absent, present ]
default: present
active:
diff --git a/plugins/modules/lxc_container.py b/plugins/modules/lxc_container.py
index ddc7d3b56e..fa5e852a65 100644
--- a/plugins/modules/lxc_container.py
+++ b/plugins/modules/lxc_container.py
@@ -92,7 +92,7 @@ options:
type: str
lxc_path:
description:
- - Place container under C(PATH).
+ - Place container under E(PATH).
type: path
container_log:
description:
diff --git a/plugins/modules/mail.py b/plugins/modules/mail.py
index feaac69233..117aa4e363 100644
--- a/plugins/modules/mail.py
+++ b/plugins/modules/mail.py
@@ -114,18 +114,18 @@ options:
default: utf-8
subtype:
description:
- - The minor mime type, can be either C(plain) or C(html).
- - The major type is always C(text).
+ - The minor mime type, can be either V(plain) or V(html).
+ - The major type is always V(text).
type: str
choices: [ html, plain ]
default: plain
secure:
description:
- - If C(always), the connection will only send email if the connection is Encrypted.
+ - If V(always), the connection will only send email if the connection is Encrypted.
If the server doesn't accept the encrypted connection it will fail.
- - If C(try), the connection will attempt to setup a secure SSL/TLS session, before trying to send.
- - If C(never), the connection will not attempt to setup a secure SSL/TLS session, before sending
- - If C(starttls), the connection will try to upgrade to a secure SSL/TLS connection, before sending.
+ - If V(try), the connection will attempt to setup a secure SSL/TLS session, before trying to send.
+ - If V(never), the connection will not attempt to setup a secure SSL/TLS session, before sending
+ - If V(starttls), the connection will try to upgrade to a secure SSL/TLS connection, before sending.
If it is unable to do so it will fail.
type: str
choices: [ always, never, starttls, try ]
diff --git a/plugins/modules/manageiq_group.py b/plugins/modules/manageiq_group.py
index a142a939fe..132d261a63 100644
--- a/plugins/modules/manageiq_group.py
+++ b/plugins/modules/manageiq_group.py
@@ -52,7 +52,7 @@ options:
type: str
description:
- The the group role name
- - The C(role_id) has precedence over the C(role) when supplied.
+ - The O(role_id) has precedence over the O(role) when supplied.
required: false
default: null
tenant_id:
@@ -65,7 +65,7 @@ options:
type: str
description:
- The tenant for the group identified by the tenant name.
- - The C(tenant_id) has precedence over the C(tenant) when supplied.
+ - The O(tenant_id) has precedence over the O(tenant) when supplied.
- Tenant names are case sensitive.
required: false
default: null
@@ -78,7 +78,7 @@ options:
type: str
description:
- In merge mode existing categories are kept or updated, new categories are added.
- - In replace mode all categories will be replaced with the supplied C(managed_filters).
+ - In replace mode all categories will be replaced with the supplied O(managed_filters).
choices: [ merge, replace ]
default: replace
belongsto_filters:
@@ -90,8 +90,8 @@ options:
belongsto_filters_merge_mode:
type: str
description:
- - In merge mode existing settings are merged with the supplied C(belongsto_filters).
- - In replace mode current values are replaced with the supplied C(belongsto_filters).
+ - In merge mode existing settings are merged with the supplied O(belongsto_filters).
+ - In replace mode current values are replaced with the supplied O(belongsto_filters).
choices: [ merge, replace ]
default: replace
'''
diff --git a/plugins/modules/manageiq_provider.py b/plugins/modules/manageiq_provider.py
index bbc27214b7..79beb853d4 100644
--- a/plugins/modules/manageiq_provider.py
+++ b/plugins/modules/manageiq_provider.py
@@ -138,7 +138,7 @@ options:
description: The CA bundle string with custom certificates. defaults to None.
path:
type: str
- description: Database name for oVirt metrics. Defaults to C(ovirt_engine_history).
+ description: Database name for oVirt metrics. Defaults to V(ovirt_engine_history).
alerts:
description: Alerts endpoint connection information.
diff --git a/plugins/modules/manageiq_tenant.py b/plugins/modules/manageiq_tenant.py
index d68e26a735..0cc33eee6c 100644
--- a/plugins/modules/manageiq_tenant.py
+++ b/plugins/modules/manageiq_tenant.py
@@ -50,13 +50,13 @@ options:
type: int
description:
- The id of the parent tenant. If not supplied the root tenant is used.
- - The C(parent_id) takes president over C(parent) when supplied
+ - The O(parent_id) takes president over O(parent) when supplied
required: false
default: null
parent:
type: str
description:
- - The name of the parent tenant. If not supplied and no C(parent_id) is supplied the root tenant is used.
+ - The name of the parent tenant. If not supplied and no O(parent_id) is supplied the root tenant is used.
required: false
default: null
quotas:
diff --git a/plugins/modules/manageiq_user.py b/plugins/modules/manageiq_user.py
index 0d3d8718b4..05827f6d86 100644
--- a/plugins/modules/manageiq_user.py
+++ b/plugins/modules/manageiq_user.py
@@ -60,7 +60,7 @@ options:
default: always
choices: ['always', 'on_create']
description:
- - C(always) will update passwords unconditionally. C(on_create) will only set the password for a newly created user.
+ - V(always) will update passwords unconditionally. V(on_create) will only set the password for a newly created user.
'''
EXAMPLES = '''
diff --git a/plugins/modules/mas.py b/plugins/modules/mas.py
index 532f6a2dc1..8bb80840ca 100644
--- a/plugins/modules/mas.py
+++ b/plugins/modules/mas.py
@@ -36,7 +36,7 @@ options:
state:
description:
- Desired state of the app installation.
- - The C(absent) value requires root permissions, also see the examples.
+ - The V(absent) value requires root permissions, also see the examples.
type: str
choices:
- absent
diff --git a/plugins/modules/modprobe.py b/plugins/modules/modprobe.py
index 6389d758d2..3909a3a2f2 100644
--- a/plugins/modules/modprobe.py
+++ b/plugins/modules/modprobe.py
@@ -49,14 +49,14 @@ options:
description:
- Persistency between reboots for configured module.
- This option creates files in C(/etc/modules-load.d/) and C(/etc/modprobe.d/) that make your module configuration persistent during reboots.
- - If C(present), adds module name to C(/etc/modules-load.d/) and params to C(/etc/modprobe.d/) so the module will be loaded on next reboot.
- - If C(absent), will comment out module name from C(/etc/modules-load.d/) and comment out params from C(/etc/modprobe.d/) so the module will not be
+ - If V(present), adds module name to C(/etc/modules-load.d/) and params to C(/etc/modprobe.d/) so the module will be loaded on next reboot.
+ - If V(absent), will comment out module name from C(/etc/modules-load.d/) and comment out params from C(/etc/modprobe.d/) so the module will not be
loaded on next reboot.
- - If C(disabled), will not touch anything and leave C(/etc/modules-load.d/) and C(/etc/modprobe.d/) as it is.
+ - If V(disabled), will not touch anything and leave C(/etc/modules-load.d/) and C(/etc/modprobe.d/) as it is.
- Note that it is usually a better idea to rely on the automatic module loading by PCI IDs, USB IDs, DMI IDs or similar triggers encoded in the
kernel modules themselves instead of configuration like this.
- In fact, most modern kernel modules are prepared for automatic loading already.
- - "B(Note:) This option works only with distributions that use C(systemd) when set to values other than C(disabled)."
+ - "B(Note:) This option works only with distributions that use C(systemd) when set to values other than V(disabled)."
'''
EXAMPLES = '''
diff --git a/plugins/modules/nexmo.py b/plugins/modules/nexmo.py
index 7461c1cb97..39f127f98c 100644
--- a/plugins/modules/nexmo.py
+++ b/plugins/modules/nexmo.py
@@ -50,7 +50,7 @@ options:
required: true
validate_certs:
description:
- - If C(false), SSL certificates will not be validated. This should only be used
+ - 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: true
diff --git a/plugins/modules/nomad_job_info.py b/plugins/modules/nomad_job_info.py
index 5ee25a57a4..00076ffed1 100644
--- a/plugins/modules/nomad_job_info.py
+++ b/plugins/modules/nomad_job_info.py
@@ -29,8 +29,6 @@ options:
- Name of job for Get info.
- If not specified, lists all jobs.
type: str
-notes:
- - C(check_mode) is supported.
seealso:
- name: Nomad jobs documentation
description: Complete documentation for Nomad API jobs.
diff --git a/plugins/modules/nsupdate.py b/plugins/modules/nsupdate.py
index b2a84f76ba..ac3c695cf2 100644
--- a/plugins/modules/nsupdate.py
+++ b/plugins/modules/nsupdate.py
@@ -45,27 +45,27 @@ options:
type: str
port:
description:
- - Use this TCP port when connecting to C(server).
+ - Use this TCP port when connecting to O(server).
default: 53
type: int
key_name:
description:
- - Use TSIG key name to authenticate against DNS C(server)
+ - Use TSIG key name to authenticate against DNS O(server)
type: str
key_secret:
description:
- - Use TSIG key secret, associated with C(key_name), to authenticate against C(server)
+ - Use TSIG key secret, associated with O(key_name), to authenticate against O(server)
type: str
key_algorithm:
description:
- - Specify key algorithm used by C(key_secret).
+ - Specify key algorithm used by O(key_secret).
choices: ['HMAC-MD5.SIG-ALG.REG.INT', 'hmac-md5', 'hmac-sha1', 'hmac-sha224', 'hmac-sha256', 'hmac-sha384',
'hmac-sha512']
default: 'hmac-md5'
type: str
zone:
description:
- - DNS record will be modified on this C(zone).
+ - DNS record will be modified on this O(zone).
- When omitted DNS will be queried to attempt finding the correct zone.
- Starting with Ansible 2.7 this parameter is optional.
type: str
diff --git a/plugins/modules/odbc.py b/plugins/modules/odbc.py
index fbc4b63ae5..2ee544e8d1 100644
--- a/plugins/modules/odbc.py
+++ b/plugins/modules/odbc.py
@@ -43,7 +43,7 @@ options:
description:
- Perform a commit after the execution of the SQL query.
- Some databases allow a commit after a select whereas others raise an exception.
- - Default is C(true) to support legacy module behavior.
+ - Default is V(true) to support legacy module behavior.
type: bool
default: true
version_added: 1.3.0
diff --git a/plugins/modules/one_host.py b/plugins/modules/one_host.py
index c4578f9501..eea1121733 100644
--- a/plugins/modules/one_host.py
+++ b/plugins/modules/one_host.py
@@ -38,11 +38,11 @@ options:
state:
description:
- Takes the host to the desired lifecycle state.
- - If C(absent) the host will be deleted from the cluster.
- - If C(present) the host will be created in the cluster (includes C(enabled), C(disabled) and C(offline) states).
- - If C(enabled) the host is fully operational.
- - C(disabled), e.g. to perform maintenance operations.
- - C(offline), host is totally offline.
+ - If V(absent) the host will be deleted from the cluster.
+ - If V(present) the host will be created in the cluster (includes V(enabled), V(disabled) and V(offline) states).
+ - If V(enabled) the host is fully operational.
+ - V(disabled), e.g. to perform maintenance operations.
+ - V(offline), host is totally offline.
choices:
- absent
- present
diff --git a/plugins/modules/one_image.py b/plugins/modules/one_image.py
index a50b33e93e..a0081a0fe0 100644
--- a/plugins/modules/one_image.py
+++ b/plugins/modules/one_image.py
@@ -29,32 +29,32 @@ options:
- 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.
type: str
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.
type: str
api_password:
description:
- Password of the user to login into OpenNebula RPC server. If not set
- - then the value of the C(ONE_PASSWORD) environment variable is used.
+ - then the value of the E(ONE_PASSWORD) environment variable is used.
type: str
id:
description:
- - A C(id) of the image you would like to manage.
+ - A O(id) of the image you would like to manage.
type: int
name:
description:
- - A C(name) of the image you would like to manage.
+ - A O(name) of the image you would like to manage.
type: str
state:
description:
- - C(present) - state that is used to manage the image
- - C(absent) - delete the image
- - C(cloned) - clone the image
- - C(renamed) - rename the image to the C(new_name)
+ - V(present) - state that is used to manage the image
+ - V(absent) - delete the image
+ - V(cloned) - clone the image
+ - V(renamed) - rename the image to the O(new_name)
choices: ["present", "absent", "cloned", "renamed"]
default: present
type: str
@@ -65,7 +65,7 @@ options:
new_name:
description:
- A name that will be assigned to the existing or new image.
- - In the case of cloning, by default C(new_name) will take the name of the origin image with the prefix 'Copy of'.
+ - In the case of cloning, by default O(new_name) will take the name of the origin image with the prefix 'Copy of'.
type: str
author:
- "Milan Ilic (@ilicmilan)"
diff --git a/plugins/modules/one_image_info.py b/plugins/modules/one_image_info.py
index 938f0ef2a4..3b270e3ad5 100644
--- a/plugins/modules/one_image_info.py
+++ b/plugins/modules/one_image_info.py
@@ -26,17 +26,17 @@ options:
- 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.
type: str
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.
type: str
api_password:
description:
- Password of the user to login into OpenNebula RPC server. If not set
- - then the value of the C(ONE_PASSWORD) environment variable is used.
+ - then the value of the E(ONE_PASSWORD) environment variable is used.
type: str
ids:
description:
@@ -46,10 +46,10 @@ options:
elements: str
name:
description:
- - A C(name) of the image whose facts will be gathered.
- - If the C(name) begins with '~' the C(name) will be used as regex pattern
+ - A O(name) of the image whose facts will be gathered.
+ - If the O(name) begins with V(~) the O(name) will be used as regex pattern
- which restricts the list of images (whose facts will be returned) whose names match specified regex.
- - Also, if the C(name) begins with '~*' case-insensitive matching will be performed.
+ - Also, if the O(name) begins with V(~*) case-insensitive matching will be performed.
- See examples for more details.
type: str
author:
diff --git a/plugins/modules/oneandone_server.py b/plugins/modules/oneandone_server.py
index 59f5041785..784e12ab39 100644
--- a/plugins/modules/oneandone_server.py
+++ b/plugins/modules/oneandone_server.py
@@ -62,7 +62,7 @@ options:
- The instance size name or ID of the server.
It is required only for 'present' state, and it is mutually exclusive with
vcore, cores_per_processor, ram, and hdds parameters.
- - 'The available choices are: C(S), C(M), C(L), C(XL), C(XXL), C(3XL), C(4XL), C(5XL)'
+ - 'The available choices are: V(S), V(M), V(L), V(XL), V(XXL), V(3XL), V(4XL), V(5XL)'
type: str
vcore:
description:
diff --git a/plugins/modules/oneview_enclosure_info.py b/plugins/modules/oneview_enclosure_info.py
index 3e593b7ae8..946907f96c 100644
--- a/plugins/modules/oneview_enclosure_info.py
+++ b/plugins/modules/oneview_enclosure_info.py
@@ -34,7 +34,7 @@ options:
options:
description:
- "List with options to gather additional information about an Enclosure and related resources.
- Options allowed: C(script), C(environmentalConfiguration), and C(utilization). For the option C(utilization),
+ Options allowed: V(script), V(environmentalConfiguration), and V(utilization). For the option V(utilization),
you can provide specific parameters."
type: list
elements: raw
diff --git a/plugins/modules/oneview_ethernet_network.py b/plugins/modules/oneview_ethernet_network.py
index 8eb63db5aa..981d949cdc 100644
--- a/plugins/modules/oneview_ethernet_network.py
+++ b/plugins/modules/oneview_ethernet_network.py
@@ -28,9 +28,9 @@ options:
state:
description:
- Indicates the desired state for the Ethernet Network resource.
- - C(present) will ensure data properties are compliant with OneView.
- - C(absent) will remove the resource from OneView, if it exists.
- - C(default_bandwidth_reset) will reset the network connection template to the default.
+ - V(present) will ensure data properties are compliant with OneView.
+ - V(absent) will remove the resource from OneView, if it exists.
+ - V(default_bandwidth_reset) will reset the network connection template to the default.
type: str
default: present
choices: [present, absent, default_bandwidth_reset]
diff --git a/plugins/modules/oneview_ethernet_network_info.py b/plugins/modules/oneview_ethernet_network_info.py
index e107f3b479..0bbf6a10fd 100644
--- a/plugins/modules/oneview_ethernet_network_info.py
+++ b/plugins/modules/oneview_ethernet_network_info.py
@@ -33,7 +33,7 @@ options:
options:
description:
- "List with options to gather additional information about an Ethernet Network and related resources.
- Options allowed: C(associatedProfiles) and C(associatedUplinkGroups)."
+ Options allowed: V(associatedProfiles) and V(associatedUplinkGroups)."
type: list
elements: str
extends_documentation_fragment:
diff --git a/plugins/modules/oneview_fc_network.py b/plugins/modules/oneview_fc_network.py
index 4c5f867e23..9f0c4358b7 100644
--- a/plugins/modules/oneview_fc_network.py
+++ b/plugins/modules/oneview_fc_network.py
@@ -25,8 +25,8 @@ options:
state:
description:
- Indicates the desired state for the Fibre Channel Network resource.
- C(present) will ensure data properties are compliant with OneView.
- C(absent) will remove the resource from OneView, if it exists.
+ V(present) will ensure data properties are compliant with OneView.
+ V(absent) will remove the resource from OneView, if it exists.
type: str
choices: ['present', 'absent']
required: true
diff --git a/plugins/modules/oneview_fcoe_network.py b/plugins/modules/oneview_fcoe_network.py
index 73eef5af08..5686f56b23 100644
--- a/plugins/modules/oneview_fcoe_network.py
+++ b/plugins/modules/oneview_fcoe_network.py
@@ -26,8 +26,8 @@ options:
state:
description:
- Indicates the desired state for the FCoE Network resource.
- C(present) will ensure data properties are compliant with OneView.
- C(absent) will remove the resource from OneView, if it exists.
+ V(present) will ensure data properties are compliant with OneView.
+ V(absent) will remove the resource from OneView, if it exists.
type: str
default: present
choices: ['present', 'absent']
diff --git a/plugins/modules/oneview_logical_interconnect_group.py b/plugins/modules/oneview_logical_interconnect_group.py
index cd8e875285..d1303f011a 100644
--- a/plugins/modules/oneview_logical_interconnect_group.py
+++ b/plugins/modules/oneview_logical_interconnect_group.py
@@ -29,8 +29,8 @@ options:
state:
description:
- Indicates the desired state for the Logical Interconnect Group resource.
- C(absent) will remove the resource from OneView, if it exists.
- C(present) will ensure data properties are compliant with OneView.
+ V(absent) will remove the resource from OneView, if it exists.
+ V(present) will ensure data properties are compliant with OneView.
type: str
choices: [absent, present]
default: present
diff --git a/plugins/modules/oneview_network_set.py b/plugins/modules/oneview_network_set.py
index a6a62a05c2..0efd417d63 100644
--- a/plugins/modules/oneview_network_set.py
+++ b/plugins/modules/oneview_network_set.py
@@ -28,8 +28,8 @@ options:
state:
description:
- Indicates the desired state for the Network Set resource.
- - C(present) will ensure data properties are compliant with OneView.
- - C(absent) will remove the resource from OneView, if it exists.
+ - V(present) will ensure data properties are compliant with OneView.
+ - V(absent) will remove the resource from OneView, if it exists.
type: str
default: present
choices: ['present', 'absent']
diff --git a/plugins/modules/oneview_network_set_info.py b/plugins/modules/oneview_network_set_info.py
index d1a1f2913f..e9272d8e1c 100644
--- a/plugins/modules/oneview_network_set_info.py
+++ b/plugins/modules/oneview_network_set_info.py
@@ -34,8 +34,8 @@ options:
options:
description:
- "List with options to gather information about Network Set.
- Option allowed: C(withoutEthernet).
- The option C(withoutEthernet) retrieves the list of network_sets excluding Ethernet networks."
+ Option allowed: V(withoutEthernet).
+ The option V(withoutEthernet) retrieves the list of network_sets excluding Ethernet networks."
type: list
elements: str
diff --git a/plugins/modules/oneview_san_manager.py b/plugins/modules/oneview_san_manager.py
index 65a016b1c2..15282aec21 100644
--- a/plugins/modules/oneview_san_manager.py
+++ b/plugins/modules/oneview_san_manager.py
@@ -28,9 +28,9 @@ options:
state:
description:
- Indicates the desired state for the Uplink Set resource.
- - C(present) ensures data properties are compliant with OneView.
- - C(absent) removes the resource from OneView, if it exists.
- - C(connection_information_set) updates the connection information for the SAN Manager. This operation is non-idempotent.
+ - V(present) ensures data properties are compliant with OneView.
+ - V(absent) removes the resource from OneView, if it exists.
+ - V(connection_information_set) updates the connection information for the SAN Manager. This operation is non-idempotent.
type: str
default: present
choices: [present, absent, connection_information_set]
diff --git a/plugins/modules/oneview_san_manager_info.py b/plugins/modules/oneview_san_manager_info.py
index 9b00a6bb5d..d3211e53a1 100644
--- a/plugins/modules/oneview_san_manager_info.py
+++ b/plugins/modules/oneview_san_manager_info.py
@@ -34,10 +34,10 @@ options:
description:
- List of params to delimit, filter and sort the list of resources.
- "params allowed:
- - C(start): The first item to return, using 0-based indexing.
- - C(count): The number of resources to return.
- - C(query): A general query string to narrow the list of resources returned.
- - C(sort): The sort order of the returned data set."
+ - V(start): The first item to return, using 0-based indexing.
+ - V(count): The number of resources to return.
+ - V(query): A general query string to narrow the list of resources returned.
+ - V(sort): The sort order of the returned data set."
type: dict
extends_documentation_fragment:
- community.general.oneview
diff --git a/plugins/modules/opkg.py b/plugins/modules/opkg.py
index 308e1e85ec..86dd5c9d80 100644
--- a/plugins/modules/opkg.py
+++ b/plugins/modules/opkg.py
@@ -46,7 +46,7 @@ options:
force:
description:
- The C(opkg --force) parameter used.
- - Passing C("") as value and not passing any value at all have both
+ - Passing V("") as value and not passing any value at all have both
the same effect of B(not) using any C(--force-) parameter.
choices:
- ""
diff --git a/plugins/modules/osx_defaults.py b/plugins/modules/osx_defaults.py
index 4233841e60..d84ebf298c 100644
--- a/plugins/modules/osx_defaults.py
+++ b/plugins/modules/osx_defaults.py
@@ -38,7 +38,7 @@ options:
host:
description:
- The host on which the preference should apply.
- - The special value C(currentHost) corresponds to the C(-currentHost) switch of the defaults commandline tool.
+ - The special value V(currentHost) corresponds to the C(-currentHost) switch of the defaults commandline tool.
type: str
key:
description:
@@ -63,7 +63,7 @@ options:
state:
description:
- The state of the user defaults.
- - If set to V(list) will query the given parameter specified by C(key). Returns 'null' is nothing found or mis-spelled.
+ - If set to V(list) will query the given parameter specified by O(key). Returns V(null) is nothing found or mis-spelled.
- V(list) added in Ansible 2.8.
type: str
choices: [ absent, list, present ]
diff --git a/plugins/modules/packet_ip_subnet.py b/plugins/modules/packet_ip_subnet.py
index afeb7ea04c..642be7823f 100644
--- a/plugins/modules/packet_ip_subnet.py
+++ b/plugins/modules/packet_ip_subnet.py
@@ -40,7 +40,7 @@ attributes:
options:
auth_token:
description:
- - Packet API token. You can also supply it in env var C(PACKET_API_TOKEN).
+ - Packet API token. You can also supply it in environment variable E(PACKET_API_TOKEN).
type: str
hostname:
@@ -77,9 +77,9 @@ options:
state:
description:
- Desired state of the IP subnet on the specified device.
- - With state == C(present), you must specify either hostname or device_id. Subnet with given CIDR will then be assigned to the specified device.
- - With state == C(absent), you can specify either hostname or device_id. The subnet will be removed from specified devices.
- - If you leave both hostname and device_id empty, the subnet will be removed from any device it's assigned to.
+ - With O(state=present), you must specify either O(hostname) or O(device_id). Subnet with given CIDR will then be assigned to the specified device.
+ - With O(state=absent), you can specify either O(hostname) or O(device_id). The subnet will be removed from specified devices.
+ - If you leave both O(hostname) and O(device_id) empty, the subnet will be removed from any device it's assigned to.
choices: ['present', 'absent']
default: 'present'
type: str
diff --git a/plugins/modules/packet_project.py b/plugins/modules/packet_project.py
index da4a2bb89f..5b4143d5b7 100644
--- a/plugins/modules/packet_project.py
+++ b/plugins/modules/packet_project.py
@@ -51,7 +51,7 @@ options:
auth_token:
description:
- - Packet api token. You can also supply it in env var C(PACKET_API_TOKEN).
+ - Packet api token. You can also supply it in environment variable E(PACKET_API_TOKEN).
type: str
name:
diff --git a/plugins/modules/packet_sshkey.py b/plugins/modules/packet_sshkey.py
index 97f55ba23b..7600d9d34d 100644
--- a/plugins/modules/packet_sshkey.py
+++ b/plugins/modules/packet_sshkey.py
@@ -32,7 +32,7 @@ options:
type: str
auth_token:
description:
- - Packet API token. You can also supply it in env var C(PACKET_API_TOKEN).
+ - Packet API token. You can also supply it in environment variable E(PACKET_API_TOKEN).
type: str
label:
description:
diff --git a/plugins/modules/packet_volume.py b/plugins/modules/packet_volume.py
index 910d64b55b..4090c97ce6 100644
--- a/plugins/modules/packet_volume.py
+++ b/plugins/modules/packet_volume.py
@@ -50,7 +50,7 @@ options:
auth_token:
description:
- - Packet API token. You can also supply it in env var C(PACKET_API_TOKEN).
+ - Packet API token. You can also supply it in environment variable E(PACKET_API_TOKEN).
type: str
name:
diff --git a/plugins/modules/packet_volume_attachment.py b/plugins/modules/packet_volume_attachment.py
index 7f6c68e054..50a1c00394 100644
--- a/plugins/modules/packet_volume_attachment.py
+++ b/plugins/modules/packet_volume_attachment.py
@@ -48,7 +48,7 @@ options:
auth_token:
description:
- - Packet API token. You can also supply it in env var C(PACKET_API_TOKEN).
+ - Packet API token. You can also supply it in environment variable E(PACKET_API_TOKEN).
type: str
project_id:
diff --git a/plugins/modules/pamd.py b/plugins/modules/pamd.py
index 6ffc8624e9..f6bff64113 100644
--- a/plugins/modules/pamd.py
+++ b/plugins/modules/pamd.py
@@ -37,7 +37,7 @@ options:
type:
description:
- The type of the PAM rule being modified.
- - The C(type), C(control) and C(module_path) all must match a rule to be modified.
+ - The O(type), O(control), and O(module_path) options all must match a rule to be modified.
type: str
required: true
choices: [ account, -account, auth, -auth, password, -password, session, -session ]
@@ -46,13 +46,13 @@ options:
- The control of the PAM rule being modified.
- This may be a complicated control with brackets. If this is the case, be
sure to put "[bracketed controls]" in quotes.
- - The C(type), C(control) and C(module_path) all must match a rule to be modified.
+ - The O(type), O(control), and O(module_path) options all must match a rule to be modified.
type: str
required: true
module_path:
description:
- The module path of the PAM rule being modified.
- - The C(type), C(control) and C(module_path) all must match a rule to be modified.
+ - The O(type), O(control), and O(module_path) options all must match a rule to be modified.
type: str
required: true
new_type:
@@ -70,9 +70,9 @@ options:
type: str
module_arguments:
description:
- - When state is C(updated), the module_arguments will replace existing module_arguments.
- - When state is C(args_absent) args matching those listed in module_arguments will be removed.
- - When state is C(args_present) any args listed in module_arguments are added if
+ - When O(state=updated), the O(module_arguments) will replace existing module_arguments.
+ - When O(state=args_absent) args matching those listed in O(module_arguments) will be removed.
+ - When O(state=args_present) any args listed in O(module_arguments) are added if
missing from the existing rule.
- Furthermore, if the module argument takes a value denoted by C(=),
the value will be changed to that specified in module_arguments.
@@ -80,15 +80,15 @@ options:
elements: str
state:
description:
- - The default of C(updated) will modify an existing rule if type,
+ - The default of V(updated) will modify an existing rule if type,
control and module_path all match an existing rule.
- - With C(before), the new rule will be inserted before a rule matching type,
+ - With V(before), the new rule will be inserted before a rule matching type,
control and module_path.
- - Similarly, with C(after), the new rule will be inserted after an existing rulematching type,
+ - Similarly, with V(after), the new rule will be inserted after an existing rulematching type,
control and module_path.
- - With either C(before) or C(after) new_type, new_control, and new_module_path must all be specified.
- - If state is C(args_absent) or C(args_present), new_type, new_control, and new_module_path will be ignored.
- - State C(absent) will remove the rule. The 'absent' state was added in Ansible 2.4.
+ - With either V(before) or V(after) O(new_type), O(new_control), and O(new_module_path) must all be specified.
+ - If state is V(args_absent) or V(args_present), O(new_type), O(new_control), and O(new_module_path) will be ignored.
+ - State V(absent) will remove the rule. The V(absent) state was added in Ansible 2.4.
type: str
choices: [ absent, before, after, args_absent, args_present, updated ]
default: updated
diff --git a/plugins/modules/pear.py b/plugins/modules/pear.py
index d7cb01b920..8ac61f4985 100644
--- a/plugins/modules/pear.py
+++ b/plugins/modules/pear.py
@@ -53,7 +53,7 @@ options:
- "To specify an answer, the item will be a dict with the regular expression as key and the answer as value C(my_regular_expression: 'an_answer')."
- You can provide a list containing items with or without answer.
- A prompt list can be shorter or longer than the packages list but will issue a warning.
- - If you want to specify that a package will not need prompts in the middle of a list, C(null).
+ - If you want to specify that a package will not need prompts in the middle of a list, V(null).
type: list
elements: raw
version_added: 0.2.0
diff --git a/plugins/modules/pip_package_info.py b/plugins/modules/pip_package_info.py
index 2cde7218d4..6aea178cec 100644
--- a/plugins/modules/pip_package_info.py
+++ b/plugins/modules/pip_package_info.py
@@ -21,7 +21,7 @@ options:
clients:
description:
- A list of the pip executables that will be used to get the packages.
- They can be supplied with the full path or just the executable name, for example C(pip3.7).
+ They can be supplied with the full path or just the executable name, for example V(pip3.7).
default: ['pip']
required: false
type: list
diff --git a/plugins/modules/portage.py b/plugins/modules/portage.py
index 1c6b365376..112f6d2d7c 100644
--- a/plugins/modules/portage.py
+++ b/plugins/modules/portage.py
@@ -33,7 +33,7 @@ attributes:
options:
package:
description:
- - Package atom or set, e.g. C(sys-apps/foo) or C(>foo-2.13) or C(@world)
+ - Package atom or set, for example V(sys-apps/foo) or V(>foo-2.13) or V(@world)
aliases: [name]
type: list
elements: str
@@ -124,8 +124,8 @@ options:
sync:
description:
- Sync package repositories first
- - If C(yes), perform "emerge --sync"
- - If C(web), perform "emerge-webrsync"
+ - If V(yes), perform "emerge --sync"
+ - If V(web), perform "emerge-webrsync"
choices: [ "web", "yes", "no" ]
type: str
diff --git a/plugins/modules/profitbricks.py b/plugins/modules/profitbricks.py
index c8bcceb936..84082998df 100644
--- a/plugins/modules/profitbricks.py
+++ b/plugins/modules/profitbricks.py
@@ -130,7 +130,7 @@ options:
state:
description:
- create or terminate instances
- - 'The choices available are: C(running), C(stopped), C(absent), C(present).'
+ - 'The choices available are: V(running), V(stopped), V(absent), V(present).'
type: str
default: 'present'
disk_type:
diff --git a/plugins/modules/profitbricks_datacenter.py b/plugins/modules/profitbricks_datacenter.py
index a096db752d..4aa1fa5eeb 100644
--- a/plugins/modules/profitbricks_datacenter.py
+++ b/plugins/modules/profitbricks_datacenter.py
@@ -63,7 +63,7 @@ options:
state:
description:
- Create or terminate datacenters.
- - "The available choices are: C(present), C(absent)."
+ - "The available choices are: V(present), V(absent)."
type: str
required: false
default: 'present'
diff --git a/plugins/modules/profitbricks_nic.py b/plugins/modules/profitbricks_nic.py
index 17a30b052c..9498be15dc 100644
--- a/plugins/modules/profitbricks_nic.py
+++ b/plugins/modules/profitbricks_nic.py
@@ -65,7 +65,7 @@ options:
state:
description:
- Indicate desired state of the resource
- - "The available choices are: C(present), C(absent)."
+ - "The available choices are: V(present), V(absent)."
type: str
required: false
default: 'present'
diff --git a/plugins/modules/profitbricks_volume.py b/plugins/modules/profitbricks_volume.py
index f9d257b682..f623da7128 100644
--- a/plugins/modules/profitbricks_volume.py
+++ b/plugins/modules/profitbricks_volume.py
@@ -68,7 +68,7 @@ options:
licence_type:
description:
- The licence type for the volume. This is used when the image is non-standard.
- - "The available choices are: C(LINUX), C(WINDOWS), C(UNKNOWN), C(OTHER)."
+ - "The available choices are: V(LINUX), V(WINDOWS), V(UNKNOWN), V(OTHER)."
type: str
required: false
default: UNKNOWN
@@ -113,7 +113,7 @@ options:
state:
description:
- create or terminate datacenters
- - "The available choices are: C(present), C(absent)."
+ - "The available choices are: V(present), V(absent)."
type: str
required: false
default: 'present'
diff --git a/plugins/modules/profitbricks_volume_attachments.py b/plugins/modules/profitbricks_volume_attachments.py
index 75cd73df3c..76459515ee 100644
--- a/plugins/modules/profitbricks_volume_attachments.py
+++ b/plugins/modules/profitbricks_volume_attachments.py
@@ -58,7 +58,7 @@ options:
state:
description:
- Indicate desired state of the resource
- - "The available choices are: C(present), C(absent)."
+ - "The available choices are: V(present), V(absent)."
type: str
required: false
default: 'present'
diff --git a/plugins/modules/python_requirements_info.py b/plugins/modules/python_requirements_info.py
index 8bf2a843fc..63c33cc983 100644
--- a/plugins/modules/python_requirements_info.py
+++ b/plugins/modules/python_requirements_info.py
@@ -23,8 +23,8 @@ options:
description: >
A list of version-likes or module names to check for installation.
Supported operators: <, >, <=, >=, or ==. The bare module name like
- C(ansible), the module with a specific version like C(boto3==1.6.1), or a
- partial version like C(requests>2) are all valid specifications.
+ V(ansible), the module with a specific version like V(boto3==1.6.1), or a
+ partial version like V(requests>2) are all valid specifications.
default: []
author:
- Will Thames (@willthames)
diff --git a/plugins/modules/rax_cdb.py b/plugins/modules/rax_cdb.py
index 687b6ff249..9538579fad 100644
--- a/plugins/modules/rax_cdb.py
+++ b/plugins/modules/rax_cdb.py
@@ -47,7 +47,7 @@ options:
type: str
description:
- version of database (MySQL supports 5.1 and 5.6, MariaDB supports 10, Percona supports 5.6)
- - "The available choices are: C(5.1), C(5.6) and C(10)."
+ - "The available choices are: V(5.1), V(5.6) and V(10)."
default: '5.6'
aliases: ['version']
state:
diff --git a/plugins/modules/rax_dns_record.py b/plugins/modules/rax_dns_record.py
index d4a0eeae22..e414ca6e95 100644
--- a/plugins/modules/rax_dns_record.py
+++ b/plugins/modules/rax_dns_record.py
@@ -93,7 +93,7 @@ notes:
the Rackspace CloudDNS API"
- To manipulate a C(PTR) record either C(loadbalancer) or C(server) must be
supplied
- - As of version 1.7, the C(type) field is required and no longer defaults to an C(A) record.
+ - As of version 1.7, the O(type) field is required and no longer defaults to an C(A) record.
- C(PTR) record support was added in version 1.7
author: "Matt Martz (@sivel)"
extends_documentation_fragment:
diff --git a/plugins/modules/rax_mon_alarm.py b/plugins/modules/rax_mon_alarm.py
index 72b67a91eb..b66611a90f 100644
--- a/plugins/modules/rax_mon_alarm.py
+++ b/plugins/modules/rax_mon_alarm.py
@@ -28,7 +28,7 @@ options:
state:
type: str
description:
- - Ensure that the alarm with this C(label) exists or does not exist.
+ - Ensure that the alarm with this O(label) exists or does not exist.
choices: [ "present", "absent" ]
required: false
default: present
diff --git a/plugins/modules/rax_mon_notification.py b/plugins/modules/rax_mon_notification.py
index 91d0793593..7539f2a378 100644
--- a/plugins/modules/rax_mon_notification.py
+++ b/plugins/modules/rax_mon_notification.py
@@ -26,7 +26,7 @@ options:
state:
type: str
description:
- - Ensure that the notification with this C(label) exists or does not exist.
+ - Ensure that the notification with this O(label) exists or does not exist.
choices: ['present', 'absent']
default: present
label:
diff --git a/plugins/modules/rax_mon_notification_plan.py b/plugins/modules/rax_mon_notification_plan.py
index d64dee7736..31647304b9 100644
--- a/plugins/modules/rax_mon_notification_plan.py
+++ b/plugins/modules/rax_mon_notification_plan.py
@@ -27,7 +27,7 @@ options:
state:
type: str
description:
- - Ensure that the notification plan with this C(label) exists or does not
+ - Ensure that the notification plan with this O(label) exists or does not
exist.
choices: ['present', 'absent']
default: present
diff --git a/plugins/modules/redis.py b/plugins/modules/redis.py
index 1778a067e4..a212d3145c 100644
--- a/plugins/modules/redis.py
+++ b/plugins/modules/redis.py
@@ -26,9 +26,9 @@ options:
command:
description:
- The selected redis command
- - C(config) ensures a configuration setting on an instance.
- - C(flush) flushes all the instance or a specified db.
- - C(replica) sets a redis instance in replica or master mode. (C(slave) is an alias for C(replica).)
+ - V(config) ensures a configuration setting on an instance.
+ - V(flush) flushes all the instance or a specified db.
+ - V(replica) sets a redis instance in replica or master mode. (V(slave) is an alias for V(replica).)
choices: [ config, flush, replica, slave ]
type: str
tls:
@@ -51,7 +51,7 @@ options:
replica_mode:
description:
- The mode of the redis instance [replica command]
- - C(slave) is an alias for C(replica).
+ - V(slave) is an alias for V(replica).
default: replica
choices: [ master, replica, slave ]
type: str
diff --git a/plugins/modules/redis_data.py b/plugins/modules/redis_data.py
index c0c8dcc9a6..fe5cc07ef9 100644
--- a/plugins/modules/redis_data.py
+++ b/plugins/modules/redis_data.py
@@ -121,12 +121,12 @@ EXAMPLES = '''
RETURN = '''
old_value:
description: Value of key before setting.
- returned: on_success if state is C(present) and key exists in database.
+ returned: on_success if O(state=present) and key exists in database.
type: str
sample: 'old_value_of_key'
value:
description: Value key was set to.
- returned: on success if state is C(present).
+ returned: on success if O(state=present).
type: str
sample: 'new_value_of_key'
msg:
diff --git a/plugins/modules/rhn_channel.py b/plugins/modules/rhn_channel.py
index 5a89a3a3e4..b69bb0c686 100644
--- a/plugins/modules/rhn_channel.py
+++ b/plugins/modules/rhn_channel.py
@@ -60,8 +60,8 @@ options:
type: str
validate_certs:
description:
- - If C(False), SSL certificates will not be validated.
- - This should only set to C(False) when used on self controlled sites
+ - If V(false), SSL certificates will not be validated.
+ - This should only set to V(false) when used on self controlled sites
using self-signed certificates, and you are absolutely sure that nobody
can modify traffic between the module and the site.
type: bool
diff --git a/plugins/modules/riak.py b/plugins/modules/riak.py
index 024e5424d2..fe295d2d6d 100644
--- a/plugins/modules/riak.py
+++ b/plugins/modules/riak.py
@@ -64,7 +64,7 @@ options:
type: str
validate_certs:
description:
- - If C(false), SSL certificates will not be validated. This should only be used
+ - 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: true
diff --git a/plugins/modules/rollbar_deployment.py b/plugins/modules/rollbar_deployment.py
index 314e65bc6c..4bce9ab980 100644
--- a/plugins/modules/rollbar_deployment.py
+++ b/plugins/modules/rollbar_deployment.py
@@ -63,7 +63,7 @@ options:
default: 'https://api.rollbar.com/api/1/deploy/'
validate_certs:
description:
- - If C(false), SSL certificates for the target url will not be validated.
+ - If V(false), SSL certificates for the target url will not be validated.
This should only be used on personally controlled sites using
self-signed certificates.
required: false
diff --git a/plugins/modules/rpm_ostree_pkg.py b/plugins/modules/rpm_ostree_pkg.py
index 52219cd1ba..826c33f2d1 100644
--- a/plugins/modules/rpm_ostree_pkg.py
+++ b/plugins/modules/rpm_ostree_pkg.py
@@ -35,8 +35,8 @@ options:
state:
description:
- State of the overlay package.
- - C(present) simply ensures that a desired package is installed.
- - C(absent) removes the specified package.
+ - V(present) simply ensures that a desired package is installed.
+ - V(absent) removes the specified package.
choices: [ 'absent', 'present' ]
default: 'present'
type: str
diff --git a/plugins/modules/runit.py b/plugins/modules/runit.py
index 7c5882af88..2f1609ca6e 100644
--- a/plugins/modules/runit.py
+++ b/plugins/modules/runit.py
@@ -31,11 +31,11 @@ options:
required: true
state:
description:
- - C(started)/C(stopped) are idempotent actions that will not run
- commands unless necessary. C(restarted) will always bounce the
- service (sv restart) and C(killed) will always bounce the service (sv force-stop).
- C(reloaded) will send a HUP (sv reload).
- C(once) will run a normally downed sv once (sv once), not really
+ - V(started)/V(stopped) are idempotent actions that will not run
+ commands unless necessary. V(restarted) will always bounce the
+ service (sv restart) and V(killed) will always bounce the service (sv force-stop).
+ V(reloaded) will send a HUP (sv reload).
+ V(once) will run a normally downed sv once (sv once), not really
an idempotent operation.
type: str
choices: [ killed, once, reloaded, restarted, started, stopped ]
diff --git a/plugins/modules/selinux_permissive.py b/plugins/modules/selinux_permissive.py
index 7249a01b82..80439e1de7 100644
--- a/plugins/modules/selinux_permissive.py
+++ b/plugins/modules/selinux_permissive.py
@@ -37,7 +37,7 @@ options:
no_reload:
description:
- Disable reloading of the SELinux policy after making change to a domain's permissive setting.
- - The default is C(false), which causes policy to be reloaded when a domain changes state.
+ - The default is V(false), which causes policy to be reloaded when a domain changes state.
- Reloading the policy does not work on older versions of the C(policycoreutils-python) library, for example in EL 6."
type: bool
default: false
diff --git a/plugins/modules/sensu_client.py b/plugins/modules/sensu_client.py
index 2e0bd12eec..eca0804b0a 100644
--- a/plugins/modules/sensu_client.py
+++ b/plugins/modules/sensu_client.py
@@ -77,7 +77,7 @@ options:
deregister:
description:
- If a deregistration event should be created upon Sensu client process stop.
- - Default is C(false).
+ - Default is V(false).
type: bool
deregistration:
type: dict
diff --git a/plugins/modules/serverless.py b/plugins/modules/serverless.py
index 67d673d4d7..8aa9396d62 100644
--- a/plugins/modules/serverless.py
+++ b/plugins/modules/serverless.py
@@ -46,13 +46,13 @@ options:
region:
description:
- AWS region to deploy the service to.
- - This parameter defaults to C(us-east-1).
+ - This parameter defaults to V(us-east-1).
type: str
default: ''
deploy:
description:
- Whether or not to deploy artifacts after building them.
- - When this option is C(false) all the functions will be built, but no stack update will be run to send them out.
+ - When this option is V(false) all the functions will be built, but no stack update will be run to send them out.
- This is mostly useful for generating artifacts to be stored/deployed elsewhere.
type: bool
default: true
diff --git a/plugins/modules/shutdown.py b/plugins/modules/shutdown.py
index f4a9c1acf6..d8108425eb 100644
--- a/plugins/modules/shutdown.py
+++ b/plugins/modules/shutdown.py
@@ -12,7 +12,7 @@ DOCUMENTATION = r'''
module: shutdown
short_description: Shut down a machine
notes:
- - C(PATH) is ignored on the remote node when searching for the C(shutdown) command. Use O(search_paths)
+ - E(PATH) is ignored on the remote node when searching for the C(shutdown) command. Use O(search_paths)
to specify locations to search if the default paths do not work.
- The O(msg) and O(delay) options are not supported when a shutdown command is not found in O(search_paths), instead
the module will attempt to shutdown the system by calling C(systemctl shutdown).
@@ -47,7 +47,7 @@ options:
search_paths:
description:
- Paths to search on the remote machine for the C(shutdown) command.
- - I(Only) these paths will be searched for the C(shutdown) command. C(PATH) is ignored in the remote node when searching for the C(shutdown) command.
+ - I(Only) these paths will be searched for the C(shutdown) command. E(PATH) is ignored in the remote node when searching for the C(shutdown) command.
type: list
elements: path
default: ['/sbin', '/usr/sbin', '/usr/local/sbin']
diff --git a/plugins/modules/sl_vm.py b/plugins/modules/sl_vm.py
index 94055d1d22..3a5286c2a1 100644
--- a/plugins/modules/sl_vm.py
+++ b/plugins/modules/sl_vm.py
@@ -158,7 +158,7 @@ options:
state:
description:
- Create, or cancel a virtual instance.
- - Specify C(present) for create, C(absent) to cancel.
+ - Specify V(present) for create, V(absent) to cancel.
choices: [ absent, present ]
default: present
type: str
diff --git a/plugins/modules/slackpkg.py b/plugins/modules/slackpkg.py
index 208061a4cb..e3d7a15429 100644
--- a/plugins/modules/slackpkg.py
+++ b/plugins/modules/slackpkg.py
@@ -40,7 +40,7 @@ options:
state:
description:
- - state of the package, you can use "installed" as an alias for C(present) and removed as one for C(absent).
+ - State of the package, you can use V(installed) as an alias for V(present) and V(removed) as one for V(absent).
choices: [ 'present', 'absent', 'latest', 'installed', 'removed' ]
required: false
default: present
diff --git a/plugins/modules/smartos_image_info.py b/plugins/modules/smartos_image_info.py
index e93ffb9ac1..8db879b347 100644
--- a/plugins/modules/smartos_image_info.py
+++ b/plugins/modules/smartos_image_info.py
@@ -29,9 +29,9 @@ options:
filters:
description:
- Criteria for selecting image. Can be any value from image
- manifest and 'published_date', 'published', 'source', 'clones',
- and 'size'. More information can be found at U(https://smartos.org/man/1m/imgadm)
- under 'imgadm list'.
+ manifest and C(published_date), C(published), C(source), C(clones),
+ and C(size). More information can be found at U(https://smartos.org/man/1m/imgadm)
+ under C(imgadm list).
type: str
'''
diff --git a/plugins/modules/spectrum_model_attrs.py b/plugins/modules/spectrum_model_attrs.py
index 028ad7f9f3..44ef44bb07 100644
--- a/plugins/modules/spectrum_model_attrs.py
+++ b/plugins/modules/spectrum_model_attrs.py
@@ -50,7 +50,7 @@ options:
aliases: [password]
use_proxy:
description:
- - if C(false), it will not use a proxy, even if one is defined in
+ - if V(false), it will not use a proxy, even if one is defined in
an environment variable on the target hosts.
default: true
required: false
@@ -67,7 +67,7 @@ options:
required: true
validate_certs:
description:
- - Validate SSL certificates. Only change this to C(false) if you can guarantee that you are talking to the correct endpoint and there is no
+ - Validate SSL certificates. Only change this to V(false) if you can guarantee that you are talking to the correct endpoint and there is no
man-in-the-middle attack happening.
type: bool
default: true
@@ -109,7 +109,7 @@ options:
required: true
value:
description:
- - Attribute value. Empty strings should be C("") or C(null).
+ - Attribute value. Empty strings should be V("") or V(null).
type: str
required: true
'''
diff --git a/plugins/modules/spotinst_aws_elastigroup.py b/plugins/modules/spotinst_aws_elastigroup.py
index 02f2d3c5c2..5672a255b1 100644
--- a/plugins/modules/spotinst_aws_elastigroup.py
+++ b/plugins/modules/spotinst_aws_elastigroup.py
@@ -46,13 +46,13 @@ options:
description:
- A Personal API Access Token issued by Spotinst.
- >-
- When not specified, the module will try to obtain it, in that order, from: environment variable C(SPOTINST_TOKEN), or from the credentials path.
+ When not specified, the module will try to obtain it, in that order, from: environment variable E(SPOTINST_TOKEN), or from the credentials path.
type: str
availability_vs_cost:
description:
- The strategy orientation.
- - "The choices available are: C(availabilityOriented), C(costOriented), C(balanced)."
+ - "The choices available are: V(availabilityOriented), V(costOriented), V(balanced)."
required: true
type: str
@@ -127,7 +127,7 @@ options:
elastic_ips:
description:
- - List of ElasticIps Allocation Ids (Example C(eipalloc-9d4e16f8)) to associate to the group instances
+ - List of ElasticIps Allocation Ids (example V(eipalloc-9d4e16f8)) to associate to the group instances
type: list
elements: str
@@ -139,7 +139,7 @@ options:
health_check_grace_period:
description:
- The amount of time, in seconds, after the instance has launched to start and check its health.
- - If not specified, it defaults to C(300).
+ - If not specified, it defaults to V(300).
type: int
health_check_unhealthy_duration_before_replacement:
@@ -150,7 +150,7 @@ options:
health_check_type:
description:
- The service to use for the health check.
- - "The choices available are: C(ELB), C(HCS), C(TARGET_GROUP), C(MLB), C(EC2)."
+ - "The choices available are: V(ELB), V(HCS), V(TARGET_GROUP), V(MLB), V(EC2)."
type: str
iam_role_name:
@@ -283,7 +283,7 @@ options:
product:
description:
- Operation system type.
- - "Available choices are: C(Linux/UNIX), C(SUSE Linux), C(Windows), C(Linux/UNIX (Amazon VPC)), C(SUSE Linux (Amazon VPC))."
+ - "Available choices are: V(Linux/UNIX), V(SUSE Linux), V(Windows), V(Linux/UNIX (Amazon VPC)), V(SUSE Linux (Amazon VPC))."
required: true
type: str
@@ -404,7 +404,7 @@ options:
tenancy:
description:
- Dedicated vs shared tenancy.
- - "The available choices are: C(default), C(dedicated)."
+ - "The available choices are: V(default), V(dedicated)."
type: str
terminate_at_end_of_billing_hour:
@@ -415,7 +415,7 @@ options:
unit:
description:
- The capacity unit to launch instances by.
- - "The available choices are: C(instance), C(weight)."
+ - "The available choices are: V(instance), V(weight)."
type: str
up_scaling_policies:
diff --git a/plugins/modules/statsd.py b/plugins/modules/statsd.py
index 65d33b7099..8bc0f0b187 100644
--- a/plugins/modules/statsd.py
+++ b/plugins/modules/statsd.py
@@ -14,8 +14,8 @@ version_added: 2.1.0
description:
- The C(statsd) module sends metrics to StatsD.
- For more information, see U(https://statsd-metrics.readthedocs.io/en/latest/).
- - Supported metric types are C(counter) and C(gauge).
- Currently unupported metric types are C(timer), C(set), and C(gaugedelta).
+ - Supported metric types are V(counter) and V(gauge).
+ Currently unupported metric types are V(timer), V(set), and V(gaugedelta).
author: "Mark Mercado (@mamercad)"
requirements:
- statsd
@@ -30,7 +30,7 @@ options:
state:
type: str
description:
- - State of the check, only C(present) makes sense.
+ - State of the check, only V(present) makes sense.
choices: ["present"]
default: present
host:
@@ -42,7 +42,7 @@ options:
type: int
default: 8125
description:
- - The port on C(host) which StatsD is listening on.
+ - The port on O(host) which StatsD is listening on.
protocol:
type: str
default: udp
@@ -53,7 +53,7 @@ options:
type: float
default: 1.0
description:
- - Sender timeout, only applicable if C(protocol) is C(tcp).
+ - Sender timeout, only applicable if O(protocol) is V(tcp).
metric:
type: str
required: true
@@ -79,7 +79,7 @@ options:
type: bool
default: false
description:
- - If the metric is of type C(gauge), change the value by C(delta).
+ - If the metric is of type V(gauge), change the value by O(delta).
'''
EXAMPLES = '''
diff --git a/plugins/modules/svc.py b/plugins/modules/svc.py
index bd2eaeb22e..b327ddfd60 100644
--- a/plugins/modules/svc.py
+++ b/plugins/modules/svc.py
@@ -31,11 +31,11 @@ options:
required: true
state:
description:
- - C(Started)/C(stopped) are idempotent actions that will not run
- commands unless necessary. C(restarted) will always bounce the
- svc (svc -t) and C(killed) will always bounce the svc (svc -k).
- C(reloaded) will send a sigusr1 (svc -1).
- C(once) will run a normally downed svc once (svc -o), not really
+ - V(started)/V(stopped) are idempotent actions that will not run
+ commands unless necessary. V(restarted) will always bounce the
+ svc (svc -t) and V(killed) will always bounce the svc (svc -k).
+ V(reloaded) will send a sigusr1 (svc -1).
+ V(once) will run a normally downed svc once (svc -o), not really
an idempotent operation.
type: str
choices: [ killed, once, reloaded, restarted, started, stopped ]
diff --git a/plugins/modules/swdepot.py b/plugins/modules/swdepot.py
index c4660c70d5..28a8ce3145 100644
--- a/plugins/modules/swdepot.py
+++ b/plugins/modules/swdepot.py
@@ -36,7 +36,7 @@ options:
type: str
state:
description:
- - whether to install (C(present), C(latest)), or remove (C(absent)) a package.
+ - whether to install (V(present), V(latest)), or remove (V(absent)) a package.
required: true
choices: [ 'present', 'latest', 'absent']
type: str
diff --git a/plugins/modules/sysupgrade.py b/plugins/modules/sysupgrade.py
index ac80e01965..639fa345ad 100644
--- a/plugins/modules/sysupgrade.py
+++ b/plugins/modules/sysupgrade.py
@@ -43,7 +43,7 @@ options:
fetch_only:
description:
- Fetch and verify files and create /bsd.upgrade but do not reboot.
- - Set to C(false) if you want sysupgrade to reboot. This will cause Ansible to error, as it expects the module to exit gracefully. See the examples.
+ - Set to V(false) if you want sysupgrade to reboot. This will cause Ansible to error, as it expects the module to exit gracefully. See the examples.
default: true
type: bool
installurl:
diff --git a/plugins/modules/vdo.py b/plugins/modules/vdo.py
index f1ea40e2e4..8b0e745960 100644
--- a/plugins/modules/vdo.py
+++ b/plugins/modules/vdo.py
@@ -57,7 +57,7 @@ options:
activated:
description:
- The "activate" status for a VDO volume. If this is set
- to C(false), the VDO volume cannot be started, and it will
+ to V(false), the VDO volume cannot be started, and it will
not start on system startup. However, on initial
creation, a VDO volume with "activated" set to "off"
will be running, until stopped. This is the default
diff --git a/plugins/modules/vertica_role.py b/plugins/modules/vertica_role.py
index 704594a128..a1ef40c7a5 100644
--- a/plugins/modules/vertica_role.py
+++ b/plugins/modules/vertica_role.py
@@ -36,7 +36,7 @@ options:
type: str
state:
description:
- - Whether to create C(present), drop C(absent) or lock C(locked) a role.
+ - Whether to create V(present), drop V(absent) or lock V(locked) a role.
choices: ['present', 'absent']
default: present
type: str
diff --git a/plugins/modules/vertica_schema.py b/plugins/modules/vertica_schema.py
index 01f8f721e7..95e434ef3a 100644
--- a/plugins/modules/vertica_schema.py
+++ b/plugins/modules/vertica_schema.py
@@ -50,7 +50,7 @@ options:
type: str
state:
description:
- - Whether to create C(present), or drop C(absent) a schema.
+ - Whether to create V(present), or drop V(absent) a schema.
default: present
choices: ['present', 'absent']
type: str
diff --git a/plugins/modules/webfaction_app.py b/plugins/modules/webfaction_app.py
index e1893ca7a1..75682f381e 100644
--- a/plugins/modules/webfaction_app.py
+++ b/plugins/modules/webfaction_app.py
@@ -29,7 +29,7 @@ notes:
You can run playbooks that use this on a local machine, or on a Webfaction host, or elsewhere, since the scripts use the remote webfaction API.
The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you do not specify C(localhost) as
your host, you may want to add C(serial=1) to the plays.
- - See `the webfaction API `_ for more info.
+ - See L(the webfaction API, https://docs.webfaction.com/xmlrpc-api/) for more info.
extends_documentation_fragment:
- community.general.attributes
diff --git a/plugins/modules/webfaction_db.py b/plugins/modules/webfaction_db.py
index cfdc8b7175..1ab57fd890 100644
--- a/plugins/modules/webfaction_db.py
+++ b/plugins/modules/webfaction_db.py
@@ -26,7 +26,7 @@ notes:
You can run playbooks that use this on a local machine, or on a Webfaction host, or elsewhere, since the scripts use the remote webfaction API.
The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you do not specify C(localhost) as
your host, you may want to add C(serial=1) to the plays.
- - See `the webfaction API `_ for more info.
+ - See L(the webfaction API, https://docs.webfaction.com/xmlrpc-api/) for more info.
extends_documentation_fragment:
- community.general.attributes
attributes:
diff --git a/plugins/modules/webfaction_domain.py b/plugins/modules/webfaction_domain.py
index 2947f3b766..69d2784182 100644
--- a/plugins/modules/webfaction_domain.py
+++ b/plugins/modules/webfaction_domain.py
@@ -25,7 +25,7 @@ notes:
You can run playbooks that use this on a local machine, or on a Webfaction host, or elsewhere, since the scripts use the remote webfaction API.
The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you do not specify C(localhost) as
your host, you may want to add C(serial=1) to the plays.
- - See `the webfaction API `_ for more info.
+ - See L(the webfaction API, https://docs.webfaction.com/xmlrpc-api/) for more info.
extends_documentation_fragment:
- community.general.attributes
diff --git a/plugins/modules/webfaction_mailbox.py b/plugins/modules/webfaction_mailbox.py
index 6a290b0c76..95b5a116be 100644
--- a/plugins/modules/webfaction_mailbox.py
+++ b/plugins/modules/webfaction_mailbox.py
@@ -23,7 +23,7 @@ notes:
You can run playbooks that use this on a local machine, or on a Webfaction host, or elsewhere, since the scripts use the remote webfaction API.
The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you do not specify C(localhost) as
your host, you may want to add C(serial=1) to the plays.
- - See `the webfaction API `_ for more info.
+ - See L(the webfaction API, https://docs.webfaction.com/xmlrpc-api/) for more info.
extends_documentation_fragment:
- community.general.attributes
diff --git a/plugins/modules/webfaction_site.py b/plugins/modules/webfaction_site.py
index 15e8540d0c..440e5e032c 100644
--- a/plugins/modules/webfaction_site.py
+++ b/plugins/modules/webfaction_site.py
@@ -26,7 +26,7 @@ notes:
You can run playbooks that use this on a local machine, or on a Webfaction host, or elsewhere, since the scripts use the remote webfaction API.
The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you do not specify C(localhost) as
your host, you may want to add C(serial=1) to the plays.
- - See `the webfaction API `_ for more info.
+ - See L(the webfaction API, https://docs.webfaction.com/xmlrpc-api/) for more info.
extends_documentation_fragment:
- community.general.attributes
diff --git a/plugins/modules/xbps.py b/plugins/modules/xbps.py
index 1fea5b384a..bcbbb3f021 100644
--- a/plugins/modules/xbps.py
+++ b/plugins/modules/xbps.py
@@ -62,7 +62,7 @@ options:
- Whether or not to upgrade the xbps package when necessary.
Before installing new packages,
xbps requires the user to update the xbps package itself.
- Thus when this option is set to C(false),
+ Thus when this option is set to V(false),
upgrades and installations will fail when xbps is not up to date.
type: bool
default: true
diff --git a/plugins/modules/xenserver_guest.py b/plugins/modules/xenserver_guest.py
index 31552bb46a..8464687446 100644
--- a/plugins/modules/xenserver_guest.py
+++ b/plugins/modules/xenserver_guest.py
@@ -136,7 +136,7 @@ options:
suboptions:
size:
description:
- - 'Disk size with unit. Unit must be: C(b), C(kb), C(mb), C(gb), C(tb). VM needs to be shut down to reconfigure this parameter.'
+ - 'Disk size with unit. Unit must be: V(b), V(kb), V(mb), V(gb), V(tb). VM needs to be shut down to reconfigure this parameter.'
- If no unit is specified, size is assumed to be in bytes.
type: str
size_b:
diff --git a/plugins/modules/xenserver_guest_info.py b/plugins/modules/xenserver_guest_info.py
index dd28cf7d07..b61ba44968 100644
--- a/plugins/modules/xenserver_guest_info.py
+++ b/plugins/modules/xenserver_guest_info.py
@@ -36,7 +36,7 @@ options:
description:
- Name of the VM to gather facts from.
- VMs running on XenServer do not necessarily have unique names. The module will fail if multiple VMs with same name are found.
- - In case of multiple VMs with same name, use C(uuid) to uniquely specify VM to manage.
+ - In case of multiple VMs with same name, use O(uuid) to uniquely specify VM to manage.
- This parameter is case sensitive.
type: str
aliases: [ name_label ]
diff --git a/plugins/modules/xenserver_guest_powerstate.py b/plugins/modules/xenserver_guest_powerstate.py
index ba88bbf1de..c270a999d4 100644
--- a/plugins/modules/xenserver_guest_powerstate.py
+++ b/plugins/modules/xenserver_guest_powerstate.py
@@ -39,8 +39,8 @@ options:
state:
description:
- Specify the state VM should be in.
- - If C(state) is set to value other than C(present), then VM is transitioned into required state and facts are returned.
- - If C(state) is set to C(present), then VM is just checked for existence and facts are returned.
+ - If O(state) is set to value other than V(present), then VM is transitioned into required state and facts are returned.
+ - If O(state) is set to V(present), then VM is just checked for existence and facts are returned.
type: str
default: present
choices: [ powered-on, powered-off, restarted, shutdown-guest, reboot-guest, suspended, present ]
@@ -48,7 +48,7 @@ options:
description:
- Name of the VM to manage.
- VMs running on XenServer do not necessarily have unique names. The module will fail if multiple VMs with same name are found.
- - In case of multiple VMs with same name, use C(uuid) to uniquely specify VM to manage.
+ - In case of multiple VMs with same name, use O(uuid) to uniquely specify VM to manage.
- This parameter is case sensitive.
type: str
aliases: [ name_label ]
@@ -65,7 +65,7 @@ options:
default: false
state_change_timeout:
description:
- - 'By default, module will wait indefinitely for VM to change state or acquire an IP address if C(wait_for_ip_address: true).'
+ - 'By default, module will wait indefinitely for VM to change state or acquire an IP address if O(wait_for_ip_address=true).'
- If this parameter is set to positive value, the module will instead wait specified number of seconds for the state change.
- In case of timeout, module will generate an error message.
type: int
diff --git a/plugins/modules/xml.py b/plugins/modules/xml.py
index 0138cbec99..a3c12b8eec 100644
--- a/plugins/modules/xml.py
+++ b/plugins/modules/xml.py
@@ -63,7 +63,7 @@ options:
value:
description:
- Desired state of the selected attribute.
- - Either a string, or to unset a value, the Python C(None) keyword (YAML Equivalent, V(null)).
+ - Either a string, or to unset a value, the Python V(None) keyword (YAML Equivalent, V(null)).
- Elements default to no value (but present).
- Attributes default to an empty string.
type: raw
diff --git a/plugins/modules/yum_versionlock.py b/plugins/modules/yum_versionlock.py
index e5d32dc77e..fa942a0080 100644
--- a/plugins/modules/yum_versionlock.py
+++ b/plugins/modules/yum_versionlock.py
@@ -31,8 +31,8 @@ options:
elements: str
state:
description:
- - If state is C(present), package(s) will be added to yum versionlock list.
- - If state is C(absent), package(s) will be removed from yum versionlock list.
+ - If state is V(present), package(s) will be added to yum versionlock list.
+ - If state is V(absent), package(s) will be removed from yum versionlock list.
choices: [ 'absent', 'present' ]
type: str
default: present
diff --git a/plugins/modules/zfs.py b/plugins/modules/zfs.py
index 4cd79c36e2..f23cc4580d 100644
--- a/plugins/modules/zfs.py
+++ b/plugins/modules/zfs.py
@@ -24,19 +24,19 @@ attributes:
- In certain situations it may report a task as changed that will not be reported
as changed when C(check_mode) is disabled.
- For example, this might occur when the zpool C(altroot) option is set or when
- a size is written using human-readable notation, such as C(1M) or C(1024K),
- instead of as an unqualified byte count, such as C(1048576).
+ a size is written using human-readable notation, such as V(1M) or V(1024K),
+ instead of as an unqualified byte count, such as V(1048576).
diff_mode:
support: full
options:
name:
description:
- - File system, snapshot or volume name e.g. C(rpool/myfs).
+ - File system, snapshot or volume name, for example V(rpool/myfs).
required: true
type: str
state:
description:
- - Whether to create (C(present)), or remove (C(absent)) a
+ - Whether to create (V(present)), or remove (V(absent)) a
file system, snapshot or volume. All parents/children
will be created/destroyed as needed to reach the desired state.
choices: [ absent, present ]