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