]>
Commit | Line | Data |
---|---|---|
82b4917a | 1 | ifdef::manvolnum[] |
7e2fdb3d DM |
2 | PVE(1) |
3 | ====== | |
38fd0958 | 4 | include::attributes.txt[] |
5f09af76 DM |
5 | :pve-toplevel: |
6 | ||
82b4917a DM |
7 | NAME |
8 | ---- | |
9 | ||
10 | vzdump - Backup Utility for VMs and Containers | |
11 | ||
12 | ||
49a5e11c | 13 | SYNOPSIS |
82b4917a DM |
14 | -------- |
15 | ||
16 | include::vzdump.1-synopsis.adoc[] | |
17 | ||
18 | ||
19 | DESCRIPTION | |
20 | ----------- | |
21 | endif::manvolnum[] | |
22 | ||
23 | ifndef::manvolnum[] | |
24 | Backup and Restore | |
25 | ================== | |
38fd0958 | 26 | include::attributes.txt[] |
82b4917a DM |
27 | endif::manvolnum[] |
28 | ||
5f09af76 DM |
29 | ifdef::wiki[] |
30 | :pve-toplevel: | |
31 | endif::wiki[] | |
32 | ||
12b04941 | 33 | Backups are a requirements for any sensible IT deployment, and {pve} |
94e50bf6 DM |
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. | |
38 | ||
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. | |
12b04941 | 42 | |
c7678c11 EK |
43 | .Backup Storage |
44 | ||
94e50bf6 DM |
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 | |
12b04941 EK |
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. | |
94e50bf6 DM |
49 | You can save those backups later to a tape drive, for off-site |
50 | archiving. | |
12b04941 | 51 | |
c7678c11 EK |
52 | .Scheduled Backup |
53 | ||
94e50bf6 DM |
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. | |
12b04941 | 58 | |
c7678c11 EK |
59 | Backup modes |
60 | ------------ | |
94e50bf6 | 61 | |
12b04941 EK |
62 | There are several ways to provide consistency (option `mode`), |
63 | depending on the guest type. | |
82b4917a | 64 | |
c7678c11 | 65 | .Backup modes for VMs: |
01d37422 DM |
66 | |
67 | `stop` mode:: | |
94e50bf6 DM |
68 | |
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. | |
01d37422 DM |
74 | |
75 | `suspend` mode:: | |
76 | ||
94e50bf6 DM |
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. | |
01d37422 DM |
81 | |
82 | `snapshot` mode:: | |
83 | ||
94e50bf6 DM |
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 | |
8c1189b6 | 88 | `guest-fsfreeze-freeze` and `guest-fsfreeze-thaw` to improve |
c7678c11 | 89 | consistency. |
01d37422 DM |
90 | |
91 | A technical overview of the Proxmox VE live backup for QemuServer can | |
92 | be found online | |
fccf8df6 | 93 | https://git.proxmox.com/?p=pve-qemu-kvm.git;a=blob;f=backup.txt[here]. |
01d37422 | 94 | |
94e50bf6 DM |
95 | NOTE: Proxmox VE live backup provides snapshot-like semantics on any |
96 | storage type. It does not require that the underlying storage supports | |
97 | snapshots. | |
01d37422 | 98 | |
c7678c11 | 99 | .Backup modes for Containers: |
82b4917a DM |
100 | |
101 | `stop` mode:: | |
102 | ||
94e50bf6 DM |
103 | Stop the container for the duration of the backup. This potentially |
104 | results in a very long downtime. | |
82b4917a DM |
105 | |
106 | `suspend` mode:: | |
107 | ||
01d37422 | 108 | This mode uses rsync to copy the container data to a temporary |
94e50bf6 DM |
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. | |
0006064d | 113 | + |
5eba0743 | 114 | When the container is on a local file system and the target storage of |
94e50bf6 | 115 | the backup is an NFS server, you should set `--tmpdir` to reside on a |
5eba0743 | 116 | local file system too, as this will result in a many fold performance |
94e50bf6 DM |
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. | |
82b4917a DM |
120 | |
121 | `snapshot` mode:: | |
122 | ||
01d37422 | 123 | This mode uses the snapshotting facilities of the underlying |
b74af7b6 FG |
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. | |
128 | ||
129 | NOTE: `snapshot` mode requires that all backed up volumes are on a storage that | |
8c1189b6 | 130 | supports snapshots. Using the `backup=no` mount point option individual volumes |
b74af7b6 | 131 | can be excluded from the backup (and thus this requirement). |
82b4917a | 132 | |
5eba0743 FG |
133 | NOTE: bind and device mount points are skipped during backup operations, like |
134 | volume mount points with the backup option disabled. | |
21c12755 | 135 | |
82b4917a DM |
136 | |
137 | Backup File Names | |
138 | ----------------- | |
139 | ||
8e4bb261 | 140 | Newer versions of vzdump encode the guest type and the |
82b4917a DM |
141 | backup time into the filename, for example |
142 | ||
143 | vzdump-lxc-105-2009_10_09-11_04_43.tar | |
144 | ||
871e1fd6 | 145 | That way it is possible to store several backup in the same |
82b4917a | 146 | directory. The parameter `maxfiles` can be used to specify the |
871e1fd6 | 147 | maximum number of backups to keep. |
82b4917a DM |
148 | |
149 | Restore | |
150 | ------- | |
151 | ||
152 | The resulting archive files can be restored with the following programs. | |
153 | ||
154 | ||
871e1fd6 | 155 | `pct restore`:: Container restore utility |
82b4917a DM |
156 | |
157 | `qmrestore`:: QemuServer restore utility | |
158 | ||
159 | For details see the corresponding manual pages. | |
160 | ||
161 | Configuration | |
162 | ------------- | |
163 | ||
8c1189b6 | 164 | Global configuration is stored in `/etc/vzdump.conf`. The file uses a |
d083d3d3 DM |
165 | simple colon separated key/value format. Each line has the following |
166 | format: | |
167 | ||
168 | OPTION: value | |
169 | ||
8c1189b6 | 170 | Blank lines in the file are ignored, and lines starting with a `#` |
956afd0a DM |
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 | |
173 | line. | |
d083d3d3 DM |
174 | |
175 | We currently support the following options: | |
176 | ||
177 | include::vzdump.conf.5-opts.adoc[] | |
178 | ||
179 | ||
8c1189b6 | 180 | .Example `vzdump.conf` Configuration |
d083d3d3 DM |
181 | ---- |
182 | tmpdir: /mnt/fast_local_disk | |
183 | storage: my_backup_storage | |
184 | mode: snapshot | |
185 | bwlimit: 10000 | |
186 | ---- | |
82b4917a DM |
187 | |
188 | Hook Scripts | |
189 | ------------ | |
190 | ||
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 | |
8c1189b6 | 194 | directory (`vzdump-hook-script.pl`). |
82b4917a DM |
195 | |
196 | File Exclusions | |
197 | --------------- | |
198 | ||
8e4bb261 FG |
199 | NOTE: this option is only available for container backups. |
200 | ||
8c1189b6 | 201 | `vzdump` skips the following files by default (disable with the option |
8e4bb261 | 202 | `--stdexcludes 0`) |
82b4917a | 203 | |
bf01f882 WB |
204 | /tmp/?* |
205 | /var/tmp/?* | |
206 | /var/run/?*pid | |
82b4917a | 207 | |
8e4bb261 | 208 | You can also manually specify (additional) exclude paths, for example: |
82b4917a | 209 | |
bf01f882 | 210 | # vzdump 777 --exclude-path /tmp/ --exclude-path '/var/foo*' |
82b4917a DM |
211 | |
212 | (only excludes tmp directories) | |
213 | ||
214 | Configuration files are also stored inside the backup archive | |
65647b07 | 215 | (in `./etc/vzdump/`) and will be correctly restored. |
82b4917a DM |
216 | |
217 | Examples | |
218 | -------- | |
219 | ||
c31f32a9 | 220 | Simply dump guest 777 - no snapshot, just archive the guest private area and |
82b4917a | 221 | configuration files to the default dump directory (usually |
8c1189b6 | 222 | `/var/lib/vz/dump/`). |
82b4917a DM |
223 | |
224 | # vzdump 777 | |
225 | ||
871e1fd6 | 226 | Use rsync and suspend/resume to create a snapshot (minimal downtime). |
82b4917a DM |
227 | |
228 | # vzdump 777 --mode suspend | |
229 | ||
c31f32a9 | 230 | Backup all guest systems and send notification mails to root and admin. |
82b4917a DM |
231 | |
232 | # vzdump --all --mode suspend --mailto root --mailto admin | |
233 | ||
b74af7b6 | 234 | Use snapshot mode (no downtime) and non-default dump directory. |
82b4917a DM |
235 | |
236 | # vzdump 777 --dumpdir /mnt/backup --mode snapshot | |
237 | ||
c31f32a9 | 238 | Backup more than one guest (selectively) |
82b4917a DM |
239 | |
240 | # vzdump 101 102 103 --mailto root | |
241 | ||
c31f32a9 | 242 | Backup all guests excluding 101 and 102 |
82b4917a DM |
243 | |
244 | # vzdump --mode suspend --exclude 101,102 | |
245 | ||
c31f32a9 | 246 | Restore a container to a new CT 600 |
82b4917a DM |
247 | |
248 | # pct restore 600 /mnt/backup/vzdump-lxc-777.tar | |
249 | ||
c31f32a9 | 250 | Restore a QemuServer VM to VM 601 |
82b4917a DM |
251 | |
252 | # qmrestore /mnt/backup/vzdump-qemu-888.vma 601 | |
253 | ||
254 | Clone an existing container 101 to a new container 300 with a 4GB root | |
255 | file system, using pipes | |
256 | ||
257 | # vzdump 101 --stdout | pct restore --rootfs 4 300 - | |
258 | ||
259 | ||
260 | ifdef::manvolnum[] | |
261 | include::pve-copyright.adoc[] | |
262 | endif::manvolnum[] | |
263 |