ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Add more semantic markup (#6744)

Browse source 
Add more semantic markup.
This commit is contained in:
Felix Fontein 2023-06-20 08:14:02 +02:00 committed by GitHub
parent ffb9b6ff96
commit 13e9e4b196
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
143 changed files with 346 additions and 348 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
plugins/lookup/tss.py
View file

@ -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:

2
plugins/modules/airbrake_deployment.py
View file

@ -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

8
plugins/modules/aix_devices.py
View file

@ -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

16
plugins/modules/aix_filesystem.py
View file

@ -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'''

6
plugins/modules/aix_lvg.py
View file

@ -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

10
plugins/modules/aix_lvol.py
View file

@ -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: []

10
plugins/modules/archive.py
View file

@ -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

2
plugins/modules/atomic_host.py
View file

@ -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

2
plugins/modules/atomic_image.py
View file

@ -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

2
plugins/modules/bigpanda.py
View file

@ -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

26
plugins/modules/bundler.py
View file

@ -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:

2
plugins/modules/capabilities.py
View file

@ -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 ]

4
plugins/modules/catapult.py
View file

@ -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

4
plugins/modules/cisco_webex.py
View file

@ -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

2
plugins/modules/clc_firewall_policy.py
View file

@ -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:

8
plugins/modules/cobbler_sync.py
View file

@ -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:

2
plugins/modules/composer.py
View file

@ -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

4
plugins/modules/copr.py
View file

@ -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
"""

6
plugins/modules/datadog_downtime.py
View file

@ -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
"""

2
plugins/modules/datadog_event.py
View file

@ -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

2
plugins/modules/django_manage.py
View file

@ -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]

2
plugins/modules/dnsimple.py
View file

@ -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

8
plugins/modules/dnsmadeeasy.py
View file

@ -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

4
plugins/modules/emc_vnx_sg_member.py
View file

@ -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

2
plugins/modules/flowdock.py
View file

@ -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

4
plugins/modules/gem.py
View file

@ -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:

6
plugins/modules/github_release.py
View file

@ -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:

2
plugins/modules/github_webhook.py
View file

@ -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

4
plugins/modules/gitlab_deploy_key.py
View file

@ -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" ]

4
plugins/modules/gitlab_hook.py
View file

@ -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" ]

4
plugins/modules/gitlab_merge_request.py
View file

@ -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
'''

2
plugins/modules/gitlab_protected_branch.py
View file

@ -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:

2
plugins/modules/grove.py
View file

@ -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

6
plugins/modules/hg.py
View file

@ -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:

2
plugins/modules/hipchat.py
View file

@ -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

2
plugins/modules/honeybadger_deployment.py
View file

@ -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

2
plugins/modules/hpilo_info.py
View file

@ -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"

8
plugins/modules/hwc_ecs_instance.py
View file

@ -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:

4
plugins/modules/hwc_smn_topic.py
View file

@ -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

4
plugins/modules/hwc_vpc_eip.py
View file

@ -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:

8
plugins/modules/hwc_vpc_subnet.py
View file

@ -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:

8
plugins/modules/icinga2_feature.py
View file

@ -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
'''

2
plugins/modules/idrac_redfish_info.py
View file

@ -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

14
plugins/modules/imc_rest.py
View file

@ -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)

8
plugins/modules/imgadm.py
View file

@ -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:

2
plugins/modules/installp.py
View file

@ -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

2
plugins/modules/ipa_host.py
View file

@ -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:

2
plugins/modules/ipa_otptoken.py
View file

@ -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:

8
plugins/modules/ipa_sudorule.py
View file

@ -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:

2
plugins/modules/ipbase_info.py
View file

@ -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

2
plugins/modules/ipify_facts.py
View file

@ -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:

20
plugins/modules/iso_create.py
View file

@ -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
'''

8
plugins/modules/java_cert.py
View file

@ -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:

2
plugins/modules/jenkins_build.py
View file

@ -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

4
plugins/modules/jenkins_script.py
View file

@ -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

2
plugins/modules/kibana_plugin.py
View file

@ -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:

10
plugins/modules/launchd.py
View file

@ -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:

6
plugins/modules/linode.py
View file

@ -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:

4
plugins/modules/linode_v4.py
View file

@ -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

10
plugins/modules/lvol.py
View file

@ -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:

2
plugins/modules/lxc_container.py
View file

@ -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:

12
plugins/modules/mail.py
View file

@ -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 ]

10
plugins/modules/manageiq_group.py
View file

@ -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
'''

2
plugins/modules/manageiq_provider.py
View file

@ -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.

4
plugins/modules/manageiq_tenant.py
View file

@ -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:

2
plugins/modules/manageiq_user.py
View file

@ -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 = '''

2
plugins/modules/mas.py
View file

@ -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

8
plugins/modules/modprobe.py
View file

@ -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 = '''

2
plugins/modules/nexmo.py
View file

@ -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

2
plugins/modules/nomad_job_info.py
View file

@ -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.

10
plugins/modules/nsupdate.py
View file

@ -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

2
plugins/modules/odbc.py
View file

@ -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

10
plugins/modules/one_host.py
View file

@ -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

20
plugins/modules/one_image.py
View file

@ -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)"

12
plugins/modules/one_image_info.py
View file

@ -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:

2
plugins/modules/oneandone_server.py
View file

@ -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:

2
plugins/modules/oneview_enclosure_info.py
View file

@ -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

6
plugins/modules/oneview_ethernet_network.py
View file

@ -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]

2
plugins/modules/oneview_ethernet_network_info.py
View file

@ -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:

4
plugins/modules/oneview_fc_network.py
View file

@ -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

4
plugins/modules/oneview_fcoe_network.py
View file

@ -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']

4
plugins/modules/oneview_logical_interconnect_group.py
View file

@ -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

4
plugins/modules/oneview_network_set.py
View file

@ -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']

4
plugins/modules/oneview_network_set_info.py
View file

@ -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

6
plugins/modules/oneview_san_manager.py
View file

@ -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]

8
plugins/modules/oneview_san_manager_info.py
View file

@ -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

2
plugins/modules/opkg.py
View file

@ -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:
- ""

4
plugins/modules/osx_defaults.py
View file

@ -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 ]

8
plugins/modules/packet_ip_subnet.py
View file

@ -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

2
plugins/modules/packet_project.py
View file

@ -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:

2
plugins/modules/packet_sshkey.py
View file

@ -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:

2
plugins/modules/packet_volume.py
View file

@ -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:

2
plugins/modules/packet_volume_attachment.py
View file

@ -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:

24
plugins/modules/pamd.py
View file

@ -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

2
plugins/modules/pear.py
View file

@ -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

2
plugins/modules/pip_package_info.py
View file

@ -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

6
plugins/modules/portage.py
View file

@ -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

2
plugins/modules/profitbricks.py
View file

@ -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:

2
plugins/modules/profitbricks_datacenter.py
View file

@ -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'

2
plugins/modules/profitbricks_nic.py
View file

@ -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'

Some files were not shown because too many files have changed in this diff Show more