summaryrefslogtreecommitdiffstats
path: root/ansible_collections/community/general/plugins/modules/puppet.py
diff options
context:
space:
mode:
Diffstat (limited to 'ansible_collections/community/general/plugins/modules/puppet.py')
-rw-r--r--ansible_collections/community/general/plugins/modules/puppet.py18
1 files changed, 7 insertions, 11 deletions
diff --git a/ansible_collections/community/general/plugins/modules/puppet.py b/ansible_collections/community/general/plugins/modules/puppet.py
index cd580791b..86eac062a 100644
--- a/ansible_collections/community/general/plugins/modules/puppet.py
+++ b/ansible_collections/community/general/plugins/modules/puppet.py
@@ -13,7 +13,7 @@ DOCUMENTATION = r'''
module: puppet
short_description: Runs puppet
description:
- - Runs I(puppet) agent or apply in a reliable manner.
+ - Runs C(puppet) agent or apply in a reliable manner.
extends_documentation_fragment:
- community.general.attributes
attributes:
@@ -24,7 +24,7 @@ attributes:
options:
timeout:
description:
- - How long to wait for I(puppet) to finish.
+ - How long to wait for C(puppet) to finish.
type: str
default: 30m
puppetmaster:
@@ -42,8 +42,8 @@ options:
noop:
description:
- Override puppet.conf noop mode.
- - When C(true), run Puppet agent with C(--noop) switch set.
- - When C(false), run Puppet agent with C(--no-noop) switch set.
+ - When V(true), run Puppet agent with C(--noop) switch set.
+ - When V(false), run Puppet agent with C(--no-noop) switch set.
- When unset (default), use default or puppet.conf value if defined.
type: bool
facts:
@@ -67,8 +67,8 @@ options:
logdest:
description:
- Where the puppet logs should go, if puppet apply is being used.
- - C(all) will go to both C(console) and C(syslog).
- - C(stdout) will be deprecated and replaced by C(console).
+ - V(all) will go to both C(console) and C(syslog).
+ - V(stdout) will be deprecated and replaced by C(console).
type: str
choices: [ all, stdout, syslog ]
default: stdout
@@ -114,8 +114,6 @@ options:
show_diff:
description:
- Whether to print file changes details
- - Alias C(show-diff) has been deprecated and will be removed in community.general 7.0.0.
- aliases: ['show-diff']
type: bool
default: false
requirements:
@@ -198,9 +196,7 @@ def main():
noop=dict(type='bool'),
logdest=dict(type='str', default='stdout', choices=['all', 'stdout', 'syslog']),
# The following is not related to Ansible's diff; see https://github.com/ansible-collections/community.general/pull/3980#issuecomment-1005666154
- show_diff=dict(
- type='bool', default=False, aliases=['show-diff'],
- deprecated_aliases=[dict(name='show-diff', version='7.0.0', collection_name='community.general')]),
+ show_diff=dict(type='bool', default=False),
facts=dict(type='dict'),
facter_basename=dict(type='str', default='ansible'),
environment=dict(type='str'),