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