[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 (in KiB/s).

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

Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.

`--fleecing` `[[enabled=]<1|0>] [,storage=<storage ID>]` ::

Options for backup fleecing (VM only).

`--ionice` `<integer> (0 - 8)` ('default =' `7`)::

Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value.

`--lockwait` `<integer> (0 - N)` ('default =' `180`)::

Maximal time to wait for the global lock (minutes).

`--mailnotification` `<always | failure>` ('default =' `always`)::

Deprecated: use notification targets/matchers instead. Specify when to send a notification mail

`--mailto` `<string>` ::

Deprecated: Use notification targets/matchers instead. 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. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively.
+
NOTE: Requires option(s): `storage`

`--notification-mode` `<auto | legacy-sendmail | notification-system>` ('default =' `auto`)::

Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not.

`--notification-policy` `<always | failure | never>` ('default =' `always`)::

Deprecated: Do not use

`--notification-target` `<string>` ::

Deprecated: Do not use

`--performance` `[max-workers=<integer>] [,pbs-entries-max=<integer>]` ::

Other performance-related settings.

`--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` `<storage ID>` ::

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, if N is set to a value bigger than 0, N is used 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 (in KiB/s).
	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` `<array>` ::
	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	`--fleecing` `[[enabled=]<1\|0>] [,storage=<storage ID>]` ::
	36
	37	Options for backup fleecing (VM only).
	38
	39	`--ionice` `<integer> (0 - 8)` ('default =' `7`)::
	40
	41	Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value.
	42
	43	`--lockwait` `<integer> (0 - N)` ('default =' `180`)::
	44
	45	Maximal time to wait for the global lock (minutes).
	46
	47	`--mailnotification` `<always \| failure>` ('default =' `always`)::
	48
	49	Deprecated: use notification targets/matchers instead. Specify when to send a notification mail
	50
	51	`--mailto` `<string>` ::
	52
	53	Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.
	54
	55	`--maxfiles` `<integer> (1 - N)` ::
	56
	57	Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system.
	58
	59	`--mode` `<snapshot \| stop \| suspend>` ('default =' `snapshot`)::
	60
	61	Backup mode.
	62
	63	`--node` `<string>` ::
	64
	65	Only run if executed on this node.
	66
	67	`--notes-template` `<string>` ::
	68
	69	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. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively.
	70	+
	71	NOTE: Requires option(s): `storage`
	72
	73	`--notification-mode` `<auto \| legacy-sendmail \| notification-system>` ('default =' `auto`)::
	74
	75	Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not.
	76
	77	`--notification-policy` `<always \| failure \| never>` ('default =' `always`)::
	78
	79	Deprecated: Do not use
	80
	81	`--notification-target` `<string>` ::
	82
	83	Deprecated: Do not use
	84
	85	`--performance` `[max-workers=<integer>] [,pbs-entries-max=<integer>]` ::
	86
	87	Other performance-related settings.
	88
	89	`--pigz` `<integer>` ('default =' `0`)::
	90
	91	Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
	92
	93	`--pool` `<string>` ::
	94
	95	Backup all known guest systems included in the specified pool.
	96
	97	`--protected` `<boolean>` ::
	98
	99	If true, mark backup(s) as protected.
	100	+
	101	NOTE: Requires option(s): `storage`
	102
	103	`--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`)::
	104
	105	Use these retention options instead of those from the storage configuration.
	106
	107	`--quiet` `<boolean>` ('default =' `0`)::
	108
	109	Be quiet.
	110
	111	`--remove` `<boolean>` ('default =' `1`)::
	112
	113	Prune older backups according to 'prune-backups'.
	114
	115	`--script` `<string>` ::
	116
	117	Use specified hook script.
	118
	119	`--stdexcludes` `<boolean>` ('default =' `1`)::
	120
	121	Exclude temporary files and logs.
	122
	123	`--stdout` `<boolean>` ::
	124
	125	Write tar to stdout, not to a file.
	126
	127	`--stop` `<boolean>` ('default =' `0`)::
	128
	129	Stop running backup jobs on this host.
	130
	131	`--stopwait` `<integer> (0 - N)` ('default =' `10`)::
	132
	133	Maximal time to wait until a guest system is stopped (minutes).
	134
	135	`--storage` `<storage ID>` ::
	136
	137	Store resulting file to this storage.
	138
	139	`--tmpdir` `<string>` ::
	140
	141	Store temporary files to specified directory.
	142
	143	`--zstd` `<integer>` ('default =' `1`)::
	144
	145	Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count.
	146