]> git.proxmox.com Git - qemu-server.git/blobdiff - PVE/API2/Qemu.pm
Make agent a property string, add fstrim_cloned_disks
[qemu-server.git] / PVE / API2 / Qemu.pm
index 5051cc9b1276600ce8c4a0984ca0ee48d7500533..464ba7f8d2edc4fa6f778a18e1fd47238cc8deb8 100644 (file)
@@ -7,6 +7,7 @@ use Net::SSLeay;
 use UUID;
 use POSIX;
 use IO::Socket::IP;
+use URI::Escape;
 
 use PVE::Cluster qw (cfs_read_file cfs_write_file);;
 use PVE::SafeSyslog;
@@ -64,7 +65,9 @@ my $check_storage_access = sub {
 
        my $volid = $drive->{file};
 
-       if (!$volid || $volid eq 'none') {
+       if (!$volid || ($volid eq 'none' || $volid eq 'cloudinit')) {
+           # nothing to check
+       } elsif ($volid =~ m/^(([^:\s]+):)?(cloudinit)$/) {
            # nothing to check
        } elsif ($isCDROM && ($volid eq 'cdrom')) {
            $rpcenv->check($authuser, "/", ['Sys.Console']);
@@ -141,6 +144,27 @@ my $create_disks = sub {
        if (!$volid || $volid eq 'none' || $volid eq 'cdrom') {
            delete $disk->{size};
            $res->{$ds} = PVE::QemuServer::print_drive($vmid, $disk);
+       } elsif ($volid =~ m!^(?:([^/:\s]+):)?cloudinit$!) {
+           my $storeid = $1 || $default_storage;
+           die "no storage ID specified (and no default storage)\n" if !$storeid;
+           my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
+           my $name = "vm-$vmid-cloudinit";
+           my $fmt = undef;
+           if ($scfg->{path}) {
+               $name .= ".qcow2";
+               $fmt = 'qcow2';
+           }else{
+               $fmt = 'raw';
+           }
+           # FIXME: Reasonable size? qcow2 shouldn't grow if the space isn't used anyway?
+           my $cloudinit_iso_size = 5; # in MB
+           my $volid = PVE::Storage::vdisk_alloc($storecfg, $storeid, $vmid, 
+                                                 $fmt, $name, $cloudinit_iso_size*1024);
+           $disk->{file} = $volid;
+           $disk->{media} = 'cdrom';
+           push @$vollist, $volid;
+           delete $disk->{format}; # no longer needed
+           $res->{$ds} = PVE::QemuServer::print_drive($vmid, $disk);
        } elsif ($volid =~ $NEW_DISK_RE) {
            my ($storeid, $size) = ($2 || $default_storage, $3);
            die "no storage ID specified (and no default storage)\n" if !$storeid;
@@ -267,6 +291,15 @@ my $diskoptions = {
     'vmstatestorage' => 1,
 };
 
+my $cloudinitoptions = {
+    cipassword => 1,
+    citype => 1,
+    ciuser => 1,
+    nameserver => 1,
+    searchdomain => 1,
+    sshkeys => 1,
+};
+
 my $check_vm_modify_config_perm = sub {
     my ($rpcenv, $authuser, $vmid, $pool, $key_list) = @_;
 
@@ -294,7 +327,7 @@ my $check_vm_modify_config_perm = sub {
            $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.PowerMgmt']);
        } elsif ($diskoptions->{$opt}) {
            $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.Disk']);
-       } elsif ($opt =~ m/^net\d+$/) {
+       } elsif ($cloudinitoptions->{$opt} || ($opt =~ m/^(?:net|ipconfig)\d+$/)) {
            $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.Network']);
        } else {
            # catches usb\d+, hostpci\d+, args, lock, etc.
@@ -332,7 +365,7 @@ __PACKAGE__->register_method({
        type => 'array',
        items => {
            type => "object",
-           properties => {},
+           properties => $PVE::QemuServer::vmstatus_return_properties,
        },
        links => [ { rel => 'child', href => "{vmid}" } ],
     },
@@ -349,7 +382,6 @@ __PACKAGE__->register_method({
            next if !$rpcenv->check($authuser, "/vms/$vmid", [ 'VM.Audit' ], 1);
 
            my $data = $vmstatus->{$vmid};
-           $data->{vmid} = int($vmid);
            push @$res, $data;
        }
 
@@ -406,6 +438,18 @@ __PACKAGE__->register_method({
                    type => 'string', format => 'pve-poolid',
                    description => "Add the VM to the specified pool.",
                },
+               bwlimit => {
+                   description => "Override i/o bandwidth limit (in KiB/s).",
+                   optional => 1,
+                   type => 'integer',
+                   minimum => '0',
+               },
+               start => {
+                   optional => 1,
+                   type => 'boolean',
+                   default => 0,
+                   description => "Start VM after it was created successfully.",
+               },
            }),
     },
     returns => {
@@ -423,6 +467,7 @@ __PACKAGE__->register_method({
        my $vmid = extract_param($param, 'vmid');
 
        my $archive = extract_param($param, 'archive');
+       my $is_restore = !!$archive;
 
        my $storage = extract_param($param, 'storage');
 
@@ -432,10 +477,19 @@ __PACKAGE__->register_method({
 
        my $pool = extract_param($param, 'pool');
 
+       my $bwlimit = extract_param($param, 'bwlimit');
+
+       my $start_after_create = extract_param($param, 'start');
+
        my $filename = PVE::QemuConfig->config_file($vmid);
 
        my $storecfg = PVE::Storage::config();
 
+       if (defined(my $ssh_keys = $param->{sshkeys})) {
+               $ssh_keys = URI::Escape::uri_unescape($ssh_keys);
+               PVE::Tools::validate_ssh_public_keys($ssh_keys);
+       }
+
        PVE::Cluster::check_cfs_quorum();
 
        if (defined($pool)) {
@@ -487,49 +541,41 @@ __PACKAGE__->register_method({
            }
        }
 
-       my $restorefn = sub {
-           my $vmlist = PVE::Cluster::get_vmlist();
-           if ($vmlist->{ids}->{$vmid}) {
-               my $current_node = $vmlist->{ids}->{$vmid}->{node};
-               if ($current_node eq $node) {
-                   my $conf = PVE::QemuConfig->load_config($vmid);
+       my $emsg = $is_restore ? "unable to restore VM $vmid -" : "unable to create VM $vmid -";
 
-                   PVE::QemuConfig->check_protection($conf, "unable to restore VM $vmid");
+       eval { PVE::QemuConfig->create_and_lock_config($vmid, $force) };
+       die "$emsg $@" if $@;
 
-                   die "unable to restore vm $vmid - config file already exists\n"
-                       if !$force;
+       my $restorefn = sub {
+           my $conf = PVE::QemuConfig->load_config($vmid);
 
-                   die "unable to restore vm $vmid - vm is running\n"
-                       if PVE::QemuServer::check_running($vmid);
+           PVE::QemuConfig->check_protection($conf, $emsg);
 
-                   die "unable to restore vm $vmid - vm is a template\n"
-                       if PVE::QemuConfig->is_template($conf);
-
-               } else {
-                   die "unable to restore vm $vmid - already existing on cluster node '$current_node'\n";
-               }
-           }
+           die "$emsg vm is running\n" if PVE::QemuServer::check_running($vmid);
+           die "$emsg vm is a template\n" if PVE::QemuConfig->is_template($conf);
 
            my $realcmd = sub {
                PVE::QemuServer::restore_archive($archive, $vmid, $authuser, {
                    storage => $storage,
                    pool => $pool,
-                   unique => $unique });
+                   unique => $unique,
+                   bwlimit => $bwlimit, });
 
                PVE::AccessControl::add_vm_to_pool($vmid, $pool) if $pool;
+
+               if ($start_after_create) {
+                   eval { PVE::API2::Qemu->vm_start({ vmid => $vmid, node => $node }) };
+                   warn $@ if $@;
+               }
            };
 
            # ensure no old replication state are exists
            PVE::ReplicationState::delete_guest_states($vmid);
 
-           return $rpcenv->fork_worker('qmrestore', $vmid, $authuser, $realcmd);
+           return PVE::QemuConfig->lock_config_full($vmid, 1, $realcmd);
        };
 
        my $createfn = sub {
-
-           # test after locking
-           PVE::Cluster::check_vmid_unused($vmid);
-
            # ensure no old replication state are exists
            PVE::ReplicationState::delete_guest_states($vmid);
 
@@ -563,16 +609,49 @@ __PACKAGE__->register_method({
                        eval { PVE::Storage::vdisk_free($storecfg, $volid); };
                        warn $@ if $@;
                    }
-                   die "create failed - $err";
+                   die "$emsg $err";
                }
 
                PVE::AccessControl::add_vm_to_pool($vmid, $pool) if $pool;
            };
 
-           return $rpcenv->fork_worker('qmcreate', $vmid, $authuser, $realcmd);
+           PVE::QemuConfig->lock_config_full($vmid, 1, $realcmd);
+
+           if ($start_after_create) {
+               print "Execute autostart\n";
+               eval { PVE::API2::Qemu->vm_start({vmid => $vmid, node => $node}) };
+               warn $@ if $@;
+           }
        };
 
-       return PVE::QemuConfig->lock_config_full($vmid, 1, $archive ? $restorefn : $createfn);
+       my ($code, $worker_name);
+       if ($is_restore) {
+           $worker_name = 'qmrestore';
+           $code = sub {
+               eval { $restorefn->() };
+               if (my $err = $@) {
+                   eval { PVE::QemuConfig->remove_lock($vmid, 'create') };
+                   warn $@ if $@;
+                   die $err;
+               }
+           };
+       } else {
+           $worker_name = 'qmcreate';
+           $code = sub {
+               eval { $createfn->() };
+               if (my $err = $@) {
+                   eval {
+                       my $conffile = PVE::QemuConfig->config_file($vmid);
+                       unlink($conffile)
+                           or die "failed to remove config file: $@\n";
+                   };
+                   warn $@ if $@;
+                   die $err;
+               }
+           };
+       }
+
+       return $rpcenv->fork_worker($worker_name, $vmid, $authuser, $code);
     }});
 
 __PACKAGE__->register_method({
@@ -748,13 +827,14 @@ __PACKAGE__->register_method({
        },
     },
     returns => {
+       description => "The current VM configuration.",
        type => "object",
-       properties => {
+       properties => PVE::QemuServer::json_config_properties({
            digest => {
                type => 'string',
                description => 'SHA1 digest of configuration file. This can be used to prevent concurrent modifications.',
            }
-       },
+       }),
     },
     code => sub {
        my ($param) = @_;
@@ -778,6 +858,11 @@ __PACKAGE__->register_method({
 
        delete $conf->{pending};
 
+       # hide cloudinit password
+       if ($conf->{cipassword}) {
+           $conf->{cipassword} = '**********';
+       }
+
        return $conf;
     }});
 
@@ -842,6 +927,13 @@ __PACKAGE__->register_method({
            $item->{value} = $conf->{$opt} if defined($conf->{$opt});
            $item->{pending} = $conf->{pending}->{$opt} if defined($conf->{pending}->{$opt});
            $item->{delete} = ($pending_delete_hash->{$opt} ? 2 : 1) if exists $pending_delete_hash->{$opt};
+
+           # hide cloudinit password
+           if ($opt eq 'cipassword') {
+               $item->{value} = '**********' if defined($item->{value});
+               # the trailing space so that the pending string is different
+               $item->{pending} = '********** ' if defined($item->{pending});
+           }
            push @$res, $item;
        }
 
@@ -851,6 +943,11 @@ __PACKAGE__->register_method({
            next if defined($conf->{$opt});
            my $item = { key => $opt };
            $item->{pending} = $conf->{pending}->{$opt};
+
+           # hide cloudinit password
+           if ($opt eq 'cipassword') {
+               $item->{pending} = '**********' if defined($item->{pending});
+           }
            push @$res, $item;
        }
 
@@ -891,9 +988,16 @@ my $update_vm_api  = sub {
 
     my $background_delay = extract_param($param, 'background_delay');
 
+    if (defined(my $cipassword = $param->{cipassword})) {
+       # Same logic as in cloud-init (but with the regex fixed...)
+       $param->{cipassword} = PVE::Tools::encrypt_pw($cipassword)
+           if $cipassword !~ /^\$(?:[156]|2[ay])(\$.+){2}/;
+    }
+
     my @paramarr = (); # used for log message
     foreach my $key (sort keys %$param) {
-       push @paramarr, "-$key", $param->{$key};
+       my $value = $key eq 'cipassword' ? '<hidden>' : $param->{$key};
+       push @paramarr, "-$key", $value;
     }
 
     my $skiplock = extract_param($param, 'skiplock');
@@ -906,6 +1010,11 @@ my $update_vm_api  = sub {
 
     my $force = extract_param($param, 'force');
 
+    if (defined(my $ssh_keys = $param->{sshkeys})) {
+       $ssh_keys = URI::Escape::uri_unescape($ssh_keys);
+       PVE::Tools::validate_ssh_public_keys($ssh_keys);
+    }
+
     die "no options specified\n" if !$delete_str && !$revert_str && !scalar(keys %$param);
 
     my $storecfg = PVE::Storage::config();
@@ -1063,6 +1172,7 @@ my $update_vm_api  = sub {
 
                if (PVE::QemuServer::is_valid_drivename($opt)) {
                    my $drive = PVE::QemuServer::parse_drive($opt, $param->{$opt});
+                   # FIXME: cloudinit: CDROM or Disk?
                    if (PVE::QemuServer::drive_is_cdrom($drive)) { # CDROM
                        $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.CDROM']);
                    } else {
@@ -1752,7 +1862,26 @@ __PACKAGE__->register_method({
            vmid => get_standard_option('pve-vmid'),
        },
     },
-    returns => { type => 'object' },
+    returns => {
+       type => 'object',
+       properties => {
+           %$PVE::QemuServer::vmstatus_return_properties,
+           ha => {
+               description => "HA manager service status.",
+               type => 'object',
+           },
+           spice => {
+               description => "Qemu VGA configuration supports spice.",
+               type => 'boolean',
+               optional => 1,
+           },
+           agent => {
+               description => "Qemu GuestAgent enabled in config.",
+               type => 'boolean',
+               optional => 1,
+           },
+       },
+    },
     code => sub {
        my ($param) = @_;
 
@@ -1765,8 +1894,7 @@ __PACKAGE__->register_method({
        $status->{ha} = PVE::HA::Config::get_service_status("vm:$param->{vmid}");
 
        $status->{spice} = 1 if PVE::QemuServer::vga_conf_has_spice($conf->{vga});
-
-       $status->{agent} = 1 if $conf->{agent};
+       $status->{agent} = 1 if (PVE::QemuServer::parse_guest_agent($conf)->{enabled});
 
        return $status;
     }});
@@ -2413,7 +2541,9 @@ __PACKAGE__->register_method({
        properties => {
            node => get_standard_option('pve-node'),
            vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
-           newid => get_standard_option('pve-vmid', { description => 'VMID for the clone.' }),
+           newid => get_standard_option('pve-vmid', {
+               completion => \&PVE::Cluster::complete_next_vmid,
+               description => 'VMID for the clone.' }),
            name => {
                optional => 1,
                type => 'string', format => 'dns-name',
@@ -2434,12 +2564,10 @@ __PACKAGE__->register_method({
             }),
            storage => get_standard_option('pve-storage-id', {
                description => "Target storage for full clone.",
-               requires => 'full',
                optional => 1,
            }),
            'format' => {
-               description => "Target format for file storage.",
-               requires => 'full',
+               description => "Target format for file storage. Only valid for full clone.",
                type => 'string',
                optional => 1,
                enum => [ 'raw', 'qcow2', 'vmdk'],
@@ -2447,9 +2575,8 @@ __PACKAGE__->register_method({
            full => {
                optional => 1,
                type => 'boolean',
-               description => "Create a full copy of all disk. This is always done when " .
+               description => "Create a full copy of all disks. This is always done when " .
                    "you clone a normal VM. For VM templates, we try to create a linked clone by default.",
-               default => 0,
            },
            target => get_standard_option('pve-node', {
                description => "Target node. Only allowed if the original VM is on shared storage.",
@@ -2530,6 +2657,17 @@ __PACKAGE__->register_method({
            die "snapshot '$snapname' does not exist\n"
                if $snapname && !defined( $conf->{snapshots}->{$snapname});
 
+           my $full = extract_param($param, 'full');
+           if (!defined($full)) {
+               $full = !PVE::QemuConfig->is_template($conf);
+           }
+
+           die "parameter 'storage' not allowed for linked clones\n"
+               if defined($storage) && !$full;
+
+           die "parameter 'format' not allowed for linked clones\n"
+               if defined($format) && !$full;
+
            my $oldconf = $snapname ? $conf->{snapshots}->{$snapname} : $conf;
 
            my $sharedvm = &$check_storage_access_clone($rpcenv, $authuser, $storecfg, $oldconf, $storage);
@@ -2565,10 +2703,10 @@ __PACKAGE__->register_method({
                } elsif (PVE::QemuServer::is_valid_drivename($opt)) {
                    my $drive = PVE::QemuServer::parse_drive($opt, $value);
                    die "unable to parse drive options for '$opt'\n" if !$drive;
-                   if (PVE::QemuServer::drive_is_cdrom($drive)) {
+                   if (PVE::QemuServer::drive_is_cdrom($drive, 1)) {
                        $newconf->{$opt} = $value; # simply copy configuration
                    } else {
-                       if ($param->{full}) {
+                       if ($full || PVE::QemuServer::drive_is_cloudinit($drive)) {
                            die "Full clone feature is not supported for drive '$opt'\n"
                                if !PVE::Storage::volume_has_feature($storecfg, 'copy', $drive->{file}, $snapname, $running);
                            $fullclone->{$opt} = 1;
@@ -2645,6 +2783,13 @@ __PACKAGE__->register_method({
                    }
 
                    delete $newconf->{lock};
+
+                   # do not write pending changes
+                   if ($newconf->{pending}) {
+                       warn "found pending changes, discarding for clone\n";
+                       delete $newconf->{pending};
+                   }
+
                    PVE::QemuConfig->write_config($newid, $newconf);
 
                     if ($target) {
@@ -2776,7 +2921,7 @@ __PACKAGE__->register_method({
 
            my $old_volid = $drive->{file} || die "disk '$disk' has no associated volume\n";
 
-           die "you can't move a cdrom\n" if PVE::QemuServer::drive_is_cdrom($drive);
+           die "you can't move a cdrom\n" if PVE::QemuServer::drive_is_cdrom($drive, 1);
 
            my $oldfmt;
            my ($oldstoreid, $oldvolname) = PVE::Storage::parse_volume_id($old_volid);
@@ -3192,7 +3337,32 @@ __PACKAGE__->register_method({
        type => 'array',
        items => {
            type => "object",
-           properties => {},
+           properties => {
+               name => {
+                   description => "Snapshot identifier. Value 'current' identifies the current VM.",
+                   type => 'string',
+               },
+               vmstate => {
+                   description => "Snapshot includes RAM.",
+                   type => 'boolean',
+                   optional => 1,
+               },
+               description => {
+                   description => "Snapshot description.",
+                   type => 'string',
+               },
+               snaptime => {
+                   description => "Snapshot creation time",
+                   type => 'integer',
+                   renderer => 'timestamp',
+                   optional => 1,
+               },
+               parent => {
+                   description => "Parent snapshot identifier.",
+                   type => 'string',
+                   optional => 1,
+               },
+           },
        },
        links => [ { rel => 'child', href => "{name}" } ],
     },
@@ -3220,7 +3390,12 @@ __PACKAGE__->register_method({
        }
 
        my $running = PVE::QemuServer::check_running($vmid, 1) ? 1 : 0;
-       my $current = { name => 'current', digest => $conf->{digest}, running => $running };
+       my $current = {
+           name => 'current',
+           digest => $conf->{digest},
+           running => $running,
+           description => "You are here!",
+       };
        $current->{parent} = $conf->{parent} if $conf->{parent};
 
        push @$res, $current;