NAME

WebService::OPNsense::Role::Settings - Role for settings get/set methods

VERSION

version 0.003

DESCRIPTION

Provides shared get/set methods for controller settings. All methods in this section are called on the consuming object, not on the role directly.

This role is consumed by WebService::OPNsense::CaptivePortal::Settings, WebService::OPNsense::Cron::Settings, WebService::OPNsense::Dnsmasq::Settings, WebService::OPNsense::IDS::Settings, WebService::OPNsense::IPsec::Connections, WebService::OPNsense::IPsec::KeyPairs, WebService::OPNsense::IPsec::PreSharedKeys, WebService::OPNsense::IPsec::Settings, WebService::OPNsense::Kea::CtrlAgent, WebService::OPNsense::Kea::Ddns, WebService::OPNsense::Kea::Dhcpv4, WebService::OPNsense::Kea::Dhcpv6, WebService::OPNsense::TrafficShaper::Settings, and WebService::OPNsense::Unbound::Settings.

PROVIDED METHODS

get_settings

my $config = $ctrl->get_settings;

Returns settings.

set_settings

my $result = $ctrl->set_settings( $settings_data );

Updates the settings.

client

my $http_client = $ctrl->client;

Returns the underlying HTTP client object used for API requests.

SEE ALSO

WebService::OPNsense::CaptivePortal::Settings, WebService::OPNsense::Cron::Settings, WebService::OPNsense::Dnsmasq::Settings, WebService::OPNsense::IDS::Settings, WebService::OPNsense::IPsec::Connections, WebService::OPNsense::IPsec::KeyPairs, WebService::OPNsense::IPsec::PreSharedKeys, WebService::OPNsense::IPsec::Settings, WebService::OPNsense::Kea::CtrlAgent, WebService::OPNsense::Kea::Ddns, WebService::OPNsense::Kea::Dhcpv4, WebService::OPNsense::Kea::Dhcpv6, WebService::OPNsense::TrafficShaper::Settings, WebService::OPNsense::Unbound::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