NAME
WebService::OPNsense::Role::Service - Role for service control methods (status/start/stop/restart/reconfigure)
VERSION
version 0.002
DESCRIPTION
Provides shared service lifecycle methods (status, start, stop, restart, reconfigure). All methods in this section are called on the consuming object, not on the role directly.
This role is consumed by WebService::OPNsense::IPsec::Service, WebService::OPNsense::CaptivePortal::Service, WebService::OPNsense::Dnsmasq::Service, WebService::OPNsense::IDS::Service, WebService::OPNsense::Kea::Service, and WebService::OPNsense::Unbound::Service.
PROVIDED METHODS
status
my $status = $ctrl->status;Returns service status.
start
my $result = $ctrl->start;Starts the service.
stop
my $result = $ctrl->stop;Stops the service.
restart
my $result = $ctrl->restart;Restarts the service.
reconfigure
my $result = $ctrl->reconfigure;Reconfigures the service.
client
my $http_client = $ctrl->client;Returns the underlying HTTP client object used for API requests.
SEE ALSO
WebService::OPNsense::IPsec::Service, WebService::OPNsense::CaptivePortal::Service, WebService::OPNsense::Dnsmasq::Service, WebService::OPNsense::IDS::Service, WebService::OPNsense::Kea::Service, WebService::OPNsense::Unbound::Service
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