Commit d7c6257f authored by Dietmar Maurer's avatar Dietmar Maurer

adopt vzdump to pve 2

parent 46e1d3ca
......@@ -383,7 +383,7 @@ sub json_config_properties {
}
# read global vz.conf
my $read_global_vz_config = sub {
sub read_global_vz_config {
my $res = {
rootdir => '/var/lib/vz/root/$VEID', # note '$VEID' is a place holder
......@@ -431,7 +431,7 @@ my $read_global_vz_config = sub {
return $res;
};
my $global_vzconf = &$read_global_vz_config();
my $global_vzconf = read_global_vz_config();
my $res_unlimited = LONG_MAX;
sub parse_netif {
......@@ -1065,6 +1065,15 @@ sub generate_raw_config {
return $text;
}
sub create_lock_manager {
return LockFile::Simple->make(-format => '%f',
-autoclean => 1,
-max => 30,
-delay => 2,
-stale => 1,
-nfs => 0);
}
sub lock_container {
my ($vmid, $code, @param) = @_;
......@@ -1074,12 +1083,7 @@ sub lock_container {
eval {
my $lockmgr = LockFile::Simple->make(-format => '%f',
-autoclean => 1,
-max => 30,
-delay => 2,
-stale => 1,
-nfs => 0);
my $lockmgr = create_lock_manager();
$lock = $lockmgr->lock($filename) || die "can't lock container $vmid\n";
......
package PVE::VZDump;
# Copyright (C) 2007-2009 Proxmox Server Solutions GmbH
#
# Copyright: vzdump is under GNU GPL, the GNU General Public License.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 dated June, 1991.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the
# Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
# MA 02110-1301, USA.
#
# Author: Dietmar Maurer <dietmar@proxmox.com>
use strict;
use warnings;
use Fcntl ':flock';
use Sys::Hostname;
use Sys::Syslog;
use PVE::SafeSyslog;
use IO::File;
use IO::Select;
use IPC::Open3;
use POSIX qw(strftime);
use File::Path;
use PVE::Storage;
use PVE::Cluster qw(cfs_read_file);
use PVE::VZDump::OpenVZ;
use Time::localtime;
use Time::Local;
......@@ -84,112 +65,32 @@ sub debugmsg {
sub run_command {
my ($logfd, $cmdstr, %param) = @_;
my $timeout;
my $input;
my $output;
foreach my $p (keys %param) {
if ($p eq 'timeout') {
$timeout = $param{$p};
} elsif ($p eq 'input') {
$input = $param{$p};
} elsif ($p eq 'output') {
$output = $param{$p};
} else {
die "got unknown parameter '$p' for run_command\n";
}
}
my $reader = $output && $output =~ m/^>&/ ? $output : IO::File->new();
my $writer = $input && $input =~ m/^<&/ ? $input : IO::File->new();
my $error = IO::File->new();
my $returnstdout = $param{returnstdout};
delete $param{returnstdout};
my $orig_pid = $$;
my $ostream = 0;
my $pid;
eval {
# suppress LVM warnings like: "File descriptor 3 left open";
local $ENV{LVM_SUPPRESS_FD_WARNINGS} = "1";
$pid = open3 ($writer, $reader, $error, ($cmdstr)) || die $!;
my $outfunc = sub {
my $line = shift;
$ostream .= "$line\n" if $returnstdout;
debugmsg ('info', $line, $logfd);
};
my $err = $@;
# catch exec errors
if ($orig_pid != $$) {
debugmsg ('err', "command '$cmdstr' failed - fork failed: $!", $logfd);
POSIX::_exit (1);
kill ('KILL', $$);
}
die $err if $err;
if (ref($writer)) {
print $writer $input if defined $input;
close $writer;
}
my $select = new IO::Select;
$select->add ($reader) if ref($reader);
$select->add ($error);
my ($ostream, $estream, $logout, $logerr) = ('', '', '', '');
while ($select->count) {
my @handles = $select->can_read ($timeout);
if (defined ($timeout) && (scalar (@handles) == 0)) {
die "command '$cmdstr' failed: timeout\n";
}
foreach my $h (@handles) {
my $buf = '';
my $count = sysread ($h, $buf, 4096);
if (!defined ($count)) {
waitpid ($pid, 0);
die "command '$cmdstr' failed: $!\n";
}
$select->remove ($h) if !$count;
if ($h eq $reader) {
$ostream .= $buf;
$logout .= $buf;
while ($logout =~ s/^([^\n]*\n)//s) {
my $line = $1;
debugmsg ('info', $line, $logfd);
}
} elsif ($h eq $error) {
$estream .= $buf;
$logerr .= $buf;
while ($logerr =~ s/^([^\n]*\n)//s) {
my $line = $1;
debugmsg ('info', $line, $logfd);
}
}
}
}
debugmsg ('info', $logout, $logfd);
debugmsg ('info', $logerr, $logfd);
waitpid ($pid, 0);
my $ec = ($? >> 8);
return $ostream if $ec == 24 && ($cmdstr =~ m|^(\S+/)?rsync\s|);
my $errfunc = sub {
my $line = shift;
debugmsg ('info', $line, $logfd);
};
die "command '$cmdstr' failed with exit code $ec\n" if $ec;
PVE::Tools::run_command($cmdstr, %param, outfunc => $outfunc, errfunc => $errfunc);
return $ostream;
return $returnstdout ? $ostream : undef;
}
sub storage_info {
my $storage = shift;
eval { require PVE::Storage; };
die "unable to query storage info for '$storage' - $@\n" if $@;
my $cfg = PVE::Storage::load_config();
my $scfg = PVE::Storage::storage_config ($cfg, $storage);
my $cfg = cfs_read_file('storage.cfg');
my $scfg = PVE::Storage::storage_config($cfg, $storage);
my $type = $scfg->{type};
die "can't use storage type '$type' for backup\n"
......@@ -197,7 +98,7 @@ sub storage_info {
die "can't use storage for backups - wrong content type\n"
if (!$scfg->{content}->{backup});
PVE::Storage::activate_storage ($cfg, $storage);
PVE::Storage::activate_storage($cfg, $storage);
return {
dumpdir => $scfg->{path},
......@@ -272,7 +173,7 @@ sub check_vmids {
foreach my $vmid (@vmids) {
die "ERROR: strange VM ID '${vmid}'\n" if $vmid !~ m/^\d+$/;
$vmid = int ($vmid); # remove leading zeros
die "ERROR: got reserved VM ID '${vmid}'\n" if $vmid < 100;
next if !$vmid;
push @$res, $vmid;
}
......@@ -374,7 +275,7 @@ my $sendmail = sub {
my $mailto = $opts->{mailto};
return if !$mailto;
return if !($mailto && scalar(@$mailto));
my $cmdline = $self->{cmdline};
......@@ -394,10 +295,9 @@ my $sendmail = sub {
my $stat = $ecount ? 'backup failed' : 'backup successful';
my $hostname = `hostname -f` || hostname();
my $hostname = `hostname -f` || PVE::INotify::nodename();
chomp $hostname;
my $boundary = "----_=_NextPart_001_".int(time).$$;
my $rcvrarg = '';
......@@ -539,6 +439,7 @@ my $sendmail = sub {
# end html part
print MAIL "\n--$boundary--\n";
close(MAIL);
};
sub new {
......@@ -1136,6 +1037,10 @@ sub exec_backup {
eval { $self->$sendmail ($tasklist, $totaltime); };
debugmsg ('err', $@) if $@;
die $err if $err;
die "job errors\n" if $errcount;
}
1;
......@@ -24,117 +24,33 @@ use strict;
use warnings;
use File::Path;
use File::Basename;
use PVE::INotify;
use PVE::VZDump;
use Sys::Hostname;
use LockFile::Simple;
use PVE::OpenVZ;
use base qw (PVE::VZDump::Plugin);
use constant SCRIPT_EXT => qw (start stop mount umount);
use constant VZDIR => '/etc/vz';
my $remove_quotes = sub {
my $str = shift;
$str =~ s/^\s*\"?//;
$str =~ s/\"?\s*$//;
return $str;
};
# read global vz.conf
sub read_global_vz_config {
local $/;
my $res = {
rootdir => '/vz/root/$VEID', # note '$VEID' is a place holder
privatedir => '/vz/private/$VEID', # note '$VEID' is a place holder
dumpdir => '/vz/dump',
lockdir => '/var/lib/vz/lock',
};
my $filename = VZDIR . "/vz.conf";
my $fh = IO::File->new ($filename, "r");
return $res if !$fh;
my $data = <$fh> || '';
$fh->close();
if ($data =~ m/^\s*VE_PRIVATE=(.*)$/m) {
my $dir = &$remove_quotes ($1);
if ($dir !~ m/\$VEID/) {
warn "VE_PRIVATE does not contain '\$VEID' ('$dir')\n";
} else {
$res->{privatedir} = $dir;
}
}
if ($data =~ m/^\s*VE_ROOT=(.*)$/m) {
my $dir = &$remove_quotes ($1);
if ($dir !~ m/\$VEID/) {
warn "VE_ROOT does not contain '\$VEID' ('$dir')\n";
} else {
$res->{rootdir} = $dir;
}
}
if ($data =~ m/^\s*DUMPDIR=(.*)$/m) {
my $dir = &$remove_quotes ($1);
$dir =~ s|/\$VEID$||;
$res->{dumpdir} = $dir;
}
if ($data =~ m/^\s*LOCKDIR=(.*)$/m) {
my $dir = &$remove_quotes ($1);
$res->{lockdir} = $dir;
}
return $res;
}
my $load_vz_conf = sub {
my ($self, $vmid) = @_;
local $/;
my $conf = PVE::OpenVZ::load_config($vmid);
my $conf = $self->{vmlist}->{$vmid}->{conffile};
my $fh = IO::File->new ($conf, "r") ||
die "unable to open config file '$conf'\n";
my $data = <$fh>;
$fh->close();
my $dir;
if ($data =~ m/^\s*VE_PRIVATE=(.*)$/m) {
$dir = &$remove_quotes ($1);
} else {
$dir = $self->{privatedir};
my $dir = $self->{privatedir};
if ($conf->{ve_private} && $conf->{ve_private}->{value}) {
$dir = $conf->{ve_private}->{value};
}
$dir =~ s/\$VEID/$vmid/;
$self->{vmlist}->{$vmid}->{dir} = $dir;
if ($data =~ m/^\s*HOSTNAME=(.*)/m) {
$self->{vmlist}->{$vmid}->{hostname} = &$remove_quotes ($1);
} else {
$self->{vmlist}->{$vmid}->{hostname} = "VM $vmid";
my $hostname = "CT $vmid";
if ($conf->{hostname} && $conf->{hostname}->{value}) {
$hostname = $conf->{hostname}->{value};
}
$self->{vmlist}->{$vmid}->{hostname} = $hostname;
};
sub read_vz_list {
my $vmlist = {};
my $dir = VZDIR . "/conf";
foreach my $conf (<$dir/*.conf>) {
next if $conf !~ m|/(\d\d\d+)\.conf$|;
my $vmid = $1;
$vmlist->{$vmid}->{conffile} = $conf;
}
return $vmlist;
}
my $rsync_vm = sub {
my ($self, $task, $from, $to, $text) = @_;
......@@ -160,11 +76,11 @@ sub new {
PVE::VZDump::check_bin ('vzctl');
my $self = bless read_global_vz_config ();
my $self = bless PVE::OpenVZ::read_global_vz_config ();
$self->{vzdump} = $vzdump;
$self->{vmlist} = read_vz_list ();
$self->{vmlist} = PVE::OpenVZ::config_list();
return $self;
};
......@@ -176,12 +92,12 @@ sub type {
sub vm_status {
my ($self, $vmid) = @_;
my $status_text = $self->cmd ("vzctl status $vmid");
my $status_text = $self->cmd ("vzctl status $vmid", returnstdout => 1);
chomp $status_text;
my $running = $status_text =~ m/running/ ? 1 : 0;
return wantarray ? ($running, $status_text) : $running;
return wantarray ? ($running, $running ? 'running' : 'stopped') : $running;
}
sub prepare {
......@@ -197,7 +113,7 @@ sub prepare {
$task->{diskinfo} = $diskinfo;
my $hostname = hostname();
my $hostname = PVE::INotify::nodename();
if ($mode eq 'snapshot') {
......@@ -236,12 +152,7 @@ sub lock_vm {
my $filename = "$self->{lockdir}/103.lck";
my $lockmgr = LockFile::Simple->make(-format => '%f',
-autoclean => 1,
-max => 30,
-delay => 2,
-stale => 1,
-nfs => 0);
my $lockmgr = PVE::OpenVZ::create_lock_manager();
$self->{lock} = $lockmgr->lock($filename) || die "can't lock VM $vmid\n";
}
......@@ -325,7 +236,7 @@ sub resume_vm {
sub assemble {
my ($self, $task, $vmid) = @_;
my $conffile = $self->{vmlist}->{$vmid}->{conffile};
my $conffile = PVE::OpenVZ::config_file($vmid);
my $dir = $task->{snapdir};
......@@ -354,9 +265,13 @@ sub archive {
my $taropts = "--totals --sparse --numeric-owner --no-recursion --ignore-failed-read --one-file-system";
if ($snapdir eq $task->{tmpdir} && $snapdir =~ m|^$opts->{dumpdir}/|) {
$taropts .= " --remove-files"; # try to save space
}
# note: --remove-files does not work because we do not
# backup all files (filters). tar complains:
# Cannot rmdir: Directory not empty
# we we disable this optimization for now
#if ($snapdir eq $task->{tmpdir} && $snapdir =~ m|^$opts->{dumpdir}/|) {
# $taropts .= " --remove-files"; # try to save space
#}
my $cmd = "(";
$cmd .= "cd $snapdir;find . $findargs|sed 's/\\\\/\\\\\\\\/g'|";
......
package PVE::VZDump::Plugin;
# Copyright (C) 2007-2009 Proxmox Server Solutions GmbH
#
# Copyright: vzdump is under GNU GPL, the GNU General Public License.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 dated June, 1991.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the
# Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
# MA 02110-1301, USA.
#
# Author: Dietmar Maurer <dietmar@proxmox.com>
use strict;
use warnings;
use PVE::VZDump;
sub set_logfd {
my ($self, $logfd) = @_;
......@@ -47,13 +28,13 @@ sub cmd_noerr {
sub loginfo {
my ($self, $msg) = @_;
PVE::VZDump::debugmsg ('info', $msg, $self->{logfd}, 0);
PVE::VZDump::debugmsg('info', $msg, $self->{logfd}, 0);
}
sub logerr {
my ($self, $msg) = @_;
PVE::VZDump::debugmsg ('err', $msg, $self->{logfd}, 0);
PVE::VZDump::debugmsg('err', $msg, $self->{logfd}, 0);
}
sub type {
......
......@@ -16,6 +16,7 @@ SCRIPTS = \
MANS = \
pvectl.1 \
vzdump.1 \
pvestatd.1 \
pvedaemon.1 \
pveversion.1 \
......@@ -33,6 +34,9 @@ all: ${MANS}
pvectl.1.pod: pvectl
perl -I.. ./pvectl printmanpod >$@
vzdump.1.pod: vzdump
perl -I.. ./vzdump printmanpod >$@
.PHONY: install
install: ${SCRIPTS} ${MANS}
perl -I.. ./pvesh verifyapi
......
#!/usr/bin/perl -w
#
# Copyright (C) 2007-2009 Proxmox Server Solutions GmbH
#
# Copyright: vzdump is under GNU GPL, the GNU General Public License.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 dated June, 1991.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the
# Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
# MA 02110-1301, USA.
#
# Author: Dietmar Maurer <dietmar@proxmox.com>
#
use strict;
use Getopt::Long;
use Sys::Syslog;
use PVE::Exception qw(raise_param_exc);;
use PVE::Tools qw(extract_param);
use PVE::Cluster qw(cfs_register_file cfs_read_file);
use PVE::SafeSyslog;
use PVE::INotify;
use PVE::RPCEnvironment;
use PVE::CLIHandler;
use PVE::JSONSchema qw(get_standard_option);
use PVE::Storage;
use PVE::VZDump;
$ENV{LANG} = "C"; # avoid locale related issues/warnings
# by default we set --rsyncable for gzip
$ENV{GZIP} = "--rsyncable" if !$ENV{GZIP};
# just to be sure that we have a resonable path
$ENV{PATH} = "/sbin:/bin:/usr/sbin:/usr/bin:/usr/local/sbin:/usr/local/bin";
my $cmdline = join (' ', 'vzdump', @ARGV);
openlog ('vzdump', 'cons,pid', 'daemon');
$SIG{INT} = $SIG{TERM} = $SIG{QUIT} = $SIG{HUP} = $SIG{PIPE} = sub {
die "interrupted by signal\n";
};
my @std_opts = (
'all',
'exclude=s@',
'exclude-path=s@',
'stdexcludes',
'compress',
'mailto=s@',
'quiet',
'stop',
'suspend',
'snapshot',
'size=i',
'node=i',
'bwlimit=i',
'ionice=i',
'lockwait=i',
'stopwait=i',
'tmpdir=s',
'dumpdir=s',
'maxfiles=i',
'script=s',
'storage=s',
'stdout',
);
sub print_usage {
my $msg = shift;
print STDERR "ERROR: $msg\n\n" if $msg;
print STDERR "usage: $0 OPTIONS [--all | VMID]\n\n";
print STDERR "\t--exclude VMID\t\texclude VMID (assumes --all)\n";
print STDERR "\t--exclude-path REGEX\texclude certain files/directories\n"; print STDERR "\t--stdexcludes\t\texclude temorary files and logs\n\n";
print STDERR "\t--compress\t\tcompress dump file (gzip)\n";
print STDERR "\t--dumpdir DIR\t\tstore resulting files in DIR\n";
print STDERR "\t--maxfiles N\t\tmaximal number of backup files per VM\n";
print STDERR "\t--script FILENAME\texecute hook script\n";
print STDERR "\t--stdout write to stdout, not to a file\n";
print STDERR "\t--storage STORAGE_ID\tstore resulting files to STORAGE_ID (PVE only)\n";
print STDERR "\t--tmpdir DIR\t\tstore temporary files in DIR\n\n";
print STDERR "\t--mailto EMAIL\t\tsend notification mail to EMAIL.\n";
print STDERR "\t--quiet\t\t\tbe quiet.\n";
print STDERR "\t--stop\t\t\tstop/start VM if running\n";
print STDERR "\t--suspend\t\tsuspend/resume VM when running\n";
print STDERR "\t--snapshot\t\tuse LVM snapshot when running\n";
print STDERR "\t--size MB\t\tLVM snapshot size\n\n";
print STDERR "\t--node CID\t\tonly run on pve cluster node CID\n";
print STDERR "\t--lockwait MINUTES\tmaximal time to wait for the global lock\n";
print STDERR "\t--stopwait MINUTES\tmaximal time to wait until a VM is stopped\n";
print STDERR "\t--bwlimit KBPS\t\tlimit I/O bandwidth; KBytes per second\n";
print STDERR "\t--ionice PRI\t\tset ionice priority (0-8)\n\n";
print STDERR "\n";
}
my $opts = {};
if (!GetOptions ($opts, @std_opts)) {
print_usage ();
exit (-1);
}
if ($opts->{node}) {
PVE::VZDump::check_bin ('pveca');
my $info = `pveca -i`;
chomp $info;
die "unable to parse pveca info" if $info !~ m/^(\d+)\s+\S+\s+\S+\s+\S+$/;
my $cid = $1;
# silent exit if we run on wrong node
exit (0) if $cid != $opts->{node};
}
$opts->{all} = 1 if $opts->{exclude};
if ($opts->{all} && $#ARGV >= 0) {
print_usage ();
exit (-1);
}
if (!$opts->{all} && $#ARGV == -1) {
print_usage ();
exit (-1);
}
open STDOUT, '>/dev/null' if $opts->{quiet} && !$opts->{stdout};
open STDERR, '>/dev/null' if $opts->{quiet};
if ($opts->{stdout}) {
open my $saved_stdout, ">&STDOUT"
|| die "can't dup STDOUT: $!\n";
open STDOUT, '>&STDERR' ||
die "unable to redirect STDOUT: $!\n";
$opts->{stdout} = $saved_stdout;
die "you can only backup a single VM with option --stdout\n"
if scalar(@ARGV) != 1;
}
$opts->{vmids} = PVE::VZDump::check_vmids (@ARGV) if !$opts->{all};
$opts->{exclude} = PVE::VZDump::check_vmids (@{$opts->{exclude}}) if $opts->{exclude};
my $vzdump = PVE::VZDump->new ($cmdline, $opts);
$vzdump->getlock (); # only one process allowed
# parameters are OK - now start real work and log everything
eval {
if (defined($opts->{ionice})) {
if ($opts->{ionice} > 7) {
PVE::VZDump::run_command (undef, "ionice -c3 -p $$");
} else {
PVE::VZDump::run_command (undef, "ionice -c2 -n$opts->{ionice} -p $$");
use Data::Dumper; # fixme: remove
use base qw(PVE::CLIHandler);
$ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin';
initlog('vzdump');
die "please run as root\n" if $> != 0;
PVE::INotify::inotify_init();
my $nodename = PVE::INotify::nodename();
my $rpcenv = PVE::RPCEnvironment->init('cli');
$rpcenv->init_request();
$rpcenv->set_language($ENV{LANG});
$rpcenv->set_user('root@pam');
__PACKAGE__->register_method ({
name => 'vzdump',
path => 'vzdump',
method => 'PUT',
description => "Create backup.",
parameters => {
additionalProperties => 0,
properties => {
vmid => {
type => 'string', format => 'pve-vmid-list',
description => "The ID of the VM you want to backup.",
optional => 1,
},
node => get_standard_option('pve-node', {
description => "Only run if executed on this node.",
optional => 1,
}),
all => {
type => 'boolean',
description => "Backup all known VMs on this host.",
optional => 1,
default => 0,
},
stdexcludes => {
type => 'boolean',
description => "Exclude temorary files and logs.",
optional => 1,
default => 1,
},
compress => {
type => 'boolean',
description => "Compress dump file (gzip).",
optional => 1,
default => 0,
},
quiet => {
type => 'boolean',
description => "Be quiet.",
optional => 1,
default => 0,
},
stop => {
type => 'boolean',
description => "Stop/Restart VM when running.",
optional => 1,
},
snapshot => {
type => 'boolean',
description => "Try to use (LVM) snapshots when running.",
optional => 1,
},
suspend => {
type => 'boolean',
description => "Suspend/resume VM when running",
optional => 1,
},
stdout => {
type => 'boolean',
description => "Write tar to stdout, not to a file.",
optional => 1,
},
exclude => {
type => 'string', format => 'pve-vmid-list',
description => "exclude specified VMs (assumes --all)",
optional => 1,
},
'exclude-path' => {
type => 'string', format => 'string-list',
description => "exclude certain files/directories (regex).",
optional => 1,
},
mailto => {
type => 'string', format => 'string-list',
description => "",
optional => 1,
},
tmpdir => {
type => 'string',
description => "Store temporary files to specified directory.",
optional => 1,
},
dumpdir => {
type => 'string',
description => "Store resulting files to specified directory.",
optional => 1,
},
script => {
type => 'string',
description => "Use specified hook script.",
optional => 1,
},
storage => get_standard_option('pve-storage-id', {
description => "Store resulting file to this storage.",
optional => 1,
}),
size => {
type => 'integer',
description => "LVM snapshot size im MB.",
optional => 1,
minimum => 500,
},
bwlimit => {
type => 'integer',
description => "Limit I/O bandwidth (KBytes per second).",
optional => 1,
minimum => 0,
},
ionice => {
type => 'integer',
description => "Set CFQ ionice priority.",
optional => 1,
minimum => 0,
maximum => 8,
},
lockwait => {
type => 'integer',
description => "Maximal time to wait for the global lock (minutes).",
optional => 1,
minimum => 0,
},
stopwait => {
type => 'integer',
description => "Maximal time to wait until a VM is stopped (minutes).",
optional => 1,
minimum => 0,
},
maxfiles => {
type => 'integer',
description => "Maximal number of backup files per VM.",
optional => 1,
minimum => 1,
},
},
},
returns => { type => 'string' },
code => sub {
my ($param) = @_;
my $cmdline = 'vzdump';
foreach my $p (keys %$param) {
$cmdline .= " --$p $param->{$p}";
}
}
$vzdump->exec_backup();
};
my $err = $@;
if ($err) {
PVE::VZDump::debugmsg ('err', $err, undef, 1);
exit (-1);
}
my $rpcenv = PVE::RPCEnvironment::get();
exit 0;
my $user = $rpcenv->get_user();
__END__
if ($rpcenv->{type} ne 'cli') {
raise_param_exc({ node => "option is only allowed on the command line interface."})
if $param->{node};
=head1 NAME
vzdump - backup utility for virtual machine
raise_param_exc({ stdout => "option is only allowed on the command line interface."})
if $param->{stdout};
}
=head1 SYNOPSIS
# by default we set --rsyncable for gzip
local $ENV{GZIP} = "--rsyncable" if !$ENV{GZIP};
vzdump OPTIONS [--all | <VMID>]
$param->{all} = 1 if defined($param->{exclude});
--exclude VMID exclude VMID (assumes --all)
raise_param_exc({ all => "option conflicts with option 'vmid'"})
if $param->{all} && defined($param->{vmid});
--exclude-path REGEX exclude certain files/directories. You
can use this option more than once to specify
multiple exclude paths
raise_param_exc({ vmid => "property is missing"})
if !$param->{all} && !defined($param->{vmid});
--stdexcludes exclude temporary files and logs
# silent exit if we run on wrong node
my $nodename = PVE::INotify::nodename();
exit(0) if $param->{node} && $param->{node} ne $nodename;
--compress compress dump file (gzip)
# convert string lists to arrays
my @vmids = PVE::Tools::split_list(extract_param($param, 'vmid'));
$param->{vmids} = PVE::VZDump::check_vmids(@vmids) if !$param->{all};
my @exclude = PVE::Tools::split_list(extract_param($param, 'exclude'));
$param->{exclude} = PVE::VZDump::check_vmids(@exclude);
# exclude-path list need to be 0 separated
my @expaths = split(/\0/, $param->{'exclude-path'} || '');
$param->{'exclude-path'} = @expaths;
--storage STORAGE_ID store resulting files to STORAGE_ID (PVE only)
my @mailto = PVE::Tools::split_list(extract_param($param, 'mailto'));
$param->{mailto} = [ @mailto ];
--script execute hook script
die "you can only backup a single VM with option --stdout\n"
if $param->{stdout} && scalar(@vmids) != 1;
--dumpdir DIR store resulting files in DIR
my $vzdump = PVE::VZDump->new($cmdline, $param);
--stdout write to stdout, not to a file. You can only
backup a single VM when using this mode.
my $worker = sub {
$SIG{INT} = $SIG{TERM} = $SIG{QUIT} = $SIG{HUP} = $SIG{PIPE} = sub {
die "interrupted by signal\n";
};
--maxfiles N maximal number of backup files per VM.
$vzdump->getlock (); # only one process allowed
--tmpdir DIR store temporary files in DIR. --suspend and --stop
are using this directory to store a copy of the VM.
if (defined($param->{ionice})) {
if ($param->{ionice} > 7) {
PVE::VZDump::run_command(undef, "ionice -c3 -p $$");
} else {
PVE::VZDump::run_command(undef, "ionice -c2 -n$param->{ionice} -p $$");
}
}
$vzdump->exec_backup();
};
--mailto EMAIL send notification mail to EMAIL. You can use
this option more than once to specify multiple
receivers
open STDOUT, '>/dev/null' if $param->{quiet} && !$param->{stdout};
open STDERR, '>/dev/null' if $param->{quiet};
--stop stop/start VM if running
if ($rpcenv->{type} eq 'cli') {
if ($param->{stdout}) {
--suspend suspend/resume VM when running
open my $saved_stdout, ">&STDOUT"
|| die "can't dup STDOUT: $!\n";
--snapshot use LVM snapshot when running
open STDOUT, '>&STDERR' ||
die "unable to redirect STDOUT: $!\n";
--size MB LVM snapshot size (default 1024)
--bwlimit KBPS limit I/O bandwidth; KBytes per second
$param->{stdout} = $saved_stdout;
}
}
--ionice PRI set ionice priority (0-8). default is 7 (lowest 'best
effort' priority). Value 8 uses the ionice
'idle' scheduling class.
return $rpcenv->fork_worker('vzdump', undef, $user, $worker);
}});
--lockwait MINUTES maximal time to wait for the global
lock. vzdump uses a global lock file to make
sure that only one instance is running
(running several instance puts too much load
on a server). Default is 180 (3 hours).
my $cmddef = [ __PACKAGE__, 'vzdump', undef, undef,
sub {
my $upid = shift;
my $status = PVE::Tools::upid_read_status($upid);
exit($status eq 'OK' ? 0 : -1);
}];
--stopwait MINUTES maximal time to wait until a VM is stopped.
push @ARGV, 'help' if !scalar(@ARGV);
PVE::CLIHandler::handle_simple_cmd($cmddef, \@ARGV, undef, $0);
exit 0;
__END__
=head1 NAME
vzdump - backup utility for virtual machine
=head1 SYNOPSIS
=include synopsis
=head1 DESCRIPTION
......@@ -326,7 +369,7 @@ vzdump skips the following files wit option --stdexcludes
You can manually specify exclude paths, for example:
> vzdump --exclude-path C</tmp/.+> --exclude-path C</var/tmp/.+> 777
# vzdump --exclude-path C</tmp/.+> --exclude-path C</var/tmp/.+> 777
(only excludes tmp directories)
......@@ -340,60 +383,34 @@ VZDump does not save ACLs.
Simply dump VM 777 - no snapshot, just archive the VM private area and configuration files to the default dump directory (usually /vz/dump/).
> vzdump 777
# vzdump --vmid 777
Use rsync and suspend/resume to create an snapshot (minimal downtime).
> vzdump --suspend 777
# vzdump --suspend --vmid 777
Backup all VMs and send notification mails to root.
Backup all VMs and send notification mails to root and admin.
> vzdump --suspend --all --mailto root
# vzdump --suspend --all --mailto root --mailto admin
Use LVM2 to create snapshots (no downtime).
> vzdump --dumpdir /mnt/backup --snapshot 777
# vzdump --dumpdir /mnt/backup --snapshot --vmid 777
Backup all VMs excluding VM 101 and 102
> vzdump --suspend --exclude 101 --exclude 102
# vzdump --suspend --exclude 101 --exclude 102
Restore an OpenVZ machine to VM 600
> vzrestore /mnt/backup/vzdump-openvz-777.tar 600
# vzrestore /mnt/backup/vzdump-openvz-777.tar 600
Restore an Qemu/KVM machine to VM 601
> qmrestore /mnt/backup/vzdump-qemu-888.tar 601
# qmrestore /mnt/backup/vzdump-qemu-888.tar 601
=head1 SEE ALSO
vzrestore(1) qmrestore(1)
=head1 AUTHOR
Dietmar Maurer <dietmar@proxmox.com>
Many thanks to Proxmox Server Solutions (www.proxmox.com) for sponsoring
this work.
=head1 COPYRIGHT AND DISCLAIMER
Copyright (C) 2007-2009 Proxmox Server Solutions GmbH
Copyright: vzdump is under GNU GPL, the GNU General Public License.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; version 2 dated June, 1991.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the
Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
MA 02110-1301, USA.
vzrestore(1) qmrestore(1)
=include pve_copyright
......@@ -383,7 +383,8 @@ Ext.define('PVE.Utils', { statics: {
srvstart: 'Start service {0}',
srvstop: 'Stop service {0}',
srvrestart: 'Restart service {0}',
srvreload: 'Reload service {0}'
srvreload: 'Reload service {0}',
vzdump: 'Backup'
},
format_task_description: function(type, id) {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment