NAME
WebService::OPNsense::IDS::Settings - IDS settings controller
VERSION
version 0.001
SYNOPSIS
my $ids_settings = $opn->ids_settings;
my $settings = $ids_settings->get;DESCRIPTION
Manages IDS/IPS settings, rulesets, policies, and user rules.
NAME
WebService::OPNsense::IDS::Settings - IDS settings controller
METHODS
get
my $settings = $ids_settings->get;Returns the current IDS settings.
set_settings
my $result = $ids_settings->set_settings($settings_data);Updates IDS settings.
list_rulesets
my $rulesets = $ids_settings->list_rulesets;Lists available rulesets.
get_ruleset
my $ruleset = $ids_settings->get_ruleset($id);Returns a ruleset by ID.
set_ruleset
my $result = $ids_settings->set_ruleset($filename);Updates a ruleset by filename.
get_ruleset_properties
my $properties = $ids_settings->get_ruleset_properties;Returns ruleset properties.
set_ruleset_properties
my $result = $ids_settings->set_ruleset_properties($properties_data);Updates ruleset properties.
toggle_ruleset
my $result = $ids_settings->toggle_ruleset($filenames);Enables or disables rulesets by filename(s).
list_rule_metadata
my $metadata = $ids_settings->list_rule_metadata;Lists rule metadata.
get_rule_info
my $info = $ids_settings->get_rule_info($sid);Returns rule info by SID.
toggle_rule
my $result = $ids_settings->toggle_rule($sids, $enabled);Enables or disables rules by SID(s).
set_rule
my $result = $ids_settings->set_rule($sid);Updates a rule by SID.
search_installed_rules
my $rules = $ids_settings->search_installed_rules(%params);Searches installed rules.
search_policy
my $policies = $ids_settings->search_policy(%params);Searches for policies.
get_policy
my $policy = $ids_settings->get_policy($uuid);Returns a single policy by UUID.
add_policy
my $result = $ids_settings->add_policy($policy_data);Creates a new policy.
set_policy
my $result = $ids_settings->set_policy($uuid, $policy_data);Updates an existing policy.
del_policy
my $result = $ids_settings->del_policy($uuid);Deletes a policy by UUID.
toggle_policy
my $result = $ids_settings->toggle_policy($uuid, $enabled);Enables or disables a policy.
search_policy_rule
my $rules = $ids_settings->search_policy_rule(%params);Searches for policy rules.
get_policy_rule
my $rule = $ids_settings->get_policy_rule($uuid);Returns a single policy rule by UUID.
add_policy_rule
my $result = $ids_settings->add_policy_rule($rule_data);Creates a new policy rule.
set_policy_rule
my $result = $ids_settings->set_policy_rule($uuid, $rule_data);Updates an existing policy rule.
del_policy_rule
my $result = $ids_settings->del_policy_rule($uuid);Deletes a policy rule by UUID.
toggle_policy_rule
my $result = $ids_settings->toggle_policy_rule($uuid, $enabled);Enables or disables a policy rule.
search_user_rule
my $rules = $ids_settings->search_user_rule(%params);Searches for user rules.
get_user_rule
my $rule = $ids_settings->get_user_rule($uuid);Returns a single user rule by UUID.
add_user_rule
my $result = $ids_settings->add_user_rule($rule_data);Creates a new user rule.
set_user_rule
my $result = $ids_settings->set_user_rule($uuid, $rule_data);Updates an existing user rule.
del_user_rule
my $result = $ids_settings->del_user_rule($uuid);Deletes a user rule by UUID.
toggle_user_rule
my $result = $ids_settings->toggle_user_rule($uuid, $enabled);Enables or disables a user rule.
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