3 *vzdump* `{<vmid>}` `[OPTIONS]`
7 `<vmid>`: `<string>` ::
9 The ID of the guest system you want to backup.
11 `--all` `<boolean>` ('default =' `0`)::
13 Backup all known guest systems on this host.
15 `--bwlimit` `<integer> (0 - N)` ('default =' `0`)::
17 Limit I/O bandwidth (KBytes per second).
19 `--compress` `<0 | 1 | gzip | lzo | zstd>` ('default =' `0`)::
23 `--dumpdir` `<string>` ::
25 Store resulting files to specified directory.
27 `--exclude` `<string>` ::
29 Exclude specified guest systems (assumes --all)
31 `--exclude-path` `<string>` ::
33 Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.
35 `--ionice` `<integer> (0 - 8)` ('default =' `7`)::
37 Set CFQ ionice priority.
39 `--lockwait` `<integer> (0 - N)` ('default =' `180`)::
41 Maximal time to wait for the global lock (minutes).
43 `--mailnotification` `<always | failure>` ('default =' `always`)::
45 Specify when to send an email
47 `--mailto` `<string>` ::
49 Comma-separated list of email addresses or users that should receive email notifications.
51 `--maxfiles` `<integer> (1 - N)` ::
53 Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system.
55 `--mode` `<snapshot | stop | suspend>` ('default =' `snapshot`)::
59 `--node` `<string>` ::
61 Only run if executed on this node.
63 `--pigz` `<integer>` ('default =' `0`)::
65 Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
67 `--pool` `<string>` ::
69 Backup all known guest systems included in the specified pool.
71 `--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`)::
73 Use these retention options instead of those from the storage configuration.
75 `--quiet` `<boolean>` ('default =' `0`)::
79 `--remove` `<boolean>` ('default =' `1`)::
81 Prune older backups according to 'prune-backups'.
83 `--script` `<string>` ::
85 Use specified hook script.
87 `--stdexcludes` `<boolean>` ('default =' `1`)::
89 Exclude temporary files and logs.
91 `--stdout` `<boolean>` ::
93 Write tar to stdout, not to a file.
95 `--stop` `<boolean>` ('default =' `0`)::
97 Stop running backup jobs on this host.
99 `--stopwait` `<integer> (0 - N)` ('default =' `10`)::
101 Maximal time to wait until a guest system is stopped (minutes).
103 `--storage` `<string>` ::
105 Store resulting file to this storage.
107 `--tmpdir` `<string>` ::
109 Store temporary files to specified directory.
111 `--zstd` `<integer>` ('default =' `1`)::
113 Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count.