vzdump 4.46 KB
Newer Older
1
#!/usr/bin/perl -w -T
2 3

use strict;
Dietmar Maurer's avatar
Dietmar Maurer committed
4 5 6 7
use PVE::SafeSyslog;
use PVE::INotify;
use PVE::RPCEnvironment;
use PVE::CLIHandler;
8
use PVE::API2::VZDump;
9

Dietmar Maurer's avatar
Dietmar Maurer committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
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 $rpcenv = PVE::RPCEnvironment->init('cli');

$rpcenv->init_request();
$rpcenv->set_language($ENV{LANG});
$rpcenv->set_user('root@pam'); 

28

29
my $cmddef = [ 'PVE::API2::VZDump', 'vzdump', 'vmid', undef, 
Dietmar Maurer's avatar
Dietmar Maurer committed
30 31
	       sub {
		   my $upid = shift;
32
		   exit(0) if $upid eq 'OK';
Dietmar Maurer's avatar
Dietmar Maurer committed
33 34 35
		   my $status = PVE::Tools::upid_read_status($upid);
		   exit($status eq 'OK' ? 0 : -1);
	       }];
36

Dietmar Maurer's avatar
Dietmar Maurer committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
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
52 53 54 55

=head1 DESCRIPTION

vzdump is an utility to make consistent snapshots of running virtual
56
machines (VMs). It basically creates an archive of the VM private area,
57 58 59
which also includes the VM configuration files. vzdump currently
supports OpenVZ and QemuServer VMs.

60
There are several ways to provide consistency (option C<mode>):
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99

=over 2

=item C<stop> mode

Stop the VM during backup. This results in a very long downtime.

=item C<suspend> mode

For OpenVZ, this mode uses rsync to copy the VM to a temporary
location (see option --tmpdir). Then the VM is suspended and a second
rsync copies changed files. After that, the VM is started (resume)
again. This results in a minimal downtime, but needs additional space
to hold the VM copy.

For QemuServer, this mode work like C<stop> mode, but uses
suspend/resume instead of stop/start.

=item C<snapshot> mode

This mode uses LVM2 snapshots. There is no downtime, but snapshot mode
needs LVM2 and some free space on the corresponding volume group to
create the LVM snapshot.

=back 

=head1 BACKUP FILE NAMES

Newer version of vzdump encodes the virtual machine type and the
backup time into the filename, for example

 vzdump-openvz-105-2009_10_09-11_04_43.tar

That way it is possible to store several backup into the same
directory. The parameter C<maxfiles> can be used to specify the maximal
number of backups to keep.

=head1 RESTORE

100
The resulting archive files can be restored with the following programs.
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126

=over 1

=item vzrestore: OpenVZ restore utility

=item qmrestore: QemuServer restore utility

=back

For details see the corresponding manual pages.

=head1 CONFIGURATION

Global configuration is stored in /etc/vzdump.conf. 

 tmpdir: DIR
 dumpdir: DIR
 storage: STORAGE_ID
 mode: snapshot|suspend|stop
 bwlimit: KBPS
 ionize: PRI
 lockwait: MINUTES 
 stopwait: MINUTES 
 size: MB
 maxfiles: N
 script: FILENAME
127
 exclude-path: PATHLIST
128 129 130

=head1 HOOK SCRIPT

131
You can specify a hook script with option C<--script>. This script is called at various phases of the backup process, with parameters accordingly set. You can find an example in the documentation directory (C<vzdump-hook-script.pl>). 
132 133 134 135 136 137 138 139 140 141 142 143

=head1 EXCLUSIONS (OpenVZ only)

vzdump skips the following files wit option --stdexcludes

 /var/log/.+
 /tmp/.+
 /var/tmp/.+
 /var/run/.+pid

You can manually specify exclude paths, for example:

Dietmar Maurer's avatar
Dietmar Maurer committed
144
 # vzdump 777 --exclude-path C</tmp/.+> --exclude-path C</var/tmp/.+>
145 146 147 148 149 150 151 152 153 154 155 156 157

(only excludes tmp directories)

Configuration files are also stored inside the backup archive (/etc/vzdump), and will be correctly restored.

=head1 LIMITATIONS

VZDump does not save ACLs.

=head1 EXAMPLES

Simply dump VM 777 - no snapshot, just archive the VM private area and configuration files to the default dump directory (usually /vz/dump/).

Dietmar Maurer's avatar
Dietmar Maurer committed
158
 # vzdump 777
159 160 161

Use rsync and suspend/resume to create an snapshot (minimal downtime).

162
 # vzdump 777 --mode suspend
163

Dietmar Maurer's avatar
Dietmar Maurer committed
164
Backup all VMs and send notification mails to root and admin.
165

166
 # vzdump --all --mode suspend --mailto root --mailto admin
167 168 169

Use LVM2 to create snapshots (no downtime).

170
 # vzdump 777 --dumpdir /mnt/backup --mode snapshot
Dietmar Maurer's avatar
Dietmar Maurer committed
171 172 173 174

Backup more than one VM (selectively)

 # vzdump 101 102 103 --mailto root
175 176 177

Backup all VMs excluding VM 101 and 102

178
 # vzdump --mode suspend --exclude 101,102
179 180 181

Restore an OpenVZ machine to VM 600

Dietmar Maurer's avatar
Dietmar Maurer committed
182
 # vzrestore /mnt/backup/vzdump-openvz-777.tar 600
183 184 185

Restore an Qemu/KVM machine to VM 601

186
 # qmrestore /mnt/backup/vzdump-qemu-888.vma 601
187

Dietmar Maurer's avatar
Dietmar Maurer committed
188 189 190 191
Clone an existing container 101 to container 300 using pipes

 # vzdump 101 --stdout|vzrestore - 300

192 193
=head1 SEE ALSO

Dietmar Maurer's avatar
Dietmar Maurer committed
194
vzrestore(1) qmrestore(1)
195

Dietmar Maurer's avatar
Dietmar Maurer committed
196
=include pve_copyright