4 include::attributes.txt[]
11 vzdump - Backup Utility for VMs and Containers
17 include::vzdump.1-synopsis.adoc[]
27 include::attributes.txt[]
34 Backups are a requirements for any sensible IT deployment, and {pve}
35 provides a fully integrated solution, using the capabilities of each
36 storage and each guest system type. This allows the system
37 administrator to fine tune via the `mode` option between consistency
38 of the backups and downtime of the guest system.
40 {pve} backups are always full backups - containing the VM/CT
41 configuration and all data. Backups can be started via the GUI or via
42 the `vzdump` command line tool.
46 Before a backup can run, a backup storage must be defined. Refer to
47 the Storage documentation on how to add a storage. A backup storage
48 must be a file level storage, as backups are stored as regular files.
49 In most situations, using a NFS server is a good way to store backups.
50 You can save those backups later to a tape drive, for off-site
55 Backup jobs can be scheduled so that they are executed automatically
56 on specific days and times, for selectable nodes and guest systems.
57 Configuration of scheduled backups is done at the Datacenter level in
58 the GUI, which will generate a cron entry in /etc/cron.d/vzdump.
63 There are several ways to provide consistency (option `mode`),
64 depending on the guest type.
66 .Backup modes for VMs:
70 This mode provides the highest consistency of the backup, at the cost
71 of a downtime in the VM operation. It works by executing an orderly
72 shutdown of the VM, and then runs a background Qemu process to backup
73 the VM data. After the backup is complete, the Qemu process resumes
74 the VM to full operation mode if it was previously running.
78 This mode is provided for compatibility reason, and suspends the VM
79 before calling the `snapshot` mode. Since suspending the VM results in
80 a longer downtime and does not necessarily improve the data
81 consistency, the use of the `snapshot` mode is recommended instead.
85 This mode provides the lowest operation downtime, at the cost of a
86 small inconstancy risk. It works by performing a Proxmox VE live
87 backup, in which data blocks are copied while the VM is running. If the
88 guest agent is enabled (`agent: 1`) and running, it calls
89 `guest-fsfreeze-freeze` and `guest-fsfreeze-thaw` to improve
92 A technical overview of the Proxmox VE live backup for QemuServer can
94 https://git.proxmox.com/?p=pve-qemu-kvm.git;a=blob;f=backup.txt[here].
96 NOTE: Proxmox VE live backup provides snapshot-like semantics on any
97 storage type. It does not require that the underlying storage supports
100 .Backup modes for Containers:
104 Stop the container for the duration of the backup. This potentially
105 results in a very long downtime.
109 This mode uses rsync to copy the container data to a temporary
110 location (see option `--tmpdir`). Then the container is suspended and
111 a second rsync copies changed files. After that, the container is
112 started (resumed) again. This results in minimal downtime, but needs
113 additional space to hold the container copy.
115 When the container is on a local file system and the target storage of
116 the backup is an NFS server, you should set `--tmpdir` to reside on a
117 local file system too, as this will result in a many fold performance
118 improvement. Use of a local `tmpdir` is also required if you want to
119 backup a local container using ACLs in suspend mode if the backup
120 storage is an NFS server.
124 This mode uses the snapshotting facilities of the underlying
125 storage. First, the container will be suspended to ensure data consistency.
126 A temporary snapshot of the container's volumes will be made and the
127 snapshot content will be archived in a tar file. Finally, the temporary
128 snapshot is deleted again.
130 NOTE: `snapshot` mode requires that all backed up volumes are on a storage that
131 supports snapshots. Using the `backup=no` mount point option individual volumes
132 can be excluded from the backup (and thus this requirement).
134 NOTE: bind and device mount points are skipped during backup operations, like
135 volume mount points with the backup option disabled.
141 Newer versions of vzdump encode the guest type and the
142 backup time into the filename, for example
144 vzdump-lxc-105-2009_10_09-11_04_43.tar
146 That way it is possible to store several backup in the same
147 directory. The parameter `maxfiles` can be used to specify the
148 maximum number of backups to keep.
153 The resulting archive files can be restored with the following programs.
156 `pct restore`:: Container restore utility
158 `qmrestore`:: QemuServer restore utility
160 For details see the corresponding manual pages.
165 Global configuration is stored in `/etc/vzdump.conf`. The file uses a
166 simple colon separated key/value format. Each line has the following
171 Blank lines in the file are ignored, and lines starting with a `#`
172 character are treated as comments and are also ignored. Values from
173 this file are used as default, and can be overwritten on the command
176 We currently support the following options:
178 include::vzdump.conf.5-opts.adoc[]
181 .Example `vzdump.conf` Configuration
183 tmpdir: /mnt/fast_local_disk
184 storage: my_backup_storage
192 You can specify a hook script with option `--script`. This script is
193 called at various phases of the backup process, with parameters
194 accordingly set. You can find an example in the documentation
195 directory (`vzdump-hook-script.pl`).
200 NOTE: this option is only available for container backups.
202 `vzdump` skips the following files by default (disable with the option
209 You can also manually specify (additional) exclude paths, for example:
211 # vzdump 777 --exclude-path /tmp/ --exclude-path '/var/foo*'
213 (only excludes tmp directories)
215 Configuration files are also stored inside the backup archive
216 (in `./etc/vzdump/`) and will be correctly restored.
221 Simply dump guest 777 - no snapshot, just archive the guest private area and
222 configuration files to the default dump directory (usually
223 `/var/lib/vz/dump/`).
227 Use rsync and suspend/resume to create a snapshot (minimal downtime).
229 # vzdump 777 --mode suspend
231 Backup all guest systems and send notification mails to root and admin.
233 # vzdump --all --mode suspend --mailto root --mailto admin
235 Use snapshot mode (no downtime) and non-default dump directory.
237 # vzdump 777 --dumpdir /mnt/backup --mode snapshot
239 Backup more than one guest (selectively)
241 # vzdump 101 102 103 --mailto root
243 Backup all guests excluding 101 and 102
245 # vzdump --mode suspend --exclude 101,102
247 Restore a container to a new CT 600
249 # pct restore 600 /mnt/backup/vzdump-lxc-777.tar
251 Restore a QemuServer VM to VM 601
253 # qmrestore /mnt/backup/vzdump-qemu-888.vma 601
255 Clone an existing container 101 to a new container 300 with a 4GB root
256 file system, using pipes
258 # vzdump 101 --stdout | pct restore --rootfs 4 300 -
262 include::pve-copyright.adoc[]