5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-01-08 21:17:52 +03:00
pve-docs/vzdump.1-synopsis.adoc
Thomas Lamprecht 9226ccbcd1 run make update
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2019-07-04 16:17:53 +02:00

111 lines
2.2 KiB
Plaintext

*vzdump* `help`
*vzdump* `{<vmid>}` `[OPTIONS]`
Create backup.
`<vmid>`: `<string>` ::
The ID of the guest system you want to backup.
`--all` `<boolean>` ('default =' `0`)::
Backup all known guest systems on this host.
`--bwlimit` `<integer> (0 - N)` ('default =' `0`)::
Limit I/O bandwidth (KBytes per second).
`--compress` `<0 | 1 | gzip | lzo>` ('default =' `0`)::
Compress dump file.
`--dumpdir` `<string>` ::
Store resulting files to specified directory.
`--exclude` `<string>` ::
Exclude specified guest systems (assumes --all)
`--exclude-path` `<string>` ::
Exclude certain files/directories (shell globs).
`--ionice` `<integer> (0 - 8)` ('default =' `7`)::
Set CFQ ionice priority.
`--lockwait` `<integer> (0 - N)` ('default =' `180`)::
Maximal time to wait for the global lock (minutes).
`--mailnotification` `<always | failure>` ('default =' `always`)::
Specify when to send an email
`--mailto` `<string>` ::
Comma-separated list of email addresses that should receive email notifications.
`--maxfiles` `<integer> (1 - N)` ('default =' `1`)::
Maximal number of backup files per guest system.
`--mode` `<snapshot | stop | suspend>` ('default =' `snapshot`)::
Backup mode.
`--node` `<string>` ::
Only run if executed on this node.
`--pigz` `<integer>` ('default =' `0`)::
Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
`--pool` `<string>` ::
Backup all known guest systems included in the specified pool.
`--quiet` `<boolean>` ('default =' `0`)::
Be quiet.
`--remove` `<boolean>` ('default =' `1`)::
Remove old backup files if there are more than 'maxfiles' backup files.
`--script` `<string>` ::
Use specified hook script.
`--size` `<integer> (500 - N)` ('default =' `1024`)::
Unused, will be removed in a future release.
`--stdexcludes` `<boolean>` ('default =' `1`)::
Exclude temporary files and logs.
`--stdout` `<boolean>` ::
Write tar to stdout, not to a file.
`--stop` `<boolean>` ('default =' `0`)::
Stop running backup jobs on this host.
`--stopwait` `<integer> (0 - N)` ('default =' `10`)::
Maximal time to wait until a guest system is stopped (minutes).
`--storage` `<string>` ::
Store resulting file to this storage.
`--tmpdir` `<string>` ::
Store temporary files to specified directory.