File Coverage

blib/lib/Net/Proxmox/VE/Cluster.pm

Criterion	Covered	Total	%
statement	9	128	7.0
branch	0	124	0.0
condition			n/a
subroutine	3	25	12.0
pod	22	22	100.0
total	34	299	11.3

#!/bin/false
#
# PODNAME: Net::Proxmox::VE::Cluster
# ABSTRACT: Functions for the 'cluster' portion of the API

use strict;
use warnings;

package Net::Proxmox::VE::Cluster;
$Net::Proxmox::VE::Cluster::VERSION = '0.36';
use parent 'Exporter';

our @EXPORT  =
  qw(
    cluster
    cluster_backup
    create_cluster_backup
    get_cluster_backup
    update_cluster_backup
    delete_cluster_backup
    cluster_ha
    get_cluster_ha_config
    get_cluster_ha_changes
    commit_cluster_ha_changes
    revert_cluster_ha_changes
    cluster_ha_groups
    create_cluster_ha_groups
    get_cluster_ha_groups
    update_cluster_ha_groups
    delete_cluster_ha_group
    get_cluster_log
    get_cluster_options
    update_cluster_options
    get_cluster_resources
    get_cluster_status
    get_cluster_tasks
  );


my $base = '/cluster';

sub cluster {

    my $self = shift or return;

    return $self->get($base)

}


sub cluster_backup {

    my $self = shift or return;

    return $self->get($base, 'backup')

}


sub create_cluster_backup {

    my $self = shift or return;

    my @p = @_;

    die 'No arguments for create_cluster_backup()' unless @p;
    my %args;

    if ( @p == 1 ) {
        die 'Single argument not a hash for create_cluster_backup()'
          unless ref $a eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        die 'Odd number of arguments for create_cluster_backup()'
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->post( $base, 'backup', \%args )

}


sub get_cluster_backup {

    my $self = shift or return;

    my $a = shift or die 'No id for get_cluster_backup()';
    die 'id must be a scalar for get_cluster_backup()' if ref $a;

    return $self->get( $base, $a )

}


sub update_cluster_backup {

    my $self = shift or return;

    my $a = shift or die 'No id for update_cluster_backup()';
    die 'id must be a scalar for update_cluster_backup()' if ref $a;

    my @p = @_;

    die 'No arguments for update_cluster_backup()' unless @p;
    my %args;

    if ( @p == 1 ) {
        die 'Single argument not a hash for update_cluster_backup()'
          unless ref $a eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        die 'Odd number of arguments for update_cluster_backup()'
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->put( $base, 'backup', $a, \%args )

}


sub delete_cluster_backup {

    my $self = shift or return;

    my $a = shift or die 'No id for delete_cluster_backup()';
    die 'id must be a scalar for delete_cluster_backup()' if ref $a;

    return $self->delete( $base, $a )

}


sub cluster_ha {

    my $self = shift or return;

    return $self->get($base, 'ha')

}


sub get_cluster_ha_config {

    my $self = shift or return;

    return $self->get($base, 'ha', 'config')

}


sub get_cluster_ha_changes {

    my $self = shift or return;

    return $self->get($base, 'ha', 'changes')

}


sub commit_cluster_ha_changes {

    my $self = shift or return;

    return $self->post($base, 'ha', 'changes')

}


sub revert_cluster_ha_changes {

    my $self = shift or return;

    return $self->delete($base, 'ha', 'changes')

}


sub cluster_ha_groups {

    my $self = shift or return;

    return $self->get($base, 'ha','groups')

}


sub create_cluster_ha_groups {

    my $self = shift or return;

    my @p = @_;

    die 'No arguments for create_cluster_ha_groups()' unless @p;
    my %args;

    if ( @p == 1 ) {
        die 'Single argument not a hash for create_cluster_ha_groups()'
          unless ref $a eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        die 'Odd number of arguments for create_cluster_ha_groups()'
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->put( $base, 'ha', 'groups', \%args )

}


sub get_cluster_ha_groups {

    my $self = shift or return;

    my $a = shift or die 'No id for get_cluster_ha_groups()';
    die 'id must be a scalar for get_cluster_ha_groups()' if ref $a;

    return $self->get( $base, 'ha', 'groups', $a )

}



sub update_cluster_ha_groups {

    my $self = shift or return;

    my $a = shift or die 'No id for update_cluster_ha_groups()';
    die 'id must be a scalar for update_cluster_ha_groups()' if ref $a;

    my @p = @_;

    die 'No arguments for update_cluster_ha_groups()' unless @p;
    my %args;

    if ( @p == 1 ) {
        die 'Single argument not a hash for update_cluster_ha_groups()'
          unless ref $a eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        die 'Odd number of arguments for update_cluster_ha_groups()'
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->put( $base, 'ha', 'groups', $a, \%args )

}


sub delete_cluster_ha_group {

    my $self = shift or return;

    my $a = shift or die 'No id for delete_cluster_ha_group()';
    die 'id must be a scalar for delete_cluster_ha_group()' if ref $a;

    return $self->delete( $base, 'ha', 'groups', $a )

}


sub get_cluster_log {

    my $self = shift or return;

    my @p = @_;

    die 'No arguments for get_cluster_log()' unless @p;
    my %args;

    if ( @p == 1 ) {
        die 'Single argument not a hash for get_cluster_log()'
          unless ref $a eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        die 'Odd number of arguments for get_cluster_log()'
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->get( $base, 'log', \%args )

}


sub get_cluster_options {

    my $self = shift or return;

    return $self->get($base, 'options')

}


sub update_cluster_options {

    my $self = shift or return;

    my @p = @_;

    die 'No arguments for update_cluster_options()' unless @p;
    my %args;

    if ( @p == 1 ) {
        die 'Single argument not a hash for update_cluster_options()'
          unless ref $a eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        die 'Odd number of arguments for update_cluster_options()'
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->put( $base, 'log', \%args )

}



sub get_cluster_resources {

    my $self = shift or return;

    my @p = @_;

    die 'No arguments for get_cluster_resources()' unless @p;
    my %args;

    if ( @p == 1 ) {
        die 'Single argument not a hash for get_cluster_resources()'
          unless ref $a eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        die 'Odd number of arguments for get_cluster_resources()'
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->get( $base, 'resources', \%args )

}



sub get_cluster_status {

    my $self = shift or return;

    return $self->get($base, 'status')

}


sub get_cluster_tasks {

    my $self = shift or return;

    return $self->get($base, 'tasks')

}


1;

=pod

=encoding UTF-8

=head1 NAME

Net::Proxmox::VE::Cluster - Functions for the 'cluster' portion of the API

=head1 VERSION

version 0.36

=head1 SYNOPSIS

  # assuming $obj is a Net::Proxmox::VE object

=head1 METHODS

=head2 cluster

Returns the 'Cluster index':

  @list = $obj->cluster()

Note: Accessible by all authententicated users.

=head2 cluster_backup

List vzdump backup schedule.

  @list = $obj->cluster_backup()

Note: Accessible by all authententicated users.

=head2 create_cluster_backup

Create new vzdump backup job.

  $ok = $obj->create_cluster_backup(\%args)

node is a string in pve-node format

I<%args> may items contain from the following list

=over 4

=item starttime

String. Job start time, format is HH::MM. Required.

=item all

Boolean. Backup all known VMs on this host. Required.

=item bwlimit

Integer. Limit I/O bandwidth (KBytes per second). Optional.

=item compress

Enum. Either 0, 1, gzip or lzo. Comress dump file. Optional

=item dow

String. Day of the week in pve-day-of-week-list format. Optional.

=item dumpdir

String. Store resulting files to specified directory. Optional.

=item exclude

String. Exclude specified VMs (assumes --all) in pve-vmid-list. Optional.

=item exclude-path

String. Exclude certain files/directories (regex) in string-alist. Optional.

=item ionice

Integer. Set CFQ ionice priority. Optional.

=item lockwait

Integer. Maximal time to wait for the global lock (minutes). Optional.

=item mailto

String. List of email addresses in string-list format. Optional.

=item maxfiles

Integer. Maximal number of backup files per vm. Optional.

=item mode

Enum. A value from snapshot, suspend or stop. Backup mode. Optional.

=item node

String. Only run if executed on this node in pve-node format. Optional.

=item quiet

Boolean. Be quiet. Optional.

=item remove

Boolean. Remove old backup files if there are more than 'maxfiles' backup files. Optional.

=item script

String. Use specified hook script. Optional.

=item size

Integer. LVM snapshot size in MB. Optional.

=item stdexcludes

Boolean. Exclude temporary files and logs. Optional.

=item stopwait

Integer. Maximal time to wait until a VM is stopped (minutes). Optional.

=item storage

String. Store resulting file to this storage, in pve-storage-id format. Optional.

=item tmpdir

String. Store temporary files to specified directory. Optional.

=item vmid

String. The ID of the VM you want to backup in pve-vm-list format. Optional.

=back

Note: required permissions are ["perm","/",["Sys.Modify"]]

=head2 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"]]

=head2 update_cluster_backup

Update vzdump backup job definition.

  $ok = $obj->update_cluster_backup(\%args)

id is the job ID

I<%args> may items contain from the following list

=over 4

=item starttime

String. Job start time, format is HH::MM. Required.

=item all

Boolean. Backup all known VMs on this host. Required.

=item bwlimit

Integer. Limit I/O bandwidth (KBytes per second). Optional.

=item compress

Enum. Either 0, 1, gzip or lzo. Comress dump file. Optional

=item dow

String. Day of the week in pve-day-of-week-list format. Optional.

=item dumpdir

String. Store resulting files to specified directory. Optional.

=item exclude

String. Exclude specified VMs (assumes --all) in pve-vmid-list. Optional.

=item exclude-path

String. Exclude certain files/directories (regex) in string-alist. Optional.

=item ionice

Integer. Set CFQ ionice priority. Optional.

=item lockwait

Integer. Maximal time to wait for the global lock (minutes). Optional.

=item mailto

String. List of email addresses in string-list format. Optional.

=item maxfiles

Integer. Maximal number of backup files per vm. Optional.

=item mode

Enum. A value from snapshot, suspend or stop. Backup mode. Optional.

=item node

String. Only run if executed on this node in pve-node format. Optional.

=item quiet

Boolean. Be quiet. Optional.

=item remove

Boolean. Remove old backup files if there are more than 'maxfiles' backup files. Optional.

=item script

String. Use specified hook script. Optional.

=item size

Integer. LVM snapshot size in MB. Optional.

=item stdexcludes

Boolean. Exclude temporary files and logs. Optional.

=item stopwait

Integer. Maximal time to wait until a VM is stopped (minutes). Optional.

=item storage

String. Store resulting file to this storage, in pve-storage-id format. Optional.

=item tmpdir

String. Store temporary files to specified directory. Optional.

=item vmid

String. The ID of the VM you want to backup in pve-vm-list format. Optional.

=back

Note: required permissions are ["perm","/",["Sys.Modify"]]

=head2 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"]]

=head2 cluster_ha

List ha index

  @list = $obj->cluster_ha()

Note: Required permissions are ["perm","/",["Sys.Audit"]]

=head2 get_cluster_ha_config

List ha config

  @list = $obj->get_cluster_ha_config()

Note: Required permissions are ["perm","/",["Sys.Audit"]]

=head2 get_cluster_ha_changes

List ha changes

  @list = $obj->get_cluster_ha_changes()

Note: Required permissions are ["perm","/",["Sys.Audit"]]

=head2 commit_cluster_ha_changes

Commit ha changes

  @list = $obj->commit_cluster_ha_changes()

Note: Required permissions are ["perm","/",["Sys.Modify"]]

=head2 revert_cluster_ha_changes

Revert ha changes

  @list = $obj->revert_cluster_ha_changes()

Note: Required permissions are ["perm","/",["Sys.Modify"]]

=head2 cluster_ha_groups

List resource groups

  @list = $obj->cluster_ha_groups()

Note: Required permissions are ["perm","/",["Sys.Audit"]]

=head2 create_cluster_ha_groups

Create a new resource groups.

  $ok = $obj->create_cluster_ha_groups(\%args)

I<%args> may items contain from the following list

=over 4

=item vmid

Integer. The unique id of the vm in pve-vmid format. Required.

=item autostart

Boolean. As per the API spec - "Service is started when quorum forms". Optional.

=back

Note: required permissions are ["perm","/",["Sys.Modify"]]

=head2 get_cluster_ha_groups

List resource groups

  $job = $obj->get_cluster_ha_groups('id')

id is the resource group id (for example pvevm:200)

Note: required permissions are ["perm","/",["Sys.Audit"]]

=head2 update_cluster_ha_groups

Update resource groups settings

  $ok = $obj->update_cluster_ha_groups('id', \%args)

id is the group ID for example pvevm:200

I<%args> may items contain from the following list

=over 4

=item autostart

Boolean. As per the API spec - "Service is started when quorum forms". Optional.

=back

Note: required permissions are ["perm","/",["Sys.Modify"]]

=head2 delete_cluster_ha_group

Delete resource group

  $ok = $obj->delete_cluster_ha_group('id')

id is the group ID for example pvevm:200

Note: required permissions are ["perm","/",["Sys.Modify"]]

=head2 get_cluster_log

Read cluster log

  $job = $obj->get_cluster_log(\%args)

Note: Accessible by all authenticated users

I<%args> may items contain from the following list

=over 4

=item max

Integer. Maximum number of entries. Optional.

=back

=head2 get_cluster_options

Get datacenter options (this is what the API says)

  @list = $obj->get_cluster_options()

Note: Required permissions are ["perm","/",["Sys.Audit"]]

=head2 update_cluster_options

Update datacenter options (this is what the spec says)

  $job = $obj->update_cluster_options(\%args)

Note: permissions required are ["perm","/",["Sys.Modify"]]

I<%args> may items contain from the following list

=over 4

=item delete

String. A list of settings you want to delete in pve-configid-list format. Optional

=item http_proxy

String. Specify external http proxy to use when downloading, ie http://user:pass@foo:port/. Optional.

=item keyboard

Enum. Default keyboard layout for VNC sessions. Selected from pt, ja, es, no, is, fr-ca, fr, pt-br, da, fr-ch, sl, de-ch, en-gb, it, en-us, fr-be, hu, pl, nl, mk, fi, lt, sv, de. Optional

=item language

Enum. Default GUI language. Either en or de. Optional.

=back

=head2 get_cluster_resources

Resources index (cluster wide)

  @list = $obj->get_cluster_resources()

Note: Accessible by all authententicated users.

I<%args> may items contain from the following list

=over 4

=item Type

Enum. One from vm, storage or node. Optional.

=back

=head2 get_cluster_status

Get cluster status informations.

  @list = $obj->get_cluster_status()

Note: Required permissions are ["perm","/",["Sys.Audit"]]

=head2 get_cluster_tasks

List recent tasks (cluster wide)

  @list = $obj->get_cluster_tasks()

Note: Available to all authenticated users

=head1 SEE ALSO

L

=head1 AUTHOR

Brendan Beveridge , Dean Hamstead

=head1 COPYRIGHT AND LICENSE

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

This is free software, licensed under:

  The MIT (X11) License

=cut

__END__