From b4628e27b2f42bb92aad3e80ec78c745493366b3 Mon Sep 17 00:00:00 2001 From: Alexei Znamensky <103110+russoz@users.noreply.github.com> Date: Fri, 28 Apr 2023 23:27:03 +1200 Subject: [PATCH] awall: improve docs (#6442) * awall: improve docs * Update plugins/modules/awall.py Co-authored-by: Felix Fontein --------- Co-authored-by: Felix Fontein --- plugins/modules/awall.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/plugins/modules/awall.py b/plugins/modules/awall.py index 856cf782d4..da1b29f701 100644 --- a/plugins/modules/awall.py +++ b/plugins/modules/awall.py @@ -15,7 +15,7 @@ module: awall short_description: Manage awall policies author: Ted Trask (@tdtrask) 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 and activates the configuration on the system. extends_documentation_fragment: @@ -41,8 +41,11 @@ options: description: - Activate the new firewall rules. - 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 default: false +notes: + - At least one of I(name) and I(activate) is required. ''' EXAMPLES = r'''