NAME
WebService::OPNsense::Firewall::Category - Firewall category controller
VERSION
version 0.002
SYNOPSIS
my $category = $opn->firewall->category;
my $results = $category->search_item;
my $item = $category->get_item($uuid);DESCRIPTION
Manages firewall category items. Categories group firewall rules for organizational purposes.
METHODS
set_category
my $result = $category->set_category($category_data);Sets global category settings.
download
my $data = $category->download;Downloads all category configuration.
upload
my $result = $category->upload($upload_data);Uploads category configuration.
get
my $categories = $category->get;Returns all category configuration.
PROVIDED METHODS
The following methods are inherited from consumed roles.
search_item
my $results = $ctrl->search_item( %params );Searches for categories.
get_item
my $category = $ctrl->get_item( $uuid );Returns a single category by UUID. Throws if $uuid is not a valid UUID.
add_item
my $result = $ctrl->add_item( $category_data );Creates category.
set_item
my $result = $ctrl->set_item( $uuid, $category_data );Updates category. Throws if $uuid is not a valid UUID.
del_item
my $result = $ctrl->del_item( $uuid );Deletes a category by UUID. Throws if $uuid is not a valid UUID.
client
my $http_client = $ctrl->client;Returns the underlying HTTP client object used for API requests.
SEE ALSO
WebService::OPNsense::Firewall::Filter, WebService::OPNsense::Firewall::Alias, WebService::OPNsense::Firewall::DNat, WebService::OPNsense::Firewall::OneToOne, WebService::OPNsense::Firewall::SourceNat, WebService::OPNsense::Firewall::Npt
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