/ 
WebService-OPNsense-0.003
/ WebService::OPNsense::System

NAME

WebService::OPNsense::System - System API controller

VERSION

version 0.003

SYNOPSIS

my $sys = $opn->system;

my $status  = $sys->status;
my $info    = $sys->firmware_info;
my $upgrade = $sys->firmware_upgrade;

DESCRIPTION

System status, firmware information, and system operations.

METHODS

changelog

my $changelog = $sys->changelog($version);

Returns the firmware changelog for the given version.

firmware_info

my $info = $sys->firmware_info;

Returns firmware version and update information.

firmware_status

my $status = $sys->firmware_status;

Returns current firmware status (e.g. if updates are available).

firmware_upgrade

my $result = $sys->firmware_upgrade;

Starts a firmware upgrade process. Returns the upgrade job result.

halt

my $result = $sys->halt;

Halts (shuts down) the system immediately.

reboot

my $result = $sys->reboot;

Reboots the system immediately.

status

my $status = $sys->status;

Returns system status information.

client

my $http_client = $sys->client;

Returns the underlying HTTP client object used for API requests.

SEE ALSO

WebService::OPNsense

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