/ 
WebService-OPNsense-0.001
/ WebService::OPNsense::OpenVPN::Instances

NAME

WebService::OPNsense::OpenVPN::Instances - OpenVPN instances controller

VERSION

version 0.001

SYNOPSIS

my $instances = $opn->openvpn_instances;

# List instances
my $list = $instances->search(current => 1, rowCount => 50);

# Create an instance
$instances->add({
    server => {
        enabled  => 1,
        port     => 1194,
        protocol => 'UDP',
    },
});

# Toggle an instance
$instances->toggle($uuid, 0);

# Generate a key
my $key = $instances->gen_key('tls-crypt');

DESCRIPTION

OpenVPN server and client instances.

NAME

WebService::OPNsense::OpenVPN::Instances - OpenVPN instances controller

METHODS

set_instance

my $result = $instances->set_instance($uuid, $instance_data);

Updates an existing instance.

gen_key

my $key = $instances->gen_key;
my $key = $instances->gen_key($type);

Generates an OpenVPN key. Optionally specify a key type (e.g. 'tls-crypt').

search_static_key

my $results = $instances->search_static_key(%params);

Searches for static keys.

get_static_key

my $key = $instances->get_static_key($uuid);

Returns a single static key by UUID.

add_static_key

my $result = $instances->add_static_key($key_data);

Creates a new static key.

set_static_key

my $result = $instances->set_static_key($uuid, $key_data);

Updates an existing static key.

del_static_key

my $result = $instances->del_static_key($uuid);

Deletes a static key by UUID.

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