/ 
WebService-OPNsense-0.001
/ WebService::OPNsense::Routes

NAME

WebService::OPNsense::Routes - Routes API controller

VERSION

version 0.001

SYNOPSIS

my $routes = $opn->routes;

my $status = $routes->status;
my $list   = $routes->search_route(current => 1, rowCount => 50);

$routes->add_route({
    route => {
        network  => '10.0.0.0/8',
        gateway  => '192.168.1.1',
        disabled => 0,
    },
});

DESCRIPTION

Manages static routes.

NAME

WebService::OPNsense::Routes - Routes API controller

METHODS

status

my $status = $routes->status;

Returns gateway status information.

search_route

my $results = $routes->search_route(%params);

Searches for routes. Parameters: current, rowCount, searchPhrase.

get_route

my $route = $routes->get_route($uuid);

Returns a single route by UUID.

add_route

my $result = $routes->add_route($route_data);

Creates a new static route. $route_data should be a hashref matching the OPNsense API format (e.g. { route => { ... } }).

set_route

my $result = $routes->set_route($uuid, $route_data);

Updates an existing route.

del_route

my $result = $routes->del_route($uuid);

Deletes a route by UUID.

toggle_route

my $result = $routes->toggle_route($uuid, $disabled);

Enables or disables a route.

reconfigure

my $result = $routes->reconfigure;

Applies pending route changes.

get

my $routes = $routes->get;

Returns all route configuration.

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