NAME
WebService::OPNsense::Firewall::Alias - Firewall alias controller
VERSION
version 0.001
SYNOPSIS
my $alias = $opn->firewall_alias;
# Search aliases
my $results = $alias->search_item;
# Create an alias
$alias->add_item({
alias => {
name => 'web-servers',
type => 'host',
content => "192.0.2.10\n192.0.2.11",
description => 'My web servers',
},
});DESCRIPTION
Manages firewall aliases.
NAME
WebService::OPNsense::Firewall::Alias - Firewall alias controller
METHODS
toggle_item
my $result = $alias->toggle_item($uuid, $enabled);reconfigure
my $result = $alias->reconfigure;Reconfigures aliases after changes.
get_alias_uuid
my $uuid = $alias->get_alias_uuid($name);Returns the UUID for an alias by name.
export
my $data = $alias->export($uuid);Exports an alias by UUID.
import_alias
my $result = $alias->import_alias($import_data);Imports an alias from data.
get_table_size
my $size = $alias->get_table_size;Returns the current alias table size.
list_categories
my $categories = $alias->list_categories;Returns a list of available alias categories.
list_countries
my $countries = $alias->list_countries;Returns a list of country codes for geo-based aliases.
list_network_aliases
my $aliases = $alias->list_network_aliases;Returns a list of network aliases available for nesting.
list_user_groups
my $groups = $alias->list_user_groups;Returns a list of user groups.
update
my $result = $alias->update($action);Updates aliases. Optionally specify an action (e.g. 'flush').
set_alias
my $result = $alias->set_alias($alias_data);Sets alias configuration (bulk operation).
get
my $aliases = $alias->get;Returns all alias configuration.
AUTHOR
Dean Hamstead <dean@fragfest.com.au>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2026 by Dean Hamstead.
This is free software, licensed under:
The MIT (X11) License