use PVE::RESTHandler;
use PVE::JSONSchema qw(get_standard_option);
use PVE::QemuServer;
+use PVE::QemuServer::Agent qw(agent_available agent_cmd check_agent_error);
+use PVE::QemuServer::Monitor qw(mon_cmd);
+use MIME::Base64 qw(encode_base64 decode_base64);
+use JSON;
use base qw(PVE::RESTHandler);
+# max size for file-read over the api
+my $MAX_READ_SIZE = 16 * 1024 * 1024; # 16 MiB
+
# list of commands
# will generate one api endpoint per command
# needs a 'method' property and optionally a 'perms' property (default VM.Monitor)
method => 'POST',
},
'get-time' => {
- method => 'POST',
+ method => 'GET',
},
'info' => {
- method => 'POST',
+ method => 'GET',
},
'fsfreeze-status' => {
method => 'POST',
method => 'POST',
},
'network-get-interfaces' => {
- method => 'POST',
+ method => 'GET',
},
'get-vcpus' => {
- method => 'POST',
+ method => 'GET',
},
'get-fsinfo' => {
- method => 'POST',
+ method => 'GET',
},
'get-memory-blocks' => {
- method => 'POST',
+ method => 'GET',
},
'get-memory-block-info' => {
- method => 'POST',
+ method => 'GET',
},
'suspend-hybrid' => {
method => 'POST',
'shutdown' => {
method => 'POST',
},
+ # added since qemu 2.9
+ 'get-host-name' => {
+ method => 'GET',
+ },
+ 'get-osinfo' => {
+ method => 'GET',
+ },
+ 'get-users' => {
+ method => 'GET',
+ },
+ 'get-timezone' => {
+ method => 'GET',
+ },
};
__PACKAGE__->register_method({
my $result = [];
- for my $cmd (sort keys %$guest_agent_commands) {
+ my $cmds = [keys %$guest_agent_commands];
+ push @$cmds, qw(
+ exec
+ exec-status
+ file-read
+ file-write
+ set-user-password
+ );
+
+ for my $cmd ( sort @$cmds) {
push @$result, { name => $cmd };
}
my $conf = PVE::QemuConfig->load_config ($vmid); # check if VM exists
- die "No Qemu Guest Agent\n" if !defined($conf->{agent});
- die "VM $vmid is not running\n" if !PVE::QemuServer::check_running($vmid);
+ agent_available($vmid, $conf);
my $cmd = $param->{command} // $command;
- my $res = PVE::QemuServer::vm_mon_cmd($vmid, "guest-$cmd");
+ my $res = mon_cmd($vmid, "guest-$cmd");
return { result => $res };
}});
__PACKAGE__->register_command($cmd, $props->{method}, $props->{perms});
}
+# commands with parameters are complicated and we want to register them manually
+__PACKAGE__->register_method({
+ name => 'set-user-password',
+ path => 'set-user-password',
+ method => 'POST',
+ protected => 1,
+ proxyto => 'node',
+ description => "Sets the password for the given user to the given password",
+ permissions => { check => [ 'perm', '/vms/{vmid}', [ 'VM.Monitor' ]]},
+ parameters => {
+ additionalProperties => 0,
+ properties => {
+ node => get_standard_option('pve-node'),
+ vmid => get_standard_option('pve-vmid', {
+ completion => \&PVE::QemuServer::complete_vmid_running }),
+ username => {
+ type => 'string',
+ description => 'The user to set the password for.'
+ },
+ password => {
+ type => 'string',
+ description => 'The new password.',
+ minLength => 5,
+ maxLength => 1024,
+ },
+ crypted => {
+ type => 'boolean',
+ description => 'set to 1 if the password has already been passed through crypt()',
+ optional => 1,
+ default => 0,
+ },
+ },
+ },
+ returns => {
+ type => 'object',
+ description => "Returns an object with a single `result` property.",
+ },
+ code => sub {
+ my ($param) = @_;
+
+ my $vmid = $param->{vmid};
+
+ my $crypted = $param->{crypted} // 0;
+ my $args = {
+ username => $param->{username},
+ password => encode_base64($param->{password}),
+ crypted => $crypted ? JSON::true : JSON::false,
+ };
+ my $res = agent_cmd($vmid, "set-user-password", $args, 'cannot set user password');
+
+ return { result => $res };
+ }});
+
+__PACKAGE__->register_method({
+ name => 'exec',
+ path => 'exec',
+ method => 'POST',
+ protected => 1,
+ proxyto => 'node',
+ description => "Executes the given command in the vm via the guest-agent and returns an object with the pid.",
+ permissions => { check => [ 'perm', '/vms/{vmid}', [ 'VM.Monitor' ]]},
+ parameters => {
+ additionalProperties => 0,
+ properties => {
+ node => get_standard_option('pve-node'),
+ vmid => get_standard_option('pve-vmid', {
+ completion => \&PVE::QemuServer::complete_vmid_running }),
+ command => {
+ type => 'string',
+ format => 'string-alist',
+ description => 'The command as a list of program + arguments',
+ optional => 1,
+ },
+ 'input-data' => {
+ type => 'string',
+ maxLength => 64 * 1024,
+ description => "Data to pass as 'input-data' to the guest. Usually treated as STDIN to 'command'.",
+ optional => 1,
+ },
+ },
+ },
+ returns => {
+ type => 'object',
+ properties => {
+ pid => {
+ type => 'integer',
+ description => "The PID of the process started by the guest-agent.",
+ },
+ },
+ },
+ code => sub {
+ my ($param) = @_;
+
+ my $vmid = $param->{vmid};
+ my $cmd = undef;
+ if ($param->{command}) {
+ $cmd = [PVE::Tools::split_list($param->{command})];
+ }
+
+ my $res = PVE::QemuServer::Agent::qemu_exec($vmid, $param->{'input-data'}, $cmd);
+ return $res;
+ }});
+
+__PACKAGE__->register_method({
+ name => 'exec-status',
+ path => 'exec-status',
+ method => 'GET',
+ protected => 1,
+ proxyto => 'node',
+ description => "Gets the status of the given pid started by the guest-agent",
+ permissions => { check => [ 'perm', '/vms/{vmid}', [ 'VM.Monitor' ]]},
+ parameters => {
+ additionalProperties => 0,
+ properties => {
+ node => get_standard_option('pve-node'),
+ vmid => get_standard_option('pve-vmid', {
+ completion => \&PVE::QemuServer::complete_vmid_running }),
+ pid => {
+ type => 'integer',
+ description => 'The PID to query'
+ },
+ },
+ },
+ returns => {
+ type => 'object',
+ properties => {
+ exited => {
+ type => 'boolean',
+ description => 'Tells if the given command has exited yet.',
+ },
+ exitcode => {
+ type => 'integer',
+ optional => 1,
+ description => 'process exit code if it was normally terminated.',
+ },
+ signal=> {
+ type => 'integer',
+ optional => 1,
+ description => 'signal number or exception code if the process was abnormally terminated.',
+ },
+ 'out-data' => {
+ type => 'string',
+ optional => 1,
+ description => 'stdout of the process',
+ },
+ 'err-data' => {
+ type => 'string',
+ optional => 1,
+ description => 'stderr of the process',
+ },
+ 'out-truncated' => {
+ type => 'boolean',
+ optional => 1,
+ description => 'true if stdout was not fully captured',
+ },
+ 'err-truncated' => {
+ type => 'boolean',
+ optional => 1,
+ description => 'true if stderr was not fully captured',
+ },
+ },
+ },
+ code => sub {
+ my ($param) = @_;
+
+ my $vmid = $param->{vmid};
+ my $pid = int($param->{pid});
+
+ my $res = PVE::QemuServer::Agent::qemu_exec_status($vmid, $pid);
+
+ return $res;
+ }});
+
+__PACKAGE__->register_method({
+ name => 'file-read',
+ path => 'file-read',
+ method => 'GET',
+ protected => 1,
+ proxyto => 'node',
+ description => "Reads the given file via guest agent. Is limited to $MAX_READ_SIZE bytes.",
+ permissions => { check => [ 'perm', '/vms/{vmid}', [ 'VM.Monitor' ]]},
+ parameters => {
+ additionalProperties => 0,
+ properties => {
+ node => get_standard_option('pve-node'),
+ vmid => get_standard_option('pve-vmid', {
+ completion => \&PVE::QemuServer::complete_vmid_running }),
+ file => {
+ type => 'string',
+ description => 'The path to the file'
+ },
+ },
+ },
+ returns => {
+ type => 'object',
+ description => "Returns an object with a `content` property.",
+ properties => {
+ content => {
+ type => 'string',
+ description => "The content of the file, maximum $MAX_READ_SIZE",
+ },
+ truncated => {
+ type => 'boolean',
+ optional => 1,
+ description => "If set to 1, the output is truncated and not complete"
+ }
+ },
+ },
+ code => sub {
+ my ($param) = @_;
+
+ my $vmid = $param->{vmid};
+
+ my $qgafh = agent_cmd($vmid, "file-open", { path => $param->{file} }, "can't open file");
+
+ my $bytes_left = $MAX_READ_SIZE;
+ my $eof = 0;
+ my $read_size = 1024*1024;
+ my $content = "";
+
+ while ($bytes_left > 0 && !$eof) {
+ my $read = mon_cmd($vmid, "guest-file-read", handle => $qgafh, count => int($read_size));
+ check_agent_error($read, "can't read from file");
+
+ $content .= decode_base64($read->{'buf-b64'});
+ $bytes_left -= $read->{count};
+ $eof = $read->{eof} // 0;
+ }
+
+ my $res = mon_cmd($vmid, "guest-file-close", handle => $qgafh);
+ check_agent_error($res, "can't close file", 1);
+
+ my $result = {
+ content => $content,
+ 'bytes-read' => ($MAX_READ_SIZE-$bytes_left),
+ };
+
+ if (!$eof) {
+ warn "agent file-read: reached maximum read size: $MAX_READ_SIZE bytes. output might be truncated.\n";
+ $result->{truncated} = 1;
+ }
+
+ return $result;
+ }});
+
+__PACKAGE__->register_method({
+ name => 'file-write',
+ path => 'file-write',
+ method => 'POST',
+ protected => 1,
+ proxyto => 'node',
+ description => "Writes the given file via guest agent.",
+ permissions => { check => [ 'perm', '/vms/{vmid}', [ 'VM.Monitor' ]]},
+ parameters => {
+ additionalProperties => 0,
+ properties => {
+ node => get_standard_option('pve-node'),
+ vmid => get_standard_option('pve-vmid', {
+ completion => \&PVE::QemuServer::complete_vmid_running }),
+ file => {
+ type => 'string',
+ description => 'The path to the file.'
+ },
+ content => {
+ type => 'string',
+ maxLength => 60*1024, # 60k, smaller than our 64k POST limit
+ description => "The content to write into the file."
+ }
+ },
+ },
+ returns => { type => 'null' },
+ code => sub {
+ my ($param) = @_;
+
+ my $vmid = $param->{vmid};
+ my $buf = encode_base64($param->{content});
+
+ my $qgafh = agent_cmd($vmid, "file-open", { path => $param->{file}, mode => 'wb' }, "can't open file");
+ my $write = agent_cmd($vmid, "file-write", { handle => $qgafh, 'buf-b64' => $buf }, "can't write to file");
+ my $res = agent_cmd($vmid, "file-close", { handle => $qgafh }, "can't close file");
+
+ return;
+ }});
+
1;
projects / qemu-server.git / blobdiff