Configure Group Batch

POST 
/vyos/firewall/groups/batch

Configure firewall group using batch operations.

This is the main endpoint for configuring firewall groups. All operations are version-aware and sent to VyOS in a single batch for efficiency.

Address Group Operations (IPv4):

Operation	Value Required	Description
set_address_group	No	Create address group
delete_address_group	No	Delete address group
set_address_group_description	Yes	Set group description
delete_address_group_description	No	Delete group description
set_address_group_address	Yes	Add IPv4 address or range (e.g., 10.0.0.1 or 10.0.0.1-10.0.0.10)
delete_address_group_address	Yes	Remove IPv4 address or range

IPv6 Address Group Operations:

Operation	Value Required	Description
set_ipv6_address_group	No	Create IPv6 address group
delete_ipv6_address_group	No	Delete IPv6 address group
set_ipv6_address_group_description	Yes	Set group description
delete_ipv6_address_group_description	No	Delete group description
set_ipv6_address_group_address	Yes	Add IPv6 address or range
delete_ipv6_address_group_address	Yes	Remove IPv6 address or range

Network Group Operations (IPv4):

Operation	Value Required	Description
set_network_group	No	Create network group
delete_network_group	No	Delete network group
set_network_group_description	Yes	Set group description
delete_network_group_description	No	Delete group description
set_network_group_network	Yes	Add IPv4 network in CIDR (e.g., 10.0.0.0/24)
delete_network_group_network	Yes	Remove IPv4 network

IPv6 Network Group Operations:

Operation	Value Required	Description
set_ipv6_network_group	No	Create IPv6 network group
delete_ipv6_network_group	No	Delete IPv6 network group
set_ipv6_network_group_description	Yes	Set group description
delete_ipv6_network_group_description	No	Delete group description
set_ipv6_network_group_network	Yes	Add IPv6 network in CIDR
delete_ipv6_network_group_network	Yes	Remove IPv6 network

Port Group Operations:

Operation	Value Required	Description
set_port_group	No	Create port group
delete_port_group	No	Delete port group
set_port_group_description	Yes	Set group description
delete_port_group_description	No	Delete group description
set_port_group_port	Yes	Add port (number, range, or name: 80, 8000-8100, http)
delete_port_group_port	Yes	Remove port

Interface Group Operations:

Operation	Value Required	Description
set_interface_group	No	Create interface group
delete_interface_group	No	Delete interface group
set_interface_group_description	Yes	Set group description
delete_interface_group_description	No	Delete group description
set_interface_group_interface	Yes	Add interface name (e.g., eth0, eth1.100)
delete_interface_group_interface	Yes	Remove interface name

MAC Group Operations:

Operation	Value Required	Description
set_mac_group	No	Create MAC address group
delete_mac_group	No	Delete MAC address group
set_mac_group_description	Yes	Set group description
delete_mac_group_description	No	Delete group description
set_mac_group_mac	Yes	Add MAC address (e.g., 00:11:22:33:44:55)
delete_mac_group_mac	Yes	Remove MAC address

Domain Group Operations (VyOS 1.5+ only):

Operation	Value Required	Description
set_domain_group	No	Create domain name group
delete_domain_group	No	Delete domain name group
set_domain_group_description	Yes	Set group description
delete_domain_group_description	No	Delete group description
set_domain_group_address	Yes	Add domain name (e.g., example.com)
delete_domain_group_address	Yes	Remove domain name

Remote Group Operations (VyOS 1.5+ only):

Operation	Value Required	Description
set_remote_group	No	Create remote address group
delete_remote_group	No	Delete remote address group
set_remote_group_description	Yes	Set group description
delete_remote_group_description	No	Delete group description
set_remote_group_url	Yes	Set URL for remote address list (http/https)
delete_remote_group_url	No	Delete URL from remote group

Example:

{
    "group_name": "INTERNAL_NETS",
    "operations": [
        {"op": "set_network_group"},
        {"op": "set_network_group_description", "value": "Internal networks"},
        {"op": "set_network_group_network", "value": "10.0.0.0/8"},
        {"op": "set_network_group_network", "value": "192.168.0.0/16"}
    ]
}

Request

Responses

200

Successful Response

422

Validation Error