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