projects / pve-docs.git / blame
| Commit | Line | Data |
|---|---|---|
| 1f554f76 DM |
1 | *vzdump* `help` |
| 2 | ||
| 3 | *vzdump* `{<vmid>}` `[OPTIONS]` | |
| 4 | ||
| 5 | Create backup. | |
| 6 | ||
| 7 | `<vmid>` `string` :: | |
| 8 | ||
| 9 | The ID of the VM you want to backup. | |
| 10 | ||
| 11 | `-all` `boolean` (default=`0`):: | |
| 12 | ||
| 13 | Backup all known VMs on this host. | |
| 14 | ||
| 15 | `-bwlimit` `integer (0 - N)` :: | |
| 16 | ||
| 17 | Limit I/O bandwidth (KBytes per second). | |
| 18 | ||
| 19 | `-compress` `(0 | 1 | gzip | lzo)` (default=`lzo`):: | |
| 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 VMs (assumes --all) | |
| 30 | ||
| 31 | `-exclude-path` `string` :: | |
| 32 | ||
| 33 | exclude certain files/directories (shell globs). | |
| 34 | ||
| 35 | `-ionice` `integer (0 - 8)` :: | |
| 36 | ||
| 37 | Set CFQ ionice priority. | |
| 38 | ||
| 39 | `-lockwait` `integer (0 - N)` :: | |
| 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 | no description available | |
| 50 | ||
| 51 | `-maxfiles` `integer (1 - N)` :: | |
| 52 | ||
| 53 | Maximal number of backup files per VM. | |
| 54 | ||
| 55 | `-mode` `(snapshot | stop | suspend)` (default=`stop`):: | |
| 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 | Uses pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as | |
| 66 | thread count. | |
| 67 | ||
| 68 | `-quiet` `boolean` (default=`0`):: | |
| 69 | ||
| 70 | Be quiet. | |
| 71 | ||
| 72 | `-remove` `boolean` (default=`1`):: | |
| 73 | ||
| 74 | Remove old backup files if there are more than 'maxfiles' backup files. | |
| 75 | ||
| 76 | `-script` `string` :: | |
| 77 | ||
| 78 | Use specified hook script. | |
| 79 | ||
| 80 | `-size` `integer (500 - N)` :: | |
| 81 | ||
| 82 | LVM snapshot size in MB. | |
| 83 | ||
| 84 | `-stdexcludes` `boolean` (default=`1`):: | |
| 85 | ||
| 86 | Exclude temorary files and logs. | |
| 87 | ||
| 88 | `-stdout` `boolean` :: | |
| 89 | ||
| 90 | Write tar to stdout, not to a file. | |
| 91 | ||
| 92 | `-stop` `boolean` (default=`0`):: | |
| 93 | ||
| 94 | Stop runnig backup jobs on this host. | |
| 95 | ||
| 96 | `-stopwait` `integer (0 - N)` :: | |
| 97 | ||
| 98 | Maximal time to wait until a VM is stopped (minutes). | |
| 99 | ||
| 100 | `-storage` `string` :: | |
| 101 | ||
| 102 | Store resulting file to this storage. | |
| 103 | ||
| 104 | `-tmpdir` `string` :: | |
| 105 | ||
| 106 | Store temporary files to specified directory. | |
| 107 |