]>
Commit | Line | Data |
---|---|---|
1f554f76 DM |
1 | *pvesm* `<COMMAND> [ARGS] [OPTIONS]` |
2 | ||
3 | *pvesm add* `<type> <storage>` `[OPTIONS]` | |
4 | ||
5 | Create a new storage. | |
6 | ||
5f4e66fe | 7 | `<type>`: `<btrfs | cephfs | cifs | dir | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | pbs | rbd | zfs | zfspool>` :: |
1f554f76 DM |
8 | |
9 | Storage type. | |
10 | ||
013dc89f | 11 | `<storage>`: `<string>` :: |
1f554f76 DM |
12 | |
13 | The storage identifier. | |
14 | ||
2489d6df | 15 | `--authsupported` `<string>` :: |
1f554f76 DM |
16 | |
17 | Authsupported. | |
18 | ||
2489d6df | 19 | `--base` `<string>` :: |
1f554f76 DM |
20 | |
21 | Base volume. This volume is automatically activated. | |
22 | ||
2489d6df | 23 | `--blocksize` `<string>` :: |
1f554f76 DM |
24 | |
25 | block size | |
26 | ||
27a7acb2 DM |
27 | `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` :: |
28 | ||
29 | Set bandwidth/io limits various operations. | |
30 | ||
2489d6df | 31 | `--comstar_hg` `<string>` :: |
1f554f76 DM |
32 | |
33 | host group for comstar views | |
34 | ||
2489d6df | 35 | `--comstar_tg` `<string>` :: |
1f554f76 DM |
36 | |
37 | target group for comstar views | |
38 | ||
2489d6df | 39 | `--content` `<string>` :: |
1f554f76 | 40 | |
04ce4dfa DM |
41 | Allowed content types. |
42 | + | |
c2993fe5 | 43 | NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. |
1f554f76 | 44 | |
c30bb419 TL |
45 | `--data-pool` `<string>` :: |
46 | ||
47 | Data Pool (for erasure coding only) | |
48 | ||
c5aa7e14 TL |
49 | `--datastore` `<string>` :: |
50 | ||
4772952b | 51 | Proxmox Backup Server datastore name. |
c5aa7e14 | 52 | |
2489d6df | 53 | `--disable` `<boolean>` :: |
1f554f76 DM |
54 | |
55 | Flag to disable the storage. | |
56 | ||
27a7acb2 DM |
57 | `--domain` `<string>` :: |
58 | ||
59 | CIFS domain. | |
60 | ||
739d4d64 | 61 | `--encryption-key` `a file containing an encryption key, or the special value "autogen"` :: |
04d22a9f TL |
62 | |
63 | Encryption key. Use 'autogen' to generate one automatically without passphrase. | |
64 | ||
2489d6df | 65 | `--export` `<string>` :: |
1f554f76 DM |
66 | |
67 | NFS export path. | |
68 | ||
c5aa7e14 TL |
69 | `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` :: |
70 | ||
71 | Certificate SHA 256 fingerprint. | |
72 | ||
2489d6df | 73 | `--format` `<string>` :: |
1f554f76 | 74 | |
04ce4dfa | 75 | Default image format. |
1f554f76 | 76 | |
5370fa8c TL |
77 | `--fs-name` `<string>` :: |
78 | ||
79 | The Ceph filesystem name. | |
80 | ||
5da3d723 TL |
81 | `--fuse` `<boolean>` :: |
82 | ||
83 | Mount CephFS through FUSE. | |
84 | ||
2489d6df | 85 | `--is_mountpoint` `<string>` ('default =' `no`):: |
2c0dde61 | 86 | |
2489d6df | 87 | Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field. |
2c0dde61 | 88 | |
2489d6df | 89 | `--iscsiprovider` `<string>` :: |
1f554f76 DM |
90 | |
91 | iscsi provider | |
92 | ||
5370fa8c TL |
93 | `--keyring` `file containing the keyring to authenticate in the Ceph cluster` :: |
94 | ||
95 | Client keyring contents (for external clusters). | |
96 | ||
2489d6df | 97 | `--krbd` `<boolean>` :: |
1f554f76 | 98 | |
e2d681b3 | 99 | Always access rbd through krbd kernel module. |
1f554f76 | 100 | |
4d47f125 TL |
101 | `--lio_tpg` `<string>` :: |
102 | ||
103 | target portal group for Linux LIO targets | |
104 | ||
d2656385 TL |
105 | `--master-pubkey` `a file containing a PEM-formatted master public key` :: |
106 | ||
5f4e66fe | 107 | Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. |
d2656385 | 108 | |
7af2edf9 TL |
109 | `--max-protected-backups` `<integer> (-1 - N)` ('default =' `Unlimited for users with Datastore.Allocate privilege, 5 for other users`):: |
110 | ||
111 | Maximal number of protected backups per guest. Use '-1' for unlimited. | |
112 | ||
2489d6df | 113 | `--maxfiles` `<integer> (0 - N)` :: |
1f554f76 | 114 | |
5f4e66fe | 115 | Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited. |
1f554f76 | 116 | |
2489d6df | 117 | `--mkdir` `<boolean>` ('default =' `yes`):: |
2c0dde61 DM |
118 | |
119 | Create the directory if it doesn't exist. | |
120 | ||
2489d6df | 121 | `--monhost` `<string>` :: |
1f554f76 | 122 | |
2489d6df | 123 | IP addresses of monitors (for external clusters). |
1f554f76 | 124 | |
5c1699e5 TL |
125 | `--mountpoint` `<string>` :: |
126 | ||
127 | mount point | |
128 | ||
d2656385 TL |
129 | `--namespace` `<string>` :: |
130 | ||
de786b48 | 131 | Namespace. |
d2656385 | 132 | |
5f4e66fe TL |
133 | `--nocow` `<boolean>` ('default =' `0`):: |
134 | ||
135 | Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system. | |
136 | ||
2489d6df | 137 | `--nodes` `<string>` :: |
1f554f76 DM |
138 | |
139 | List of cluster node names. | |
140 | ||
2489d6df | 141 | `--nowritecache` `<boolean>` :: |
1f554f76 DM |
142 | |
143 | disable write caching on the target | |
144 | ||
2489d6df | 145 | `--options` `<string>` :: |
1f554f76 DM |
146 | |
147 | NFS mount options (see 'man nfs') | |
148 | ||
5da3d723 | 149 | `--password` `<password>` :: |
27a7acb2 | 150 | |
04d22a9f | 151 | Password for accessing the share/datastore. |
27a7acb2 | 152 | |
2489d6df | 153 | `--path` `<string>` :: |
1f554f76 DM |
154 | |
155 | File system path. | |
156 | ||
2489d6df | 157 | `--pool` `<string>` :: |
1f554f76 DM |
158 | |
159 | Pool. | |
160 | ||
4772952b TL |
161 | `--port` `<integer> (1 - 65535)` ('default =' `8007`):: |
162 | ||
163 | For non default port. | |
164 | ||
2489d6df | 165 | `--portal` `<string>` :: |
1f554f76 DM |
166 | |
167 | iSCSI portal (IP or DNS name with optional port). | |
168 | ||
5370fa8c TL |
169 | `--preallocation` `<falloc | full | metadata | off>` ('default =' `metadata`):: |
170 | ||
171 | Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. | |
172 | ||
4772952b | 173 | `--prune-backups` `[keep-all=<1|0>] [,keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` :: |
739d4d64 TL |
174 | |
175 | The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups. | |
176 | ||
2489d6df | 177 | `--saferemove` `<boolean>` :: |
1f554f76 DM |
178 | |
179 | Zero-out data when removing LVs. | |
180 | ||
2489d6df | 181 | `--saferemove_throughput` `<string>` :: |
1f554f76 DM |
182 | |
183 | Wipe throughput (cstream -t parameter value). | |
184 | ||
2489d6df | 185 | `--server` `<string>` :: |
1f554f76 DM |
186 | |
187 | Server IP or DNS name. | |
188 | ||
2489d6df | 189 | `--server2` `<string>` :: |
1f554f76 DM |
190 | |
191 | Backup volfile server IP or DNS name. | |
192 | + | |
193 | NOTE: Requires option(s): `server` | |
194 | ||
27a7acb2 DM |
195 | `--share` `<string>` :: |
196 | ||
197 | CIFS share. | |
198 | ||
2489d6df | 199 | `--shared` `<boolean>` :: |
1f554f76 DM |
200 | |
201 | Mark storage as shared. | |
202 | ||
5370fa8c | 203 | `--smbversion` `<2.0 | 2.1 | 3 | 3.0 | 3.11 | default>` ('default =' `default`):: |
27a7acb2 | 204 | |
5370fa8c | 205 | SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. |
27a7acb2 | 206 | |
2489d6df | 207 | `--sparse` `<boolean>` :: |
1f554f76 DM |
208 | |
209 | use sparse volumes | |
210 | ||
5da3d723 TL |
211 | `--subdir` `<string>` :: |
212 | ||
213 | Subdir to mount. | |
214 | ||
2489d6df | 215 | `--tagged_only` `<boolean>` :: |
2c0dde61 DM |
216 | |
217 | Only use logical volumes tagged with 'pve-vm-ID'. | |
218 | ||
2489d6df | 219 | `--target` `<string>` :: |
1f554f76 DM |
220 | |
221 | iSCSI target. | |
222 | ||
2489d6df | 223 | `--thinpool` `<string>` :: |
1f554f76 DM |
224 | |
225 | LVM thin pool LV name. | |
226 | ||
2489d6df | 227 | `--transport` `<rdma | tcp | unix>` :: |
1f554f76 DM |
228 | |
229 | Gluster transport: tcp or rdma | |
230 | ||
2489d6df | 231 | `--username` `<string>` :: |
1f554f76 DM |
232 | |
233 | RBD Id. | |
234 | ||
2489d6df | 235 | `--vgname` `<string>` :: |
1f554f76 DM |
236 | |
237 | Volume group name. | |
238 | ||
2489d6df | 239 | `--volume` `<string>` :: |
1f554f76 DM |
240 | |
241 | Glusterfs Volume. | |
242 | ||
1f554f76 DM |
243 | *pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]` |
244 | ||
245 | Allocate disk images. | |
246 | ||
013dc89f | 247 | `<storage>`: `<string>` :: |
1f554f76 DM |
248 | |
249 | The storage identifier. | |
250 | ||
013dc89f | 251 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
252 | |
253 | Specify owner VM | |
254 | ||
013dc89f | 255 | `<filename>`: `<string>` :: |
1f554f76 DM |
256 | |
257 | The name of the file to create. | |
258 | ||
013dc89f | 259 | `<size>`: `\d+[MG]?` :: |
1f554f76 | 260 | |
c2993fe5 | 261 | Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M) |
1f554f76 | 262 | |
2489d6df | 263 | `--format` `<qcow2 | raw | subvol>` :: |
1f554f76 DM |
264 | |
265 | no description available | |
266 | + | |
267 | NOTE: Requires option(s): `size` | |
268 | ||
c5aa7e14 TL |
269 | *pvesm apiinfo* |
270 | ||
271 | Returns APIVER and APIAGE. | |
272 | ||
e2d681b3 | 273 | *pvesm cifsscan* |
27a7acb2 | 274 | |
e2d681b3 | 275 | An alias for 'pvesm scan cifs'. |
27a7acb2 | 276 | |
5d9c884c DM |
277 | *pvesm export* `<volume> <format> <filename>` `[OPTIONS]` |
278 | ||
04d22a9f | 279 | Used internally to export a volume. |
5d9c884c DM |
280 | |
281 | `<volume>`: `<string>` :: | |
282 | ||
283 | Volume identifier | |
284 | ||
5f4e66fe | 285 | `<format>`: `<btrfs | qcow2+size | raw+size | tar+size | vmdk+size | zfs>` :: |
5d9c884c DM |
286 | |
287 | Export stream format | |
288 | ||
289 | `<filename>`: `<string>` :: | |
290 | ||
291 | Destination file name | |
292 | ||
d2656385 | 293 | `--base` `(?^i:[a-z0-9_\-]{1,40})` :: |
5d9c884c DM |
294 | |
295 | Snapshot to start an incremental stream from | |
296 | ||
d2656385 | 297 | `--snapshot` `(?^i:[a-z0-9_\-]{1,40})` :: |
5d9c884c DM |
298 | |
299 | Snapshot to export | |
300 | ||
5f4e66fe TL |
301 | `--snapshot-list` `<string>` :: |
302 | ||
303 | Ordered list of snapshots to transfer | |
304 | ||
2489d6df | 305 | `--with-snapshots` `<boolean>` ('default =' `0`):: |
5d9c884c DM |
306 | |
307 | Whether to include intermediate snapshots in the stream | |
308 | ||
2c0dde61 DM |
309 | *pvesm extractconfig* `<volume>` |
310 | ||
311 | Extract configuration from vzdump backup archive. | |
312 | ||
013dc89f | 313 | `<volume>`: `<string>` :: |
2c0dde61 DM |
314 | |
315 | Volume identifier | |
316 | ||
1f554f76 DM |
317 | *pvesm free* `<volume>` `[OPTIONS]` |
318 | ||
319 | Delete volume | |
320 | ||
013dc89f | 321 | `<volume>`: `<string>` :: |
1f554f76 DM |
322 | |
323 | Volume identifier | |
324 | ||
1c532546 TL |
325 | `--delay` `<integer> (1 - 30)` :: |
326 | ||
327 | Time to wait for the task to finish. We return 'null' if the task finish within that time. | |
328 | ||
2489d6df | 329 | `--storage` `<string>` :: |
1f554f76 DM |
330 | |
331 | The storage identifier. | |
332 | ||
e2d681b3 | 333 | *pvesm glusterfsscan* |
1f554f76 | 334 | |
e2d681b3 | 335 | An alias for 'pvesm scan glusterfs'. |
1f554f76 | 336 | |
35a75dd3 | 337 | *pvesm help* `[OPTIONS]` |
1f554f76 DM |
338 | |
339 | Get help about specified command. | |
340 | ||
35a75dd3 | 341 | `--extra-args` `<array>` :: |
1f554f76 | 342 | |
35a75dd3 | 343 | Shows help for a specific command |
1f554f76 | 344 | |
2489d6df | 345 | `--verbose` `<boolean>` :: |
1f554f76 DM |
346 | |
347 | Verbose output format. | |
348 | ||
5d9c884c DM |
349 | *pvesm import* `<volume> <format> <filename>` `[OPTIONS]` |
350 | ||
04d22a9f | 351 | Used internally to import a volume. |
5d9c884c DM |
352 | |
353 | `<volume>`: `<string>` :: | |
354 | ||
355 | Volume identifier | |
356 | ||
5f4e66fe | 357 | `<format>`: `<btrfs | qcow2+size | raw+size | tar+size | vmdk+size | zfs>` :: |
5d9c884c DM |
358 | |
359 | Import stream format | |
360 | ||
361 | `<filename>`: `<string>` :: | |
362 | ||
d2656385 | 363 | Source file name. For '-' stdin is used, the tcp://<IP-or-CIDR> format allows to use a TCP connection, the unix://PATH-TO-SOCKET format a UNIX socket as input.Else, the file is treated as common file. |
5d9c884c | 364 | |
c5aa7e14 TL |
365 | `--allow-rename` `<boolean>` ('default =' `0`):: |
366 | ||
367 | Choose a new volume ID if the requested volume ID already exists, instead of throwing an error. | |
368 | ||
d2656385 | 369 | `--base` `(?^i:[a-z0-9_\-]{1,40})` :: |
5d9c884c DM |
370 | |
371 | Base snapshot of an incremental stream | |
372 | ||
d2656385 | 373 | `--delete-snapshot` `(?^i:[a-z0-9_\-]{1,80})` :: |
5d9c884c DM |
374 | |
375 | A snapshot to delete on success | |
376 | ||
5f4e66fe TL |
377 | `--snapshot` `(?^i:[a-z0-9_\-]{1,40})` :: |
378 | ||
379 | The current-state snapshot if the stream contains snapshots | |
380 | ||
2489d6df | 381 | `--with-snapshots` `<boolean>` ('default =' `0`):: |
5d9c884c DM |
382 | |
383 | Whether the stream includes intermediate snapshots | |
384 | ||
e2d681b3 | 385 | *pvesm iscsiscan* |
1f554f76 | 386 | |
e2d681b3 | 387 | An alias for 'pvesm scan iscsi'. |
1f554f76 | 388 | |
1f554f76 DM |
389 | *pvesm list* `<storage>` `[OPTIONS]` |
390 | ||
391 | List storage content. | |
392 | ||
013dc89f | 393 | `<storage>`: `<string>` :: |
1f554f76 DM |
394 | |
395 | The storage identifier. | |
396 | ||
2489d6df | 397 | `--content` `<string>` :: |
1f554f76 DM |
398 | |
399 | Only list content of this type. | |
400 | ||
2489d6df | 401 | `--vmid` `<integer> (1 - N)` :: |
1f554f76 DM |
402 | |
403 | Only list images for this VM | |
404 | ||
1f554f76 DM |
405 | *pvesm lvmscan* |
406 | ||
e2d681b3 | 407 | An alias for 'pvesm scan lvm'. |
9b3e4991 | 408 | |
e2d681b3 | 409 | *pvesm lvmthinscan* |
9b3e4991 | 410 | |
e2d681b3 | 411 | An alias for 'pvesm scan lvmthin'. |
9b3e4991 | 412 | |
e2d681b3 | 413 | *pvesm nfsscan* |
1f554f76 | 414 | |
e2d681b3 | 415 | An alias for 'pvesm scan nfs'. |
1f554f76 | 416 | |
1f554f76 DM |
417 | *pvesm path* `<volume>` |
418 | ||
419 | Get filesystem path for specified volume | |
420 | ||
013dc89f | 421 | `<volume>`: `<string>` :: |
1f554f76 DM |
422 | |
423 | Volume identifier | |
424 | ||
739d4d64 TL |
425 | *pvesm prune-backups* `<storage>` `[OPTIONS]` |
426 | ||
4772952b TL |
427 | Prune backups. Only those using the standard naming scheme are considered. |
428 | If no keep options are specified, those from the storage configuration are | |
429 | used. | |
739d4d64 TL |
430 | |
431 | `<storage>`: `<string>` :: | |
432 | ||
433 | The storage identifier. | |
434 | ||
435 | `--dry-run` `<boolean>` :: | |
436 | ||
437 | Only show what would be pruned, don't delete anything. | |
438 | ||
4772952b TL |
439 | `--keep-all` `<boolean>` :: |
440 | ||
441 | Keep all backups. Conflicts with the other options when true. | |
442 | ||
443 | `--keep-daily` `<N>` :: | |
444 | ||
445 | Keep backups for the last <N> different days. If there is morethan one backup for a single day, only the latest one is kept. | |
446 | ||
447 | `--keep-hourly` `<N>` :: | |
448 | ||
449 | Keep backups for the last <N> different hours. If there is morethan one backup for a single hour, only the latest one is kept. | |
450 | ||
451 | `--keep-last` `<N>` :: | |
739d4d64 | 452 | |
4772952b TL |
453 | Keep the last <N> backups. |
454 | ||
455 | `--keep-monthly` `<N>` :: | |
456 | ||
457 | Keep backups for the last <N> different months. If there is morethan one backup for a single month, only the latest one is kept. | |
458 | ||
459 | `--keep-weekly` `<N>` :: | |
460 | ||
461 | Keep backups for the last <N> different weeks. If there is morethan one backup for a single week, only the latest one is kept. | |
462 | ||
463 | `--keep-yearly` `<N>` :: | |
464 | ||
465 | Keep backups for the last <N> different years. If there is morethan one backup for a single year, only the latest one is kept. | |
739d4d64 TL |
466 | |
467 | `--type` `<lxc | qemu>` :: | |
468 | ||
469 | Either 'qemu' or 'lxc'. Only consider backups for guests of this type. | |
470 | ||
471 | `--vmid` `<integer> (1 - N)` :: | |
472 | ||
473 | Only consider backups for this guest. | |
474 | ||
1f554f76 DM |
475 | *pvesm remove* `<storage>` |
476 | ||
477 | Delete storage configuration. | |
478 | ||
013dc89f | 479 | `<storage>`: `<string>` :: |
1f554f76 DM |
480 | |
481 | The storage identifier. | |
482 | ||
e2d681b3 TL |
483 | *pvesm scan cifs* `<server>` `[OPTIONS]` |
484 | ||
485 | Scan remote CIFS server. | |
486 | ||
487 | `<server>`: `<string>` :: | |
488 | ||
489 | The server address (name or IP). | |
490 | ||
491 | `--domain` `<string>` :: | |
492 | ||
493 | SMB domain (Workgroup). | |
494 | ||
495 | `--password` `<password>` :: | |
496 | ||
497 | User password. | |
498 | ||
499 | `--username` `<string>` :: | |
500 | ||
501 | User name. | |
502 | ||
503 | *pvesm scan glusterfs* `<server>` | |
504 | ||
505 | Scan remote GlusterFS server. | |
506 | ||
507 | `<server>`: `<string>` :: | |
508 | ||
509 | The server address (name or IP). | |
510 | ||
511 | *pvesm scan iscsi* `<portal>` | |
512 | ||
513 | Scan remote iSCSI server. | |
514 | ||
515 | `<portal>`: `<string>` :: | |
516 | ||
517 | The iSCSI portal (IP or DNS name with optional port). | |
518 | ||
519 | *pvesm scan lvm* | |
520 | ||
521 | List local LVM volume groups. | |
522 | ||
523 | *pvesm scan lvmthin* `<vg>` | |
524 | ||
525 | List local LVM Thin Pools. | |
526 | ||
527 | `<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` :: | |
528 | ||
529 | no description available | |
530 | ||
531 | *pvesm scan nfs* `<server>` | |
532 | ||
533 | Scan remote NFS server. | |
534 | ||
535 | `<server>`: `<string>` :: | |
536 | ||
537 | The server address (name or IP). | |
538 | ||
d2656385 TL |
539 | *pvesm scan pbs* `<server> <username> --password <string>` `[OPTIONS]` `[FORMAT_OPTIONS]` |
540 | ||
541 | Scan remote Proxmox Backup Server. | |
542 | ||
543 | `<server>`: `<string>` :: | |
544 | ||
545 | The server address (name or IP). | |
546 | ||
547 | `<username>`: `<string>` :: | |
548 | ||
549 | User-name or API token-ID. | |
550 | ||
551 | `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` :: | |
552 | ||
553 | Certificate SHA 256 fingerprint. | |
554 | ||
555 | `--password` `<string>` :: | |
556 | ||
557 | User password or API token secret. | |
558 | ||
559 | `--port` `<integer> (1 - 65535)` ('default =' `8007`):: | |
560 | ||
561 | Optional port. | |
562 | ||
e2d681b3 TL |
563 | *pvesm scan zfs* |
564 | ||
565 | Scan zfs pool list on local node. | |
566 | ||
1f554f76 DM |
567 | *pvesm set* `<storage>` `[OPTIONS]` |
568 | ||
569 | Update storage configuration. | |
570 | ||
013dc89f | 571 | `<storage>`: `<string>` :: |
1f554f76 DM |
572 | |
573 | The storage identifier. | |
574 | ||
2489d6df | 575 | `--blocksize` `<string>` :: |
1f554f76 DM |
576 | |
577 | block size | |
578 | ||
27a7acb2 DM |
579 | `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` :: |
580 | ||
581 | Set bandwidth/io limits various operations. | |
582 | ||
2489d6df | 583 | `--comstar_hg` `<string>` :: |
1f554f76 DM |
584 | |
585 | host group for comstar views | |
586 | ||
2489d6df | 587 | `--comstar_tg` `<string>` :: |
1f554f76 DM |
588 | |
589 | target group for comstar views | |
590 | ||
2489d6df | 591 | `--content` `<string>` :: |
1f554f76 | 592 | |
04ce4dfa DM |
593 | Allowed content types. |
594 | + | |
c2993fe5 | 595 | NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. |
1f554f76 | 596 | |
c30bb419 TL |
597 | `--data-pool` `<string>` :: |
598 | ||
599 | Data Pool (for erasure coding only) | |
600 | ||
2489d6df | 601 | `--delete` `<string>` :: |
1f554f76 DM |
602 | |
603 | A list of settings you want to delete. | |
604 | ||
2489d6df | 605 | `--digest` `<string>` :: |
1f554f76 | 606 | |
c2993fe5 | 607 | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
1f554f76 | 608 | |
2489d6df | 609 | `--disable` `<boolean>` :: |
1f554f76 DM |
610 | |
611 | Flag to disable the storage. | |
612 | ||
27a7acb2 DM |
613 | `--domain` `<string>` :: |
614 | ||
615 | CIFS domain. | |
616 | ||
739d4d64 | 617 | `--encryption-key` `a file containing an encryption key, or the special value "autogen"` :: |
04d22a9f TL |
618 | |
619 | Encryption key. Use 'autogen' to generate one automatically without passphrase. | |
620 | ||
c5aa7e14 TL |
621 | `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` :: |
622 | ||
623 | Certificate SHA 256 fingerprint. | |
624 | ||
2489d6df | 625 | `--format` `<string>` :: |
1f554f76 | 626 | |
04ce4dfa | 627 | Default image format. |
1f554f76 | 628 | |
5370fa8c TL |
629 | `--fs-name` `<string>` :: |
630 | ||
631 | The Ceph filesystem name. | |
632 | ||
5da3d723 TL |
633 | `--fuse` `<boolean>` :: |
634 | ||
635 | Mount CephFS through FUSE. | |
636 | ||
2489d6df | 637 | `--is_mountpoint` `<string>` ('default =' `no`):: |
2c0dde61 | 638 | |
2489d6df | 639 | Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field. |
2c0dde61 | 640 | |
5370fa8c TL |
641 | `--keyring` `file containing the keyring to authenticate in the Ceph cluster` :: |
642 | ||
643 | Client keyring contents (for external clusters). | |
644 | ||
2489d6df | 645 | `--krbd` `<boolean>` :: |
1f554f76 | 646 | |
e2d681b3 | 647 | Always access rbd through krbd kernel module. |
1f554f76 | 648 | |
4d47f125 TL |
649 | `--lio_tpg` `<string>` :: |
650 | ||
651 | target portal group for Linux LIO targets | |
652 | ||
d2656385 TL |
653 | `--master-pubkey` `a file containing a PEM-formatted master public key` :: |
654 | ||
5f4e66fe | 655 | Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. |
d2656385 | 656 | |
7af2edf9 TL |
657 | `--max-protected-backups` `<integer> (-1 - N)` ('default =' `Unlimited for users with Datastore.Allocate privilege, 5 for other users`):: |
658 | ||
659 | Maximal number of protected backups per guest. Use '-1' for unlimited. | |
660 | ||
2489d6df | 661 | `--maxfiles` `<integer> (0 - N)` :: |
1f554f76 | 662 | |
5f4e66fe | 663 | Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited. |
1f554f76 | 664 | |
2489d6df | 665 | `--mkdir` `<boolean>` ('default =' `yes`):: |
2c0dde61 DM |
666 | |
667 | Create the directory if it doesn't exist. | |
668 | ||
2489d6df WB |
669 | `--monhost` `<string>` :: |
670 | ||
671 | IP addresses of monitors (for external clusters). | |
672 | ||
5c1699e5 TL |
673 | `--mountpoint` `<string>` :: |
674 | ||
675 | mount point | |
676 | ||
d2656385 TL |
677 | `--namespace` `<string>` :: |
678 | ||
de786b48 | 679 | Namespace. |
d2656385 | 680 | |
5f4e66fe TL |
681 | `--nocow` `<boolean>` ('default =' `0`):: |
682 | ||
683 | Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system. | |
684 | ||
2489d6df | 685 | `--nodes` `<string>` :: |
1f554f76 DM |
686 | |
687 | List of cluster node names. | |
688 | ||
2489d6df | 689 | `--nowritecache` `<boolean>` :: |
1f554f76 DM |
690 | |
691 | disable write caching on the target | |
692 | ||
2489d6df | 693 | `--options` `<string>` :: |
1f554f76 DM |
694 | |
695 | NFS mount options (see 'man nfs') | |
696 | ||
04d22a9f | 697 | `--password` `<password>` :: |
27a7acb2 | 698 | |
04d22a9f | 699 | Password for accessing the share/datastore. |
27a7acb2 | 700 | |
2489d6df | 701 | `--pool` `<string>` :: |
1f554f76 DM |
702 | |
703 | Pool. | |
704 | ||
4772952b TL |
705 | `--port` `<integer> (1 - 65535)` ('default =' `8007`):: |
706 | ||
707 | For non default port. | |
708 | ||
5370fa8c TL |
709 | `--preallocation` `<falloc | full | metadata | off>` ('default =' `metadata`):: |
710 | ||
711 | Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. | |
712 | ||
4772952b | 713 | `--prune-backups` `[keep-all=<1|0>] [,keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` :: |
739d4d64 TL |
714 | |
715 | The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups. | |
716 | ||
2489d6df | 717 | `--saferemove` `<boolean>` :: |
1f554f76 DM |
718 | |
719 | Zero-out data when removing LVs. | |
720 | ||
2489d6df | 721 | `--saferemove_throughput` `<string>` :: |
1f554f76 DM |
722 | |
723 | Wipe throughput (cstream -t parameter value). | |
724 | ||
2489d6df | 725 | `--server` `<string>` :: |
1f554f76 DM |
726 | |
727 | Server IP or DNS name. | |
728 | ||
2489d6df | 729 | `--server2` `<string>` :: |
1f554f76 DM |
730 | |
731 | Backup volfile server IP or DNS name. | |
732 | + | |
733 | NOTE: Requires option(s): `server` | |
734 | ||
2489d6df | 735 | `--shared` `<boolean>` :: |
1f554f76 DM |
736 | |
737 | Mark storage as shared. | |
738 | ||
5370fa8c | 739 | `--smbversion` `<2.0 | 2.1 | 3 | 3.0 | 3.11 | default>` ('default =' `default`):: |
27a7acb2 | 740 | |
5370fa8c | 741 | SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. |
27a7acb2 | 742 | |
2489d6df | 743 | `--sparse` `<boolean>` :: |
1f554f76 DM |
744 | |
745 | use sparse volumes | |
746 | ||
5da3d723 TL |
747 | `--subdir` `<string>` :: |
748 | ||
749 | Subdir to mount. | |
750 | ||
2489d6df | 751 | `--tagged_only` `<boolean>` :: |
2c0dde61 DM |
752 | |
753 | Only use logical volumes tagged with 'pve-vm-ID'. | |
754 | ||
2489d6df | 755 | `--transport` `<rdma | tcp | unix>` :: |
1f554f76 DM |
756 | |
757 | Gluster transport: tcp or rdma | |
758 | ||
2489d6df | 759 | `--username` `<string>` :: |
1f554f76 DM |
760 | |
761 | RBD Id. | |
762 | ||
1f554f76 DM |
763 | *pvesm status* `[OPTIONS]` |
764 | ||
765 | Get status for all datastores. | |
766 | ||
2489d6df | 767 | `--content` `<string>` :: |
1f554f76 DM |
768 | |
769 | Only list stores which support this content type. | |
770 | ||
2489d6df | 771 | `--enabled` `<boolean>` ('default =' `0`):: |
1f554f76 DM |
772 | |
773 | Only list stores which are enabled (not disabled in config). | |
774 | ||
35a75dd3 DM |
775 | `--format` `<boolean>` ('default =' `0`):: |
776 | ||
777 | Include information about formats | |
778 | ||
2489d6df | 779 | `--storage` `<string>` :: |
1f554f76 DM |
780 | |
781 | Only list status for specified storage | |
782 | ||
2489d6df | 783 | `--target` `<string>` :: |
1f554f76 | 784 | |
c2993fe5 | 785 | If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node. |
1f554f76 | 786 | |
1f554f76 DM |
787 | *pvesm zfsscan* |
788 | ||
e2d681b3 | 789 | An alias for 'pvesm scan zfs'. |
1f554f76 DM |
790 | |
791 |