vzdump.1-synopsis.adoc

   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 `--ionice` `<integer> (0 - 8)` ('default =' `7`)::
  36
  37 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.
  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 Deprecated: use 'notification-policy' instead.
  46
  47 `--mailto` `<string>` ::
  48
  49 Comma-separated list of email addresses or users that should receive email notifications. Has no effect if the 'notification-target' option  is set at the same time.
  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. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively.
  66 +
  67 NOTE: Requires option(s): `storage`
  68
  69 `--notification-policy` `<always | failure | never>` ('default =' `always`)::
  70
  71 Specify when to send a notification
  72
  73 `--notification-target` `<string>` ::
  74
  75 Determine the target to which notifications should be sent. Can either be a notification endpoint or a notification group. This option takes precedence over 'mailto', meaning that if both are  set, the 'mailto' option will be ignored.
  76
  77 `--performance` `[max-workers=<integer>] [,pbs-entries-max=<integer>]` ::
  78
  79 Other performance-related settings.
  80
  81 `--pigz` `<integer>` ('default =' `0`)::
  82
  83 Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
  84
  85 `--pool` `<string>` ::
  86
  87 Backup all known guest systems included in the specified pool.
  88
  89 `--protected` `<boolean>` ::
  90
  91 If true, mark backup(s) as protected.
  92 +
  93 NOTE: Requires option(s): `storage`
  94
  95 `--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`)::
  96
  97 Use these retention options instead of those from the storage configuration.
  98
  99 `--quiet` `<boolean>` ('default =' `0`)::
 100
 101 Be quiet.
 102
 103 `--remove` `<boolean>` ('default =' `1`)::
 104
 105 Prune older backups according to 'prune-backups'.
 106
 107 `--script` `<string>` ::
 108
 109 Use specified hook script.
 110
 111 `--stdexcludes` `<boolean>` ('default =' `1`)::
 112
 113 Exclude temporary files and logs.
 114
 115 `--stdout` `<boolean>` ::
 116
 117 Write tar to stdout, not to a file.
 118
 119 `--stop` `<boolean>` ('default =' `0`)::
 120
 121 Stop running backup jobs on this host.
 122
 123 `--stopwait` `<integer> (0 - N)` ('default =' `10`)::
 124
 125 Maximal time to wait until a guest system is stopped (minutes).
 126
 127 `--storage` `<string>` ::
 128
 129 Store resulting file to this storage.
 130
 131 `--tmpdir` `<string>` ::
 132
 133 Store temporary files to specified directory.
 134
 135 `--zstd` `<integer>` ('default =' `1`)::
 136
 137 Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count.
 138