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