]>
Commit | Line | Data |
---|---|---|
1 | *vzdump* `help` | |
2 | ||
3 | *vzdump* `{<vmid>}` `[OPTIONS]` | |
4 | ||
5 | Create backup. | |
6 | ||
7 | `<vmid>`: `<string>` :: | |
8 | ||
9 | The ID of the guest system you want to backup. | |
10 | ||
11 | `--all` `<boolean>` ('default =' `0`):: | |
12 | ||
13 | Backup all known guest systems on this host. | |
14 | ||
15 | `--bwlimit` `<integer> (0 - N)` ('default =' `0`):: | |
16 | ||
17 | Limit I/O bandwidth (KBytes per second). | |
18 | ||
19 | `--compress` `<0 | 1 | gzip | lzo | zstd>` ('default =' `0`):: | |
20 | ||
21 | Compress dump file. | |
22 | ||
23 | `--dumpdir` `<string>` :: | |
24 | ||
25 | Store resulting files to specified directory. | |
26 | ||
27 | `--exclude` `<string>` :: | |
28 | ||
29 | Exclude specified guest systems (assumes --all) | |
30 | ||
31 | `--exclude-path` `<string>` :: | |
32 | ||
33 | Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. | |
34 | ||
35 | `--ionice` `<integer> (0 - 8)` ('default =' `7`):: | |
36 | ||
37 | Set CFQ ionice priority. | |
38 | ||
39 | `--lockwait` `<integer> (0 - N)` ('default =' `180`):: | |
40 | ||
41 | Maximal time to wait for the global lock (minutes). | |
42 | ||
43 | `--mailnotification` `<always | failure>` ('default =' `always`):: | |
44 | ||
45 | Specify when to send an email | |
46 | ||
47 | `--mailto` `<string>` :: | |
48 | ||
49 | Comma-separated list of email addresses or users that should receive email notifications. | |
50 | ||
51 | `--maxfiles` `<integer> (1 - N)` :: | |
52 | ||
53 | Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system. | |
54 | ||
55 | `--mode` `<snapshot | stop | suspend>` ('default =' `snapshot`):: | |
56 | ||
57 | Backup mode. | |
58 | ||
59 | `--node` `<string>` :: | |
60 | ||
61 | Only run if executed on this node. | |
62 | ||
63 | `--notes-template` `<string>` :: | |
64 | ||
65 | Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are \{\{cluster\}\}, \{\{guestname\}\}, \{\{node\}\}, and \{\{vmid\}\}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. | |
66 | + | |
67 | NOTE: Requires option(s): `storage` | |
68 | ||
69 | `--performance` `[max-workers=<integer>]` :: | |
70 | ||
71 | Other performance-related settings. | |
72 | ||
73 | `--pigz` `<integer>` ('default =' `0`):: | |
74 | ||
75 | Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. | |
76 | ||
77 | `--pool` `<string>` :: | |
78 | ||
79 | Backup all known guest systems included in the specified pool. | |
80 | ||
81 | `--protected` `<boolean>` :: | |
82 | ||
83 | If true, mark backup(s) as protected. | |
84 | + | |
85 | NOTE: Requires option(s): `storage` | |
86 | ||
87 | `--prune-backups` `[keep-all=<1|0>] [,keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ('default =' `keep-all=1`):: | |
88 | ||
89 | Use these retention options instead of those from the storage configuration. | |
90 | ||
91 | `--quiet` `<boolean>` ('default =' `0`):: | |
92 | ||
93 | Be quiet. | |
94 | ||
95 | `--remove` `<boolean>` ('default =' `1`):: | |
96 | ||
97 | Prune older backups according to 'prune-backups'. | |
98 | ||
99 | `--script` `<string>` :: | |
100 | ||
101 | Use specified hook script. | |
102 | ||
103 | `--stdexcludes` `<boolean>` ('default =' `1`):: | |
104 | ||
105 | Exclude temporary files and logs. | |
106 | ||
107 | `--stdout` `<boolean>` :: | |
108 | ||
109 | Write tar to stdout, not to a file. | |
110 | ||
111 | `--stop` `<boolean>` ('default =' `0`):: | |
112 | ||
113 | Stop running backup jobs on this host. | |
114 | ||
115 | `--stopwait` `<integer> (0 - N)` ('default =' `10`):: | |
116 | ||
117 | Maximal time to wait until a guest system is stopped (minutes). | |
118 | ||
119 | `--storage` `<string>` :: | |
120 | ||
121 | Store resulting file to this storage. | |
122 | ||
123 | `--tmpdir` `<string>` :: | |
124 | ||
125 | Store temporary files to specified directory. | |
126 | ||
127 | `--zstd` `<integer>` ('default =' `1`):: | |
128 | ||
129 | Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count. | |
130 |