]> git.proxmox.com Git - qemu-server.git/blobdiff - PVE/API2/Qemu.pm
snapshot: save state and implement rollback
[qemu-server.git] / PVE / API2 / Qemu.pm
index fb4b2804afa110a15b0ca45038c67d8e6103d0fd..ba54461d2bde21f68277e748df91048d67337225 100644 (file)
@@ -81,15 +81,36 @@ my $create_disks = sub {
            my $volid = PVE::Storage::vdisk_alloc($storecfg, $storeid, $vmid,
                                                  $fmt, undef, $size*1024*1024);
            $disk->{file} = $volid;
+           $disk->{size} = $size*1024*1024*1024;
            push @$vollist, $volid;
            delete $disk->{format}; # no longer needed
            $res->{$ds} = PVE::QemuServer::print_drive($vmid, $disk);
        } else {
+
            my $path = $rpcenv->check_volume_access($authuser, $storecfg, $vmid, $volid);
-           PVE::Storage::activate_volumes($storecfg, [ $volid ])
-               if PVE::Storage::parse_volume_id ($volid, 1);
-           die "image '$path' does not exists\n" if (!(-f $path || -b $path));
-           $res->{$ds} = $settings->{$ds};
+           
+           my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
+
+           my $foundvolid = undef;
+
+           if ($storeid) {
+               PVE::Storage::activate_volumes($storecfg, [ $volid ]);
+               my $dl = PVE::Storage::vdisk_list($storecfg, $storeid, undef);
+
+               PVE::Storage::foreach_volid($dl, sub {
+                   my ($volumeid) = @_;
+                   if($volumeid eq $volid) {
+                       $foundvolid = 1;
+                       return;
+                   }
+               });
+           }
+       
+           die "image '$path' does not exists\n" if (!(-f $path || -b $path || $foundvolid));
+
+           my ($size) = PVE::Storage::volume_size_info($storecfg, $volid, 1);
+           $disk->{size} = $size;
+           $res->{$ds} = PVE::QemuServer::print_drive($vmid, $disk);
        }
     });
 
@@ -269,7 +290,6 @@ __PACKAGE__->register_method({
 
        if (defined($pool)) {
            $rpcenv->check_pool_exist($pool);
-           $rpcenv->check_perm_modify($authuser, "/pool/$pool");
        } 
 
        $rpcenv->check($authuser, "/storage/$storage", ['Datastore.AllocateSpace'])
@@ -432,9 +452,11 @@ __PACKAGE__->register_method({
            { subdir => 'unlink' },
            { subdir => 'vncproxy' },
            { subdir => 'migrate' },
+           { subdir => 'resize' },
            { subdir => 'rrd' },
            { subdir => 'rrddata' },
            { subdir => 'monitor' },
+           { subdir => 'snapshot' },
            ];
 
        return $res;
@@ -558,6 +580,8 @@ __PACKAGE__->register_method({
 
        my $conf = PVE::QemuServer::load_config($param->{vmid});
 
+       delete $conf->{snapshots};
+
        return $conf;
     }});
 
@@ -637,6 +661,16 @@ my $vmconfig_delete_option = sub {
     PVE::QemuServer::update_config_nolock($vmid, $conf, 1);
 };
 
+my $safe_num_ne = sub {
+    my ($a, $b) = @_;
+
+    return 0 if !defined($a) && !defined($b); 
+    return 1 if !defined($a); 
+    return 1 if !defined($b); 
+
+    return $a != $b;
+};
+
 my $vmconfig_update_disk = sub {
     my ($rpcenv, $authuser, $conf, $storecfg, $vmid, $opt, $value, $force) = @_;
 
@@ -662,6 +696,18 @@ my $vmconfig_update_disk = sub {
                &$vmconfig_delete_option($rpcenv, $authuser, $conf, $storecfg, $vmid, $opt, $force);
                $conf = PVE::QemuServer::load_config($vmid); # update/reload
            }
+
+            if(&$safe_num_ne($drive->{mbps}, $old_drive->{mbps}) ||
+               &$safe_num_ne($drive->{mbps_rd}, $old_drive->{mbps_rd}) ||
+               &$safe_num_ne($drive->{mbps_wr}, $old_drive->{mbps_wr}) ||
+               &$safe_num_ne($drive->{iops}, $old_drive->{iops}) ||
+               &$safe_num_ne($drive->{iops_rd}, $old_drive->{iops_rd}) ||
+               &$safe_num_ne($drive->{iops_wr}, $old_drive->{iops_wr})) {
+               PVE::QemuServer::qemu_block_set_io_throttle($vmid,"drive-$opt", $drive->{mbps}*1024*1024, 
+                                                          $drive->{mbps_rd}*1024*1024, $drive->{mbps_wr}*1024*1024, 
+                                                          $drive->{iops}, $drive->{iops_rd}, $drive->{iops_wr}) 
+                  if !PVE::QemuServer::drive_is_cdrom($drive);
+            }
        }
     }
 
@@ -675,11 +721,11 @@ my $vmconfig_update_disk = sub {
 
        if (PVE::QemuServer::check_running($vmid)) {
            if ($drive->{file} eq 'none') {
-               PVE::QemuServer::vm_monitor_command($vmid, "eject -f drive-$opt", 0);
+               PVE::QemuServer::vm_mon_cmd($vmid, "eject",force => JSON::true,device => "drive-$opt");
            } else {
                my $path = PVE::QemuServer::get_iso_path($storecfg, $vmid, $drive->{file});
-               PVE::QemuServer::vm_monitor_command($vmid, "eject -f drive-$opt", 0); #force eject if locked
-               PVE::QemuServer::vm_monitor_command($vmid, "change drive-$opt \"$path\"", 0) if $path;
+               PVE::QemuServer::vm_mon_cmd($vmid, "eject",force => JSON::true,device => "drive-$opt"); #force eject if locked
+               PVE::QemuServer::vm_mon_cmd($vmid, "change",device => "drive-$opt",target => "$path") if $path;
            }
        }
 
@@ -1129,7 +1175,7 @@ __PACKAGE__->register_method({
        # test if VM exists
        my $conf = PVE::QemuServer::load_config($param->{vmid});
 
-       my $vmstatus = PVE::QemuServer::vmstatus($param->{vmid});
+       my $vmstatus = PVE::QemuServer::vmstatus($param->{vmid}, 1);
        my $status = $vmstatus->{$param->{vmid}};
 
        $status->{ha} = &$vm_is_ha_managed($param->{vmid});
@@ -1154,6 +1200,8 @@ __PACKAGE__->register_method({
            vmid => get_standard_option('pve-vmid'),
            skiplock => get_standard_option('skiplock'),
            stateuri => get_standard_option('pve-qm-stateuri'),
+           migratedfrom => get_standard_option('pve-node',{ optional => 1 }),
+
        },
     },
     returns => {
@@ -1178,6 +1226,10 @@ __PACKAGE__->register_method({
        raise_param_exc({ skiplock => "Only root may use this option." })
            if $skiplock && $authuser ne 'root@pam';
 
+       my $migratedfrom = extract_param($param, 'migratedfrom');
+       raise_param_exc({ migratedfrom => "Only root may use this option." })
+           if $migratedfrom && $authuser ne 'root@pam';
+
        my $storecfg = PVE::Storage::config();
 
        if (&$vm_is_ha_managed($vmid) && !$stateuri &&
@@ -1206,7 +1258,7 @@ __PACKAGE__->register_method({
 
                syslog('info', "start VM $vmid: $upid\n");
 
-               PVE::QemuServer::vm_start($storecfg, $vmid, $stateuri, $skiplock);
+               PVE::QemuServer::vm_start($storecfg, $vmid, $stateuri, $skiplock, $migratedfrom);
 
                return;
            };
@@ -1231,6 +1283,7 @@ __PACKAGE__->register_method({
            node => get_standard_option('pve-node'),
            vmid => get_standard_option('pve-vmid'),
            skiplock => get_standard_option('skiplock'),
+           migratedfrom => get_standard_option('pve-node',{ optional => 1 }),
            timeout => {
                description => "Wait maximal timeout seconds.",
                type => 'integer',
@@ -1267,6 +1320,11 @@ __PACKAGE__->register_method({
        raise_param_exc({ keepActive => "Only root may use this option." })
            if $keepActive && $authuser ne 'root@pam';
 
+       my $migratedfrom = extract_param($param, 'migratedfrom');
+       raise_param_exc({ migratedfrom => "Only root may use this option." })
+           if $migratedfrom && $authuser ne 'root@pam';
+
+
        my $storecfg = PVE::Storage::config();
 
        if (&$vm_is_ha_managed($vmid) && $rpcenv->{type} ne 'ha') {
@@ -1294,7 +1352,7 @@ __PACKAGE__->register_method({
                syslog('info', "stop VM $vmid: $upid\n");
 
                PVE::QemuServer::vm_stop($storecfg, $vmid, $skiplock, 0,
-                                        $param->{timeout}, 0, 1, $keepActive);
+                                        $param->{timeout}, 0, 1, $keepActive, $migratedfrom);
 
                return;
            };
@@ -1703,11 +1761,461 @@ __PACKAGE__->register_method({
 
        my $res = '';
        eval {
-           $res = PVE::QemuServer::vm_monitor_command($vmid, $param->{command});
+           $res = PVE::QemuServer::vm_human_monitor_command($vmid, $param->{command});
        };
        $res = "ERROR: $@" if $@;
 
        return $res;
     }});
 
+__PACKAGE__->register_method({
+    name => 'resize_vm',
+    path => '{vmid}/resize',
+    method => 'PUT',
+    protected => 1,
+    proxyto => 'node',
+    description => "Extend volume size.",
+    permissions => {
+        check => ['perm', '/vms/{vmid}', [ 'VM.Config.Disk' ]],
+    },
+    parameters => {
+        additionalProperties => 0,
+        properties => {
+           node => get_standard_option('pve-node'),
+           vmid => get_standard_option('pve-vmid'),
+           skiplock => get_standard_option('skiplock'),
+           disk => {
+               type => 'string',
+               description => "The disk you want to resize.",
+               enum => [PVE::QemuServer::disknames()],
+           },
+           size => {
+               type => 'string',
+               pattern => '\+?\d+(\.\d+)?[KMGT]?',
+               description => "The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.",
+           },
+           digest => {
+               type => 'string',
+               description => 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.',
+               maxLength => 40,
+               optional => 1,
+           },
+       },
+    },
+    returns => { type => 'null'},
+    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 $digest = extract_param($param, 'digest');
+
+        my $disk = extract_param($param, 'disk');
+       my $sizestr = extract_param($param, 'size');
+
+       my $skiplock = extract_param($param, 'skiplock');
+        raise_param_exc({ skiplock => "Only root may use this option." })
+            if $skiplock && $authuser ne 'root@pam';
+
+        my $storecfg = PVE::Storage::config();
+
+        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;
+
+           die "disk '$disk' does not exist\n" if !$conf->{$disk};
+
+           my $drive = PVE::QemuServer::parse_drive($disk, $conf->{$disk});
+
+           my $volid = $drive->{file};
+
+           die "disk '$disk' has no associated volume\n" if !$volid;
+
+           die "you can't resize a cdrom\n" if PVE::QemuServer::drive_is_cdrom($drive);
+
+           my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid);
+
+           $rpcenv->check($authuser, "/storage/$storeid", ['Datastore.AllocateSpace']);
+
+           my $size = PVE::Storage::volume_size_info($storecfg, $volid, 5);
+
+           die "internal error" if $sizestr !~ m/^(\+)?(\d+(\.\d+)?)([KMGT])?$/;
+           my ($ext, $newsize, $unit) = ($1, $2, $4);
+           if ($unit) {
+               if ($unit eq 'K') {
+                   $newsize = $newsize * 1024;
+               } elsif ($unit eq 'M') {
+                   $newsize = $newsize * 1024 * 1024;
+               } elsif ($unit eq 'G') {
+                   $newsize = $newsize * 1024 * 1024 * 1024;
+               } elsif ($unit eq 'T') {
+                   $newsize = $newsize * 1024 * 1024 * 1024 * 1024;
+               }
+           }
+           $newsize += $size if $ext;
+           $newsize = int($newsize);
+
+           die "unable to skrink disk size\n" if $newsize < $size;
+
+           return if $size == $newsize;
+
+            PVE::Cluster::log_msg('info', $authuser, "update VM $vmid: resize --disk $disk --size $sizestr");
+
+           PVE::QemuServer::qemu_block_resize($vmid, "drive-$disk", $storecfg, $volid, $newsize);
+           
+           $drive->{size} = $newsize;
+           $conf->{$disk} = PVE::QemuServer::print_drive($vmid, $drive);
+
+           PVE::QemuServer::update_config_nolock($vmid, $conf, 1);
+       };
+
+        PVE::QemuServer::lock_config($vmid, $updatefn);
+        return undef;
+    }});
+
+__PACKAGE__->register_method({
+    name => 'snapshot_list',
+    path => '{vmid}/snapshot',
+    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 $conf = PVE::QemuServer::load_config($param->{vmid});
+       my $snaphash = $conf->{snapshots} || {};
+
+       my $res = [];
+
+       foreach my $name (keys %$snaphash) {
+           my $d = $snaphash->{$name};
+           my $item = { 
+               name => $name, 
+               snaptime => $d->{snaptime} || 0, 
+               description => $d->{description} || '',
+           };
+           $item->{parent} = $d->{parent} if $d->{parent};
+           $item->{snapstate} = $d->{snapstate} if $d->{snapstate};
+           push @$res, $item;
+       }
+
+       if ($conf->{parent}) {
+           push @$res, { name => '__current', parent => $conf->{parent} };
+       } else {
+           push @$res, { name => '__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.Snapshot' ]],
+    },
+    parameters => {
+       additionalProperties => 0,
+       properties => {
+           node => get_standard_option('pve-node'),
+           vmid => get_standard_option('pve-vmid'),
+           snapname => get_standard_option('pve-snapshot-name'),
+           vmstate => {
+               optional => 1,
+               type => 'boolean',
+               description => "Save the vmstate",
+           },
+           freezefs => {
+               optional => 1,
+               type => 'boolean',
+               description => "Freeze the filesystem",
+           },
+           description => {
+               optional => 1,
+               type => 'string',
+               description => "A textual description or comment.",
+           },
+       },
+    },
+    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, "snapshot VM $vmid: $snapname");
+           PVE::QemuServer::snapshot_create($vmid, $snapname, $param->{vmstate}, 
+                                            $param->{freezefs}, $param->{description});
+       };
+
+       return $rpcenv->fork_worker('qmsnapshot', $vmid, $authuser, $realcmd);
+    }});
+
+__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 $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);
+
+           PVE::QemuServer::check_lock($conf);
+
+           my $snap = $conf->{snapshots}->{$snapname};
+
+           die "snapshot '$snapname' does not exist\n" if !defined($snap); 
+           
+           $snap->{description} = $param->{description} if defined($param->{description});
+
+            PVE::QemuServer::update_config_nolock($vmid, $conf, 1);
+       };
+
+       PVE::QemuServer::lock_config($vmid, $updatefn);
+
+       return undef;
+    }});
+
+__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) = @_;
+
+       my $rpcenv = PVE::RPCEnvironment::get();
+
+       my $authuser = $rpcenv->get_user();
+
+       my $vmid = extract_param($param, 'vmid');
+
+       my $snapname = extract_param($param, 'snapname');
+
+       my $conf = PVE::QemuServer::load_config($vmid);
+
+       my $snap = $conf->{snapshots}->{$snapname};
+
+       die "snapshot '$snapname' does not exist\n" if !defined($snap); 
+           
+       return $snap;
+    }});
+
+__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) = @_;
+
+       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, "rollback snapshot VM $vmid: $snapname");
+           PVE::QemuServer::snapshot_rollback($vmid, $snapname);
+       };
+
+       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;