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