summaryrefslogtreecommitdiff
path: root/docs/vyos.rest.vyos_firewall_rules_module.rst
diff options
context:
space:
mode:
authorJohn Estabrook <jestabro@vyos.io>2026-08-21 14:06:28 -0500
committerGitHub <noreply@github.com>2026-08-21 14:06:28 -0500
commitff5224728484eb4f3bbf6ae52fe0b79f64959660 (patch)
tree71b3e53e0080da60abf9fd2381705971dfe4d507 /docs/vyos.rest.vyos_firewall_rules_module.rst
parent7a6b5e4f3a7a021cfa75faa7bf833741dfc09cff (diff)
parent45dc95873fd906c582fbbd5e6ca3838caf867399 (diff)
downloadrest.vyos-ff5224728484eb4f3bbf6ae52fe0b79f64959660.tar.gz
rest.vyos-ff5224728484eb4f3bbf6ae52fe0b79f64959660.zip
Merge pull request #16 from vyos/T8989_wave4
T8989: wave4 vyos_command, dict_op refactor
Diffstat (limited to 'docs/vyos.rest.vyos_firewall_rules_module.rst')
-rw-r--r--docs/vyos.rest.vyos_firewall_rules_module.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/vyos.rest.vyos_firewall_rules_module.rst b/docs/vyos.rest.vyos_firewall_rules_module.rst
index b0e32c8..1f316fd 100644
--- a/docs/vyos.rest.vyos_firewall_rules_module.rst
+++ b/docs/vyos.rest.vyos_firewall_rules_module.rst
@@ -564,6 +564,7 @@ Notes
- Requires ``ansible_connection=httpapi`` with the VyOS httpapi plugin.
- ``ansible_network_os`` must be set to ``vyos.rest.vyos``.
- Rule sets are identified by AFI and name. Deleting a rule set removes all its rules.
+ - The ``group`` suboption can only reference an address-group. VyOS also supports network-group/port-group/domain-group references, which this module can read back (via ``gathered``) if already configured by other means, but cannot create -- the argspec has no group-type discriminator.
@@ -690,7 +691,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
<span style="color: purple">dictionary</span>
</div>
</td>
- <td>when changes are applied</td>
+ <td>always</td>
<td>
<div>Raw API response.</div>
<br/>
@@ -705,7 +706,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
<span style="color: purple">boolean</span>
</div>
</td>
- <td>when changes are applied</td>
+ <td>when changed</td>
<td>
<div>Whether the config was saved after changes.</div>
<br/>