/ 
WebService-OPNsense-0.002
/ WebService::OPNsense::IPsec::Pools

NAME

WebService::OPNsense::IPsec::Pools - IPsec pool controller

VERSION

version 0.002

SYNOPSIS

my $pools = $opn->ipsec_pools;

my $results = $pools->search;
$pools->add({ pool => { ... } });

DESCRIPTION

Manages IPsec pools.

PROVIDED METHODS

The following methods are inherited from consumed roles.

my $results = $ctrl->search( %params );

Searches for pools.

get

my $pool = $ctrl->get( $uuid );

Returns a single pool by UUID. Throws if $uuid is not a valid UUID.

set

my $result = $ctrl->set( $uuid, $pool_data );

Updates a pool by UUID. Throws if $uuid is not a valid UUID.

add

my $result = $ctrl->add( $pool_data );

Creates pool.

del

my $result = $ctrl->del( $uuid );

Deletes a pool by UUID. Throws if $uuid is not a valid UUID.

toggle

my $result = $ctrl->toggle( $uuid, $enabled );

Enables or disables a pool. Throws if $uuid is not a valid UUID.

client

my $http_client = $ctrl->client;

Returns the underlying HTTP client object used for API requests.

SEE ALSO

WebService::OPNsense::Role::Crud

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