/ 
WebService-OPNsense-0.001
/ WebService::OPNsense::System

NAME

WebService::OPNsense::System - System API controller

VERSION

version 0.001

SYNOPSIS

my $sys = $opn->system;

my $status = $sys->status;
my $info   = $sys->firmware_info;
my $version = $sys->version;

DESCRIPTION

System status, firmware information, and system operations.

NAME

WebService::OPNsense::System - System API controller

METHODS

status

my $status = $sys->status;

Returns system status information.

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).

hostname

my $hostname = $sys->hostname;

Returns the system hostname.

version

my $version = $sys->version;

Returns the OPNsense version string.

logging

my $logs = $sys->logging(%params);

Searches system logs. Parameters: current, rowCount, searchPhrase, facility, severity.

changelog

my $changelog = $sys->changelog;

Returns the firmware changelog.

reboot

my $result = $sys->reboot;

Reboots the system immediately.

halt

my $result = $sys->halt;

Halts (shuts down) the system immediately.

my $menu = $sys->menu;

Returns the navigation menu structure.

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