X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=vzdump.1-synopsis.adoc;h=39600b27b5e194af2cf3fc339ce5eb81caca8dcb;hp=09147c3b508692b410840a94a851ba482cc68904;hb=2f0886ca0c0af2dd1ff629e603009e1efd4b20c2;hpb=1f554f760e12ff7da82dd3d425d9533a71ca979f diff --git a/vzdump.1-synopsis.adoc b/vzdump.1-synopsis.adoc index 09147c3..39600b2 100644 --- a/vzdump.1-synopsis.adoc +++ b/vzdump.1-synopsis.adoc @@ -4,104 +4,103 @@ Create backup. -`` `string` :: +``: `` :: -The ID of the VM you want to backup. +The ID of the guest system you want to backup. -`-all` `boolean` (default=`0`):: +`-all` `` ('default =' `0`):: -Backup all known VMs on this host. +Backup all known guest systems on this host. -`-bwlimit` `integer (0 - N)` :: +`-bwlimit` ` (0 - N)` ('default =' `0`):: Limit I/O bandwidth (KBytes per second). -`-compress` `(0 | 1 | gzip | lzo)` (default=`lzo`):: +`-compress` `<0 | 1 | gzip | lzo>` ('default =' `0`):: Compress dump file. -`-dumpdir` `string` :: +`-dumpdir` `` :: Store resulting files to specified directory. -`-exclude` `string` :: +`-exclude` `` :: -exclude specified VMs (assumes --all) +Exclude specified guest systems (assumes --all) -`-exclude-path` `string` :: +`-exclude-path` `` :: -exclude certain files/directories (shell globs). +Exclude certain files/directories (shell globs). -`-ionice` `integer (0 - 8)` :: +`-ionice` ` (0 - 8)` ('default =' `7`):: Set CFQ ionice priority. -`-lockwait` `integer (0 - N)` :: +`-lockwait` ` (0 - N)` ('default =' `180`):: Maximal time to wait for the global lock (minutes). -`-mailnotification` `(always | failure)` (default=`always`):: +`-mailnotification` `` ('default =' `always`):: Specify when to send an email -`-mailto` `string` :: +`-mailto` `` :: -no description available +Comma-separated list of email addresses that should receive email notifications. -`-maxfiles` `integer (1 - N)` :: +`-maxfiles` ` (1 - N)` ('default =' `1`):: -Maximal number of backup files per VM. +Maximal number of backup files per guest system. -`-mode` `(snapshot | stop | suspend)` (default=`stop`):: +`-mode` `` ('default =' `snapshot`):: Backup mode. -`-node` `string` :: +`-node` `` :: Only run if executed on this node. -`-pigz` `integer` (default=`0`):: +`-pigz` `` ('default =' `0`):: -Uses pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as -thread count. +Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. -`-quiet` `boolean` (default=`0`):: +`-quiet` `` ('default =' `0`):: Be quiet. -`-remove` `boolean` (default=`1`):: +`-remove` `` ('default =' `1`):: Remove old backup files if there are more than 'maxfiles' backup files. -`-script` `string` :: +`-script` `` :: Use specified hook script. -`-size` `integer (500 - N)` :: +`-size` ` (500 - N)` ('default =' `1024`):: -LVM snapshot size in MB. +Unused, will be removed in a future release. -`-stdexcludes` `boolean` (default=`1`):: +`-stdexcludes` `` ('default =' `1`):: -Exclude temorary files and logs. +Exclude temporary files and logs. -`-stdout` `boolean` :: +`-stdout` `` :: Write tar to stdout, not to a file. -`-stop` `boolean` (default=`0`):: +`-stop` `` ('default =' `0`):: Stop runnig backup jobs on this host. -`-stopwait` `integer (0 - N)` :: +`-stopwait` ` (0 - N)` ('default =' `10`):: -Maximal time to wait until a VM is stopped (minutes). +Maximal time to wait until a guest system is stopped (minutes). -`-storage` `string` :: +`-storage` `` :: Store resulting file to this storage. -`-tmpdir` `string` :: +`-tmpdir` `` :: Store temporary files to specified directory.