Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

firewall: T5493: Document remote-group #1619

Merged
merged 1 commit into from
Mar 30, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/configuration/firewall/groups.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,33 @@ In an **address group** a single IP address or IP address range is defined.

Provide a IPv4 or IPv6 address group description

Remote Groups
==============

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

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

Define remote list of IPv4 addresses/ranges/CIDRs to fetch

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

Set a description for a remote group

The format of the remote list is very flexible. VyOS will attempt to parse the
first word of each line as an entry, and will skip if it cannot find a valid
match. Below is a list of acceptable matches that would be parsed correctly:

.. code-block:: none

127.0.0.1
127.0.0.0/24
127.0.0.1-127.0.0.254

Network Groups
==============

Expand Down