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 (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).
  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 that should receive email notifications.
  50
  51 `--maxfiles` `<integer> (1 - N)` ('default =' `1`)::
  52
  53 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 `--pigz` `<integer>` ('default =' `0`)::
  64
  65 Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
  66
  67 `--pool` `<string>` ::
  68
  69 Backup all known guest systems included in the specified pool.
  70
  71 `--prune-backups` `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
  72
  73 Use these retention options instead of those from the storage configuration.
  74
  75 `--quiet` `<boolean>` ('default =' `0`)::
  76
  77 Be quiet.
  78
  79 `--remove` `<boolean>` ('default =' `1`)::
  80
  81 Remove old backup files if there are more than 'maxfiles' backup files.
  82
  83 `--script` `<string>` ::
  84
  85 Use specified hook script.
  86
  87 `--size` `<integer> (500 - N)` ('default =' `1024`)::
  88
  89 Unused, will be removed in a future release.
  90
  91 `--stdexcludes` `<boolean>` ('default =' `1`)::
  92
  93 Exclude temporary files and logs.
  94
  95 `--stdout` `<boolean>` ::
  96
  97 Write tar to stdout, not to a file.
  98
  99 `--stop` `<boolean>` ('default =' `0`)::
 100
 101 Stop running backup jobs on this host.
 102
 103 `--stopwait` `<integer> (0 - N)` ('default =' `10`)::
 104
 105 Maximal time to wait until a guest system is stopped (minutes).
 106
 107 `--storage` `<string>` ::
 108
 109 Store resulting file to this storage.
 110
 111 `--tmpdir` `<string>` ::
 112
 113 Store temporary files to specified directory.
 114
 115 `--zstd` `<integer>` ('default =' `1`)::
 116
 117 Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count.
 118