/ 
Net-Proxmox-VE-0.37
River stage zero No dependents
/ Net::Proxmox::VE::Pools

NAME

Net::Proxmox::VE::Pools - Presents a pool object

VERSION

version 0.37

SYNOPSIS

@pools = $obj->pools();
$pool  = $obj->get_pool('poolid');

$ok = $obj->create_pool(%args);
$ok = $obj->create_pool(\%args);

$ok = $obj->delete_pool('poolid');

$ok = $obj->update_pool('poolid', %args);
$ok = $obj->update_pool('poolid', \%args);

DESCRIPTION

This module implements the 'pools' section of the Proxmox API for Net::Proxmox::VE, you should use the API via that module. This documentation is for detailed reference.

To be clear, this module isn't useful as a stand alone piece of software.

NOTE

String formats that are mentioned herein are done so for convenience and are defined in detail in the Proxmox API documents on the Proxmox project website.

This module doesnt enforce them, it will send whatever garbage you provide straight to the server API. So garbage-in, garbage-out!

METHODS

pools

Gets a list of pools (aka the a Pool Index)

@pools = $obj->pools();

get_pool

Gets a single pool's configuration details

$pool = $obj->get_pool('poolid');

poolid is a string in pve-poolid format

create_pool

Creates a new pool

$ok = $obj->create_pool( %args );
$ok = $obj->create_pool( \%args );

%args may items contain from the following list

poolid

String. The id of the pool you wish to access, in pve-poolid format. This is required.

comment

String. This is a comment associated with the new pool, this is optional

delete_pool

Deletes a single pool

$ok = $obj->delete_pool('poolid')

poolid is a string in pve-poolid format

update_pool

Updates (sets) a pool's data

$ok = $obj->update_pool( 'poolid', %args );
$ok = $obj->update_pool( 'poolid', \%args );

poolid is a string in pve-poolid format

%args may items contain from the following list

comment

String. This is a comment associated with the new pool, this is optional

delete

Boolean. Removes the vms/storage rather than adding it.

storage

String. List of storage ids (in pve-storage-id-list format)

vms

String. List of virtual machines in pve-vmid-list format.

SEE ALSO

Net::Proxmox::VE

AUTHOR

Brendan Beveridge <brendan@nodeintegration.com.au>, Dean Hamstead <dean@fragfest.com.au>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2023 by Dean Hamstad.

This is free software, licensed under:

The MIT (X11) License