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

awall: improve docs (#6442)

* awall: improve docs

* Update plugins/modules/awall.py

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2023-04-28 23:27:03 +12:00 committed by GitHub
parent c58dda14c2
commit b4628e27b2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -15,7 +15,7 @@ module: awall
short_description: Manage awall policies short_description: Manage awall policies
author: Ted Trask (@tdtrask) <ttrask01@yahoo.com> author: Ted Trask (@tdtrask) <ttrask01@yahoo.com>
description: description:
- This modules allows for enable/disable/activate of I(awall) policies. - This modules allows for enable/disable/activate of C(awall) policies.
- Alpine Wall (I(awall)) generates a firewall configuration from the enabled policy files - Alpine Wall (I(awall)) generates a firewall configuration from the enabled policy files
and activates the configuration on the system. and activates the configuration on the system.
extends_documentation_fragment: extends_documentation_fragment:
@ -41,8 +41,11 @@ options:
description: description:
- Activate the new firewall rules. - Activate the new firewall rules.
- Can be run with other steps or on its own. - Can be run with other steps or on its own.
- Idempotency is affected if I(activate=true), as the module will always report a changed state.
type: bool type: bool
default: false default: false
notes:
- At least one of I(name) and I(activate) is required.
''' '''
EXAMPLES = r''' EXAMPLES = r'''