[pve-docs.git] / vzdump.1-synopsis.adoc

*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 | zstd>` ('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). Paths starting with '/' are anchored to the container's root,  other paths match relative to each subdirectory.

`--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 or users that should receive email notifications.

`--maxfiles` `<integer> (1 - N)` ::

Deprecated: use 'prune-backups' instead. 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.

`--notes-template` `<string>` ::

Template 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.
+
NOTE: Requires option(s): `storage`

`--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.

`--protected` `<boolean>` ::

If true, mark backup(s) as protected.
+
NOTE: Requires option(s): `storage`

`--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`)::

Use these retention options instead of those from the storage configuration.

`--quiet` `<boolean>` ('default =' `0`)::

Be quiet.

`--remove` `<boolean>` ('default =' `1`)::

Prune older backups according to 'prune-backups'.

`--script` `<string>` ::

Use specified hook script.

`--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.

`--zstd` `<integer>` ('default =' `1`)::

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