NAME
WebService::OPNsense::IPsec::PreSharedKeys - IPsec pre-shared key controller
VERSION
version 0.002
SYNOPSIS
my $psk = $opn->ipsec_pre_shared_keys;
my $items = $psk->search_item;
$psk->add_item({ ... });DESCRIPTION
Manages IPsec pre-shared keys.
PROVIDED METHODS
The following methods are inherited from consumed roles.
search_item
my $results = $ctrl->search_item( %params );Searches for pre-shared keys.
get_item
my $item = $ctrl->get_item( $uuid );Returns a single pre-shared key by UUID. Throws if $uuid is not a valid UUID.
add_item
my $result = $ctrl->add_item( $item_data );Creates a pre-shared key.
set_item
my $result = $ctrl->set_item( $uuid, $item_data );Updates a pre-shared key. Throws if $uuid is not a valid UUID.
del_item
my $result = $ctrl->del_item( $uuid );Deletes a pre-shared key by UUID. Throws if $uuid is not a valid UUID.
toggle_item
my $result = $ctrl->toggle_item( $uuid, $enabled );Enables or disables a pre-shared key. Throws if $uuid is not a valid UUID.
get_settings
my $config = $ctrl->get_settings;Returns pre-shared key settings.
set_settings
my $result = $ctrl->set_settings( $settings_data );Updates pre-shared key settings.
client
my $http_client = $ctrl->client;Returns the underlying HTTP client object used for API requests.
SEE ALSO
WebService::OPNsense::Role::ItemCrud
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