NAME
WebService::OPNsense::Role::ItemCrud - Role for item CRUD methods
VERSION
version 0.002
DESCRIPTION
Provides shared item CRUD methods (search_item, get_item, add_item, set_item, del_item, toggle_item). All methods in this section are called on the consuming object, not on the role directly.
This role is consumed by WebService::OPNsense::IPsec::KeyPairs, WebService::OPNsense::IPsec::PreSharedKeys, WebService::OPNsense::Firewall::Alias, and WebService::OPNsense::Firewall::Category.
PROVIDED METHODS
search_item
my $results = $ctrl->search_item( %params );Searches for items.
get_item
my $item = $ctrl->get_item( $uuid );Returns a single item by UUID. Throws if $uuid is not a valid UUID.
add_item
my $result = $ctrl->add_item( $item_data );Creates item.
set_item
my $result = $ctrl->set_item( $uuid, $item_data );Updates item. Throws if $uuid is not a valid UUID.
del_item
my $result = $ctrl->del_item( $uuid );Deletes an item by UUID. Throws if $uuid is not a valid UUID.
toggle_item
my $result = $ctrl->toggle_item( $uuid, $enabled );Enables or disables an item. 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::IPsec::KeyPairs, WebService::OPNsense::IPsec::PreSharedKeys, WebService::OPNsense::Firewall::Alias, WebService::OPNsense::Firewall::Category
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