]>
Commit | Line | Data |
---|---|---|
1f554f76 DM |
1 | *vzdump* `help` |
2 | ||
3 | *vzdump* `{<vmid>}` `[OPTIONS]` | |
4 | ||
5 | Create backup. | |
6 | ||
013dc89f | 7 | `<vmid>`: `<string>` :: |
1f554f76 | 8 | |
04ce4dfa | 9 | The ID of the guest system you want to backup. |
1f554f76 | 10 | |
2489d6df | 11 | `--all` `<boolean>` ('default =' `0`):: |
1f554f76 | 12 | |
04ce4dfa | 13 | Backup all known guest systems on this host. |
1f554f76 | 14 | |
2489d6df | 15 | `--bwlimit` `<integer> (0 - N)` ('default =' `0`):: |
1f554f76 | 16 | |
4a407cfd | 17 | Limit I/O bandwidth (in KiB/s). |
1f554f76 | 18 | |
c5aa7e14 | 19 | `--compress` `<0 | 1 | gzip | lzo | zstd>` ('default =' `0`):: |
1f554f76 DM |
20 | |
21 | Compress dump file. | |
22 | ||
2489d6df | 23 | `--dumpdir` `<string>` :: |
1f554f76 DM |
24 | |
25 | Store resulting files to specified directory. | |
26 | ||
2489d6df | 27 | `--exclude` `<string>` :: |
1f554f76 | 28 | |
04ce4dfa | 29 | Exclude specified guest systems (assumes --all) |
1f554f76 | 30 | |
4a407cfd | 31 | `--exclude-path` `<array>` :: |
1f554f76 | 32 | |
c6d5bae8 | 33 | Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. |
1f554f76 | 34 | |
2489d6df | 35 | `--ionice` `<integer> (0 - 8)` ('default =' `7`):: |
1f554f76 | 36 | |
159464a9 | 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. |
1f554f76 | 38 | |
2489d6df | 39 | `--lockwait` `<integer> (0 - N)` ('default =' `180`):: |
1f554f76 DM |
40 | |
41 | Maximal time to wait for the global lock (minutes). | |
42 | ||
2489d6df | 43 | `--mailnotification` `<always | failure>` ('default =' `always`):: |
1f554f76 | 44 | |
c6d5bae8 | 45 | Deprecated: use notification targets/matchers instead. Specify when to send a notification mail |
1f554f76 | 46 | |
2489d6df | 47 | `--mailto` `<string>` :: |
1f554f76 | 48 | |
c6d5bae8 | 49 | Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications. |
1f554f76 | 50 | |
0695fdaf | 51 | `--maxfiles` `<integer> (1 - N)` :: |
1f554f76 | 52 | |
0695fdaf | 53 | Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system. |
1f554f76 | 54 | |
2489d6df | 55 | `--mode` `<snapshot | stop | suspend>` ('default =' `snapshot`):: |
1f554f76 DM |
56 | |
57 | Backup mode. | |
58 | ||
2489d6df | 59 | `--node` `<string>` :: |
1f554f76 DM |
60 | |
61 | Only run if executed on this node. | |
62 | ||
7af2edf9 TL |
63 | `--notes-template` `<string>` :: |
64 | ||
4e7f60c2 | 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. |
7af2edf9 TL |
66 | + |
67 | NOTE: Requires option(s): `storage` | |
68 | ||
c6d5bae8 TL |
69 | `--notification-mode` `<auto | legacy-sendmail | notification-system>` ('default =' `auto`):: |
70 | ||
71 | 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. | |
72 | ||
82551b2b TL |
73 | `--notification-policy` `<always | failure | never>` ('default =' `always`):: |
74 | ||
c6d5bae8 | 75 | Deprecated: Do not use |
82551b2b TL |
76 | |
77 | `--notification-target` `<string>` :: | |
78 | ||
c6d5bae8 | 79 | Deprecated: Do not use |
82551b2b TL |
80 | |
81 | `--performance` `[max-workers=<integer>] [,pbs-entries-max=<integer>]` :: | |
4e7f60c2 TL |
82 | |
83 | Other performance-related settings. | |
84 | ||
2489d6df | 85 | `--pigz` `<integer>` ('default =' `0`):: |
1f554f76 | 86 | |
c2993fe5 | 87 | Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. |
1f554f76 | 88 | |
9226ccbc TL |
89 | `--pool` `<string>` :: |
90 | ||
91 | Backup all known guest systems included in the specified pool. | |
92 | ||
7af2edf9 TL |
93 | `--protected` `<boolean>` :: |
94 | ||
95 | If true, mark backup(s) as protected. | |
96 | + | |
97 | NOTE: Requires option(s): `storage` | |
98 | ||
0695fdaf | 99 | `--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`):: |
739d4d64 TL |
100 | |
101 | Use these retention options instead of those from the storage configuration. | |
102 | ||
2489d6df | 103 | `--quiet` `<boolean>` ('default =' `0`):: |
1f554f76 DM |
104 | |
105 | Be quiet. | |
106 | ||
2489d6df | 107 | `--remove` `<boolean>` ('default =' `1`):: |
1f554f76 | 108 | |
0695fdaf | 109 | Prune older backups according to 'prune-backups'. |
1f554f76 | 110 | |
2489d6df | 111 | `--script` `<string>` :: |
1f554f76 DM |
112 | |
113 | Use specified hook script. | |
114 | ||
2489d6df | 115 | `--stdexcludes` `<boolean>` ('default =' `1`):: |
1f554f76 | 116 | |
04ce4dfa | 117 | Exclude temporary files and logs. |
1f554f76 | 118 | |
2489d6df | 119 | `--stdout` `<boolean>` :: |
1f554f76 DM |
120 | |
121 | Write tar to stdout, not to a file. | |
122 | ||
2489d6df | 123 | `--stop` `<boolean>` ('default =' `0`):: |
1f554f76 | 124 | |
1e3f8156 | 125 | Stop running backup jobs on this host. |
1f554f76 | 126 | |
2489d6df | 127 | `--stopwait` `<integer> (0 - N)` ('default =' `10`):: |
1f554f76 | 128 | |
04ce4dfa | 129 | Maximal time to wait until a guest system is stopped (minutes). |
1f554f76 | 130 | |
2489d6df | 131 | `--storage` `<string>` :: |
1f554f76 DM |
132 | |
133 | Store resulting file to this storage. | |
134 | ||
2489d6df | 135 | `--tmpdir` `<string>` :: |
1f554f76 DM |
136 | |
137 | Store temporary files to specified directory. | |
138 | ||
c5aa7e14 TL |
139 | `--zstd` `<integer>` ('default =' `1`):: |
140 | ||
c6d5bae8 | 141 | 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. |
c5aa7e14 | 142 |