]>
Commit | Line | Data |
---|---|---|
1f554f76 DM |
1 | *vzdump* `help` |
2 | ||
3 | *vzdump* `{<vmid>}` `[OPTIONS]` | |
4 | ||
5 | Create backup. | |
6 | ||
013dc89f | 7 | `<vmid>`: `<string>` :: |
1f554f76 | 8 | |
04ce4dfa | 9 | The ID of the guest system you want to backup. |
1f554f76 | 10 | |
2489d6df | 11 | `--all` `<boolean>` ('default =' `0`):: |
1f554f76 | 12 | |
04ce4dfa | 13 | Backup all known guest systems on this host. |
1f554f76 | 14 | |
2489d6df | 15 | `--bwlimit` `<integer> (0 - N)` ('default =' `0`):: |
1f554f76 DM |
16 | |
17 | Limit I/O bandwidth (KBytes per second). | |
18 | ||
c5aa7e14 | 19 | `--compress` `<0 | 1 | gzip | lzo | zstd>` ('default =' `0`):: |
1f554f76 DM |
20 | |
21 | Compress dump file. | |
22 | ||
2489d6df | 23 | `--dumpdir` `<string>` :: |
1f554f76 DM |
24 | |
25 | Store resulting files to specified directory. | |
26 | ||
2489d6df | 27 | `--exclude` `<string>` :: |
1f554f76 | 28 | |
04ce4dfa | 29 | Exclude specified guest systems (assumes --all) |
1f554f76 | 30 | |
2489d6df | 31 | `--exclude-path` `<string>` :: |
1f554f76 | 32 | |
04ce4dfa | 33 | Exclude certain files/directories (shell globs). |
1f554f76 | 34 | |
2489d6df | 35 | `--ionice` `<integer> (0 - 8)` ('default =' `7`):: |
1f554f76 DM |
36 | |
37 | Set CFQ ionice priority. | |
38 | ||
2489d6df | 39 | `--lockwait` `<integer> (0 - N)` ('default =' `180`):: |
1f554f76 DM |
40 | |
41 | Maximal time to wait for the global lock (minutes). | |
42 | ||
2489d6df | 43 | `--mailnotification` `<always | failure>` ('default =' `always`):: |
1f554f76 DM |
44 | |
45 | Specify when to send an email | |
46 | ||
2489d6df | 47 | `--mailto` `<string>` :: |
1f554f76 | 48 | |
c2993fe5 | 49 | Comma-separated list of email addresses that should receive email notifications. |
1f554f76 | 50 | |
2489d6df | 51 | `--maxfiles` `<integer> (1 - N)` ('default =' `1`):: |
1f554f76 | 52 | |
04ce4dfa | 53 | Maximal number of backup files per guest system. |
1f554f76 | 54 | |
2489d6df | 55 | `--mode` `<snapshot | stop | suspend>` ('default =' `snapshot`):: |
1f554f76 DM |
56 | |
57 | Backup mode. | |
58 | ||
2489d6df | 59 | `--node` `<string>` :: |
1f554f76 DM |
60 | |
61 | Only run if executed on this node. | |
62 | ||
2489d6df | 63 | `--pigz` `<integer>` ('default =' `0`):: |
1f554f76 | 64 | |
c2993fe5 | 65 | Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. |
1f554f76 | 66 | |
9226ccbc TL |
67 | `--pool` `<string>` :: |
68 | ||
69 | Backup all known guest systems included in the specified pool. | |
70 | ||
2489d6df | 71 | `--quiet` `<boolean>` ('default =' `0`):: |
1f554f76 DM |
72 | |
73 | Be quiet. | |
74 | ||
2489d6df | 75 | `--remove` `<boolean>` ('default =' `1`):: |
1f554f76 DM |
76 | |
77 | Remove old backup files if there are more than 'maxfiles' backup files. | |
78 | ||
2489d6df | 79 | `--script` `<string>` :: |
1f554f76 DM |
80 | |
81 | Use specified hook script. | |
82 | ||
2489d6df | 83 | `--size` `<integer> (500 - N)` ('default =' `1024`):: |
1f554f76 | 84 | |
04ce4dfa | 85 | Unused, will be removed in a future release. |
1f554f76 | 86 | |
2489d6df | 87 | `--stdexcludes` `<boolean>` ('default =' `1`):: |
1f554f76 | 88 | |
04ce4dfa | 89 | Exclude temporary files and logs. |
1f554f76 | 90 | |
2489d6df | 91 | `--stdout` `<boolean>` :: |
1f554f76 DM |
92 | |
93 | Write tar to stdout, not to a file. | |
94 | ||
2489d6df | 95 | `--stop` `<boolean>` ('default =' `0`):: |
1f554f76 | 96 | |
1e3f8156 | 97 | Stop running backup jobs on this host. |
1f554f76 | 98 | |
2489d6df | 99 | `--stopwait` `<integer> (0 - N)` ('default =' `10`):: |
1f554f76 | 100 | |
04ce4dfa | 101 | Maximal time to wait until a guest system is stopped (minutes). |
1f554f76 | 102 | |
2489d6df | 103 | `--storage` `<string>` :: |
1f554f76 DM |
104 | |
105 | Store resulting file to this storage. | |
106 | ||
2489d6df | 107 | `--tmpdir` `<string>` :: |
1f554f76 DM |
108 | |
109 | Store temporary files to specified directory. | |
110 | ||
c5aa7e14 TL |
111 | `--zstd` `<integer>` ('default =' `1`):: |
112 | ||
113 | Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count. | |
114 |