Skip to content

Commit 835a750

Browse files
authored
Merge pull request #1634 from markh0338/remote-group-docs
T7386: firewall: update remote-group docs to support IPv6
2 parents 2db8434 + fe9a039 commit 835a750

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

docs/configuration/firewall/groups.rst

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,28 +41,33 @@ Remote Groups
4141
==============
4242

4343
A **remote-group** takes an argument of a URL hosting a linebreak-deliminated
44-
list of IPv4s addresses, CIDRs and ranges. VyOS will pull this list periodicity
44+
list of IPv4 and/or IPv6 addresses, CIDRs and ranges. VyOS will pull this list periodicity
4545
according to the frequency defined in the firewall **resolver-interval** and load
4646
matching entries into the group for use in rules. The list will be cached in
4747
persistent storage, so in cases of update failure rules will still function.
4848

4949
.. cfgcmd:: set firewall group remote-group <name> url <http(s) url>
5050

51-
Define remote list of IPv4 addresses/ranges/CIDRs to fetch
51+
Define remote list of IPv4 and/or IPv6 addresses/ranges/CIDRs to fetch
5252

5353
.. cfgcmd:: set firewall group remote-group <name> description <text>
5454

55-
Set a description for a remote group
55+
Set a description for a remote group
5656

5757
The format of the remote list is very flexible. VyOS will attempt to parse the
5858
first word of each line as an entry, and will skip if it cannot find a valid
59-
match. Below is a list of acceptable matches that would be parsed correctly:
59+
match. Lines that begin with an alphanumeric character but do not match valid IPv4
60+
or IPv6 addresses, ranges, or CIDRs will be logged to the system log. Below is a
61+
list of acceptable matches that would be parsed correctly:
6062

6163
.. code-block:: none
6264
6365
127.0.0.1
6466
127.0.0.0/24
6567
127.0.0.1-127.0.0.254
68+
2001:db8::1
69+
2001:db8:cafe::/48
70+
2001:db8:cafe::1-2001:db8:cafe::ffff
6671
6772
Network Groups
6873
==============
@@ -258,7 +263,7 @@ As any other firewall group, dynamic firewall groups can be used in firewall
258263
rules as matching options. For example:
259264

260265
.. code-block:: none
261-
266+
262267
set firewall ipv4 input filter rule 10 source group dynamic-address-group FOO
263268
set firewall ipv4 input filter rule 10 destination group dynamic-address-group BAR
264269
@@ -272,10 +277,10 @@ General example
272277
As said before, once firewall groups are created, they can be referenced
273278
either in firewall, nat, nat66 and/or policy-route rules.
274279

275-
Here is an example were multiple groups are created:
280+
Here is an example were multiple groups are created:
276281

277282
.. code-block:: none
278-
283+
279284
set firewall group address-group SERVERS address 198.51.100.101
280285
set firewall group address-group SERVERS address 198.51.100.102
281286
set firewall group network-group TRUSTEDv4 network 192.0.2.0/30
@@ -290,7 +295,7 @@ Here is an example were multiple groups are created:
290295
And next, some configuration example where groups are used:
291296

292297
.. code-block:: none
293-
298+
294299
set firewall ipv4 output filter rule 10 action accept
295300
set firewall ipv4 output filter rule 10 outbound-interface group !LAN
296301
set firewall ipv4 forward filter rule 20 action accept
@@ -453,4 +458,4 @@ Here is an example of such command:
453458
PORT-SERVERS port_group route-PBR-201 443
454459
route-PBR-201 5000-5010
455460
nat-destination-101 http
456-
vyos@vyos:~$
461+
vyos@vyos:~$

0 commit comments

Comments
 (0)