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