NAME
Net::Proxmox::VE::Cluster - Functions for the 'cluster' portion of the API
SYNOPSIS
# assuming $obj is a Net::Proxmox::VE objectMETHODS
cluster
Returns the 'Cluster index':
@list = $obj->cluster()Note: Accessible by all authententicated users.
cluster_backup
List vzdump backup schedule.
@list = $obj->cluster_backup()Note: Accessible by all authententicated users.
create_cluster_backup
Create new vzdump backup job.
$ok = $obj->create_cluster_backup(\%args)node is a string in pve-node format
%args may items contain from the following list
- starttime
-
String. Job start time, format is HH::MM. Required.
- all
-
Boolean. Backup all known VMs on this host. Required.
- bwlimit
-
Integer. Limit I/O bandwidth (KBytes per second). Optional.
- compress
-
Enum. Either 0, 1, gzip or lzo. Comress dump file. Optional
- dow
-
String. Day of the week in pve-day-of-week-list format. Optional.
- dumpdir
-
String. Store resulting files to specified directory. Optional.
- exclude
-
String. Exclude specified VMs (assumes --all) in pve-vmid-list. Optional.
- exclude-path
-
String. Exclude certain files/directories (regex) in string-alist. Optional.
- ionice
-
Integer. Set CFQ ionice priority. Optional.
- lockwait
-
Integer. Maximal time to wait for the global lock (minutes). Optional.
- mailto
-
String. List of email addresses in string-list format. Optional.
- maxfiles
-
Integer. Maximal number of backup files per vm. Optional.
- mode
-
Enum. A value from snapshot, suspend or stop. Backup mode. Optional.
- node
-
String. Only run if executed on this node in pve-node format. Optional.
- quiet
-
Boolean. Be quiet. Optional.
- remove
-
Boolean. Remove old backup files if there are more than 'maxfiles' backup files. Optional.
- script
-
String. Use specified hook script. Optional.
- size
-
Integer. LVM snapshot size in MB. Optional.
- stdexcludes
-
Boolean. Exclude temporary files and logs. Optional.
- stopwait
-
Integer. Maximal time to wait until a VM is stopped (minutes). Optional.
- storage
-
String. Store resulting file to this storage, in pve-storage-id format. Optional.
- tmpdir
-
String. Store temporary files to specified directory. Optional.
- vmid
-
String. The ID of the VM you want to backup in pve-vm-list format. Optional.
Note: required permissions are ["perm","/",["Sys.Modify"]]
get_cluster_backup
Read vzdump backup job definition.
$job = $obj->get_cluster_backup('id')id is the job ID
Note: required permissions are ["perm","/",["Sys.Audit"]]
update_cluster_backup
Update vzdump backup job definition.
$ok = $obj->update_cluster_backup(\%args)id is the job ID
%args may items contain from the following list
- starttime
-
String. Job start time, format is HH::MM. Required.
- all
-
Boolean. Backup all known VMs on this host. Required.
- bwlimit
-
Integer. Limit I/O bandwidth (KBytes per second). Optional.
- compress
-
Enum. Either 0, 1, gzip or lzo. Comress dump file. Optional
- dow
-
String. Day of the week in pve-day-of-week-list format. Optional.
- dumpdir
-
String. Store resulting files to specified directory. Optional.
- exclude
-
String. Exclude specified VMs (assumes --all) in pve-vmid-list. Optional.
- exclude-path
-
String. Exclude certain files/directories (regex) in string-alist. Optional.
- ionice
-
Integer. Set CFQ ionice priority. Optional.
- lockwait
-
Integer. Maximal time to wait for the global lock (minutes). Optional.
- mailto
-
String. List of email addresses in string-list format. Optional.
- maxfiles
-
Integer. Maximal number of backup files per vm. Optional.
- mode
-
Enum. A value from snapshot, suspend or stop. Backup mode. Optional.
- node
-
String. Only run if executed on this node in pve-node format. Optional.
- quiet
-
Boolean. Be quiet. Optional.
- remove
-
Boolean. Remove old backup files if there are more than 'maxfiles' backup files. Optional.
- script
-
String. Use specified hook script. Optional.
- size
-
Integer. LVM snapshot size in MB. Optional.
- stdexcludes
-
Boolean. Exclude temporary files and logs. Optional.
- stopwait
-
Integer. Maximal time to wait until a VM is stopped (minutes). Optional.
- storage
-
String. Store resulting file to this storage, in pve-storage-id format. Optional.
- tmpdir
-
String. Store temporary files to specified directory. Optional.
- vmid
-
String. The ID of the VM you want to backup in pve-vm-list format. Optional.
Note: required permissions are ["perm","/",["Sys.Modify"]]
delete_cluster_backup
Delete vzdump backup job definition.
$job = $obj->delete_cluster_backup('id')id is the job ID
Note: required permissions are ["perm","/",["Sys.Modify"]]