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 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 cluster node names.
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 Mark storage as shared.
215 `--smbversion` `<2.0 | 2.1 | 3 | 3.0 | 3.11 | default>` ('default =' `default`)::
217 SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server.
219 `--sparse` `<boolean>` ::
223 `--subdir` `<string>` ::
227 `--tagged_only` `<boolean>` ::
229 Only use logical volumes tagged with 'pve-vm-ID'.
231 `--target` `<string>` ::
235 `--thinpool` `<string>` ::
237 LVM thin pool LV name.
239 `--transport` `<rdma | tcp | unix>` ::
241 Gluster transport: tcp or rdma
243 `--username` `<string>` ::
247 `--vgname` `<string>` ::
251 `--volume` `<string>` ::
255 *pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
257 Allocate disk images.
259 `<storage>`: `<string>` ::
261 The storage identifier.
263 `<vmid>`: `<integer> (100 - 999999999)` ::
267 `<filename>`: `<string>` ::
269 The name of the file to create.
271 `<size>`: `\d+[MG]?` ::
273 Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
275 `--format` `<qcow2 | raw | subvol>` ::
277 no description available
279 NOTE: Requires option(s): `size`
283 Returns APIVER and APIAGE.
287 An alias for 'pvesm scan cifs'.
289 *pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
291 Used internally to export a volume.
293 `<volume>`: `<string>` ::
297 `<format>`: `<btrfs | qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
301 `<filename>`: `<string>` ::
303 Destination file name
305 `--base` `(?^i:[a-z0-9_\-]{1,40})` ::
307 Snapshot to start an incremental stream from
309 `--snapshot` `(?^i:[a-z0-9_\-]{1,40})` ::
313 `--snapshot-list` `<string>` ::
315 Ordered list of snapshots to transfer
317 `--with-snapshots` `<boolean>` ('default =' `0`)::
319 Whether to include intermediate snapshots in the stream
321 *pvesm extractconfig* `<volume>`
323 Extract configuration from vzdump backup archive.
325 `<volume>`: `<string>` ::
329 *pvesm free* `<volume>` `[OPTIONS]`
333 `<volume>`: `<string>` ::
337 `--delay` `<integer> (1 - 30)` ::
339 Time to wait for the task to finish. We return 'null' if the task finish within that time.
341 `--storage` `<string>` ::
343 The storage identifier.
345 *pvesm glusterfsscan*
347 An alias for 'pvesm scan glusterfs'.
349 *pvesm help* `[OPTIONS]`
351 Get help about specified command.
353 `--extra-args` `<array>` ::
355 Shows help for a specific command
357 `--verbose` `<boolean>` ::
359 Verbose output format.
361 *pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
363 Used internally to import a volume.
365 `<volume>`: `<string>` ::
369 `<format>`: `<btrfs | qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
373 `<filename>`: `<string>` ::
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.
377 `--allow-rename` `<boolean>` ('default =' `0`)::
379 Choose a new volume ID if the requested volume ID already exists, instead of throwing an error.
381 `--base` `(?^i:[a-z0-9_\-]{1,40})` ::
383 Base snapshot of an incremental stream
385 `--delete-snapshot` `(?^i:[a-z0-9_\-]{1,80})` ::
387 A snapshot to delete on success
389 `--snapshot` `(?^i:[a-z0-9_\-]{1,40})` ::
391 The current-state snapshot if the stream contains snapshots
393 `--with-snapshots` `<boolean>` ('default =' `0`)::
395 Whether the stream includes intermediate snapshots
399 An alias for 'pvesm scan iscsi'.
401 *pvesm list* `<storage>` `[OPTIONS]`
403 List storage content.
405 `<storage>`: `<string>` ::
407 The storage identifier.
409 `--content` `<string>` ::
411 Only list content of this type.
413 `--vmid` `<integer> (100 - 999999999)` ::
415 Only list images for this VM
419 An alias for 'pvesm scan lvm'.
423 An alias for 'pvesm scan lvmthin'.
427 An alias for 'pvesm scan nfs'.
429 *pvesm path* `<volume>`
431 Get filesystem path for specified volume
433 `<volume>`: `<string>` ::
437 *pvesm prune-backups* `<storage>` `[OPTIONS]`
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
443 `<storage>`: `<string>` ::
445 The storage identifier.
447 `--dry-run` `<boolean>` ::
449 Only show what would be pruned, don't delete anything.
451 `--keep-all` `<boolean>` ::
453 Keep all backups. Conflicts with the other options when true.
455 `--keep-daily` `<N>` ::
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.
459 `--keep-hourly` `<N>` ::
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.
463 `--keep-last` `<N>` ::
465 Keep the last <N> backups.
467 `--keep-monthly` `<N>` ::
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.
471 `--keep-weekly` `<N>` ::
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.
475 `--keep-yearly` `<N>` ::
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.
479 `--type` `<lxc | qemu>` ::
481 Either 'qemu' or 'lxc'. Only consider backups for guests of this type.
483 `--vmid` `<integer> (100 - 999999999)` ::
485 Only consider backups for this guest.
487 *pvesm remove* `<storage>`
489 Delete storage configuration.
491 `<storage>`: `<string>` ::
493 The storage identifier.
495 *pvesm scan cifs* `<server>` `[OPTIONS]`
497 Scan remote CIFS server.
499 `<server>`: `<string>` ::
501 The server address (name or IP).
503 `--domain` `<string>` ::
505 SMB domain (Workgroup).
507 `--password` `<password>` ::
511 `--username` `<string>` ::
515 *pvesm scan glusterfs* `<server>`
517 Scan remote GlusterFS server.
519 `<server>`: `<string>` ::
521 The server address (name or IP).
523 *pvesm scan iscsi* `<portal>`
525 Scan remote iSCSI server.
527 `<portal>`: `<string>` ::
529 The iSCSI portal (IP or DNS name with optional port).
533 List local LVM volume groups.
535 *pvesm scan lvmthin* `<vg>`
537 List local LVM Thin Pools.
539 `<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
541 no description available
543 *pvesm scan nfs* `<server>`
545 Scan remote NFS server.
547 `<server>`: `<string>` ::
549 The server address (name or IP).
551 *pvesm scan pbs* `<server> <username> --password <string>` `[OPTIONS]` `[FORMAT_OPTIONS]`
553 Scan remote Proxmox Backup Server.
555 `<server>`: `<string>` ::
557 The server address (name or IP).
559 `<username>`: `<string>` ::
561 User-name or API token-ID.
563 `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
565 Certificate SHA 256 fingerprint.
567 `--password` `<string>` ::
569 User password or API token secret.
571 `--port` `<integer> (1 - 65535)` ('default =' `8007`)::
577 Scan zfs pool list on local node.
579 *pvesm set* `<storage>` `[OPTIONS]`
581 Update storage configuration.
583 `<storage>`: `<string>` ::
585 The storage identifier.
587 `--blocksize` `<string>` ::
591 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
593 Set I/O bandwidth limit for various operations (in KiB/s).
595 `--comstar_hg` `<string>` ::
597 host group for comstar views
599 `--comstar_tg` `<string>` ::
601 target group for comstar views
603 `--content` `<string>` ::
605 Allowed content types.
607 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
609 `--content-dirs` `<string>` ::
611 Overrides for default content type directories.
613 `--create-base-path` `<boolean>` ('default =' `yes`)::
615 Create the base directory if it doesn't exist.
617 `--create-subdirs` `<boolean>` ('default =' `yes`)::
619 Populate the directory with the default structure.
621 `--data-pool` `<string>` ::
623 Data Pool (for erasure coding only)
625 `--delete` `<string>` ::
627 A list of settings you want to delete.
629 `--digest` `<string>` ::
631 Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
633 `--disable` `<boolean>` ::
635 Flag to disable the storage.
637 `--domain` `<string>` ::
641 `--encryption-key` `a file containing an encryption key, or the special value "autogen"` ::
643 Encryption key. Use 'autogen' to generate one automatically without passphrase.
645 `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
647 Certificate SHA 256 fingerprint.
649 `--format` `<string>` ::
651 Default image format.
653 `--fs-name` `<string>` ::
655 The Ceph filesystem name.
657 `--fuse` `<boolean>` ::
659 Mount CephFS through FUSE.
661 `--is_mountpoint` `<string>` ('default =' `no`)::
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.
665 `--keyring` `file containing the keyring to authenticate in the Ceph cluster` ::
667 Client keyring contents (for external clusters).
669 `--krbd` `<boolean>` ::
671 Always access rbd through krbd kernel module.
673 `--lio_tpg` `<string>` ::
675 target portal group for Linux LIO targets
677 `--master-pubkey` `a file containing a PEM-formatted master public key` ::
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.
681 `--max-protected-backups` `<integer> (-1 - N)` ('default =' `Unlimited for users with Datastore.Allocate privilege, 5 for other users`)::
683 Maximal number of protected backups per guest. Use '-1' for unlimited.
685 `--maxfiles` `<integer> (0 - N)` ::
687 Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited.
689 `--mkdir` `<boolean>` ('default =' `yes`)::
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.
693 `--monhost` `<string>` ::
695 IP addresses of monitors (for external clusters).
697 `--mountpoint` `<string>` ::
701 `--namespace` `<string>` ::
705 `--nocow` `<boolean>` ('default =' `0`)::
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.
709 `--nodes` `<string>` ::
711 List of cluster node names.
713 `--nowritecache` `<boolean>` ::
715 disable write caching on the target
717 `--options` `<string>` ::
719 NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs')
721 `--password` `<password>` ::
723 Password for accessing the share/datastore.
725 `--pool` `<string>` ::
729 `--port` `<integer> (1 - 65535)` ('default =' `8007`)::
731 For non default port.
733 `--preallocation` `<falloc | full | metadata | off>` ('default =' `metadata`)::
735 Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off.
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>]` ::
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.
741 `--saferemove` `<boolean>` ::
743 Zero-out data when removing LVs.
745 `--saferemove_throughput` `<string>` ::
747 Wipe throughput (cstream -t parameter value).
749 `--server` `<string>` ::
751 Server IP or DNS name.
753 `--server2` `<string>` ::
755 Backup volfile server IP or DNS name.
757 NOTE: Requires option(s): `server`
759 `--shared` `<boolean>` ::
761 Mark storage as shared.
763 `--smbversion` `<2.0 | 2.1 | 3 | 3.0 | 3.11 | default>` ('default =' `default`)::
765 SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server.
767 `--sparse` `<boolean>` ::
771 `--subdir` `<string>` ::
775 `--tagged_only` `<boolean>` ::
777 Only use logical volumes tagged with 'pve-vm-ID'.
779 `--transport` `<rdma | tcp | unix>` ::
781 Gluster transport: tcp or rdma
783 `--username` `<string>` ::
787 *pvesm status* `[OPTIONS]`
789 Get status for all datastores.
791 `--content` `<string>` ::
793 Only list stores which support this content type.
795 `--enabled` `<boolean>` ('default =' `0`)::
797 Only list stores which are enabled (not disabled in config).
799 `--format` `<boolean>` ('default =' `0`)::
801 Include information about formats
803 `--storage` `<string>` ::
805 Only list status for specified storage
807 `--target` `<string>` ::
809 If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
813 An alias for 'pvesm scan zfs'.