vzdump.conf.5-opts.adoc

   1 `bwlimit`: `<integer> (0 - N)` ('default =' `0`)::
   2
   3 Limit I/O bandwidth (in KiB/s).
   4
   5 `compress`: `<0 | 1 | gzip | lzo | zstd>` ('default =' `0`)::
   6
   7 Compress dump file.
   8
   9 `dumpdir`: `<string>` ::
  10
  11 Store resulting files to specified directory.
  12
  13 `exclude-path`: `<array>` ::
  14
  15 Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.
  16
  17 `fleecing`: `[[enabled=]<1|0>] [,storage=<storage ID>]` ::
  18
  19 Options for backup fleecing (VM only).
  20
  21 `enabled`=`<boolean>` ('default =' `0`);;
  22
  23 Enable backup fleecing. Cache backup data from blocks where new guest writes happen on specified storage instead of copying them directly to the backup target. This can help guest IO performance and even prevent hangs, at the cost of requiring more storage space.
  24
  25 `storage`=`<storage ID>` ;;
  26
  27 Use this storage to storage fleecing images. For efficient space usage, it's best to use a local storage that supports discard and either thin provisioning or sparse files.
  28
  29 `ionice`: `<integer> (0 - 8)` ('default =' `7`)::
  30
  31 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.
  32
  33 `lockwait`: `<integer> (0 - N)` ('default =' `180`)::
  34
  35 Maximal time to wait for the global lock (minutes).
  36
  37 `mailnotification`: `<always | failure>` ('default =' `always`)::
  38
  39 Deprecated: use notification targets/matchers instead. Specify when to send a notification mail
  40
  41 `mailto`: `<string>` ::
  42
  43 Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.
  44
  45 `maxfiles`: `<integer> (1 - N)` ::
  46
  47 Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system.
  48
  49 `mode`: `<snapshot | stop | suspend>` ('default =' `snapshot`)::
  50
  51 Backup mode.
  52
  53 `notes-template`: `<string>` ::
  54
  55 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.
  56 +
  57 NOTE: Requires option(s): `storage`
  58
  59 `notification-mode`: `<auto | legacy-sendmail | notification-system>` ('default =' `auto`)::
  60
  61 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.
  62
  63 `notification-policy`: `<always | failure | never>` ('default =' `always`)::
  64
  65 Deprecated: Do not use
  66
  67 `notification-target`: `<string>` ::
  68
  69 Deprecated: Do not use
  70
  71 `performance`: `[max-workers=<integer>] [,pbs-entries-max=<integer>]` ::
  72
  73 Other performance-related settings.
  74
  75 `max-workers`=`<integer> (1 - 256)` ('default =' `16`);;
  76
  77 Applies to VMs. Allow up to this many IO workers at the same time.
  78
  79 `pbs-entries-max`=`<integer> (1 - N)` ('default =' `1048576`);;
  80
  81 Applies to container backups sent to PBS. Limits the number of entries allowed in memory at a given time to avoid unintended OOM situations. Increase it to enable backups of containers with a large amount of files.
  82
  83 `pigz`: `<integer>` ('default =' `0`)::
  84
  85 Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
  86
  87 `pool`: `<string>` ::
  88
  89 Backup all known guest systems included in the specified pool.
  90
  91 `protected`: `<boolean>` ::
  92
  93 If true, mark backup(s) as protected.
  94 +
  95 NOTE: Requires option(s): `storage`
  96
  97 `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`)::
  98
  99 Use these retention options instead of those from the storage configuration.
 100
 101 `keep-all`=`<boolean>` ;;
 102
 103 Keep all backups. Conflicts with the other options when true.
 104
 105 `keep-daily`=`<N>` ;;
 106
 107 Keep backups for the last <N> different days. If there is morethan one backup for a single day, only the latest one is kept.
 108
 109 `keep-hourly`=`<N>` ;;
 110
 111 Keep backups for the last <N> different hours. If there is morethan one backup for a single hour, only the latest one is kept.
 112
 113 `keep-last`=`<N>` ;;
 114
 115 Keep the last <N> backups.
 116
 117 `keep-monthly`=`<N>` ;;
 118
 119 Keep backups for the last <N> different months. If there is morethan one backup for a single month, only the latest one is kept.
 120
 121 `keep-weekly`=`<N>` ;;
 122
 123 Keep backups for the last <N> different weeks. If there is morethan one backup for a single week, only the latest one is kept.
 124
 125 `keep-yearly`=`<N>` ;;
 126
 127 Keep backups for the last <N> different years. If there is morethan one backup for a single year, only the latest one is kept.
 128
 129 `remove`: `<boolean>` ('default =' `1`)::
 130
 131 Prune older backups according to 'prune-backups'.
 132
 133 `script`: `<string>` ::
 134
 135 Use specified hook script.
 136
 137 `stdexcludes`: `<boolean>` ('default =' `1`)::
 138
 139 Exclude temporary files and logs.
 140
 141 `stopwait`: `<integer> (0 - N)` ('default =' `10`)::
 142
 143 Maximal time to wait until a guest system is stopped (minutes).
 144
 145 `storage`: `<storage ID>` ::
 146
 147 Store resulting file to this storage.
 148
 149 `tmpdir`: `<string>` ::
 150
 151 Store temporary files to specified directory.
 152
 153 `zstd`: `<integer>` ('default =' `1`)::
 154
 155 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.
 156