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