]> git.proxmox.com Git - qemu-server.git/blobdiff - PVE/API2/Qemu.pm
correctly set shares (allow 0)
[qemu-server.git] / PVE / API2 / Qemu.pm
index 079e522eb00461472026e3066f675197006ff759..79b419f7862f5898b1602eca1f6e33f220f2b74a 100644 (file)
@@ -147,7 +147,7 @@ my $check_vm_modify_config_perm = sub {
            $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.CPU']);
        } elsif ($opt eq 'boot' || $opt eq 'bootdisk') {
            $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.Disk']);
-       } elsif ($opt eq 'memory' || $opt eq 'balloon') {
+       } elsif ($opt eq 'memory' || $opt eq 'balloon' || $opt eq 'shares') {
            $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.Memory']);
        } elsif ($opt eq 'args' || $opt eq 'lock') {
            die "only root can set '$opt' config\n";
@@ -456,6 +456,7 @@ __PACKAGE__->register_method({
            { subdir => 'rrd' },
            { subdir => 'rrddata' },
            { subdir => 'monitor' },
+           { subdir => 'snapshot' },
            ];
 
        return $res;
@@ -579,6 +580,8 @@ __PACKAGE__->register_method({
 
        my $conf = PVE::QemuServer::load_config($param->{vmid});
 
+       delete $conf->{snapshots};
+
        return $conf;
     }});
 
@@ -1062,10 +1065,8 @@ __PACKAGE__->register_method({
            $remip = PVE::Cluster::remote_node_ip($node);
        }
 
-       # NOTE: kvm VNC traffic is already TLS encrypted,
-       # so we select the fastest chipher here (or 'none'?)
-       my $remcmd = $remip ? ['/usr/bin/ssh', '-T', '-o', 'BatchMode=yes',
-                              '-c', 'blowfish-cbc', $remip] : [];
+       # NOTE: kvm VNC traffic is already TLS encrypted
+       my $remcmd = $remip ? ['/usr/bin/ssh', '-T', '-o', 'BatchMode=yes', $remip] : [];
 
        my $timeout = 10;
 
@@ -1088,6 +1089,8 @@ __PACKAGE__->register_method({
 
        my $upid = $rpcenv->fork_worker('vncproxy', $vmid, $authuser, $realcmd);
 
+       PVE::Tools::wait_for_vnc_port($port);
+
        return {
            user => $authuser,
            ticket => $ticket,
@@ -1626,6 +1629,62 @@ __PACKAGE__->register_method({
        return;
     }});
 
+__PACKAGE__->register_method({
+    name => 'vm_feature',
+    path => '{vmid}/feature',
+    method => 'GET',
+    proxyto => 'node',
+    protected => 1, 
+    description => "Check if feature for virtual machine is available.",
+    permissions => {
+       check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
+    },
+    parameters => {
+       additionalProperties => 0,
+       properties => {
+           node => get_standard_option('pve-node'),
+           vmid => get_standard_option('pve-vmid'),
+            feature => {
+                description => "Feature to check.",
+                type => 'string',
+                enum => [ 'snapshot', 'clone' ],
+            },
+            snapname => get_standard_option('pve-snapshot-name', {
+                optional => 1,
+            }),
+       },
+
+    },
+    returns => {
+        type => 'boolean'
+    },
+    code => sub {
+       my ($param) = @_;
+
+       my $node = extract_param($param, 'node');
+
+       my $vmid = extract_param($param, 'vmid');
+
+       my $snapname = extract_param($param, 'snapname');
+
+       my $feature = extract_param($param, 'feature');
+
+       my $running = PVE::QemuServer::check_running($vmid);
+
+       my $conf = PVE::QemuServer::load_config($vmid);
+
+       if($snapname){
+           my $snap = $conf->{snapshots}->{$snapname};
+            die "snapshot '$snapname' does not exist\n" if !defined($snap);
+           $conf = $snap;
+       }
+       my $storecfg = PVE::Storage::config();
+
+       my $hasfeature = PVE::QemuServer::has_feature($feature, $conf, $storecfg, $snapname, $running);
+       my $res = $hasfeature ? 1 : 0 ;
+       return $res;
+    }});
+
 __PACKAGE__->register_method({
     name => 'migrate_vm',
     path => '{vmid}/migrate',
@@ -1882,31 +1941,78 @@ __PACKAGE__->register_method({
     }});
 
 __PACKAGE__->register_method({
-    name => 'snapshot_vm',
+    name => 'snapshot_list',
     path => '{vmid}/snapshot',
-    method => 'PUT',
+    method => 'GET',
+    description => "List all snapshots.",
+    permissions => {
+       check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
+    },
+    proxyto => 'node',
+    protected => 1, # qemu pid files are only readable by root
+    parameters => {
+       additionalProperties => 0,
+       properties => {
+           vmid => get_standard_option('pve-vmid'),
+           node => get_standard_option('pve-node'),
+       },
+    },
+    returns => {
+       type => 'array',
+       items => {
+           type => "object",
+           properties => {},
+       },
+       links => [ { rel => 'child', href => "{name}" } ],
+    },
+    code => sub {
+       my ($param) = @_;
+
+       my $vmid = $param->{vmid};
+
+       my $conf = PVE::QemuServer::load_config($vmid);
+       my $snaphash = $conf->{snapshots} || {};
+
+       my $res = [];
+
+       foreach my $name (keys %$snaphash) {
+           my $d = $snaphash->{$name};
+           my $item = { 
+               name => $name, 
+               snaptime => $d->{snaptime} || 0, 
+               vmstate => $d->{vmstate} ? 1 : 0,
+               description => $d->{description} || '',
+           };
+           $item->{parent} = $d->{parent} if $d->{parent};
+           $item->{snapstate} = $d->{snapstate} if $d->{snapstate};
+           push @$res, $item;
+       }
+
+       my $running = PVE::QemuServer::check_running($vmid, 1) ? 1 : 0;
+       my $current = { name => 'current', digest => $conf->{digest}, running => $running };
+       $current->{parent} = $conf->{parent} if $conf->{parent};
+
+       push @$res, $current;
+
+       return $res;
+    }});
+
+__PACKAGE__->register_method({
+    name => 'snapshot',
+    path => '{vmid}/snapshot',
+    method => 'POST',
     protected => 1,
     proxyto => 'node',
     description => "Snapshot a VM.",
     permissions => {
-       check => ['perm', '/vms/{vmid}', [ 'VM.Config.Disk' ]],
+       check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
     },
     parameters => {
        additionalProperties => 0,
        properties => {
            node => get_standard_option('pve-node'),
            vmid => get_standard_option('pve-vmid'),
-           skiplock => get_standard_option('skiplock'),
-           action => {
-               type => 'string',
-               description => "Action",
-               enum => [ 'create', 'delete', 'rollback' ],
-           },
-           snapname => {
-               type => 'string',
-               description => "The name of the snapshot",
-               maxLength => 40,
-           },
+           snapname => get_standard_option('pve-snapshot-name'),
            vmstate => {
                optional => 1,
                type => 'boolean',
@@ -1917,15 +2023,17 @@ __PACKAGE__->register_method({
                type => 'boolean',
                description => "Freeze the filesystem",
            },
-           digest => {
-               type => 'string',
-               description => 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.',
-               maxLength => 40,
+           description => {
                optional => 1,
+               type => 'string',
+               description => "A textual description or comment.",
            },
        },
     },
-    returns => { type => 'null'},
+    returns => {
+       type => 'string',
+       description => "the task ID.",
+    },
     code => sub {
        my ($param) = @_;
 
@@ -1937,88 +2045,239 @@ __PACKAGE__->register_method({
 
        my $vmid = extract_param($param, 'vmid');
 
-       my $digest = extract_param($param, 'digest');
+       my $snapname = extract_param($param, 'snapname');
 
-       my $action = extract_param($param, 'action');
+       die "unable to use snapshot name 'current' (reserved name)\n"
+           if $snapname eq 'current';
 
-       my $snapname = extract_param($param, 'snapname');
+       my $realcmd = sub {
+           PVE::Cluster::log_msg('info', $authuser, "snapshot VM $vmid: $snapname");
+           PVE::QemuServer::snapshot_create($vmid, $snapname, $param->{vmstate}, 
+                                            $param->{freezefs}, $param->{description});
+       };
 
-       my $vmstate = extract_param($param, 'vmstate');
-       my $freezefs = extract_param($param, 'freezefs');
+       return $rpcenv->fork_worker('qmsnapshot', $vmid, $authuser, $realcmd);
+    }});
 
-       my $skiplock = extract_param($param, 'skiplock');
-       raise_param_exc({ skiplock => "Only root may use this option." })
-               if $skiplock && $authuser ne 'root@pam';
+__PACKAGE__->register_method({
+    name => 'snapshot_cmd_idx',
+    path => '{vmid}/snapshot/{snapname}',
+    description => '',
+    method => 'GET',
+    permissions => {
+       user => 'all',
+    },
+    parameters => {
+       additionalProperties => 0,
+       properties => {
+           vmid => get_standard_option('pve-vmid'),
+           node => get_standard_option('pve-node'),
+           snapname => get_standard_option('pve-snapshot-name'),
+       },
+    },
+    returns => {
+       type => 'array',
+       items => {
+           type => "object",
+           properties => {},
+       },
+       links => [ { rel => 'child', href => "{cmd}" } ],
+    },
+    code => sub {
+       my ($param) = @_;
 
-       my $storecfg = PVE::Storage::config();
+       my $res = [];
+
+       push @$res, { cmd => 'rollback' };
+       push @$res, { cmd => 'config' };
+
+       return $res;
+    }});
+
+__PACKAGE__->register_method({
+    name => 'update_snapshot_config',
+    path => '{vmid}/snapshot/{snapname}/config',
+    method => 'PUT',
+    protected => 1,
+    proxyto => 'node',
+    description => "Update snapshot metadata.",
+    permissions => {
+       check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
+    },
+    parameters => {
+       additionalProperties => 0,
+       properties => {
+           node => get_standard_option('pve-node'),
+           vmid => get_standard_option('pve-vmid'),
+           snapname => get_standard_option('pve-snapshot-name'),
+           description => {
+               optional => 1,
+               type => 'string',
+               description => "A textual description or comment.",
+           },
+       },
+    },
+    returns => { type => 'null' },
+    code => sub {
+       my ($param) = @_;
+
+       my $rpcenv = PVE::RPCEnvironment::get();
+
+       my $authuser = $rpcenv->get_user();
+
+       my $vmid = extract_param($param, 'vmid');
+
+       my $snapname = extract_param($param, 'snapname');
+
+       return undef if !defined($param->{description});
 
        my $updatefn =  sub {
 
            my $conf = PVE::QemuServer::load_config($vmid);
 
-           die "checksum missmatch (file change by other user?)\n"
-               if $digest && $digest ne $conf->{digest};
-           PVE::QemuServer::check_lock($conf) if !$skiplock;
+           PVE::QemuServer::check_lock($conf);
 
-           &$check_storage_access($rpcenv, $authuser, $storecfg, $vmid, $conf);
+           my $snap = $conf->{snapshots}->{$snapname};
 
-           #need to implement a check to see if all storages support snapshots
+           die "snapshot '$snapname' does not exist\n" if !defined($snap); 
+           
+           $snap->{description} = $param->{description} if defined($param->{description});
 
-           if($action eq 'create'){
-               PVE::Cluster::log_msg('info', $authuser, "snapshot VM $vmid: $snapname");
+            PVE::QemuServer::update_config_nolock($vmid, $conf, 1);
+       };
 
-               PVE::QemuServer::qemu_snapshot_start($vmid,$snapname) if $vmstate;
+       PVE::QemuServer::lock_config($vmid, $updatefn);
 
-               PVE::QemuServer::qga_freezefs($vmid) if $freezefs;
+       return undef;
+    }});
 
-               PVE::QemuServer::foreach_drive($conf, sub {
-                   my ($ds, $drive) = @_;
+__PACKAGE__->register_method({
+    name => 'get_snapshot_config',
+    path => '{vmid}/snapshot/{snapname}/config',
+    method => 'GET',
+    proxyto => 'node',
+    description => "Get snapshot configuration",
+    permissions => {
+       check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
+    },
+    parameters => {
+       additionalProperties => 0,
+       properties => {
+           node => get_standard_option('pve-node'),
+           vmid => get_standard_option('pve-vmid'),
+           snapname => get_standard_option('pve-snapshot-name'),
+       },
+    },
+    returns => { type => "object" },
+    code => sub {
+       my ($param) = @_;
 
-                   return if PVE::QemuServer::drive_is_cdrom($drive);
-                   my $volid = $drive->{file};
-                   my $device = "drive-".$ds;
-                   PVE::QemuServer::qemu_volume_snapshot($vmid, $device, $storecfg, $volid, $snapname);
-               });
+       my $rpcenv = PVE::RPCEnvironment::get();
 
-               PVE::QemuServer::gqa_unfreezefs($vmid) if $freezefs;
+       my $authuser = $rpcenv->get_user();
 
-               PVE::QemuServer::qemu_snapshot_end($vmid) if $vmstate;
-           }
-           elsif($action eq 'rollback'){
+       my $vmid = extract_param($param, 'vmid');
 
-               die "unable to rollback vm $vmid: vm is running\n"
-                   if PVE::QemuServer::check_running($vmid);
+       my $snapname = extract_param($param, 'snapname');
 
-               PVE::QemuServer::foreach_drive($conf, sub {
-                   my ($ds, $drive) = @_;
+       my $conf = PVE::QemuServer::load_config($vmid);
 
-                   return if PVE::QemuServer::drive_is_cdrom($drive);
-                   my $volid = $drive->{file};
-                   my $device = "drive-".$ds;
-                   PVE::QemuServer::qemu_volume_snapshot_rollback($vmid, $device, $storecfg, $volid, $snapname);
-               });
+       my $snap = $conf->{snapshots}->{$snapname};
 
-           }
-           elsif($action eq 'delete'){
+       die "snapshot '$snapname' does not exist\n" if !defined($snap); 
+           
+       return $snap;
+    }});
 
-                PVE::QemuServer::foreach_drive($conf, sub {
-                    my ($ds, $drive) = @_;
+__PACKAGE__->register_method({
+    name => 'rollback',
+    path => '{vmid}/snapshot/{snapname}/rollback',
+    method => 'POST',
+    protected => 1,
+    proxyto => 'node',
+    description => "Rollback VM state to specified snapshot.",
+    permissions => {
+       check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
+    },
+    parameters => {
+       additionalProperties => 0,
+       properties => {
+           node => get_standard_option('pve-node'),
+           vmid => get_standard_option('pve-vmid'),
+           snapname => get_standard_option('pve-snapshot-name'),
+       },
+    },
+    returns => {
+       type => 'string',
+       description => "the task ID.",
+    },
+    code => sub {
+       my ($param) = @_;
 
-                    return if PVE::QemuServer::drive_is_cdrom($drive);
-                    my $volid = $drive->{file};
-                    my $device = "drive-".$ds;
-                    PVE::QemuServer::qemu_volume_snapshot_delete($vmid, $device, $storecfg, $volid, $snapname);
-                });
+       my $rpcenv = PVE::RPCEnvironment::get();
 
-           }
+       my $authuser = $rpcenv->get_user();
 
-           #need to implement config change with snapshots info
-           PVE::QemuServer::update_config_nolock($vmid, $conf, 1);
+       my $node = extract_param($param, 'node');
+
+       my $vmid = extract_param($param, 'vmid');
+
+       my $snapname = extract_param($param, 'snapname');
+
+       my $realcmd = sub {
+           PVE::Cluster::log_msg('info', $authuser, "rollback snapshot VM $vmid: $snapname");
+           PVE::QemuServer::snapshot_rollback($vmid, $snapname);
        };
 
-       PVE::QemuServer::lock_config($vmid, $updatefn);
-       return undef;
+       return $rpcenv->fork_worker('qmrollback', $vmid, $authuser, $realcmd);
+    }});
+
+__PACKAGE__->register_method({
+    name => 'delsnapshot',
+    path => '{vmid}/snapshot/{snapname}',
+    method => 'DELETE',
+    protected => 1,
+    proxyto => 'node',
+    description => "Delete a VM snapshot.",
+    permissions => {
+       check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
+    },
+    parameters => {
+       additionalProperties => 0,
+       properties => {
+           node => get_standard_option('pve-node'),
+           vmid => get_standard_option('pve-vmid'),
+           snapname => get_standard_option('pve-snapshot-name'),
+           force => {
+               optional => 1,
+               type => 'boolean',
+               description => "For removal from config file, even if removing disk snapshots fails.",
+           },
+       },
+    },
+    returns => {
+       type => 'string',
+       description => "the task ID.",
+    },
+    code => sub {
+       my ($param) = @_;
+
+       my $rpcenv = PVE::RPCEnvironment::get();
+
+       my $authuser = $rpcenv->get_user();
+
+       my $node = extract_param($param, 'node');
+
+       my $vmid = extract_param($param, 'vmid');
+
+       my $snapname = extract_param($param, 'snapname');
+
+       my $realcmd = sub {
+           PVE::Cluster::log_msg('info', $authuser, "delete snapshot VM $vmid: $snapname");
+           PVE::QemuServer::snapshot_delete($vmid, $snapname, $param->{force});
+       };
+
+       return $rpcenv->fork_worker('qmdelsnapshot', $vmid, $authuser, $realcmd);
     }});
 
 1;