4 include::attributes.txt[]
9 vzdump - Backup Utility for VMs and Containers
15 include::vzdump.1-synopsis.adoc[]
25 include::attributes.txt[]
28 'vzdump' is a utility to make consistent backups of running guest
29 systems. It basically creates an archive of the guest private area,
30 which also includes the guest configuration files. 'vzdump' currently
31 supports LXC containers and QemuServer VMs. There are several ways to
32 provide consistency (option `mode`), depending on the guest type.
34 .Backup `mode` for VMs:
38 This first performns a clean shutdown of the VM to make sure it is
39 stopped. It then starts the VM in suspended mode and uses the qemu
40 backup feature to dump all data. If the VM was running, we start
41 (resume) it immediately after starting the qemu backup task. This
42 keeps the downtime as low as possible.
46 This mode does not really make sense for qemu. Please use snapshot
51 This mode simply starts a qemu live backup task. If the guest agent
52 is enabled (`agent: 1`) and running, it calls 'guest-fsfreeze-freeze'
53 and 'guest-fsfreeze-thaw' to improve consistency.
55 A technical overview of the Proxmox VE live backup for QemuServer can
57 https://git.proxmox.com/?p=pve-qemu-kvm.git;a=blob;f=backup.txt[here].
59 NOTE: Qemu backup provides snapshots on any storage type. It does
60 not require that the underlying storage supports snapshots.
63 .Backup `mode` for Containers:
67 Stop the guest during backup. This results in a very long downtime.
71 This mode uses rsync to copy the container data to a temporary
72 location (see option `--tmpdir`). Then the container is suspended and a second
73 rsync copies changed files. After that, the container is started (resumed)
74 again. This results in minimal downtime, but needs additional space
75 to hold the container copy.
77 When the container is on a local filesystem and the target storage of the backup
78 is an NFS server, you should set `--tmpdir` to reside on a local filesystem too,
79 as this will result in a many fold performance improvement.
80 Use of a local `tmpdir` is also required if you want to backup in `suspend`
81 mode a local container using ACLs to an NFS server.
85 This mode uses the snapshotting facilities of the underlying
86 storage. A snapshot will be made of the container volume, and the
87 snapshot content will be archived in a tar file.
93 Newer versions of vzdump encode the virtual machine type and the
94 backup time into the filename, for example
96 vzdump-lxc-105-2009_10_09-11_04_43.tar
98 That way it is possible to store several backup in the same
99 directory. The parameter `maxfiles` can be used to specify the
100 maximum number of backups to keep.
105 The resulting archive files can be restored with the following programs.
108 `pct restore`:: Container restore utility
110 `qmrestore`:: QemuServer restore utility
112 For details see the corresponding manual pages.
117 Global configuration is stored in '/etc/vzdump.conf'. The file uses a
118 simple colon separated key/value format. Each line has the following
123 Blank lines in the file are ignored, and lines starting with a '#'
124 character are treated as comments and are also ignored.
126 We currently support the following options:
128 include::vzdump.conf.5-opts.adoc[]
131 .Example 'vzdump.conf' Configuration
133 tmpdir: /mnt/fast_local_disk
134 storage: my_backup_storage
142 You can specify a hook script with option `--script`. This script is
143 called at various phases of the backup process, with parameters
144 accordingly set. You can find an example in the documentation
145 directory ('vzdump-hook-script.pl').
150 First, this option is only available for container backups. 'vzdump'
151 skips the following files with option `--stdexcludes`
158 Or you can manually specify exclude paths, for example:
160 # vzdump 777 --exclude-path /tmp/ --exclude-path '/var/foo*'
162 (only excludes tmp directories)
164 Configuration files are also stored inside the backup archive
165 (`/etc/vzdump/`), and will be correctly restored.
170 Simply dump guest 777 - no snapshot, just archive the guest private area and
171 configuration files to the default dump directory (usually
172 '/var/liv//vz/dump/').
176 Use rsync and suspend/resume to create a snapshot (minimal downtime).
178 # vzdump 777 --mode suspend
180 Backup all guest systems and send notification mails to root and admin.
182 # vzdump --all --mode suspend --mailto root --mailto admin
184 Use snapshot mode (no downtime).
186 # vzdump 777 --dumpdir /mnt/backup --mode snapshot
188 Backup more than one guest (selectively)
190 # vzdump 101 102 103 --mailto root
192 Backup all guests excluding 101 and 102
194 # vzdump --mode suspend --exclude 101,102
196 Restore a container to a new CT 600
198 # pct restore 600 /mnt/backup/vzdump-lxc-777.tar
200 Restore a QemuServer VM to VM 601
202 # qmrestore /mnt/backup/vzdump-qemu-888.vma 601
204 Clone an existing container 101 to a new container 300 with a 4GB root
205 file system, using pipes
207 # vzdump 101 --stdout | pct restore --rootfs 4 300 -
211 include::pve-copyright.adoc[]