/ 
WebService-OPNsense-0.002
/ WebService::OPNsense::OpenVPN::ClientOverwrites

NAME

WebService::OPNsense::OpenVPN::ClientOverwrites - OpenVPN client overwrites controller

VERSION

version 0.002

SYNOPSIS

my $overwrites = $opn->openvpn_client_overwrites;

my $list = $overwrites->search(current => 1, rowCount => 50);

$overwrites->add({
    overwrite => {
        description => 'Custom client config',
    },
});

DESCRIPTION

Manages OpenVPN client-specific configuration overwrites.

METHODS

set_overwrite

my $result = $overwrites->set_overwrite($uuid, $overwrite_data);

Updates client overwrite.

PROVIDED METHODS

The following methods are inherited from consumed roles.

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

Searches for client overwrites.

get

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

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

add

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

Creates client overwrite.

del

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

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

toggle

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

Enables or disables a client overwrite. 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