File Coverage

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

Criterion	Covered	Total	%
statement	12	323	3.7
branch	0	396	0.0
condition			n/a
subroutine	4	42	9.5
pod	38	38	100.0
total	54	799	6.7

#!/bin/false
# vim: softtabstop=4 tabstop=4 shiftwidth=4 ft=perl expandtab smarttab
# PODNAME: Net::Proxmox::VE::Nodes
# ABSTRACT: Functions for the 'nodes' portion of the API

use strict;
use warnings;

package Net::Proxmox::VE::Nodes;
$Net::Proxmox::VE::Nodes::VERSION = '0.44';
use parent 'Exporter';

use Net::Proxmox::VE::Exception;

our @EXPORT = qw( nodes get_node );


my $BASEPATH = '/nodes';

sub nodes {

    my $self = shift or return;

    return $self->_get( $BASEPATH, undef );

}


sub get_node {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw('No node for get_node()');
    Net::Proxmox::VE::Exception->throw('node must be a scalar for get_node()')
      if ref $node;

    return $self->get( $BASEPATH, $node );

}


sub get_node_aplinfo {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw('No node for get_node_aplinfo()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for get_node_aplinfo()')
      if ref $node;

    return $self->get( $BASEPATH, $node, 'aplinfo' );

}


sub create_node_aplinfo {

    my $self = shift or return;

    my $node = shift
      or
      Net::Proxmox::VE::Exception->throw('No node for create_node_aplinfo()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for create_node_aplinfo()')
      if ref $node;

    my @p = @_;

    Net::Proxmox::VE::Exception->throw('No arguments for create_node_aplinfo()')
      unless @p;
    my %args;

    if ( @p == 1 ) {
        Net::Proxmox::VE::Exception->throw(
            'Single argument not a hash for create_node_aplinfo()')
          unless ref $node eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        Net::Proxmox::VE::Exception->throw(
            'Odd number of arguments for create_node_aplinfo()')
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->post( $BASEPATH, $node, 'aplinfo', \%args );

}


sub get_node_dns {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw('No node for get_node_dns()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for get_node_dns()')
      if ref $node;

    return $self->get( $BASEPATH, $node, 'dns' );

}


sub update_node_dns {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw('No node for update_node_dns()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for update_node_dns()')
      if ref $node;

    my @p = @_;

    Net::Proxmox::VE::Exception->throw('No arguments for update_node_dns()')
      unless @p;
    my %args;

    if ( @p == 1 ) {
        Net::Proxmox::VE::Exception->throw(
            'Single argument not a hash for update_node_dns()')
          unless ref $node eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        Net::Proxmox::VE::Exception->throw(
            'Odd number of arguments for update_node_dns()')
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->put( $BASEPATH, $node, 'dns', \%args );

}


sub get_node_rrd {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw('No node for get_node_rrd()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for get_node_rrd()')
      if ref $node;

    my @p = @_;

    Net::Proxmox::VE::Exception->throw('No arguments for get_node_rrd()')
      unless @p;
    my %args;

    if ( @p == 1 ) {
        Net::Proxmox::VE::Exception->throw(
            'Single argument not a hash for get_node_rrd()')
          unless ref $node eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        Net::Proxmox::VE::Exception->throw(
            'Odd number of arguments for get_node_rrd()')
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->get( $BASEPATH, $node, 'rrd', \%args );

}


sub get_node_rrddata {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw('No node for get_node_rrddata()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for get_node_rrddata()')
      if ref $node;

    my @p = @_;

    Net::Proxmox::VE::Exception->throw('No arguments for get_node_rrddata()')
      unless @p;
    my %args;

    if ( @p == 1 ) {
        Net::Proxmox::VE::Exception->throw(
            'Single argument not a hash for get_node_rrddata()')
          unless ref $node eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        Net::Proxmox::VE::Exception->throw(
            'Odd number of arguments for get_node_rrddata()')
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->get( $BASEPATH, $node, 'rrddata', \%args );

}


sub get_node_status {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw('No node for get_node_status()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for get_node_status()')
      if ref $node;

    return $self->get( $BASEPATH, $node, 'status' );

}


sub update_node_status {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw('No node for update_node_status()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for update_node_status()')
      if ref $node;

    my @p = @_;

    Net::Proxmox::VE::Exception->throw('No arguments for update_node_status()')
      unless @p;
    my %args;

    if ( @p == 1 ) {
        Net::Proxmox::VE::Exception->throw(
            'Single argument not a hash for update_node_status()')
          unless ref $node eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        Net::Proxmox::VE::Exception->throw(
            'Odd number of arguments for update_node_status()')
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->post( $BASEPATH, $node, 'status', \%args );

}


sub get_node_subscription {

    my $self = shift or return;

    my $node = shift
      or
      Net::Proxmox::VE::Exception->throw('No node for get_node_subscription()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for get_node_subscription()')
      if ref $node;

    return $self->get( $BASEPATH, $node, 'subscription' );

}


sub create_node_subscription {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw(
        'No node for create_node_subscription()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for create_node_subscription()')
      if ref $node;

    my @p = @_;

    Net::Proxmox::VE::Exception->throw(
        'No arguments for create_node_subscription()')
      unless @p;
    my %args;

    if ( @p == 1 ) {
        Net::Proxmox::VE::Exception->throw(
            'Single argument not a hash for create_node_subscription()')
          unless ref $node eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        Net::Proxmox::VE::Exception->throw(
            'Odd number of arguments for create_node_subscription()')
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->post( $BASEPATH, $node, 'subscription', \%args );

}


sub update_node_subscription_key {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw(
        'No node for update_node_subscription_key()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for update_node_subscription_key()')
      if ref $node;

    my @p = @_;

    Net::Proxmox::VE::Exception->throw(
        'No arguments for update_node_subscription_key()')
      unless @p;
    my %args;

    if ( @p == 1 ) {
        Net::Proxmox::VE::Exception->throw(
            'Single argument not a hash for update_node_subscription_key()')
          unless ref $node eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        Net::Proxmox::VE::Exception->throw(
            'Odd number of arguments for update_node_subscription_key()')
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->put( $BASEPATH, $node, 'subscription', \%args );

}


sub get_node_syslog {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw('No node for get_node_syslog()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for get_node_syslog()')
      if ref $node;

    my @p = @_;

    Net::Proxmox::VE::Exception->throw('No arguments for get_node_syslog()')
      unless @p;
    my %args;

    if ( @p == 1 ) {
        Net::Proxmox::VE::Exception->throw(
            'Single argument not a hash for get_node_syslog()')
          unless ref $node eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        Net::Proxmox::VE::Exception->throw(
            'Odd number of arguments for get_node_syslog()')
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->get( $BASEPATH, $node, 'syslog', \%args );

}


sub get_node_time {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw('No node for get_node_time()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for get_node_time()')
      if ref $node;

    return $self->get( $BASEPATH, $node, 'time' );

}


sub update_node_time {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw('No node for update_node_time()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for update_node_time()')
      if ref $node;

    my @p = @_;

    Net::Proxmox::VE::Exception->throw('No arguments for update_node_time()')
      unless @p;
    my %args;

    if ( @p == 1 ) {
        Net::Proxmox::VE::Exception->throw(
            'Single argument not a hash for update_node_time()')
          unless ref $node eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        Net::Proxmox::VE::Exception->throw(
            'Odd number of arguments for update_node_time()')
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->put( $BASEPATH, $node, 'time', \%args );

}


sub get_node_ubcfailcnt {

    my $self = shift or return;

    my $node = shift
      or
      Net::Proxmox::VE::Exception->throw('No node for get_node_ubcfailcnt()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for get_node_ubcfailcnt()')
      if ref $node;

    return $self->get( $BASEPATH, $node, 'ubcfailcnt' );

}


sub get_node_version {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw('No node for get_node_version()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for get_node_version()')
      if ref $node;

    return $self->get( $BASEPATH, $node, 'version' );

}


sub create_node_vncshell {

    my $self = shift or return;

    my $node = shift
      or
      Net::Proxmox::VE::Exception->throw('No node for create_node_vncshell()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for create_node_vncshell()')
      if ref $node;

    return $self->post( $BASEPATH, $node, 'vncshell' );

}


sub create_node_vzdump {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw('No node for create_node_vzdump()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for create_node_vzdump()')
      if ref $node;

    my @p = @_;

    Net::Proxmox::VE::Exception->throw('No arguments for create_node_vzdump()')
      unless @p;
    my %args;

    if ( @p == 1 ) {
        Net::Proxmox::VE::Exception->throw(
            'Single argument not a hash for create_node_vzdump()')
          unless ref $node eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        Net::Proxmox::VE::Exception->throw(
            'Odd number of arguments for create_node_vzdump()')
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->post( $BASEPATH, $node, 'dns', \%args );

}


sub nodes_network {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw('No node for nodes_network()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for nodes_network()')
      if ref $node;

    my @p = @_;

    Net::Proxmox::VE::Exception->throw('No arguments for nodes_network()')
      unless @p;
    my %args;

    if ( @p == 1 ) {
        Net::Proxmox::VE::Exception->throw(
            'Single argument not a hash for nodes_network()')
          unless ref $node eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        Net::Proxmox::VE::Exception->throw(
            'Odd number of arguments for nodes_network()')
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->get( $BASEPATH, $node, 'network', \%args );

}


sub create_node_network {

    my $self = shift or return;

    my $node = shift
      or
      Net::Proxmox::VE::Exception->throw('No node for create_node_network()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for create_node_network()')
      if ref $node;

    my @p = @_;

    Net::Proxmox::VE::Exception->throw('No arguments for create_node_network()')
      unless @p;
    my %args;

    if ( @p == 1 ) {
        Net::Proxmox::VE::Exception->throw(
            'Single argument not a hash for create_node_network()')
          unless ref $node eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        Net::Proxmox::VE::Exception->throw(
            'Odd number of arguments for create_node_network()')
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->post( $BASEPATH, $node, 'network', \%args );

}


sub revert_nodes_network {

    my $self = shift or return;

    my $node = shift
      or
      Net::Proxmox::VE::Exception->throw('No node for revert_nodes_network()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for revert_nodes_network()')
      if ref $node;

    return $self->delete( $BASEPATH, $node );

}


sub get_node_network_iface {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw(
        'No node for get_node_network_iface()');
    my $b = shift
      or Net::Proxmox::VE::Exception->throw(
        'No iface for get_node_network_iface()');

    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for get_node_network_iface()')
      if ref $node;
    Net::Proxmox::VE::Exception->throw(
        'iface must be a scalar for get_node_network_iface()')
      if ref $b;

    return $self->get( $BASEPATH, $node, 'network', $b );

}


sub update_node_network_iface {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw(
        'No node for update_node_network_iface()');
    my $b = shift
      or Net::Proxmox::VE::Exception->throw(
        'No iface for update_node_network_iface()');

    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for update_node_network_iface()')
      if ref $node;
    Net::Proxmox::VE::Exception->throw(
        'iface must be a scalar for update_node_network_iface()')
      if ref $b;

    my @p = @_;

    Net::Proxmox::VE::Exception->throw(
        'No arguments for update_node_network_iface()')
      unless @p;
    my %args;

    if ( @p == 1 ) {
        Net::Proxmox::VE::Exception->throw(
            'Single argument not a hash for update_node_network_iface()')
          unless ref $node eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        Net::Proxmox::VE::Exception->throw(
            'Odd number of arguments for update_node_network_iface()')
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->post( $BASEPATH, $node, 'network', $b, \%args );

}


sub delete_nodes_network_iface {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw(
        'No node for delete_nodes_network_iface()');
    my $iface = shift
      or Net::Proxmox::VE::Exception->throw(
        'No iface for delete_nodes_network_iface()');

    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for delete_nodes_network_iface()')
      if ref $node;
    Net::Proxmox::VE::Exception->throw(
        'iface must be a scalar for delete_nodes_network_iface()')
      if ref $iface;

    return $self->get( $BASEPATH, $node, 'network', $iface );

}


sub nodes_openvz {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw('No node for nodes_openvz()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for nodes_openvz()')
      if ref $node;

    return $self->get( $BASEPATH, $node, 'openvz' );

}


sub create_node_openvz {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw('No node for create_node_openvz()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for create_node_openvz()')
      if ref $node;

    my @p = @_;

    Net::Proxmox::VE::Exception->throw('No arguments for create_node_openvz()')
      unless @p;
    my %args;

    if ( @p == 1 ) {
        Net::Proxmox::VE::Exception->throw(
            'Single argument not a hash for create_node_openvz()')
          unless ref $node eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        Net::Proxmox::VE::Exception->throw(
            'Odd number of arguments for create_node_openvz()')
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->get( $BASEPATH, $node, 'openvz', \%args );

}


sub get_node_openvz {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw('No node for get_node_openvz()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for get_node_openvz()')
      if ref $node;

    my $vmid = shift
      or Net::Proxmox::VE::Exception->throw('No vmid for get_node_openvz()');
    Net::Proxmox::VE::Exception->throw(
        'vmid must be a scalar for get_node_openvz()')
      if ref $vmid;

    return $self->get( $BASEPATH, $node, 'openvz', $vmid );

}


sub delete_nodes_openvz {

    my $self = shift or return;

    my $node = shift
      or
      Net::Proxmox::VE::Exception->throw('No node for delete_nodes_openvz()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for delete_nodes_openvz()')
      if ref $node;

    my $vmid = shift
      or
      Net::Proxmox::VE::Exception->throw('No node for delete_nodes_openvz()');
    Net::Proxmox::VE::Exception->throw(
        'vmid must be a scalar for delete_nodes_openvz()')
      if ref $vmid;

    return $self->delete( $BASEPATH, $node, 'openvz', $vmid );

}


sub get_node_openvz_status {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw(
        'No node for get_node_openvz_status()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for get_node_openvz_status()')
      if ref $node;

    my $vmid = shift
      or Net::Proxmox::VE::Exception->throw(
        'No node for get_node_openvz_status()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for get_node_openvz_status()')
      if ref $vmid;

    return $self->get( $BASEPATH, $node, 'openvz', $vmid, 'status' );

}


sub get_node_openvz_status_current {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw(
        'No node for get_node_openvz_status_current()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for get_node_openvz_status_current()')
      if ref $node;

    my $vmid = shift
      or Net::Proxmox::VE::Exception->throw(
        'No node for get_node_openvz_status_current()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for get_node_openvz_status_current()')
      if ref $vmid;

    return $self->get( $BASEPATH, $node, 'openvz', $vmid, 'status', 'current' );

}


sub create_node_openvz_status_mount {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw(
        'No node for create_node_openvz_status_mount()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for create_node_openvz_status_mount()')
      if ref $node;

    my $vmid = shift
      or Net::Proxmox::VE::Exception->throw(
        'No node for create_node_openvz_status_mount()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for create_node_openvz_status_mount()')
      if ref $vmid;

    return $self->post( $BASEPATH, $node, 'openvz', $vmid, 'status', 'mount' );

}


sub create_node_openvz_status_shutdown {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw(
        'No node for create_node_openvz_status_shutdown()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for create_node_openvz_status_shutdown()')
      if ref $node;

    my $vmid = shift
      or Net::Proxmox::VE::Exception->throw(
        'No vmid for create_node_openvz_status_shutdown()');
    Net::Proxmox::VE::Exception->throw(
        'vmid must be a scalar for create_node_openvz_status_shutdown()')
      if ref $vmid;

    my @p = @_;
    Net::Proxmox::VE::Exception->throw(
        'No arguments for create_node_openvz_status_shutdown()')
      unless @p;
    my %args;

    if ( @p == 1 ) {
        Net::Proxmox::VE::Exception->throw(
'Single argument not a hash for create_node_openvz_status_shutdown()'
        ) unless ref $node eq 'HASH';
        %args = %{ $p[0] };
    }
    else {
        Net::Proxmox::VE::Exception->throw(
            'Odd number of arguments for create_node_openvz_status_shutdown()')
          if ( scalar @p % 2 != 0 );
        %args = @p;
    }

    return $self->post( $BASEPATH, $node, 'openvz', $vmid, 'status',
        'shutdown', \%args );

}


sub create_node_openvz_status_start {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw(
        'No node for create_node_openvz_status_start()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for create_node_openvz_status_start()')
      if ref $node;

    my $vmid = shift
      or Net::Proxmox::VE::Exception->throw(
        'No vmid for create_node_openvz_status_start()');
    Net::Proxmox::VE::Exception->throw(
        'vmid must be a scalar for create_node_openvz_status_start()')
      if ref $vmid;

    return $self->post( $BASEPATH, $node, 'openvz', $vmid, 'status', 'start' );

}


sub create_node_openvz_status_stop {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw(
        'No node for create_node_openvz_status_stop()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for create_node_openvz_status_stop()')
      if ref $node;

    my $vmid = shift
      or Net::Proxmox::VE::Exception->throw(
        'No vmid for create_node_openvz_status_stop()');
    Net::Proxmox::VE::Exception->throw(
        'vmid must be a scalar for create_node_openvz_status_stop()')
      if ref $vmid;

    return $self->post( $BASEPATH, $node, 'openvz', $vmid, 'status', 'start' );

}


sub get_node_openvz_status_ubc {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw(
        'No node for get_node_openvz_status_ubc()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for get_node_openvz_status_ubc()')
      if ref $node;

    my $vmid = shift
      or Net::Proxmox::VE::Exception->throw(
        'No vmid for get_node_openvz_status_ubc()');
    Net::Proxmox::VE::Exception->throw(
        'vmid must be a scalar for get_node_openvz_status_ubc()')
      if ref $vmid;

    return $self->post( $BASEPATH, $node, 'openvz', $vmid, 'status', 'ubc' );

}


sub get_node_openvz_status_umount {

    my $self = shift or return;

    my $node = shift
      or Net::Proxmox::VE::Exception->throw(
        'No node for get_node_openvz_status_umount()');
    Net::Proxmox::VE::Exception->throw(
        'node must be a scalar for get_node_openvz_status_umount()')
      if ref $node;

    my $vmid = shift
      or Net::Proxmox::VE::Exception->throw(
        'No vmid for get_node_openvz_status_umount()');
    Net::Proxmox::VE::Exception->throw(
        'vmid must be a scalar for get_node_openvz_status_umount()')
      if ref $vmid;

    return $self->post( $BASEPATH, $node, 'openvz', $vmid, 'status', 'umount' );

}


1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Net::Proxmox::VE::Nodes - Functions for the 'nodes' portion of the API

=head1 VERSION

version 0.44

=head1 SYNOPSIS

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

  my @nodes = $obj->nodes();

=head1 METHODS

=head2 nodes

Returns the 'Cluster node index'

Note: Accessible by all authententicated users.

=head2 get_node

Gets a single node details

  $ok = $obj->get_nodes( $node )

Where $Where I<$node> is a string in pve-node format

Note: Accessible by all authententicated users.

=head2 get_node_aplinfo

Gets a single nodes list of appliances

  $ok = $obj->get_node_aplinfo( $node )

Where I<$node> is a string in pve-node format

Note: Accessible by all authententicated users.

=head2 create_node_aplinfo

Create (upload) appliance templates.

  $ok = $obj->download_nodes_aplinfo( $node, \%args )

Where I<$node> is a string in pve-node format

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

=over 4

=item storage

String. The storage to be used in pve-storage-id format. Required.

=item template

Data. The actual template. Required.

=back

Note: required permissions are ["perm","/storage/{storage}",["Datastore.AllocateTemplate"]]

=head2 get_node_dns

Get DNS settings.

  $ok = $obj->get_node_dns( $node )

Where I<$node> is a string in pve-node format

Note: required permissions are ["perm","/nodes/{node}",["Sys.Audit"]]

=head2 update_node_dns

Updates (writes) DNS settings.

  $ok = $obj->update_node_dns( $node, \%args )

Where I<$node> is a string in pve-node format

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

=over 4

=item search

String. Search domain for host-name lookup. Required.

=back

Note: required permissions are ["perm","/nodes/{node}",["Sys.Audit"]]

=head2 get_node_rrd

Get nodes RRD statistics (returns PNG).

  $ok = $obj->get_node_rrd( $node, \%args )

Where I<$node> is a string in pve-node format

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

=over 4

=item ds

String. The list of datasources you wish to see, in pve-configid-list format. Required.

=item timeframe

Enum. Is either hour, day, week, month or year. Required.

=item cf

Enum. Is either AVERAGE or MAX. Controls the RRD consolidation function. Optional.

=back

Note: required permissions are ["perm","/nodes/{node}",["Sys.Audit"]]

=head2 get_node_rrddata

Get nodes RRD statistics.

  $ok = $obj->get_node_rrddata( $node, \%args )

Where I<$node> is a string in pve-node format

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

=over 4

=item timeframe

Enum. Is either hour, day, week, month or year. Required.

=item cf

Enum. Is either AVERAGE or MAX. Controls the RRD consolidation function. Optional.

=back

Note: required permissions are ["perm","/nodes/{node}",["Sys.Audit"]]

=head2 get_node_status

Gets node status

  $ok = $obj->get_node_status( $node )

Where I<$node> is a string in pve-node format

Note: required permissions are ["perm","/nodes/{node}",["Sys.Audit"]]

=head2 update_node_status

Reboot or shutdown a node

  $ok = $obj->updates_nodes_status( $node, \%args )

Where I<$node> is a string in pve-node format

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

=over 4

=item command

Enum. Either reboot or shutdown. Specifies the command. Required.

=back

Note: required permissions are ["perm","/nodes/{node}",["Sys.PowerMgmt"]]

=head2 get_node_subscription

Read nodes subscription info

  $ok = $obj->get_node_subscription( $node )

Where I<$node> is a string in pve-node format

Note: Root only.

=head2 create_node_subscription

Create/update nodes subscription info

  $ok = $obj->create_node_subscription( $node, \%args )

Where I<$node> is a string in pve-node format

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

=over 4

=item force

Boolean. Always connect to the server, even if we have up to date info inside local cache. Optional.

=back

Note: Root only.

=head2 update_node_subscription_key

Updates/sets subscription key

  $ok = $obj->update_node_subscription_key( $node, \%args )

Where I<$node> is a string in pve-node format

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

=over 4

=item key

Boolean. Proxmox VE subscription key. Required.

=back

Note: Root only.

=head2 get_node_syslog

Reads system log

  $ok = $obj->get_node_syslog( $node, \%args )

Where I<$node> is a string in pve-node format

Note: required permissions are ["perm","/nodes/{node}",["Sys.Syslog"]]

=head2 get_node_time

Read server time and time zone settings

  $ok = $obj->get_node_time( $node )

Where I<$node> is a string in pve-node format

Note: required permissions are ["perm","/nodes/{node}",["Sys.Audit"]]

=head2 update_node_time

Updates time zone

  $ok = $obj->update_node_time( $node, \%args )

Where I<$node> is a string in pve-node format

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

=over 4

=item timezone

String. Time zone to be used, see '/usr/share/zoneinfo/zone.tab'. Required.

=back

Note: required permissions are ["perm","/nodes/{node}",["Sys.Modify"]]

=head2 get_node_ubcfailcnt

Get user_beancounters failcnt for all active containers.

  $ok = $obj->get_node_ubcfailcnt( $node )

Where I<$node> is a string in pve-node format

Note: required permissions are ["perm","/nodes/{node}",["Sys.Audit"]]

=head2 get_node_version

Get user_beancounters failcnt for all active containers.

  $ok = $obj->get_node_version( $node )

Where I<$node> is a string in pve-node format

Note: Accessible by all authententicated users.

=head2 create_node_vncshell

Creates a VNC Shell proxy.

  $ok = $obj->create_node_vncshell( $node )

Where I<$node> is a string in pve-node format

Note: Restricted to users on realm 'pam'. Required permissions are ["perm","/nodes/{node}",["Sys.Console"]]

=head2 create_node_vzdump

Create backup.

  $ok = $obj->create_node_vzdump( $node, \%args )

Where I<$node> is a string in pve-node format

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

=over 4

=item all

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

=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 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 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 stdout

Boolean. Write tar to stdout rather than to a file. 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: The user needs 'VM.Backup' permissions on any VM, and 'Datastore.AllocateSpace' on the backup storage.

=head2 nodes_network

List available networks on the node

  $ok = $obj->nodes_network( $node, \%args )

Where I<$node> is a string in pve-node format

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

=over 4

=item type

Enum. One of bond, bridge, alias or eth. Only list specific interface types. Optional.

=back

Note: Accessible by all authententicated users.

=head2 create_node_network

Create network device configuration

  $ok = $obj->create_node_network( $node, \%args )

Where I<$node> is a string in pve-node format

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

=over 4

=item iface

String. The network interface name in pve-iface format. Required.

=item address

String. The ipv4 network address. Optional.

=item autostart

Boolean. Automatically start interface on boot. Optional.

=item bond_mode

Enum. Either of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb or balance-alb. Specifies the bonding mode. Optional.

=item bridge_ports

String. Specify the interfaces you want to add to your bridge in pve-iface-list format. Optional.

=item gateway

String. Default ipv4 gateway address. Optional.

=item netmask

String. Network mask for ipv4. Optional.

=item slaves

String. Specify the interfaces used by the bonding device in pve-iface-list format. Optional.

=back

Note: required permissions are ["perm","/nodes/{node}",["Sys.Modify"]]

=head2 revert_nodes_network

Revert network configuration changes.

  $ok = $obj->revert_nodes_network( $node )

Where I<$node> is a string in pve-node format

Note: required permissions are ["perm","/nodes/{node}",["Sys.Modify"]]

=head2 get_node_network_iface

Read network device configuration

  $ok = $obj->get_node_network_iface( $node, 'iface')

Where I<$node> is a string in pve-node format, iface is a string in pve-iface format

Note: required permissions are ["perm","/nodes/{node}",["Sys.Audit"]]

=head2 update_node_network_iface

Create network device configuration

  $ok = $obj->update_node_network_iface( $node, 'iface',

Where I<$node> is a string in pve-node format, iface is a string in pve-iface format

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

=over 4

=item address

String. The ipv4 network address. Optional.

=item autostart

Boolean. Automatically start interface on boot. Optional.

=item bond_mode

Enum. Either of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb or balance-alb. Specifies the bonding mode. Optional.

=item delete

String. Settings you want to delete in pve-configid-list format. Optional.

=item bridge_ports

String. Specify the interfaces you want to add to your bridge in pve-iface-list format. Optional.

=item gateway

String. Default ipv4 gateway address. Optional.

=item netmask

String. Network mask for ipv4. Optional.

=item slaves

String. Specify the interfaces used by the bonding device in pve-iface-list format. Optional.

=back

Note: required permissions are ["perm","/nodes/{node}",["Sys.Modify"]]

=head2 delete_nodes_network_iface

Delete network device configuration

  $ok = $obj->delete_nodes_network_iface( $node, $iface )

Where I<$node> is a string in pve-node format

Where I<$iface> is a string in pve-iface format

Note: required permissions are ["perm","/nodes/{node}",["Sys.Modify"]]

=head2 nodes_openvz

OpenVZ container index (per node).

  $ok = $obj->nodes_openvz( $node )

Where I<$node> is a string in pve-node format

Note: Only lists VMs where you have VM.Audit permissons on /vms/<vmid>.

=head2 create_node_openvz

Create or restore a container.

  $ok = $obj->create_node_openvz( $node, \%args )

Where I<$node> is a string in pve-node format

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

=over 4

=item ostemplate

String. The OS template or backup file. Required.

=item vmid

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

=item cpus

Integer. The number of CPUs for this container. Optional.

=item cpuunits

Integer. CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0. Optional.

=item description

String. Container description. Only used in the web interface. Optional.

=item disk

Number. Amount of disk space for the VM in GB. A zero indicates no limit. Optional.

=item force

Boolean. Allow to overwrite existing container. Optional.

=item hostname

String. Set a host name for the container. Optional.

=item ip_address

String. Specifies the address the container will be assigned. Optional.

=item memory

Integer. Amount of RAM for the VM in MB. Optional.

=item nameserver

String. Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain or nameserver. Optional.

=item netif

String. Specifies network interfaces for the container in pve-openvz-netif format. Optional.

=item onboot

Boolean. Specifies weather a VM will be started during the system bootup. Optional.

=item password

String. Sets root password insider the container. Optional.

=item pool

String. Add the VM to a specified pool in pve-poolid format. Optional.

=item quotatime

Integer. Set quota grace period (seconds). Optional.

=item quotaugidlimit

Integer. Set maximum number of user/group IDs in a container for which disk quota inside the container will be accounted. If this value is set to 0, user and group quotas inside the container will not. Optional.

=item restore

Boolean. Mark this as a restore task. Optional.

=item searchdomain

String. Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain or nameserver. Optional.

=item storage

String. Target storage in pve-storage-id. Optional.

=item swap

Integer. Amount of SWAP for the VM in MB. Optional

=back

Note: You need 'VM.Allocate' permissions on /vms/{vmid} or on the VM pool /pool/{pool}, and 'Datastore.AllocateSpace' on the storage.

required permissions are ["or",["perm","/vms/{vmid}",["VM.Allocate"]],["perm","/pool/{pool}",["VM.Allocate"],"require_param","pool"]]

=head2 get_node_openvz

Gets an openvz nodes details

  $ok = $obj->get_node_openvz( $node, $vmid )

Where I<$node> is a string in pve-node format

Where I<$vmid> is an integer in pve-vmid format

Note: Accessible by all authententicated users.

=head2 delete_nodes_openvz

Destroy the container (also delete all uses files).

  $ok = $obj->delete_nodes_openvz( $node, $vmid )

Where I<$node> is a string in pve-node format

Where I<$vmid> is an integer in pve-vmid format

Note: required permissions are ["perm","/vms/{vmid}",["VM.Allocate"]]

=head2 get_node_openvz_status

Directory index

  $ok = $obj->get_node_openvz_status( $node, $vmid )

Where I<$node> is a string in pve-node format

Where I<$vmid> is an integer in pve-vmid format

Note: Accessible by all authententicated users.

=head2 get_node_openvz_status_current

Get virtual machine status.

  $ok = $obj->get_node_openvz_status_current( $node, $vmid )

Where I<$node> is a string in pve-node format

Where I<$vmid> is an integer in pve-vmid format

Note: required permissions are ["perm","/vms/{vmid}",["VM.Audit"]]

=head2 create_node_openvz_status_mount

Mounts container private area.

  $ok = $obj->create_node_openvz_status_mount( $node, $vmid )

Where I<$node> is a string in pve-node format

Where I<$vmid> is an integer in pve-vmid format

Note: required permissions are ["perm","/vms/{vmid}",["VM.PowerMgmt"]]

=head2 create_node_openvz_status_shutdown

Shutdown the container.

  $ok = $obj->create_node_openvz_status_shutdown( $node, $vmid, \%args )

Where I<$node> is a string in pve-node format

Where I<$vmid> is an integer in pve-vmid format

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

=over 4

=item forceStop

Boolean. Make sure the container stops. Note the capital S. Optional.

=item timeout

Integer. Wait maximal timeout seconds

=back

Note: required permissions are ["perm","/vms/{vmid}",["VM.PowerMgmt"]]

=head2 create_node_openvz_status_start

Start the container.

  $ok = $obj->create_node_openvz_status_start( $node, $vmid )

Where I<$node> is a string in pve-node format

Where I<$vmid> is an integer in pve-vmid format

Note: required permissions are ["perm","/vms/{vmid}",["VM.PowerMgmt"]]

=head2 create_node_openvz_status_stop

Stop the container.

  $ok = $obj->create_node_openvz_status_stop( $node, $vmid )

Where I<$node> is a string in pve-node format

Where I<$vmid> is an integer in pve-vmid format

Note: required permissions are ["perm","/vms/{vmid}",["VM.PowerMgmt"]]

=head2 get_node_openvz_status_ubc

Get container user_beancounters.

  $ok = $obj->get_node_openvz_status_ubc( $node, $vmid )

Where I<$node> is a string in pve-node format

Where I<$vmid> is an integer in pve-vmid format

Note: required permissions are ["perm","/vms/{vmid}",["VM.Audit"]]

=head2 get_node_openvz_status_umount

Unmounts container private area.

  $ok = $obj->get_node_openvz_status_umount( $node, $vmid )

Where I<$node> is a string in pve-node format

Where I<$vmid> is an integer in pve-vmid format

Note: required permissions are ["perm","/vms/{vmid}",["VM.PowerMgmt"]]

=head1 SEE ALSO

L<Net::Proxmox::VE>

=head1 AUTHOR

Dean Hamstead <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2026 by Dean Hamstead.

This is free software, licensed under:

  The MIT (X11) License

=cut