1 *pvesm* `<COMMAND> [ARGS] [OPTIONS]`
3 *pvesm add* `<type> <storage>` `[OPTIONS]`
7 `<type>`: `<btrfs | cephfs | cifs | dir | esxi | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | pbs | rbd | zfs | zfspool>` ::
11 `<storage>`: `<string>` ::
13 The storage identifier.
15 `--authsupported` `<string>` ::
19 `--base` `<string>` ::
21 Base volume. This volume is automatically activated.
23 `--blocksize` `<string>` ::
27 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
29 Set I/O bandwidth limit for various operations (in KiB/s).
31 `--comstar_hg` `<string>` ::
33 host group for comstar views
35 `--comstar_tg` `<string>` ::
37 target group for comstar views
39 `--content` `<string>` ::
41 Allowed content types.
43 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
45 `--content-dirs` `<string>` ::
47 Overrides for default content type directories.
49 `--create-base-path` `<boolean>` ('default =' `yes`)::
51 Create the base directory if it doesn't exist.
53 `--create-subdirs` `<boolean>` ('default =' `yes`)::
55 Populate the directory with the default structure.
57 `--data-pool` `<string>` ::
59 Data Pool (for erasure coding only)
61 `--datastore` `<string>` ::
63 Proxmox Backup Server datastore name.
65 `--disable` `<boolean>` ::
67 Flag to disable the storage.
69 `--domain` `<string>` ::
73 `--encryption-key` `a file containing an encryption key, or the special value "autogen"` ::
75 Encryption key. Use 'autogen' to generate one automatically without passphrase.
77 `--export` `<string>` ::
81 `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
83 Certificate SHA 256 fingerprint.
85 `--format` `<string>` ::
89 `--fs-name` `<string>` ::
91 The Ceph filesystem name.
93 `--fuse` `<boolean>` ::
95 Mount CephFS through FUSE.
97 `--is_mountpoint` `<string>` ('default =' `no`)::
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.
101 `--iscsiprovider` `<string>` ::
105 `--keyring` `file containing the keyring to authenticate in the Ceph cluster` ::
107 Client keyring contents (for external clusters).
109 `--krbd` `<boolean>` ::
111 Always access rbd through krbd kernel module.
113 `--lio_tpg` `<string>` ::
115 target portal group for Linux LIO targets
117 `--master-pubkey` `a file containing a PEM-formatted master public key` ::
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.
121 `--max-protected-backups` `<integer> (-1 - N)` ('default =' `Unlimited for users with Datastore.Allocate privilege, 5 for other users`)::
123 Maximal number of protected backups per guest. Use '-1' for unlimited.
125 `--maxfiles` `<integer> (0 - N)` ::
127 Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited.
129 `--mkdir` `<boolean>` ('default =' `yes`)::
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.
133 `--monhost` `<string>` ::
135 IP addresses of monitors (for external clusters).
137 `--mountpoint` `<string>` ::
141 `--namespace` `<string>` ::
145 `--nocow` `<boolean>` ('default =' `0`)::
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.
149 `--nodes` `<string>` ::
151 List of nodes for which the storage configuration applies.
153 `--nowritecache` `<boolean>` ::
155 disable write caching on the target
157 `--options` `<string>` ::
159 NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs')
161 `--password` `<password>` ::
163 Password for accessing the share/datastore.
165 `--path` `<string>` ::
169 `--pool` `<string>` ::
173 `--port` `<integer> (1 - 65535)` ('default =' `8007`)::
175 For non default port.
177 `--portal` `<string>` ::
179 iSCSI portal (IP or DNS name with optional port).
181 `--preallocation` `<falloc | full | metadata | off>` ('default =' `metadata`)::
183 Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off.
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>]` ::
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.
189 `--saferemove` `<boolean>` ::
191 Zero-out data when removing LVs.
193 `--saferemove_throughput` `<string>` ::
195 Wipe throughput (cstream -t parameter value).
197 `--server` `<string>` ::
199 Server IP or DNS name.
201 `--server2` `<string>` ::
203 Backup volfile server IP or DNS name.
205 NOTE: Requires option(s): `server`
207 `--share` `<string>` ::
211 `--shared` `<boolean>` ::
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!
215 `--skip-cert-verification` `<boolean>` ('default =' `false`)::
217 Disable TLS certificate verification, only enable on fully trusted networks!
219 `--smbversion` `<2.0 | 2.1 | 3 | 3.0 | 3.11 | default>` ('default =' `default`)::
221 SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server.
223 `--sparse` `<boolean>` ::
227 `--subdir` `<string>` ::
231 `--tagged_only` `<boolean>` ::
233 Only use logical volumes tagged with 'pve-vm-ID'.
235 `--target` `<string>` ::
239 `--thinpool` `<string>` ::
241 LVM thin pool LV name.
243 `--transport` `<rdma | tcp | unix>` ::
245 Gluster transport: tcp or rdma
247 `--username` `<string>` ::
251 `--vgname` `<string>` ::
255 `--volume` `<string>` ::
259 *pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
261 Allocate disk images.
263 `<storage>`: `<string>` ::
265 The storage identifier.
267 `<vmid>`: `<integer> (100 - 999999999)` ::
271 `<filename>`: `<string>` ::
273 The name of the file to create.
275 `<size>`: `\d+[MG]?` ::
277 Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
279 `--format` `<qcow2 | raw | subvol>` ::
281 no description available
283 NOTE: Requires option(s): `size`
287 Returns APIVER and APIAGE.
291 An alias for 'pvesm scan cifs'.
293 *pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
295 Used internally to export a volume.
297 `<volume>`: `<string>` ::
301 `<format>`: `<btrfs | qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
305 `<filename>`: `<string>` ::
307 Destination file name
309 `--base` `(?^i:[a-z0-9_\-]{1,40})` ::
311 Snapshot to start an incremental stream from
313 `--snapshot` `(?^i:[a-z0-9_\-]{1,40})` ::
317 `--snapshot-list` `<string>` ::
319 Ordered list of snapshots to transfer
321 `--with-snapshots` `<boolean>` ('default =' `0`)::
323 Whether to include intermediate snapshots in the stream
325 *pvesm extractconfig* `<volume>`
327 Extract configuration from vzdump backup archive.
329 `<volume>`: `<string>` ::
333 *pvesm free* `<volume>` `[OPTIONS]`
337 `<volume>`: `<string>` ::
341 `--delay` `<integer> (1 - 30)` ::
343 Time to wait for the task to finish. We return 'null' if the task finish within that time.
345 `--storage` `<string>` ::
347 The storage identifier.
349 *pvesm glusterfsscan*
351 An alias for 'pvesm scan glusterfs'.
353 *pvesm help* `[OPTIONS]`
355 Get help about specified command.
357 `--extra-args` `<array>` ::
359 Shows help for a specific command
361 `--verbose` `<boolean>` ::
363 Verbose output format.
365 *pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
367 Used internally to import a volume.
369 `<volume>`: `<string>` ::
373 `<format>`: `<btrfs | qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
377 `<filename>`: `<string>` ::
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.
381 `--allow-rename` `<boolean>` ('default =' `0`)::
383 Choose a new volume ID if the requested volume ID already exists, instead of throwing an error.
385 `--base` `(?^i:[a-z0-9_\-]{1,40})` ::
387 Base snapshot of an incremental stream
389 `--delete-snapshot` `(?^i:[a-z0-9_\-]{1,80})` ::
391 A snapshot to delete on success
393 `--snapshot` `(?^i:[a-z0-9_\-]{1,40})` ::
395 The current-state snapshot if the stream contains snapshots
397 `--with-snapshots` `<boolean>` ('default =' `0`)::
399 Whether the stream includes intermediate snapshots
403 An alias for 'pvesm scan iscsi'.
405 *pvesm list* `<storage>` `[OPTIONS]`
407 List storage content.
409 `<storage>`: `<string>` ::
411 The storage identifier.
413 `--content` `<string>` ::
415 Only list content of this type.
417 `--vmid` `<integer> (100 - 999999999)` ::
419 Only list images for this VM
423 An alias for 'pvesm scan lvm'.
427 An alias for 'pvesm scan lvmthin'.
431 An alias for 'pvesm scan nfs'.
433 *pvesm path* `<volume>`
435 Get filesystem path for specified volume
437 `<volume>`: `<string>` ::
441 *pvesm prune-backups* `<storage>` `[OPTIONS]`
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
447 `<storage>`: `<string>` ::
449 The storage identifier.
451 `--dry-run` `<boolean>` ::
453 Only show what would be pruned, don't delete anything.
455 `--keep-all` `<boolean>` ::
457 Keep all backups. Conflicts with the other options when true.
459 `--keep-daily` `<N>` ::
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.
463 `--keep-hourly` `<N>` ::
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.
467 `--keep-last` `<N>` ::
469 Keep the last <N> backups.
471 `--keep-monthly` `<N>` ::
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.
475 `--keep-weekly` `<N>` ::
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.
479 `--keep-yearly` `<N>` ::
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.
483 `--type` `<lxc | qemu>` ::
485 Either 'qemu' or 'lxc'. Only consider backups for guests of this type.
487 `--vmid` `<integer> (100 - 999999999)` ::
489 Only consider backups for this guest.
491 *pvesm remove* `<storage>`
493 Delete storage configuration.
495 `<storage>`: `<string>` ::
497 The storage identifier.
499 *pvesm scan cifs* `<server>` `[OPTIONS]`
501 Scan remote CIFS server.
503 `<server>`: `<string>` ::
505 The server address (name or IP).
507 `--domain` `<string>` ::
509 SMB domain (Workgroup).
511 `--password` `<password>` ::
515 `--username` `<string>` ::
519 *pvesm scan glusterfs* `<server>`
521 Scan remote GlusterFS server.
523 `<server>`: `<string>` ::
525 The server address (name or IP).
527 *pvesm scan iscsi* `<portal>`
529 Scan remote iSCSI server.
531 `<portal>`: `<string>` ::
533 The iSCSI portal (IP or DNS name with optional port).
537 List local LVM volume groups.
539 *pvesm scan lvmthin* `<vg>`
541 List local LVM Thin Pools.
543 `<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
545 no description available
547 *pvesm scan nfs* `<server>`
549 Scan remote NFS server.
551 `<server>`: `<string>` ::
553 The server address (name or IP).
555 *pvesm scan pbs* `<server> <username> --password <string>` `[OPTIONS]` `[FORMAT_OPTIONS]`
557 Scan remote Proxmox Backup Server.
559 `<server>`: `<string>` ::
561 The server address (name or IP).
563 `<username>`: `<string>` ::
565 User-name or API token-ID.
567 `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
569 Certificate SHA 256 fingerprint.
571 `--password` `<string>` ::
573 User password or API token secret.
575 `--port` `<integer> (1 - 65535)` ('default =' `8007`)::
581 Scan zfs pool list on local node.
583 *pvesm set* `<storage>` `[OPTIONS]`
585 Update storage configuration.
587 `<storage>`: `<string>` ::
589 The storage identifier.
591 `--blocksize` `<string>` ::
595 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
597 Set I/O bandwidth limit for various operations (in KiB/s).
599 `--comstar_hg` `<string>` ::
601 host group for comstar views
603 `--comstar_tg` `<string>` ::
605 target group for comstar views
607 `--content` `<string>` ::
609 Allowed content types.
611 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
613 `--content-dirs` `<string>` ::
615 Overrides for default content type directories.
617 `--create-base-path` `<boolean>` ('default =' `yes`)::
619 Create the base directory if it doesn't exist.
621 `--create-subdirs` `<boolean>` ('default =' `yes`)::
623 Populate the directory with the default structure.
625 `--data-pool` `<string>` ::
627 Data Pool (for erasure coding only)
629 `--delete` `<string>` ::
631 A list of settings you want to delete.
633 `--digest` `<string>` ::
635 Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
637 `--disable` `<boolean>` ::
639 Flag to disable the storage.
641 `--domain` `<string>` ::
645 `--encryption-key` `a file containing an encryption key, or the special value "autogen"` ::
647 Encryption key. Use 'autogen' to generate one automatically without passphrase.
649 `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
651 Certificate SHA 256 fingerprint.
653 `--format` `<string>` ::
655 Default image format.
657 `--fs-name` `<string>` ::
659 The Ceph filesystem name.
661 `--fuse` `<boolean>` ::
663 Mount CephFS through FUSE.
665 `--is_mountpoint` `<string>` ('default =' `no`)::
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.
669 `--keyring` `file containing the keyring to authenticate in the Ceph cluster` ::
671 Client keyring contents (for external clusters).
673 `--krbd` `<boolean>` ::
675 Always access rbd through krbd kernel module.
677 `--lio_tpg` `<string>` ::
679 target portal group for Linux LIO targets
681 `--master-pubkey` `a file containing a PEM-formatted master public key` ::
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.
685 `--max-protected-backups` `<integer> (-1 - N)` ('default =' `Unlimited for users with Datastore.Allocate privilege, 5 for other users`)::
687 Maximal number of protected backups per guest. Use '-1' for unlimited.
689 `--maxfiles` `<integer> (0 - N)` ::
691 Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited.
693 `--mkdir` `<boolean>` ('default =' `yes`)::
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.
697 `--monhost` `<string>` ::
699 IP addresses of monitors (for external clusters).
701 `--mountpoint` `<string>` ::
705 `--namespace` `<string>` ::
709 `--nocow` `<boolean>` ('default =' `0`)::
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.
713 `--nodes` `<string>` ::
715 List of nodes for which the storage configuration applies.
717 `--nowritecache` `<boolean>` ::
719 disable write caching on the target
721 `--options` `<string>` ::
723 NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs')
725 `--password` `<password>` ::
727 Password for accessing the share/datastore.
729 `--pool` `<string>` ::
733 `--port` `<integer> (1 - 65535)` ('default =' `8007`)::
735 For non default port.
737 `--preallocation` `<falloc | full | metadata | off>` ('default =' `metadata`)::
739 Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off.
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>]` ::
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.
745 `--saferemove` `<boolean>` ::
747 Zero-out data when removing LVs.
749 `--saferemove_throughput` `<string>` ::
751 Wipe throughput (cstream -t parameter value).
753 `--server` `<string>` ::
755 Server IP or DNS name.
757 `--server2` `<string>` ::
759 Backup volfile server IP or DNS name.
761 NOTE: Requires option(s): `server`
763 `--shared` `<boolean>` ::
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!
767 `--skip-cert-verification` `<boolean>` ('default =' `false`)::
769 Disable TLS certificate verification, only enable on fully trusted networks!
771 `--smbversion` `<2.0 | 2.1 | 3 | 3.0 | 3.11 | default>` ('default =' `default`)::
773 SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server.
775 `--sparse` `<boolean>` ::
779 `--subdir` `<string>` ::
783 `--tagged_only` `<boolean>` ::
785 Only use logical volumes tagged with 'pve-vm-ID'.
787 `--transport` `<rdma | tcp | unix>` ::
789 Gluster transport: tcp or rdma
791 `--username` `<string>` ::
795 *pvesm status* `[OPTIONS]`
797 Get status for all datastores.
799 `--content` `<string>` ::
801 Only list stores which support this content type.
803 `--enabled` `<boolean>` ('default =' `0`)::
805 Only list stores which are enabled (not disabled in config).
807 `--format` `<boolean>` ('default =' `0`)::
809 Include information about formats
811 `--storage` `<string>` ::
813 Only list status for specified storage
815 `--target` `<string>` ::
817 If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
821 An alias for 'pvesm scan zfs'.