Skip to content

Commit 34663b1

Browse files
committed
Doc for categories parameter for rule and source_nat
1 parent b4c62dc commit 34663b1

File tree

3 files changed

+7
-1
lines changed

3 files changed

+7
-1
lines changed

Diff for: docs/source/modules/category.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,9 @@ Manage categories to ease maintenance of larger rulesets.
3535

3636
It currently just works with the 'Firewall' plugin:
3737

38-
- :ref:`ansibleguy.opnsense.alias <modules_alias>`
38+
- :ref:`ansibleguy.opnsense.alias <modules_alias>`, :ref:`ansibleguy.opnsense.alias_multi <modules_alias_multi>`
39+
- :ref:`ansibleguy.opnsense.rule <modules_rule>`, :ref:`ansibleguy.opnsense.rule_multi <modules_rule_multi>`
40+
- :ref:`ansibleguy.opnsense.source_nat <modules_source_nat>`
3941

4042
Examples
4143
********

Diff for: docs/source/modules/rule.rst

+2
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ Definition
7979
"gateway","string","false","\-","g, gw","Existing gateway to use"
8080
"log","boolean","false","true","l","If rule matches should be shown in the firewall logs"
8181
"description","string","false","\-","desc","Description for the rule"
82+
"categories","list","false","\-","cat",":ref:`Categories <modules_category>` for this alias."
8283
"state","string","false","'present'","st","State of the rule. One of: 'present', 'absent'"
8384
"enabled","boolean","false","true","en","If the rule should be en- or disabled"
8485
"uuid","string","false","\-","\-","Optionally you can supply the uuid of an existing rule"
@@ -138,6 +139,7 @@ Basic
138139
# destination_invert: false
139140
# log: true
140141
# gateway: 'LAN_GW'
142+
# category: ['Ansible managed']
141143
# state: 'present'
142144
# enabled: true
143145
# uuid: 'a9d85c00-0aa2-4705-b855-96aae16e05d7' # optionally use uuid to identify existing rules

Diff for: docs/source/modules/source_nat.rst

+2
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ Module alias: ansibleguy.opnsense.snat
7474
"target_port","string","false","\-","np, nat_port",""
7575
"log","boolean","false","true","l","If rule matches should be shown in the firewall logs"
7676
"description","string","false","\-","desc","Description for the rule"
77+
"categories","list","false","\-","cat",":ref:`Categories <modules_category>` for this alias."
7778
"state","string","false","'present'","st","State of the rule. One of: 'present', 'absent'"
7879
"enabled","boolean","false","true","en","If the rule should be en- or disabled"
7980
"uuid","string","false","\-","\-","Optionally you can supply the uuid of an existing rule"
@@ -133,6 +134,7 @@ Examples
133134
# target_port: none
134135
# no_nat: false
135136
# log: true
137+
# category: ['Ansible managed']
136138
# enabled: true
137139
# debug: false
138140
# state: 'present'

0 commit comments

Comments
 (0)