cluster: restructure ssh role section

[pve-docs.git] / vzdump.conf.5-opts.adoc

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

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

`prune-backups`: `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::

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

`keep-daily`=`<N>` ;;

Keep backups for the last <N> different days. If there is morethan one backup for a single day, only the latest one is kept.

`keep-hourly`=`<N>` ;;

Keep backups for the last <N> different hours. If there is morethan one backup for a single hour, only the latest one is kept.

`keep-last`=`<N>` ;;

Keep the last <N> backups.

`keep-monthly`=`<N>` ;;

Keep backups for the last <N> different months. If there is morethan one backup for a single month, only the latest one is kept.

`keep-weekly`=`<N>` ;;

Keep backups for the last <N> different weeks. If there is morethan one backup for a single week, only the latest one is kept.

`keep-yearly`=`<N>` ;;

Keep backups for the last <N> different years. If there is morethan one backup for a single year, only the latest one is kept.

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

Remove old backup files if there are more than 'maxfiles' backup files.

`script`: `<string>` ::

Use specified hook script.

`stdexcludes`: `<boolean>` ('default =' `1`)::

Exclude temporary files and logs.

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