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

Use semantic markup (modules h-j) (#6677)

Browse source 
* Use semantic markup.

* Use 'ignore:' until a new version of antsibull-docs is released.

* 'ignore:' is no longer needed.

* E() now works better.
This commit is contained in:
Felix Fontein 2023-06-15 15:47:00 +02:00 committed by GitHub
parent 2ed82e0318
commit 3e0d84bdda
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
30 changed files with 202 additions and 202 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
plugins/modules/haproxy.py
View file

@ -65,7 +65,7 @@ options:
state:
description:
- Desired state of the provided backend host.
- Note that C(drain) state was added in version 2.4.
- Note that V(drain) state was added in version 2.4.
- It is supported only by HAProxy version 1.5 or later,
- When used on versions < 1.5, it will be ignored.
type: str
@ -73,13 +73,13 @@ options:
choices: [ disabled, drain, enabled ]
agent:
description:
- Disable/enable agent checks (depending on I(state) value).
- Disable/enable agent checks (depending on O(state) value).
type: bool
default: false
version_added: 1.0.0
health:
description:
- Disable/enable health checks (depending on I(state) value).
- Disable/enable health checks (depending on O(state) value).
type: bool
default: false
version_added: "1.0.0"
@ -90,8 +90,8 @@ options:
default: false
wait:
description:
- Wait until the server reports a status of C(UP) when I(state=enabled),
status of C(MAINT) when I(state=disabled) or status of C(DRAIN) when I(state=drain).
- Wait until the server reports a status of C(UP) when O(state=enabled),
status of C(MAINT) when O(state=disabled) or status of C(DRAIN) when O(state=drain).
type: bool
default: false
wait_interval:
@ -107,7 +107,7 @@ options:
weight:
description:
- The value passed in argument.
- If the value ends with the C(%) sign, then the new weight will be
- If the value ends with the V(%) sign, then the new weight will be
relative to the initially configured weight.
- Relative weights are only permitted between 0 and 100% and absolute
weights are permitted between 0 and 256.

10
plugins/modules/heroku_collaborator.py
View file

@ -14,9 +14,9 @@ module: heroku_collaborator
short_description: Add or delete app collaborators on Heroku
description:
- Manages collaborators for Heroku apps.
- If set to C(present) and heroku user is already collaborator, then do nothing.
- If set to C(present) and heroku user is not collaborator, then add user to app.
- If set to C(absent) and heroku user is collaborator, then delete user from app.
- If set to V(present) and heroku user is already collaborator, then do nothing.
- If set to V(present) and heroku user is not collaborator, then add user to app.
- If set to V(absent) and heroku user is collaborator, then delete user from app.
author:
- Marcel Arns (@marns93)
requirements:
@ -56,8 +56,8 @@ options:
choices: ["present", "absent"]
default: "present"
notes:
- C(HEROKU_API_KEY) and C(TF_VAR_HEROKU_API_KEY) env variable can be used instead setting C(api_key).
- If you use I(--check), you can also pass the I(-v) flag to see affected apps in C(msg), e.g. ["heroku-example-app"].
- E(HEROKU_API_KEY) and E(TF_VAR_HEROKU_API_KEY) environment variables can be used instead setting O(api_key).
- If you use C(check_mode), you can also pass the C(-v) flag to see affected apps in C(msg), e.g. ["heroku-example-app"].
'''
EXAMPLES = '''

10
plugins/modules/homebrew.py
View file

@ -42,9 +42,9 @@ options:
elements: str
path:
description:
- "A C(:) separated list of paths to search for C(brew) executable.
Since a package (I(formula) in homebrew parlance) location is prefixed relative to the actual path of I(brew) command,
providing an alternative I(brew) path enables managing different set of packages in an alternative location in the system."
- "A V(:) separated list of paths to search for C(brew) executable.
Since a package (I(formula) in homebrew parlance) location is prefixed relative to the actual path of C(brew) command,
providing an alternative C(brew) path enables managing different set of packages in an alternative location in the system."
default: '/usr/local/bin:/opt/homebrew/bin:/home/linuxbrew/.linuxbrew/bin'
type: path
state:
@ -78,7 +78,7 @@ options:
version_added: '0.2.0'
notes:
- When used with a C(loop:) each package will be processed individually,
it is much more efficient to pass the list directly to the I(name) option.
it is much more efficient to pass the list directly to the O(name) option.
'''
EXAMPLES = '''
@ -87,7 +87,7 @@ EXAMPLES = '''
name: foo
state: present
# Install formula foo with 'brew' in alternate path C(/my/other/location/bin)
# Install formula foo with 'brew' in alternate path (/my/other/location/bin)
- community.general.homebrew:
name: foo
path: /my/other/location/bin

4
plugins/modules/homebrew_tap.py
View file

@ -42,7 +42,7 @@ options:
- The optional git URL of the repository to tap. The URL is not
assumed to be on GitHub, and the protocol doesn't have to be HTTP.
Any location and protocol that git can handle is fine.
- I(name) option may not be a list of multiple taps (but a single
- O(name) option may not be a list of multiple taps (but a single
tap instead) when this option is provided.
required: false
type: str
@ -55,7 +55,7 @@ options:
type: str
path:
description:
- "A C(:) separated list of paths to search for C(brew) executable."
- "A V(:) separated list of paths to search for C(brew) executable."
default: '/usr/local/bin:/opt/homebrew/bin:/home/linuxbrew/.linuxbrew/bin'
type: path
version_added: '2.1.0'

26
plugins/modules/homectl.py
View file

@ -37,7 +37,7 @@ options:
- Homed requires this value to be in cleartext on user creation and updating a user.
- The module takes the password and generates a password hash in SHA-512 with 10000 rounds of salt generation using crypt.
- See U(https://systemd.io/USER_RECORD/).
- This is required for I(state=present). When an existing user is updated this is checked against the stored hash in homed.
- This is required for O(state=present). When an existing user is updated this is checked against the stored hash in homed.
type: str
state:
description:
@ -55,11 +55,11 @@ options:
disksize:
description:
- The intended home directory disk space.
- Human readable value such as C(10G), C(10M), or C(10B).
- Human readable value such as V(10G), V(10M), or V(10B).
type: str
resize:
description:
- When used with I(disksize) this will attempt to resize the home directory immediately.
- When used with O(disksize) this will attempt to resize the home directory immediately.
default: false
type: bool
realname:
@ -90,7 +90,7 @@ options:
description:
- Path to use as home directory for the user.
- This is the directory the user's home directory is mounted to while the user is logged in.
- This is not where the user's data is actually stored, see I(imagepath) for that.
- This is not where the user's data is actually stored, see O(imagepath) for that.
- Only used when a user is first created.
type: path
imagepath:
@ -102,25 +102,25 @@ options:
uid:
description:
- Sets the UID of the user.
- If using I(gid) homed requires the value to be the same.
- If using O(gid) homed requires the value to be the same.
- Only used when a user is first created.
type: int
gid:
description:
- Sets the gid of the user.
- If using I(uid) homed requires the value to be the same.
- If using O(uid) homed requires the value to be the same.
- Only used when a user is first created.
type: int
mountopts:
description:
- String separated by comma each indicating mount options for a users home directory.
- Valid options are C(nosuid), C(nodev) or C(noexec).
- Homed by default uses C(nodev) and C(nosuid) while C(noexec) is off.
- Valid options are V(nosuid), V(nodev) or V(noexec).
- Homed by default uses V(nodev) and V(nosuid) while V(noexec) is off.
type: str
umask:
description:
- Sets the umask for the user's login sessions
- Value from C(0000) to C(0777).
- Value from V(0000) to V(0777).
type: int
memberof:
description:
@ -132,13 +132,13 @@ options:
description:
- The absolute path to the skeleton directory to populate a new home directory from.
- This is only used when a home directory is first created.
- If not specified homed by default uses C(/etc/skel).
- If not specified homed by default uses V(/etc/skel).
aliases: [ 'skel' ]
type: path
shell:
description:
- Shell binary to use for terminal logins of given user.
- If not specified homed by default uses C(/bin/bash).
- If not specified homed by default uses V(/bin/bash).
type: str
environment:
description:
@ -151,7 +151,7 @@ options:
timezone:
description:
- Preferred timezone to use for the user.
- Should be a tzdata compatible location string such as C(America/New_York).
- Should be a tzdata compatible location string such as V(America/New_York).
type: str
locked:
description:
@ -160,7 +160,7 @@ options:
language:
description:
- The preferred language/locale for the user.
- This should be in a format compatible with the C($LANG) environment variable.
- This should be in a format compatible with the E(LANG) environment variable.
type: str
passwordhint:
description:

14
plugins/modules/htpasswd.py
View file

@ -46,12 +46,12 @@ options:
description:
- Encryption scheme to be used. As well as the four choices listed
here, you can also use any other hash supported by passlib, such as
C(portable_apache22) and C(host_apache24); or C(md5_crypt) and C(sha256_crypt),
V(portable_apache22) and V(host_apache24); or V(md5_crypt) and V(sha256_crypt),
which are Linux passwd hashes. Only some schemes in addition to
the four choices below will be compatible with Apache or Nginx, and
supported schemes depend on passlib version and its dependencies.
- See U(https://passlib.readthedocs.io/en/stable/lib/passlib.apache.html#passlib.apache.HtpasswdFile) parameter C(default_scheme).
- 'Some of the available choices might be: C(apr_md5_crypt), C(des_crypt), C(ldap_sha1), C(plaintext).'
- 'Some of the available choices might be: V(apr_md5_crypt), V(des_crypt), V(ldap_sha1), V(plaintext).'
state:
type: str
required: false
@ -64,13 +64,13 @@ options:
type: bool
default: true
description:
- Used with I(state=present). If specified, the file will be created
if it does not already exist. If set to C(false), will fail if the
- Used with O(state=present). If specified, the file will be created
if it does not already exist. If set to V(false), will fail if the
file does not exist
notes:
- "This module depends on the I(passlib) Python library, which needs to be installed on all target systems."
- "On Debian, Ubuntu, or Fedora: install I(python-passlib)."
- "On RHEL or CentOS: Enable EPEL, then install I(python-passlib)."
- "This module depends on the C(passlib) Python library, which needs to be installed on all target systems."
- "On Debian, Ubuntu, or Fedora: install C(python-passlib)."
- "On RHEL or CentOS: Enable EPEL, then install C(python-passlib)."
requirements: [ passlib>=1.6 ]
author: "Ansible Core Team"
extends_documentation_fragment:

4
plugins/modules/hwc_vpc_private_ip.py
View file

@ -19,8 +19,8 @@ description:
- vpc private ip management.
short_description: Creates a resource of Vpc/PrivateIP in Huawei Cloud
notes:
- If I(id) option is provided, it takes precedence over I(subnet_id), I(ip_address) for private ip selection.
- I(subnet_id), I(ip_address) are used for private ip selection. If more than one private ip with this options exists, execution is aborted.
- If O(id) option is provided, it takes precedence over O(subnet_id), O(ip_address) for private ip selection.
- O(subnet_id), O(ip_address) are used for private ip selection. If more than one private ip with this options exists, execution is aborted.
- No parameter support updating. If one of option is changed, the module will create a new resource.
version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud)

4
plugins/modules/hwc_vpc_route.py
View file

@ -19,8 +19,8 @@ description:
- vpc route management.
short_description: Creates a resource of Vpc/Route in Huawei Cloud
notes:
- If I(id) option is provided, it takes precedence over I(destination), I(vpc_id), I(type) and I(next_hop) for route selection.
- I(destination), I(vpc_id), I(type) and I(next_hop) are used for route selection. If more than one route with this options exists, execution is aborted.
- If O(id) option is provided, it takes precedence over O(destination), O(vpc_id), O(type), and O(next_hop) for route selection.
- O(destination), O(vpc_id), O(type) and O(next_hop) are used for route selection. If more than one route with this options exists, execution is aborted.
- No parameter support updating. If one of option is changed, the module will create a new resource.
version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud)

14
plugins/modules/hwc_vpc_security_group.py
View file

@ -19,9 +19,9 @@ description:
- vpc security group management.
short_description: Creates a resource of Vpc/SecurityGroup in Huawei Cloud
notes:
- If I(id) option is provided, it takes precedence over I(name),
I(enterprise_project_id) and I(vpc_id) for security group selection.
- I(name), I(enterprise_project_id) and I(vpc_id) are used for security
- If O(id) option is provided, it takes precedence over O(name),
O(enterprise_project_id), and O(vpc_id) for security group selection.
- O(name), O(enterprise_project_id) and O(vpc_id) are used for security
group selection. If more than one security group with this options exists,
execution is aborted.
- No parameter support updating. If one of option is changed, the module
@ -45,8 +45,8 @@ options:
name:
description:
- Specifies the security group name. The value is a string of 1 to
64 characters that can contain letters, digits, underscores C(_),
hyphens (-), and periods (.).
64 characters that can contain letters, digits, underscores (V(_)),
hyphens (V(-)), and periods (V(.)).
type: str
required: true
enterprise_project_id:
@ -79,8 +79,8 @@ RETURN = '''
name:
description:
- Specifies the security group name. The value is a string of 1 to
64 characters that can contain letters, digits, underscores C(_),
hyphens (-), and periods (.).
64 characters that can contain letters, digits, underscores (V(_)),
hyphens (V(-)), and periods (V(.)).
type: str
returned: success
enterprise_project_id:

6
plugins/modules/hwc_vpc_security_group_rule.py
View file

@ -19,9 +19,9 @@ description:
- vpc security group management.
short_description: Creates a resource of Vpc/SecurityGroupRule in Huawei Cloud
notes:
- If I(id) option is provided, it takes precedence over
I(enterprise_project_id) for security group rule selection.
- I(security_group_id) is used for security group rule selection. If more
- If O(id) option is provided, it takes precedence over
O(security_group_id) for security group rule selection.
- O(security_group_id) is used for security group rule selection. If more
than one security group rule with this options exists, execution is
aborted.
- No parameter support updating. If one of option is changed, the module

14
plugins/modules/icinga2_host.py
View file

@ -31,13 +31,13 @@ options:
- HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path
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.
type: bool
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
@ -45,12 +45,12 @@ options:
type: str
description:
- The username for use in HTTP basic authentication.
- This parameter can be used without C(url_password) for sites that allow empty passwords.
- This parameter can be used without O(url_password) for sites that allow empty passwords.
url_password:
type: str
description:
- The password for use in HTTP basic authentication.
- If the C(url_username) parameter is not specified, the C(url_password) parameter will not be used.
- If the O(url_username) parameter is not specified, the O(url_password) parameter will not be used.
force_basic_auth:
description:
- httplib2, the library used by the uri module only sends authentication information when a webservice
@ -64,12 +64,12 @@ options:
description:
- PEM formatted certificate chain file to be used for SSL client
authentication. This file can also include the key as well, and if
the key is included, C(client_key) is not required.
the key is included, O(client_key) is not required.
client_key:
type: path
description:
- PEM formatted file that contains your private key to be used for SSL
client authentication. If C(client_cert) contains both the certificate
client authentication. If O(client_cert) contains both the certificate
and key, this option is not required.
state:
type: str
@ -101,7 +101,7 @@ options:
type: str
description:
- The name used to display the host.
- If not specified, it defaults to the value of the I(name) parameter.
- If not specified, it defaults to the value of the O(name) parameter.
ip:
type: str
description:

6
plugins/modules/idrac_redfish_config.py
View file

@ -33,9 +33,9 @@ options:
required: true
description:
- List of commands to execute on iDRAC.
- I(SetManagerAttributes), I(SetLifecycleControllerAttributes) and
I(SetSystemAttributes) are mutually exclusive commands when C(category)
is I(Manager).
- V(SetManagerAttributes), V(SetLifecycleControllerAttributes) and
V(SetSystemAttributes) are mutually exclusive commands when O(category)
is V(Manager).
type: list
elements: str
baseuri:

6
plugins/modules/influxdb_retention_policy.py
View file

@ -46,14 +46,14 @@ options:
duration:
description:
- Determines how long InfluxDB should keep the data. If specified, it
should be C(INF) or at least one hour. If not specified, C(INF) is
should be V(INF) or at least one hour. If not specified, V(INF) is
assumed. Supports complex duration expressions with multiple units.
- Required only if I(state) is set to C(present).
- Required only if O(state) is set to V(present).
type: str
replication:
description:
- Determines how many independent copies of each point are stored in the cluster.
- Required only if I(state) is set to C(present).
- Required only if O(state) is set to V(present).
type: int
default:
description:

58
plugins/modules/ini_file.py
View file

@ -34,35 +34,35 @@ options:
path:
description:
- Path to the INI-style file; this file is created if required.
- Before Ansible 2.3 this option was only usable as I(dest).
- Before Ansible 2.3 this option was only usable as O(dest).
type: path
required: true
aliases: [ dest ]
section:
description:
- Section name in INI file. This is added if I(state=present) automatically when
- Section name in INI file. This is added if O(state=present) automatically when
a single value is being set.
- If left empty, being omitted, or being set to C(null), the I(option) will be placed before the first I(section).
- Using C(null) is also required if the config format does not support sections.
- If left empty, being omitted, or being set to V(null), the O(option) will be placed before the first O(section).
- Using V(null) is also required if the config format does not support sections.
type: str
option:
description:
- If set (required for changing a I(value)), this is the name of the option.
- May be omitted if adding/removing a whole I(section).
- If set (required for changing a O(value)), this is the name of the option.
- May be omitted if adding/removing a whole O(section).
type: str
value:
description:
- The string value to be associated with an I(option).
- May be omitted when removing an I(option).
- Mutually exclusive with I(values).
- I(value=v) is equivalent to I(values=[v]).
- The string value to be associated with an O(option).
- May be omitted when removing an O(option).
- Mutually exclusive with O(values).
- O(value=v) is equivalent to O(values=[v]).
type: str
values:
description:
- The string value to be associated with an I(option).
- May be omitted when removing an I(option).
- Mutually exclusive with I(value).
- I(value=v) is equivalent to I(values=[v]).
- The string value to be associated with an O(option).
- May be omitted when removing an O(option).
- Mutually exclusive with O(value).
- O(value=v) is equivalent to O(values=[v]).
type: list
elements: str
version_added: 3.6.0
@ -74,22 +74,22 @@ options:
default: false
state:
description:
- If set to C(absent) and I(exclusive) set to C(true) all matching I(option) lines are removed.
- If set to C(absent) and I(exclusive) set to C(false) the specified I(option=value) lines are removed,
but the other I(option)s with the same name are not touched.
- If set to C(present) and I(exclusive) set to C(false) the specified I(option=values) lines are added,
but the other I(option)s with the same name are not touched.
- If set to C(present) and I(exclusive) set to C(true) all given I(option=values) lines will be
added and the other I(option)s with the same name are removed.
- If set to V(absent) and O(exclusive) set to V(true) all matching O(option) lines are removed.
- If set to V(absent) and O(exclusive) set to V(false) the specified O(option=value) lines are removed,
but the other O(option)s with the same name are not touched.
- If set to V(present) and O(exclusive) set to V(false) the specified O(option=values) lines are added,
but the other O(option)s with the same name are not touched.
- If set to V(present) and O(exclusive) set to V(true) all given O(option=values) lines will be
added and the other O(option)s with the same name are removed.
type: str
choices: [ absent, present ]
default: present
exclusive:
description:
- If set to C(true) (default), all matching I(option) lines are removed when I(state=absent),
or replaced when I(state=present).
- If set to C(false), only the specified I(value(s)) are added when I(state=present),
or removed when I(state=absent), and existing ones are not modified.
- If set to V(true) (default), all matching O(option) lines are removed when O(state=absent),
or replaced when O(state=present).
- If set to V(false), only the specified O(value)/O(values) are added when O(state=present),
or removed when O(state=absent), and existing ones are not modified.
type: bool
default: true
version_added: 3.6.0
@ -100,7 +100,7 @@ options:
default: false
create:
description:
- If set to C(false), the module will fail if the file does not already exist.
- If set to V(false), the module will fail if the file does not already exist.
- By default it will create the file if it is missing.
type: bool
default: true
@ -112,13 +112,13 @@ options:
follow:
description:
- This flag indicates that filesystem links, if they exist, should be followed.
- I(follow=true) can modify I(src) when combined with parameters such as I(mode).
- O(follow=true) can modify O(path) when combined with parameters such as O(mode).
type: bool
default: false
version_added: 7.1.0
notes:
- While it is possible to add an I(option) without specifying a I(value), this makes no sense.
- As of Ansible 2.3, the I(dest) option has been changed to I(path) as default, but I(dest) still works as well.
- While it is possible to add an O(option) without specifying a O(value), this makes no sense.
- As of Ansible 2.3, the O(dest) option has been changed to O(path) as default, but O(dest) still works as well.
- As of community.general 3.2.0, UTF-8 BOM markers are discarded when reading files.
author:
- Jan-Piet Mens (@jpmens)

8
plugins/modules/interfaces_file.py
View file

@ -46,9 +46,9 @@ options:
value:
type: str
description:
- If I(option) is not presented for the I(interface) and I(state) is C(present) option will be added.
If I(option) already exists and is not C(pre-up), C(up), C(post-up) or C(down), it's value will be updated.
C(pre-up), C(up), C(post-up) and C(down) options can't be updated, only adding new options, removing existing
- If O(option) is not presented for the O(iface) and O(state) is V(present) option will be added.
If O(option) already exists and is not V(pre-up), V(up), V(post-up) or V(down), it's value will be updated.
V(pre-up), V(up), V(post-up) and V(down) options cannot be updated, only adding new options, removing existing
ones or cleaning the whole option set are supported
backup:
description:
@ -59,7 +59,7 @@ options:
state:
type: str
description:
- If set to C(absent) the option or section will be removed if present instead of created.
- If set to V(absent) the option or section will be removed if present instead of created.
default: "present"
choices: [ "present", "absent" ]

8
plugins/modules/ipa_dnsrecord.py
View file

@ -45,8 +45,8 @@ options:
record_value:
description:
- Manage DNS record name with this value.
- Mutually exclusive with I(record_values), and exactly one of I(record_value) and I(record_values) has to be specified.
- Use I(record_values) if you need to specify multiple values.
- Mutually exclusive with O(record_values), and exactly one of O(record_value) and O(record_values) has to be specified.
- Use O(record_values) if you need to specify multiple values.
- In the case of 'A' or 'AAAA' record types, this will be the IP address.
- In the case of 'A6' record type, this will be the A6 Record data.
- In the case of 'CNAME' record type, this will be the hostname.
@ -59,7 +59,7 @@ options:
record_values:
description:
- Manage DNS record name with this value.
- Mutually exclusive with I(record_value), and exactly one of I(record_value) and I(record_values) has to be specified.
- Mutually exclusive with O(record_value), and exactly one of O(record_value) and O(record_values) has to be specified.
- In the case of 'A' or 'AAAA' record types, this will be the IP address.
- In the case of 'A6' record type, this will be the A6 Record data.
- In the case of 'CNAME' record type, this will be the hostname.
@ -73,7 +73,7 @@ options:
record_ttl:
description:
- Set the TTL for the record.
- Applies only when adding a new or changing the value of I(record_value) or I(record_values).
- Applies only when adding a new or changing the value of O(record_value) or O(record_values).
required: false
type: int
state:

18
plugins/modules/ipa_group.py
View file

@ -22,8 +22,8 @@ attributes:
options:
append:
description:
- If C(true), add the listed I(user) and I(group) to the group members.
- If C(false), only the listed I(user) and I(group) will be group members, removing any other members.
- If V(true), add the listed O(user) and O(group) to the group members.
- If V(false), only the listed O(user) and O(group) will be group members, removing any other members.
default: false
type: bool
version_added: 4.0.0
@ -50,9 +50,9 @@ options:
group:
description:
- List of group names assigned to this group.
- If I(append=false) and an empty list is passed all groups will be removed from this group.
- If O(append=false) and an empty list is passed all groups will be removed from this group.
- Groups that are already assigned but not passed will be removed.
- If I(append=true) the listed groups will be assigned without removing other groups.
- If O(append=true) the listed groups will be assigned without removing other groups.
- If option is omitted assigned groups will not be checked or changed.
type: list
elements: str
@ -63,20 +63,20 @@ options:
user:
description:
- List of user names assigned to this group.
- If I(append=false) and an empty list is passed all users will be removed from this group.
- If O(append=false) and an empty list is passed all users will be removed from this group.
- Users that are already assigned but not passed will be removed.
- If I(append=true) the listed users will be assigned without removing other users.
- If O(append=true) the listed users will be assigned without removing other users.
- If option is omitted assigned users will not be checked or changed.
type: list
elements: str
external_user:
description:
- List of external users assigned to this group.
- Behaves identically to I(user) with respect to I(append) attribute.
- List entries can be in C(DOMAIN\\username) or SID format.
- Behaves identically to O(user) with respect to O(append) attribute.
- List entries can be in V(DOMAIN\\\\username) or SID format.
- Unless SIDs are provided, the module will always attempt to make changes even if the group already has all the users.
This is because only SIDs are returned by IPA query.
- I(external=true) is needed for this option to work.
- O(external=true) is needed for this option to work.
type: list
elements: str
version_added: 6.3.0

4
plugins/modules/ipa_hostgroup.py
View file

@ -22,8 +22,8 @@ attributes:
options:
append:
description:
- If C(true), add the listed I(host) to the I(hostgroup).
- If C(false), only the listed I(host) will be in I(hostgroup), removing any other hosts.
- If V(true), add the listed O(host) to the O(hostgroup).
- If V(false), only the listed O(host) will be in O(hostgroup), removing any other hosts.
default: false
type: bool
version_added: 6.6.0

2
plugins/modules/ipa_user.py
View file

@ -51,7 +51,7 @@ options:
password:
description:
- Password for a user.
- Will not be set for an existing user unless I(update_password=always), which is the default.
- Will not be set for an existing user unless O(update_password=always), which is the default.
type: str
sn:
description: Surname.

16
plugins/modules/ipmi_power.py
View file

@ -58,7 +58,7 @@ options:
- shutdown -- Have system request OS proper shutdown
- reset -- Request system reset without waiting for OS
- boot -- If system is off, then 'on', else 'reset'"
- Either this option or I(machine) is required.
- Either this option or O(machine) is required.
choices: ['on', 'off', shutdown, reset, boot]
type: str
timeout:
@ -70,7 +70,7 @@ options:
description:
- Provide a list of the remote target address for the bridge IPMI request,
and the power status.
- Either this option or I(state) is required.
- Either this option or O(state) is required.
required: false
type: list
elements: dict
@ -83,9 +83,9 @@ options:
required: true
state:
description:
- Whether to ensure that the machine specified by I(targetAddress) in desired state.
- If this option is not set, the power state is set by I(state).
- If both this option and I(state) are set, this option takes precedence over I(state).
- Whether to ensure that the machine specified by O(machine[].targetAddress) in desired state.
- If this option is not set, the power state is set by O(state).
- If both this option and O(state) are set, this option takes precedence over O(state).
choices: ['on', 'off', shutdown, reset, boot]
type: str
@ -98,18 +98,18 @@ author: "Bulat Gaifullin (@bgaifullin) <gaifullinbf@gmail.com>"
RETURN = '''
powerstate:
description: The current power state of the machine.
returned: success and I(machine) is not provided
returned: success and O(machine) is not provided
type: str
sample: 'on'
status:
description: The current power state of the machine when the machine option is set.
returned: success and I(machine) is provided
returned: success and O(machine) is provided
type: list
elements: dict
version_added: 4.3.0
contains:
powerstate:
description: The current power state of the machine specified by I(targetAddress).
description: The current power state of the machine specified by RV(status[].targetAddress).
type: str
targetAddress:
description: The remote target address.

18
plugins/modules/iptables_state.py
View file

@ -34,8 +34,8 @@ description:
notes:
- The rollback feature is not a module option and depends on task's
attributes. To enable it, the module must be played asynchronously, i.e.
by setting task attributes I(poll) to C(0), and I(async) to a value less
or equal to C(ANSIBLE_TIMEOUT). If I(async) is greater, the rollback will
by setting task attributes C(poll) to V(0), and C(async) to a value less
or equal to C(ANSIBLE_TIMEOUT). If C(async) is greater, the rollback will
still happen if it shall happen, but you will experience a connection
timeout instead of more relevant info returned by the module after its
failure.
@ -52,7 +52,7 @@ options:
counters:
description:
- Save or restore the values of all packet and byte counters.
- When C(true), the module is not idempotent.
- When V(true), the module is not idempotent.
type: bool
default: false
ip_version:
@ -65,14 +65,14 @@ options:
description:
- Specify the path to the C(modprobe) program internally used by iptables
related commands to load kernel modules.
- By default, C(/proc/sys/kernel/modprobe) is inspected to determine the
- By default, V(/proc/sys/kernel/modprobe) is inspected to determine the
executable's path.
type: path
noflush:
description:
- For I(state=restored), ignored otherwise.
- If C(false), restoring iptables rules from a file flushes (deletes)
all previous contents of the respective table(s). If C(true), the
- For O(state=restored), ignored otherwise.
- If V(false), restoring iptables rules from a file flushes (deletes)
all previous contents of the respective table(s). If V(true), the
previous rules are left untouched (but policies are updated anyway,
for all built-in chains).
type: bool
@ -92,10 +92,10 @@ options:
required: true
table:
description:
- When I(state=restored), restore only the named table even if the input
- When O(state=restored), restore only the named table even if the input
file contains other tables. Fail if the named table is not declared in
the file.
- When I(state=saved), restrict output to the specified table. If not
- When O(state=saved), restrict output to the specified table. If not
specified, output includes all active tables.
type: str
choices: [ filter, nat, mangle, raw, security ]

16
plugins/modules/ipwcli_dns.py
View file

@ -54,7 +54,7 @@ options:
address:
description:
- The IP address for the A or AAAA record.
- Required for I(type=A) or I(type=AAAA).
- Required for O(type=A) or O(type=AAAA).
type: str
ttl:
description:
@ -80,38 +80,38 @@ options:
port:
description:
- Sets the port of the SRV record.
- Required for I(type=SRV).
- Required for O(type=SRV).
type: int
target:
description:
- Sets the target of the SRV record.
- Required for I(type=SRV).
- Required for O(type=SRV).
type: str
order:
description:
- Sets the order of the NAPTR record.
- Required for I(type=NAPTR).
- Required for O(type=NAPTR).
type: int
preference:
description:
- Sets the preference of the NAPTR record.
- Required for I(type=NAPTR).
- Required for O(type=NAPTR).
type: int
flags:
description:
- Sets one of the possible flags of NAPTR record.
- Required for I(type=NAPTR).
- Required for O(type=NAPTR).
type: str
choices: ['S', 'A', 'U', 'P']
service:
description:
- Sets the service of the NAPTR record.
- Required for I(type=NAPTR).
- Required for O(type=NAPTR).
type: str
replacement:
description:
- Sets the replacement of the NAPTR record.
- Required for I(type=NAPTR).
- Required for O(type=NAPTR).
type: str
username:
description:

4
plugins/modules/iso_customize.py
View file

@ -15,7 +15,7 @@ module: iso_customize
short_description: Add/remove/change files in ISO file
description:
- This module is used to add/remove/change files in ISO file.
- The file inside ISO will be overwritten if it exists by option I(add_files).
- The file inside ISO will be overwritten if it exists by option O(add_files).
author:
- Yuhua Zou (@ZouYuhua) <zouy@vmware.com>
requirements:
@ -72,7 +72,7 @@ options:
notes:
- The C(pycdlib) library states it supports Python 2.7 and 3.4 only.
- >
The function I(add_file) in pycdlib will overwrite the existing file in ISO with type ISO9660 / Rock Ridge 1.12 / Joliet / UDF.
The function C(add_file) in pycdlib will overwrite the existing file in ISO with type ISO9660 / Rock Ridge 1.12 / Joliet / UDF.
But it will not overwrite the existing file in ISO with Rock Ridge 1.09 / 1.10.
So we take workaround "delete the existing file and then add file for ISO with Rock Ridge".
'''

8
plugins/modules/iso_extract.py
View file

@ -58,18 +58,18 @@ options:
required: true
force:
description:
- If C(true), which will replace the remote file when contents are different than the source.
- If C(false), the file will only be extracted and copied if the destination does not already exist.
- If V(true), which will replace the remote file when contents are different than the source.
- If V(false), the file will only be extracted and copied if the destination does not already exist.
type: bool
default: true
executable:
description:
- The path to the C(7z) executable to use for extracting files from the ISO.
- If not provided, it will assume the value C(7z).
- If not provided, it will assume the value V(7z).
type: path
notes:
- Only the file checksum (content) is taken into account when extracting files
from the ISO image. If I(force=false), only checks the presence of the file.
from the ISO image. If O(force=false), only checks the presence of the file.
- In Ansible 2.3 this module was using C(mount) and C(umount) commands only,
requiring root access. This is no longer needed with the introduction of 7zip
for extraction.

32
plugins/modules/java_keystore.py
View file

@ -36,7 +36,7 @@ options:
- If the fingerprint of the provided certificate does not match the
fingerprint of the certificate bundled in the keystore, the keystore
is regenerated with the provided certificate.
- Exactly one of I(certificate) or I(certificate_path) is required.
- Exactly one of O(certificate) or O(certificate_path) is required.
type: str
certificate_path:
description:
@ -44,18 +44,18 @@ options:
- If the fingerprint of the provided certificate does not match the
fingerprint of the certificate bundled in the keystore, the keystore
is regenerated with the provided certificate.
- Exactly one of I(certificate) or I(certificate_path) is required.
- Exactly one of O(certificate) or O(certificate_path) is required.
type: path
version_added: '3.0.0'
private_key:
description:
- Content of the private key used to create the keystore.
- Exactly one of I(private_key) or I(private_key_path) is required.
- Exactly one of O(private_key) or O(private_key_path) is required.
type: str
private_key_path:
description:
- Location of the private key used to create the keystore.
- Exactly one of I(private_key) or I(private_key_path) is required.
- Exactly one of O(private_key) or O(private_key_path) is required.
type: path
version_added: '3.0.0'
private_key_passphrase:
@ -108,13 +108,13 @@ options:
- Type of the Java keystore.
- When this option is omitted and the keystore doesn't already exist, the
behavior follows C(keytool)'s default store type which depends on
Java version; C(pkcs12) since Java 9 and C(jks) prior (may also
be C(pkcs12) if new default has been backported to this version).
Java version; V(pkcs12) since Java 9 and V(jks) prior (may also
be V(pkcs12) if new default has been backported to this version).
- When this option is omitted and the keystore already exists, the current
type is left untouched, unless another option leads to overwrite the
keystore (in that case, this option behaves like for keystore creation).
- When I(keystore_type) is set, the keystore is created with this type if
it doesn't already exist, or is overwritten to match the given type in
- When O(keystore_type) is set, the keystore is created with this type if
it does not already exist, or is overwritten to match the given type in
case of mismatch.
type: str
choices:
@ -122,9 +122,9 @@ options:
- pkcs12
version_added: 3.3.0
requirements:
- openssl in PATH (when I(ssl_backend=openssl))
- openssl in PATH (when O(ssl_backend=openssl))
- keytool in PATH
- cryptography >= 3.0 (when I(ssl_backend=cryptography))
- cryptography >= 3.0 (when O(ssl_backend=cryptography))
author:
- Guillaume Grossetie (@Mogztter)
- quidame (@quidame)
@ -135,13 +135,13 @@ seealso:
- module: community.crypto.openssl_pkcs12
- module: community.general.java_cert
notes:
- I(certificate) and I(private_key) require that their contents are available
on the controller (either inline in a playbook, or with the C(file) lookup),
while I(certificate_path) and I(private_key_path) require that the files are
- O(certificate) and O(private_key) require that their contents are available
on the controller (either inline in a playbook, or with the P(ansible.builtin.file#lookup) lookup),
while O(certificate_path) and O(private_key_path) require that the files are
available on the target host.
- By design, any change of a value of options I(keystore_type), I(name) or
I(password), as well as changes of key or certificate materials will cause
the existing I(dest) to be overwritten.
- By design, any change of a value of options O(keystore_type), O(name) or
O(password), as well as changes of key or certificate materials will cause
the existing O(dest) to be overwritten.
'''
EXAMPLES = '''

6
plugins/modules/jboss.py
View file

@ -30,8 +30,8 @@ options:
src:
description:
- The remote path of the application ear or war to deploy.
- Required when I(state=present).
- Ignored when I(state=absent).
- Required when O(state=present).
- Ignored when O(state=absent).
type: path
deploy_path:
default: /var/lib/jbossas/standalone/deployments
@ -46,7 +46,7 @@ options:
type: str
notes:
- The JBoss standalone deployment-scanner has to be enabled in standalone.xml
- The module can wait until I(deployment) file is deployed/undeployed by deployment-scanner.
- The module can wait until O(deployment) file is deployed/undeployed by deployment-scanner.
Duration of waiting time depends on scan-interval parameter from standalone.xml.
- Ensure no identically named application is deployed through the JBoss CLI
seealso:

14
plugins/modules/jenkins_job.py
View file

@ -30,14 +30,14 @@ options:
description:
- config in XML format.
- Required if job does not yet exist.
- Mutually exclusive with I(enabled).
- Considered if I(state=present).
- Mutually exclusive with O(enabled).
- Considered if O(state=present).
required: false
enabled:
description:
- Whether the job should be enabled or disabled.
- Mutually exclusive with I(config).
- Considered if I(state=present).
- Mutually exclusive with O(config).
- Considered if O(state=present).
type: bool
required: false
name:
@ -77,10 +77,10 @@ options:
type: bool
default: true
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.
- The C(python-jenkins) library only handles this by using the environment variable C(PYTHONHTTPSVERIFY).
- The C(python-jenkins) library only handles this by using the environment variable E(PYTHONHTTPSVERIFY).
version_added: 2.3.0
'''

10
plugins/modules/jenkins_job_info.py
View file

@ -15,7 +15,7 @@ module: jenkins_job_info
short_description: Get information about Jenkins jobs
description:
- This module can be used to query information about which Jenkins jobs which already exists.
- This module was called C(jenkins_job_info) before Ansible 2.9. The usage did not change.
- This module was called C(jenkins_job_facts) before Ansible 2.9. The usage did not change.
requirements:
- "python-jenkins >= 0.4.12"
extends_documentation_fragment:
@ -38,12 +38,12 @@ options:
type: str
description:
- Password to authenticate with the Jenkins server.
- This is mutually exclusive with I(token).
- This is mutually exclusive with O(token).
token:
type: str
description:
- API token used to authenticate with the Jenkins server.
- This is mutually exclusive with I(password).
- This is mutually exclusive with O(password).
url:
type: str
description:
@ -55,8 +55,8 @@ options:
- User to authenticate with the Jenkins server.
validate_certs:
description:
- If set to C(False), the SSL certificates will not be validated.
- This should only set to C(False) used on personally controlled sites using self-signed certificates.
- If set to V(false), the SSL certificates will not be validated.
- This should only set to V(false) used on personally controlled sites using self-signed certificates.
default: true
type: bool
author:

24
plugins/modules/jenkins_plugin.py
View file

@ -53,7 +53,7 @@ options:
type: str
description:
- Desired plugin state.
- If the C(latest) is set, the check for new version will be performed
- If set to V(latest), the check for new version will be performed
every time. This is suitable to keep the plugin up-to-date.
choices: [absent, present, pinned, unpinned, enabled, disabled, latest]
default: present
@ -65,18 +65,18 @@ options:
updates_expiration:
type: int
description:
- Number of seconds after which a new copy of the I(update-center.json)
- Number of seconds after which a new copy of the C(update-center.json)
file is downloaded. This is used to avoid the need to download the
plugin to calculate its checksum when C(latest) is specified.
- Set it to C(0) if no cache file should be used. In that case, the
plugin to calculate its checksum when O(state=latest) is specified.
- Set it to V(0) if no cache file should be used. In that case, the
plugin file will always be downloaded to calculate its checksum when
C(latest) is specified.
O(state=latest) is specified.
default: 86400
updates_url:
type: list
elements: str
description:
- A list of base URL(s) to retrieve I(update-center.json), and direct plugin files from.
- A list of base URL(s) to retrieve C(update-center.json), and direct plugin files from.
- This can be a list since community.general 3.3.0.
default: ['https://updates.jenkins.io', 'http://mirrors.jenkins.io']
update_json_url_segment:
@ -90,14 +90,14 @@ options:
type: list
elements: str
description:
- Path inside the I(updates_url) to get latest plugins from.
- Path inside the O(updates_url) to get latest plugins from.
default: ['latest']
version_added: 3.3.0
versioned_plugins_url_segments:
type: list
elements: str
description:
- Path inside the I(updates_url) to get specific version of plugins from.
- Path inside the O(updates_url) to get specific version of plugins from.
default: ['download/plugins', 'plugins']
version_added: 3.3.0
url:
@ -114,11 +114,11 @@ options:
- It might take longer to verify that the correct version is installed.
This is especially true if a specific version number is specified.
- Quote the version to prevent the value to be interpreted as float. For
example if C(1.20) would be unquoted, it would become C(1.2).
example if V(1.20) would be unquoted, it would become V(1.2).
with_dependencies:
description:
- Defines whether to install plugin dependencies.
- This option takes effect only if the I(version) is not defined.
- This option takes effect only if the O(version) is not defined.
type: bool
default: true
@ -127,11 +127,11 @@ notes:
the plugin files on the disk. Only if the plugin is not installed yet and
no version is specified, the API installation is performed which requires
only the Web UI credentials.
- It's necessary to notify the handler or call the I(service) module to
- It is necessary to notify the handler or call the M(ansible.builtin.service) module to
restart the Jenkins service after a new plugin was installed.
- Pinning works only if the plugin is installed and Jenkins service was
successfully restarted after the plugin installation.
- It is not possible to run the module remotely by changing the I(url)
- It is not possible to run the module remotely by changing the O(url)
parameter to point to the Jenkins server. The module must be used on the
host where Jenkins runs as it needs direct access to the plugin files.
extends_documentation_fragment:

28
plugins/modules/jira.py
View file

@ -44,25 +44,25 @@ options:
choices: [ attach, comment, create, edit, fetch, link, search, transition, update, worklog ]
description:
- The operation to perform.
- C(worklog) was added in community.genereal 6.5.0.
- V(worklog) was added in community.genereal 6.5.0.
username:
type: str
description:
- The username to log-in with.
- Must be used with I(password). Mutually exclusive with I(token).
- Must be used with O(password). Mutually exclusive with O(token).
password:
type: str
description:
- The password to log-in with.
- Must be used with I(username). Mutually exclusive with I(token).
- Must be used with O(username). Mutually exclusive with O(token).
token:
type: str
description:
- The personal access token to log-in with.
- Mutually exclusive with I(username) and I(password).
- Mutually exclusive with O(username) and O(password).
version_added: 4.2.0
project:
@ -128,20 +128,20 @@ options:
type: str
required: false
description:
- Only used when I(operation) is C(transition), and a bit of a misnomer, it actually refers to the transition name.
- Only used when O(operation) is V(transition), and a bit of a misnomer, it actually refers to the transition name.
assignee:
type: str
required: false
description:
- Sets the the assignee when I(operation) is C(create), C(transition) or C(edit).
- Recent versions of JIRA no longer accept a user name as a user identifier. In that case, use I(account_id) instead.
- Sets the the assignee when O(operation) is V(create), V(transition), or V(edit).
- Recent versions of JIRA no longer accept a user name as a user identifier. In that case, use O(account_id) instead.
- Note that JIRA may not allow changing field values on specific transitions or states.
account_id:
type: str
description:
- Sets the account identifier for the assignee when I(operation) is C(create), C(transition) or C(edit).
- Sets the account identifier for the assignee when O(operation) is V(create), V(transition), or V(edit).
- Note that JIRA may not allow changing field values on specific transitions or states.
version_added: 2.5.0
@ -183,8 +183,8 @@ options:
maxresults:
required: false
description:
- Limit the result of I(operation=search). If no value is specified, the default jira limit will be used.
- Used when I(operation=search) only, ignored otherwise.
- Limit the result of O(operation=search). If no value is specified, the default jira limit will be used.
- Used when O(operation=search) only, ignored otherwise.
type: int
version_added: '0.2.0'
@ -198,7 +198,7 @@ options:
validate_certs:
required: false
description:
- Require valid SSL certificates (set to C(false) if you'd like to use self-signed certificates)
- Require valid SSL certificates (set to V(false) if you would like to use self-signed certificates)
default: true
type: bool
@ -212,12 +212,12 @@ options:
required: true
type: path
description:
- The path to the file to upload (from the remote node) or, if I(content) is specified,
- The path to the file to upload (from the remote node) or, if O(attachment.content) is specified,
the filename to use for the attachment.
content:
type: str
description:
- The Base64 encoded contents of the file to attach. If not specified, the contents of I(filename) will be
- The Base64 encoded contents of the file to attach. If not specified, the contents of O(attachment.filename) will be
used instead.
mimetype:
type: str
@ -227,7 +227,7 @@ options:
notes:
- "Currently this only works with basic-auth, or tokens."
- "To use with JIRA Cloud, pass the login e-mail as the I(username) and the API token as I(password)."
- "To use with JIRA Cloud, pass the login e-mail as the O(username) and the API token as O(password)."
author:
- "Steve Smith (@tarka)"