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