ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-28 07:31:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

[PR #10463/d288555f backport][stable-10] doc style adjustments: modules p* (#10467)

Browse source 
doc style adjustments: modules p* (#10463)

* doc style adjustments: modules p*

* Update plugins/modules/pacemaker_resource.py

* Update plugins/modules/pagerduty_alert.py

* Update plugins/modules/pear.py

* Update plugins/modules/portage.py

* reformat

* adjustment from review

* Update plugins/modules/pkg5_publisher.py



---------


(cherry picked from commit d288555fd9)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Co-authored-by: Peter Oliver <github.com@mavit.org.uk>
This commit is contained in:
patchback[bot] 2025-07-27 12:13:49 +02:00 • committed by GitHub
commit 478100011b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
30 changed files with 161 additions and 155 deletions
Download patch file Download diff file Expand all files Collapse all files

14
plugins/modules/packet_device.py
View file

@ -111,9 +111,9 @@ options:
state:
description:
- Desired state of the device.
- If set to V(present) (the default), the module call will return immediately after the device-creating HTTP request
successfully returns.
- If set to V(active), the module call will block until all the specified devices are in state active due to the Packet
- If set to V(present) (the default), the module call returns immediately after the device-creating HTTP request successfully
returns.
- If set to V(active), the module call blocks until all the specified devices are in state active due to the Packet
API, or until O(wait_timeout).
choices: [present, absent, active, inactive, rebooted]
default: present
@ -127,16 +127,16 @@ options:
wait_for_public_IPv:
description:
- Whether to wait for the instance to be assigned a public IPv4/IPv6 address.
- If set to 4, it will wait until IPv4 is assigned to the instance.
- If set to 6, wait until public IPv6 is assigned to the instance.
- If set to V(4), it waits until IPv4 is assigned to the instance.
- If set to V(6), it waits until public IPv6 is assigned to the instance.
choices: [4, 6]
type: int
wait_timeout:
description:
- How long (seconds) to wait either for automatic IP address assignment, or for the device to reach the V(active) state.
- If O(wait_for_public_IPv) is set and O(state=active), the module will wait for both events consequently, applying
the timeout twice.
- If O(wait_for_public_IPv) is set and O(state=active), the module waits for both events consequently, applying the
timeout twice.
default: 900
type: int

6
plugins/modules/packet_ip_subnet.py
View file

@ -75,11 +75,11 @@ options:
state:
description:
- Desired state of the IP subnet on the specified device.
- With O(state=present), you must specify either O(hostname) or O(device_id). Subnet with given CIDR will then be assigned
- With O(state=present), you must specify either O(hostname) or O(device_id). Subnet with given CIDR is then 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
- With O(state=absent), you can specify either O(hostname) or O(device_id). The subnet is then removed from specified
devices.
- If you leave both O(hostname) and O(device_id) empty, the subnet will be removed from any device it is assigned to.
- If you leave both O(hostname) and O(device_id) empty, the subnet is then removed from any device it is assigned to.
choices: ['present', 'absent']
default: 'present'
type: str

2
plugins/modules/packet_sshkey.py
View file

@ -35,7 +35,7 @@ options:
type: str
label:
description:
- Label for the key. If you keep it empty, it will be read from key string.
- Label for the key. If you keep it empty, it is read from key string.
type: str
aliases: [name]
id:

13
plugins/modules/pacman.py
View file

@ -41,9 +41,9 @@ options:
state:
description:
- Whether to install (V(present) or V(installed), V(latest)), or remove (V(absent) or V(removed)) a package.
- V(present) and V(installed) will simply ensure that a desired package is installed.
- V(latest) will update the specified package if it is not of the latest available version.
- V(absent) and V(removed) will remove the specified package.
- V(present) and V(installed) simply ensure that a desired package is installed.
- V(latest) updates the specified package if it is not of the latest available version.
- V(absent) and V(removed) remove the specified package.
default: present
choices: [absent, installed, latest, present, removed]
type: str
@ -116,15 +116,14 @@ options:
reason_for:
description:
- Set the install reason for V(all) packages or only for V(new) packages.
- In case of O(state=latest) already installed packages which will be updated to a newer version are not counted as
V(new).
- In case of O(state=latest) already installed packages which are updated to a newer version are not counted as V(new).
default: new
choices: [all, new]
type: str
version_added: 5.4.0
notes:
- When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly
- When used with a C(loop:) each package is processed individually, it is much more efficient to pass the list directly
to the O(name) option.
- To use an AUR helper (O(executable) option), a few extra setup steps might be required beforehand. For example, a dedicated
build user with permissions to install packages could be necessary.
@ -142,7 +141,7 @@ packages:
returned: success and O(name) is specified or O(upgrade=true)
type: list
elements: str
sample: [package, other-package]
sample: ["package", "other-package"]
cache_updated:
description:

8
plugins/modules/pacman_key.py
View file

@ -18,9 +18,9 @@ description:
- Add or remove gpg keys from the pacman keyring.
notes:
- Use full-length key ID (40 characters).
- Keys will be verified when using O(data), O(file), or O(url) unless O(verify) is overridden.
- Keys will be locally signed after being imported into the keyring.
- If the key ID exists in the keyring, the key will not be added unless O(force_update) is specified.
- Keys are verified when using O(data), O(file), or O(url) unless O(verify) is overridden.
- Keys are locally signed after being imported into the keyring.
- If the key ID exists in the keyring, the key is not added unless O(force_update) is specified.
- O(data), O(file), O(url), and O(keyserver) are mutually exclusive.
requirements:
- gpg
@ -72,7 +72,7 @@ options:
keyring:
description:
- The full path to the keyring folder on the remote server.
- If not specified, module will use pacman's default (V(/etc/pacman.d/gnupg)).
- If not specified, module uses pacman's default (V(/etc/pacman.d/gnupg)).
- Useful if the remote system requires an alternative gnupg directory.
type: path
default: /etc/pacman.d/gnupg

6
plugins/modules/pagerduty.py
View file

@ -13,7 +13,7 @@ DOCUMENTATION = r"""
module: pagerduty
short_description: Create PagerDuty maintenance windows
description:
- This module will let you create PagerDuty maintenance windows.
- This module lets you create PagerDuty maintenance windows.
author:
- "Andrew Newdigate (@suprememoocow)"
- "Dylan Silva (@thaumos)"
@ -79,8 +79,8 @@ options:
default: Created by Ansible
validate_certs:
description:
- If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
self-signed certificates.
- If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed
certificates.
type: bool
default: true
"""

20
plugins/modules/pagerduty_alert.py
View file

@ -12,7 +12,7 @@ DOCUMENTATION = r"""
module: pagerduty_alert
short_description: Trigger, acknowledge or resolve PagerDuty incidents
description:
- This module will let you trigger, acknowledge or resolve a PagerDuty incident by sending events.
- This module lets you trigger, acknowledge or resolve a PagerDuty incident by sending events.
author:
- "Amanpreet Singh (@ApsOps)"
- "Xiao Shen (@xshen1)"
@ -43,7 +43,7 @@ options:
service_id:
type: str
description:
- ID of PagerDuty service when incidents will be triggered, acknowledged or resolved.
- ID of PagerDuty service when incidents are triggered, acknowledged or resolved.
- Required if O(api_version=v1).
service_key:
type: str
@ -92,10 +92,9 @@ options:
type: str
description:
- For O(state=triggered) - Required. Short description of the problem that led to this trigger. This field (or a truncated
version) will be used when generating phone calls, SMS messages and alert emails. It will also appear on the incidents
tables in the PagerDuty UI. The maximum length is 1024 characters.
- For O(state=acknowledged) or O(state=resolved) - Text that will appear in the incident's log associated with this
event.
version) is used when generating phone calls, SMS messages and alert emails. It also appears on the incidents tables
in the PagerDuty UI. The maximum length is 1024 characters.
- For O(state=acknowledged) or O(state=resolved) - Text that appears in the incident's log associated with this event.
default: Created via Ansible
incident_class:
type: str
@ -106,12 +105,11 @@ options:
type: str
description:
- Identifies the incident to which this O(state) should be applied.
- For O(state=triggered) - If there is no open (in other words unresolved) incident with this key, a new one will be
created. If there is already an open incident with a matching key, this event will be appended to that incident's
log. The event key provides an easy way to 'de-dup' problem reports. If no O(incident_key) is provided, then it will
be generated by PagerDuty.
- For O(state=triggered) - If there is no open (in other words unresolved) incident with this key, a new one is created.
If there is already an open incident with a matching key, this event is appended to that incident's log. The event
key provides an easy way to 'de-dup' problem reports. If no O(incident_key) is provided, then it is generated by PagerDuty.
- For O(state=acknowledged) or O(state=resolved) - This should be the incident_key you received back when the incident
was first opened by a trigger event. Acknowledge events referencing resolved or nonexistent incidents will be discarded.
was first opened by a trigger event. Acknowledge events referencing resolved or nonexistent incidents is discarded.
link_url:
type: str
description:

6
plugins/modules/pagerduty_change.py
View file

@ -13,8 +13,8 @@ module: pagerduty_change
short_description: Track a code or infrastructure change as a PagerDuty change event
version_added: 1.3.0
description:
- This module will let you create a PagerDuty change event each time the module is run.
- This is not an idempotent action and a new change event will be created each time it is run.
- This module lets you create a PagerDuty change event each time the module is run.
- This is not an idempotent action and a new change event is created each time it is run.
author:
- Adam Vaughan (@adamvaughan)
requirements:
@ -82,7 +82,7 @@ options:
type: str
validate_certs:
description:
- If V(false), SSL certificates for the target URL will not be validated. This should only be used on personally controlled
- If V(false), SSL certificates for the target URL are not validated. This should only be used on personally controlled
sites using self-signed certificates.
required: false
default: true

4
plugins/modules/pam_limits.py
View file

@ -80,7 +80,7 @@ options:
default: false
use_min:
description:
- If set to V(true), the minimal value will be used or conserved.
- If set to V(true), the minimal value is used or conserved.
- If the specified value is inferior to the value in the file, file content is replaced with the new value, else content
is not modified.
required: false
@ -88,7 +88,7 @@ options:
default: false
use_max:
description:
- If set to V(true), the maximal value will be used or conserved.
- If set to V(true), the maximal value is used or conserved.
- If the specified value is superior to the value in the file, file content is replaced with the new value, else content
is not modified.
required: false

17
plugins/modules/pamd.py
View file

@ -68,21 +68,20 @@ options:
type: str
module_arguments:
description:
- 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=updated), the O(module_arguments) replace existing module_arguments.
- When O(state=args_absent) args matching those listed in O(module_arguments) are 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.
- Furthermore, if the module argument takes a value denoted by C(=), the value changes to that specified in module_arguments.
type: list
elements: str
state:
description:
- The default of V(updated) will modify an existing rule if type, control and module_path all match an existing rule.
- With V(before), the new rule will be inserted before a rule matching type, control and module_path.
- Similarly, with V(after), the new rule will be inserted after an existing rulematching type, control and module_path.
- The default of V(updated) modifies an existing rule if type, control and module_path all match an existing rule.
- With V(before), the new rule is inserted before a rule matching type, control and module_path.
- Similarly, with V(after), the new rule is inserted after an existing rulematching type, control and module_path.
- 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.
- If state is V(args_absent) or V(args_present), O(new_type), O(new_control), and O(new_module_path) are ignored.
- State V(absent) removes the rule.
type: str
choices: [absent, before, after, args_absent, args_present, updated]
default: updated

17
plugins/modules/parted.py
View file

@ -50,7 +50,7 @@ options:
type: int
unit:
description:
- Selects the current default unit that Parted will use to display locations and capacities on the disk and to interpret
- Selects the current default unit that Parted uses to display locations and capacities on the disk and to interpret
those given by the user if they are not suffixed by an unit.
- When fetching information about a disk, it is recommended to always specify a unit.
type: str
@ -59,8 +59,7 @@ options:
label:
description:
- Disk label type or partition table to use.
- If O(device) already contains a different label, it will be changed to O(label) and any previous partitions will be
lost.
- If O(device) already contains a different label, it is changed to O(label) and any previous partitions are lost.
- A O(name) must be specified for a V(gpt) partition table.
type: str
choices: [aix, amiga, bsd, dvh, gpt, loop, mac, msdos, pc98, sun]
@ -74,8 +73,8 @@ options:
default: primary
part_start:
description:
- Where the partition will start as offset from the beginning of the disk, that is, the "distance" from the start of
the disk. Negative numbers specify distance from the end of the disk.
- Where the partition starts as offset from the beginning of the disk, that is, the "distance" from the start of the
disk. Negative numbers specify distance from the end of the disk.
- The distance can be specified with all the units supported by parted (except compat) and it is case sensitive, for
example V(10GiB), V(15%).
- Using negative values may require setting of O(fs_type) (see notes).
@ -83,8 +82,8 @@ options:
default: 0%
part_end:
description:
- Where the partition will end as offset from the beginning of the disk, that is, the "distance" from the start of the
disk. Negative numbers specify distance from the end of the disk.
- Where the partition ends as offset from the beginning of the disk, that is, the "distance" from the start of the disk.
Negative numbers specify distance from the end of the disk.
- The distance can be specified with all the units supported by parted (except compat) and it is case sensitive, for
example V(10GiB), V(15%).
type: str
@ -100,13 +99,13 @@ options:
state:
description:
- Whether to create or delete a partition.
- If set to V(info) the module will only return the device information.
- If set to V(info) the module only returns the device information.
type: str
choices: [absent, present, info]
default: info
fs_type:
description:
- If specified and the partition does not exist, will set filesystem type to given partition.
- If specified and the partition does not exist, sets filesystem type to given partition.
- Parameter optional, but see notes below about negative O(part_start) values.
type: str
version_added: '0.2.0'

10
plugins/modules/pear.py
View file

@ -47,14 +47,14 @@ options:
description:
- List of regular expressions that can be used to detect prompts during pear package installation to answer the expected
question.
- Prompts will be processed in the same order as the packages list.
- Prompts are processed in the same order as the packages list.
- You can optionally specify an answer to any question in the list.
- If no answer is provided, the list item will only contain the regular expression.
- "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:
- If no answer is provided, the list item must contain only the regular expression.
- "To specify an answer, the item must be a dictionary 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, V(null).
- A prompt list can be shorter or longer than the packages list but it issues a warning.
- If you want to specify that a package does not need prompts in the middle of a list, V(null).
type: list
elements: raw
version_added: 0.2.0

2
plugins/modules/pingdom.py
View file

@ -12,7 +12,7 @@ DOCUMENTATION = r"""
module: pingdom
short_description: Pause/unpause Pingdom alerts
description:
- This module will let you pause/unpause Pingdom alerts.
- This module lets you pause/unpause Pingdom alerts.
author:
- "Dylan Silva (@thaumos)"
- "Justin Johns (!UNKNOWN)"

68
plugins/modules/pip_package_info.py
View file

@ -20,8 +20,8 @@ extends_documentation_fragment:
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 V(pip3.7).
- A list of the pip executables that are used to get the packages. They can be supplied with the full path or just the
executable name, for example V(pip3.7).
default: ['pip']
required: false
type: list
@ -59,37 +59,39 @@ packages:
returned: always
type: dict
sample:
"packages": {
"pip": {
"Babel": [
{
"name": "Babel",
"source": "pip",
"version": "2.6.0"
}
],
"Flask": [
{
"name": "Flask",
"source": "pip",
"version": "1.0.2"
}
],
"Flask-SQLAlchemy": [
{
"name": "Flask-SQLAlchemy",
"source": "pip",
"version": "2.3.2"
}
],
"Jinja2": [
{
"name": "Jinja2",
"source": "pip",
"version": "2.10"
}
],
},
{
"packages": {
"pip": {
"Babel": [
{
"name": "Babel",
"source": "pip",
"version": "2.6.0"
}
],
"Flask": [
{
"name": "Flask",
"source": "pip",
"version": "1.0.2"
}
],
"Flask-SQLAlchemy": [
{
"name": "Flask-SQLAlchemy",
"source": "pip",
"version": "2.3.2"
}
],
"Jinja2": [
{
"name": "Jinja2",
"source": "pip",
"version": "2.10"
}
]
}
}
}
"""

2
plugins/modules/pipx.py
View file

@ -154,7 +154,7 @@ options:
version_added: 9.4.0
requirements:
- When using O(name) with version specifiers, the Python package C(packaging) is required.
- If the package C(packaging) is at a version lesser than C(22.0.0), it will fail silently when processing invalid specifiers,
- If the package C(packaging) is at a version lesser than C(22.0.0), it fails silently when processing invalid specifiers,
like C(tox<<<<4.0).
author:
- "Alexei Znamensky (@russoz)"

10
plugins/modules/pipx_info.py
View file

@ -115,7 +115,15 @@ cmd:
returned: success
type: list
elements: str
sample: ["/usr/bin/python3.10", "-m", "pipx", "list", "--include-injected", "--json"]
sample:
[
"/usr/bin/python3.10",
"-m",
"pipx",
"list",
"--include-injected",
"--json"
]
version:
description: Version of pipx.

2
plugins/modules/pkg5_publisher.py
View file

@ -16,7 +16,7 @@ author: "Peter Oliver (@mavit)"
short_description: Manages Solaris 11 Image Packaging System publishers
description:
- IPS packages are the native packages in Solaris 11 and higher.
- This modules will configure which publishers a client will download IPS packages from.
- This module configures which publishers a client downloads IPS packages from.
extends_documentation_fragment:
- community.general.attributes
attributes:

2
plugins/modules/pkgin.py
View file

@ -26,7 +26,7 @@ author:
- "Shaun Zinck (@szinck)"
- "Jasper Lievisse Adriaanse (@jasperla)"
notes:
- 'Known bug with pkgin < 0.8.0: if a package is removed and another package depends on it, the other package will be silently
- 'Known bug with pkgin < 0.8.0: if a package is removed and another package depends on it, the other package is silently
removed as well.'
extends_documentation_fragment:
- community.general.attributes

12
plugins/modules/pkgng.py
View file

@ -30,7 +30,7 @@ options:
name:
description:
- Name or list of names of packages to install/remove.
- With O(name=*), O(state=latest) will operate, but O(state=present) and O(state=absent) will be noops.
- With O(name=*), O(state=latest) operates, but O(state=present) and O(state=absent) are noops.
required: true
aliases: [pkg]
type: list
@ -65,19 +65,19 @@ options:
type: str
rootdir:
description:
- For C(pkgng) versions 1.5 and later, pkg will install all packages within the specified root directory.
- For C(pkgng) versions 1.5 and later, pkg installs all packages within the specified root directory.
- Can not be used together with O(chroot) or O(jail) options.
required: false
type: path
chroot:
description:
- Pkg will chroot in the specified environment.
- Pkg chroots in the specified environment.
- Can not be used together with O(rootdir) or O(jail) options.
required: false
type: path
jail:
description:
- Pkg will execute in the given jail name or ID.
- Pkg executes in the given jail name or ID.
- Can not be used together with O(chroot) or O(rootdir) options.
type: str
autoremove:
@ -103,8 +103,8 @@ options:
version_added: 9.3.0
author: "bleader (@bleader)"
notes:
- When using pkgsite, be careful that already in cache packages will not be downloaded again.
- When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly
- When using pkgsite, be careful that already in cache packages are not downloaded again.
- When used with a C(loop:) each package is processed individually, it is much more efficient to pass the list directly
to the O(name) option.
"""

4
plugins/modules/pkgutil.py
View file

@ -17,7 +17,7 @@ module: pkgutil
short_description: OpenCSW package management on Solaris
description:
- This module installs, updates and removes packages from the OpenCSW project for Solaris.
- Unlike the M(community.general.svr4pkg) module, it will resolve and download dependencies.
- Unlike the M(community.general.svr4pkg) module, it resolves and downloads dependencies.
- See U(https://www.opencsw.org/) for more information about the project.
author:
- Alexander Winkler (@dermute)
@ -50,7 +50,7 @@ options:
state:
description:
- Whether to install (V(present)/V(installed)), or remove (V(absent)/V(removed)) packages.
- The upgrade (V(latest)) operation will update/install the packages to the latest version available.
- The upgrade (V(latest)) operation updates/installs the packages to the latest version available.
type: str
required: true
choices: [absent, installed, latest, present, removed]

35
plugins/modules/pmem.py
View file

@ -46,9 +46,9 @@ options:
type: int
reserved:
description:
- Percentage of the capacity to reserve (V(0)-V(100)). O(reserved) will not be mapped into the system physical address
space and will be presented as reserved capacity with Show Device and Show Memory Resources Commands.
- O(reserved) will be set automatically if this is not configured.
- Percentage of the capacity to reserve (V(0)-V(100)). O(reserved) is not mapped into the system physical address space
and is presented as reserved capacity with Show Device and Show Memory Resources Commands.
- O(reserved) is set automatically if this is not configured.
type: int
required: false
socket:
@ -147,20 +147,21 @@ result:
namespace:
description: The list of the detail of namespace.
type: list
sample: [
{
"appdirect": 111669149696,
"memorymode": 970662608896,
"reserved": 3626500096,
"socket": 0
},
{
"appdirect": 111669149696,
"memorymode": 970662608896,
"reserved": 3626500096,
"socket": 1
}
]
sample:
[
{
"appdirect": 111669149696,
"memorymode": 970662608896,
"reserved": 3626500096,
"socket": 0
},
{
"appdirect": 111669149696,
"memorymode": 970662608896,
"reserved": 3626500096,
"socket": 1
}
]
"""
EXAMPLES = r"""

4
plugins/modules/pnpm.py
View file

@ -77,14 +77,14 @@ options:
production:
description:
- Install dependencies in production mode.
- Pnpm will ignore any dependencies under C(devDependencies) in package.json.
- Pnpm ignores any dependencies under C(devDependencies) in package.json.
required: false
type: bool
default: false
dev:
description:
- Install dependencies in development mode.
- Pnpm will ignore any regular dependencies in C(package.json).
- Pnpm ignores any regular dependencies in C(package.json).
required: false
default: false
type: bool

2
plugins/modules/portage.py
View file

@ -193,7 +193,7 @@ options:
quietfail:
description:
- Suppresses display of the build log on stdout (--quiet-fail).
- Only the die message and the path of the build log will be displayed on stdout.
- Only the die message and the path of the build log are displayed on stdout.
type: bool
default: false

6
plugins/modules/pritunl_org.py
View file

@ -35,9 +35,9 @@ options:
type: bool
default: false
description:
- If O(force) is V(true) and O(state) is V(absent), the module will delete the organization, no matter if it contains
users or not. By default O(force) is V(false), which will cause the module to fail the deletion of the organization
when it contains users.
- If O(force) is V(true) and O(state) is V(absent), the module deletes the organization, no matter if it contains users
or not. By default O(force) is V(false), which causes the module to fail the deletion of the organization when it
contains users.
state:
type: str
default: 'present'

2
plugins/modules/pritunl_org_info.py
View file

@ -27,7 +27,7 @@ options:
- org
default: null
description:
- Name of the Pritunl organization to search for. If none provided, the module will return all Pritunl organizations.
- Name of the Pritunl organization to search for. If none provided, the module returns all Pritunl organizations.
"""
EXAMPLES = r"""

18
plugins/modules/pubnub_blocks.py
View file

@ -56,13 +56,13 @@ options:
default: {}
account:
description:
- Name of PubNub account for from which O(application) will be used to manage blocks.
- User's account will be used if value not set or empty.
- Name of PubNub account for from which O(application) is used to manage blocks.
- User's account is used if value not set or empty.
type: str
default: ''
application:
description:
- Name of target PubNub application for which blocks configuration on specific O(keyset) will be done.
- Name of target PubNub application for which blocks configuration on specific O(keyset) is done.
type: str
required: true
keyset:
@ -72,19 +72,19 @@ options:
required: true
state:
description:
- Intended block state after event handlers creation / update process will be completed.
- Intended block state after event handlers creation / update process is completed.
required: false
default: 'present'
choices: ['started', 'stopped', 'present', 'absent']
type: str
name:
description:
- Name of managed block which will be later visible on admin.pubnub.com.
- Name of managed block which is later visible on admin.pubnub.com.
required: true
type: str
description:
description:
- Short block description which will be later visible on U(https://admin.pubnub.com).
- Short block description which is later visible on U(https://admin.pubnub.com).
- Used only if block does not exists and does not change description for existing block.
required: false
type: str
@ -99,8 +99,8 @@ options:
- Each entry for existing handlers should contain C(name) (so target handler can be identified). Rest parameters (C(src),
C(channels) and C(event)) can be added if changes required for them.
- It is possible to rename event handler by adding C(changes) key to event handler payload and pass dictionary, which
will contain single key C(name), where new name should be passed.
- To remove particular event handler it is possible to set C(state) for it to C(absent) and it will be removed.
contains single key C(name), where new name should be passed.
- To remove particular event handler it is possible to set C(state) for it to C(absent) and it is removed.
required: false
default: []
type: list
@ -115,7 +115,7 @@ options:
validate_certs:
description:
- This key allow to try skip certificates check when performing REST API calls. Sometimes host may have issues with
certificates on it and this will cause problems to call PubNub REST API.
certificates on it and this causes problems to call PubNub REST API.
- If check should be ignored V(false) should be passed to this parameter.
required: false
default: true

12
plugins/modules/pulp_repo.py
View file

@ -36,7 +36,7 @@ options:
description:
- C(httplib2), the library used by the M(ansible.builtin.uri) module only sends authentication information when a webservice
responds to an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins
will fail. This option forces the sending of the Basic authentication header upon initial request.
fail. This option forces the sending of the Basic authentication header upon initial request.
type: bool
default: false
generate_sqlite:
@ -131,22 +131,22 @@ options:
default: true
state:
description:
- The repo state. A state of V(sync) will queue a sync of the repo. This is asynchronous but not delayed like a scheduled
sync. A state of V(publish) will use the repository's distributor to publish the content.
- The repo state. A state of V(sync) queues a sync of the repo. This is asynchronous but not delayed like a scheduled
sync. A state of V(publish) uses the repository's distributor to publish the content.
default: present
choices: ["present", "absent", "sync", "publish"]
type: str
url_password:
description:
- The password for use in HTTP basic authentication to the pulp API. If the O(url_username) parameter is not specified,
the O(url_password) parameter will not be used.
the O(url_password) parameter is not used.
url_username:
description:
- The username for use in HTTP basic authentication to the pulp API.
validate_certs:
description:
- If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
self-signed certificates.
- If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed
certificates.
type: bool
default: true
wait_for_completion:

8
plugins/modules/puppet.py
View file

@ -66,8 +66,8 @@ options:
logdest:
description:
- Where the puppet logs should go, if puppet apply is being used.
- V(all) will go to both C(console) and C(syslog).
- V(stdout) will be deprecated and replaced by C(console).
- V(all) goes to both C(console) and C(syslog).
- V(stdout) is deprecated and replaced by C(console).
type: str
choices: [all, stdout, syslog]
default: stdout
@ -128,8 +128,8 @@ options:
- The default value, V(C), is supported on every system, but can lead to encoding errors if UTF-8 is used in the output.
- Use V(C.UTF-8) or V(en_US.UTF-8) or similar UTF-8 supporting locales in case of problems. You need to make sure the
selected locale is supported on the system the puppet agent runs on.
- Starting with community.general 9.1.0, you can use the value V(auto) and the module will try and determine the best
parseable locale to use.
- Starting with community.general 9.1.0, you can use the value V(auto) and the module tries to determine the best parseable
locale to use.
type: str
default: C
version_added: 8.6.0

2
plugins/modules/pushover.py
View file

@ -15,7 +15,7 @@ short_description: Send notifications through U(https://pushover.net)
description:
- Send notifications through pushover to subscriber list of devices and email addresses. Requires pushover app on devices.
notes:
- You will require a pushover.net account to use this module. But no account is required to receive messages.
- You need a pushover.net account to use this module. But no account is required to receive messages.
extends_documentation_fragment:
- community.general.attributes
attributes:

2
plugins/modules/python_requirements_info.py
View file

@ -92,7 +92,7 @@ python_system_path:
- /usr/lib/python/site-packages/
valid:
description: A dictionary of dependencies that matched their desired versions. If no version was specified, then RV(ignore:desired)
will be V(null).
is V(null).
returned: always
type: dict
sample: