NAME
WebService::OPNsense::TrafficShaper::Settings - Traffic shaper settings controller
VERSION
version 0.002
SYNOPSIS
my $ts_settings = $opn->trafficshaper_settings;
my $settings = $ts_settings->get_settings;DESCRIPTION
Traffic shaper pipes, queues, and rules.
METHODS
get_settings
my $settings = $ts_settings->get_settings;Returns traffic shaper settings.
set_settings
my $result = $ts_settings->set_settings($settings_data);Updates traffic shaper settings.
search_pipes
my $pipes = $ts_settings->search_pipes(%params);Searches for pipes.
get_pipe
my $pipe = $ts_settings->get_pipe($uuid);Returns a single pipe by UUID.
add_pipe
my $result = $ts_settings->add_pipe($pipe_data);Creates pipe.
set_pipe
my $result = $ts_settings->set_pipe($uuid, $pipe_data);Updates pipe.
del_pipe
my $result = $ts_settings->del_pipe($uuid);Deletes a pipe by UUID.
toggle_pipe
my $result = $ts_settings->toggle_pipe($uuid, $enabled);Enables or disables a pipe.
download_pipes
my $pipes = $ts_settings->download_pipes;Downloads all pipe configurations.
upload_pipes
my $result = $ts_settings->upload_pipes($pipes_data);Uploads pipe configurations.
search_queues
my $queues = $ts_settings->search_queues(%params);Searches for queues.
get_queue
my $queue = $ts_settings->get_queue($uuid);Returns a single queue by UUID.
add_queue
my $result = $ts_settings->add_queue($queue_data);Creates queue.
set_queue
my $result = $ts_settings->set_queue($uuid, $queue_data);Updates queue.
del_queue
my $result = $ts_settings->del_queue($uuid);Deletes a queue by UUID.
toggle_queue
my $result = $ts_settings->toggle_queue($uuid, $enabled);Enables or disables a queue.
download_queues
my $queues = $ts_settings->download_queues;Downloads all queue configurations.
upload_queues
my $result = $ts_settings->upload_queues($queues_data);Uploads queue configurations.
search_rules
my $rules = $ts_settings->search_rules(%params);Searches for traffic shaper rules.
get_rule
my $rule = $ts_settings->get_rule($uuid);Returns a single traffic shaper rule by UUID.
add_rule
my $result = $ts_settings->add_rule($rule_data);Creates traffic shaper rule.
set_rule
my $result = $ts_settings->set_rule($uuid, $rule_data);Updates traffic shaper rule.
del_rule
my $result = $ts_settings->del_rule($uuid);Deletes a traffic shaper rule by UUID.
toggle_rule
my $result = $ts_settings->toggle_rule($uuid, $enabled);Enables or disables a traffic shaper rule.
client
my $http_client = $ts_settings->client;Returns the underlying HTTP client object used for API requests.
SEE ALSO
WebService::OPNsense::Role::Settings
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