1 *pvesm* `<COMMAND> [ARGS] [OPTIONS]`
3 *pvesm add* `<type> <storage>` `[OPTIONS]`
7 `<type>`: `<cephfs | cifs | dir | drbd | 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 tp encrypt a copy of the encryption-key which will be added to each encrypted backup.
97 `--maxfiles` `<integer> (0 - N)` ::
99 Maximal number of backup files per VM. Use '0' for unlimted.
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 `--nodes` `<string>` ::
119 List of cluster node names.
121 `--nowritecache` `<boolean>` ::
123 disable write caching on the target
125 `--options` `<string>` ::
127 NFS mount options (see 'man nfs')
129 `--password` `<password>` ::
131 Password for accessing the share/datastore.
133 `--path` `<string>` ::
137 `--pool` `<string>` ::
141 `--port` `<integer> (1 - 65535)` ('default =' `8007`)::
143 For non default port.
145 `--portal` `<string>` ::
147 iSCSI portal (IP or DNS name with optional port).
149 `--prune-backups` `[keep-all=<1|0>] [,keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
151 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.
153 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
155 The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.
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>`: `<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 `--with-snapshots` `<boolean>` ('default =' `0`)::
283 Whether to include intermediate snapshots in the stream
285 *pvesm extractconfig* `<volume>`
287 Extract configuration from vzdump backup archive.
289 `<volume>`: `<string>` ::
293 *pvesm free* `<volume>` `[OPTIONS]`
297 `<volume>`: `<string>` ::
301 `--delay` `<integer> (1 - 30)` ::
303 Time to wait for the task to finish. We return 'null' if the task finish within that time.
305 `--storage` `<string>` ::
307 The storage identifier.
309 *pvesm glusterfsscan*
311 An alias for 'pvesm scan glusterfs'.
313 *pvesm help* `[OPTIONS]`
315 Get help about specified command.
317 `--extra-args` `<array>` ::
319 Shows help for a specific command
321 `--verbose` `<boolean>` ::
323 Verbose output format.
325 *pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
327 Used internally to import a volume.
329 `<volume>`: `<string>` ::
333 `<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
337 `<filename>`: `<string>` ::
339 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.
341 `--allow-rename` `<boolean>` ('default =' `0`)::
343 Choose a new volume ID if the requested volume ID already exists, instead of throwing an error.
345 `--base` `(?^i:[a-z0-9_\-]{1,40})` ::
347 Base snapshot of an incremental stream
349 `--delete-snapshot` `(?^i:[a-z0-9_\-]{1,80})` ::
351 A snapshot to delete on success
353 `--with-snapshots` `<boolean>` ('default =' `0`)::
355 Whether the stream includes intermediate snapshots
359 An alias for 'pvesm scan iscsi'.
361 *pvesm list* `<storage>` `[OPTIONS]`
363 List storage content.
365 `<storage>`: `<string>` ::
367 The storage identifier.
369 `--content` `<string>` ::
371 Only list content of this type.
373 `--vmid` `<integer> (1 - N)` ::
375 Only list images for this VM
379 An alias for 'pvesm scan lvm'.
383 An alias for 'pvesm scan lvmthin'.
387 An alias for 'pvesm scan nfs'.
389 *pvesm path* `<volume>`
391 Get filesystem path for specified volume
393 `<volume>`: `<string>` ::
397 *pvesm prune-backups* `<storage>` `[OPTIONS]`
399 Prune backups. Only those using the standard naming scheme are considered.
400 If no keep options are specified, those from the storage configuration are
403 `<storage>`: `<string>` ::
405 The storage identifier.
407 `--dry-run` `<boolean>` ::
409 Only show what would be pruned, don't delete anything.
411 `--keep-all` `<boolean>` ::
413 Keep all backups. Conflicts with the other options when true.
415 `--keep-daily` `<N>` ::
417 Keep backups for the last <N> different days. If there is morethan one backup for a single day, only the latest one is kept.
419 `--keep-hourly` `<N>` ::
421 Keep backups for the last <N> different hours. If there is morethan one backup for a single hour, only the latest one is kept.
423 `--keep-last` `<N>` ::
425 Keep the last <N> backups.
427 `--keep-monthly` `<N>` ::
429 Keep backups for the last <N> different months. If there is morethan one backup for a single month, only the latest one is kept.
431 `--keep-weekly` `<N>` ::
433 Keep backups for the last <N> different weeks. If there is morethan one backup for a single week, only the latest one is kept.
435 `--keep-yearly` `<N>` ::
437 Keep backups for the last <N> different years. If there is morethan one backup for a single year, only the latest one is kept.
439 `--type` `<lxc | qemu>` ::
441 Either 'qemu' or 'lxc'. Only consider backups for guests of this type.
443 `--vmid` `<integer> (1 - N)` ::
445 Only consider backups for this guest.
447 *pvesm remove* `<storage>`
449 Delete storage configuration.
451 `<storage>`: `<string>` ::
453 The storage identifier.
455 *pvesm scan cifs* `<server>` `[OPTIONS]`
457 Scan remote CIFS server.
459 `<server>`: `<string>` ::
461 The server address (name or IP).
463 `--domain` `<string>` ::
465 SMB domain (Workgroup).
467 `--password` `<password>` ::
471 `--username` `<string>` ::
475 *pvesm scan glusterfs* `<server>`
477 Scan remote GlusterFS server.
479 `<server>`: `<string>` ::
481 The server address (name or IP).
483 *pvesm scan iscsi* `<portal>`
485 Scan remote iSCSI server.
487 `<portal>`: `<string>` ::
489 The iSCSI portal (IP or DNS name with optional port).
493 List local LVM volume groups.
495 *pvesm scan lvmthin* `<vg>`
497 List local LVM Thin Pools.
499 `<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
501 no description available
503 *pvesm scan nfs* `<server>`
505 Scan remote NFS server.
507 `<server>`: `<string>` ::
509 The server address (name or IP).
511 *pvesm scan pbs* `<server> <username> --password <string>` `[OPTIONS]` `[FORMAT_OPTIONS]`
513 Scan remote Proxmox Backup Server.
515 `<server>`: `<string>` ::
517 The server address (name or IP).
519 `<username>`: `<string>` ::
521 User-name or API token-ID.
523 `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
525 Certificate SHA 256 fingerprint.
527 `--password` `<string>` ::
529 User password or API token secret.
531 `--port` `<integer> (1 - 65535)` ('default =' `8007`)::
537 Scan zfs pool list on local node.
539 *pvesm set* `<storage>` `[OPTIONS]`
541 Update storage configuration.
543 `<storage>`: `<string>` ::
545 The storage identifier.
547 `--blocksize` `<string>` ::
551 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
553 Set bandwidth/io limits various operations.
555 `--comstar_hg` `<string>` ::
557 host group for comstar views
559 `--comstar_tg` `<string>` ::
561 target group for comstar views
563 `--content` `<string>` ::
565 Allowed content types.
567 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
569 `--delete` `<string>` ::
571 A list of settings you want to delete.
573 `--digest` `<string>` ::
575 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
577 `--disable` `<boolean>` ::
579 Flag to disable the storage.
581 `--domain` `<string>` ::
585 `--encryption-key` `a file containing an encryption key, or the special value "autogen"` ::
587 Encryption key. Use 'autogen' to generate one automatically without passphrase.
589 `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
591 Certificate SHA 256 fingerprint.
593 `--format` `<string>` ::
595 Default image format.
597 `--fuse` `<boolean>` ::
599 Mount CephFS through FUSE.
601 `--is_mountpoint` `<string>` ('default =' `no`)::
603 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.
605 `--krbd` `<boolean>` ::
607 Always access rbd through krbd kernel module.
609 `--lio_tpg` `<string>` ::
611 target portal group for Linux LIO targets
613 `--master-pubkey` `a file containing a PEM-formatted master public key` ::
615 Base64-encoded, PEM-formatted public RSA key. Used tp encrypt a copy of the encryption-key which will be added to each encrypted backup.
617 `--maxfiles` `<integer> (0 - N)` ::
619 Maximal number of backup files per VM. Use '0' for unlimted.
621 `--mkdir` `<boolean>` ('default =' `yes`)::
623 Create the directory if it doesn't exist.
625 `--monhost` `<string>` ::
627 IP addresses of monitors (for external clusters).
629 `--mountpoint` `<string>` ::
633 `--namespace` `<string>` ::
637 `--nodes` `<string>` ::
639 List of cluster node names.
641 `--nowritecache` `<boolean>` ::
643 disable write caching on the target
645 `--options` `<string>` ::
647 NFS mount options (see 'man nfs')
649 `--password` `<password>` ::
651 Password for accessing the share/datastore.
653 `--pool` `<string>` ::
657 `--port` `<integer> (1 - 65535)` ('default =' `8007`)::
659 For non default port.
661 `--prune-backups` `[keep-all=<1|0>] [,keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
663 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.
665 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
667 The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.
669 `--saferemove` `<boolean>` ::
671 Zero-out data when removing LVs.
673 `--saferemove_throughput` `<string>` ::
675 Wipe throughput (cstream -t parameter value).
677 `--server` `<string>` ::
679 Server IP or DNS name.
681 `--server2` `<string>` ::
683 Backup volfile server IP or DNS name.
685 NOTE: Requires option(s): `server`
687 `--shared` `<boolean>` ::
689 Mark storage as shared.
691 `--smbversion` `<2.0 | 2.1 | 3.0>` ::
695 `--sparse` `<boolean>` ::
699 `--subdir` `<string>` ::
703 `--tagged_only` `<boolean>` ::
705 Only use logical volumes tagged with 'pve-vm-ID'.
707 `--transport` `<rdma | tcp | unix>` ::
709 Gluster transport: tcp or rdma
711 `--username` `<string>` ::
715 *pvesm status* `[OPTIONS]`
717 Get status for all datastores.
719 `--content` `<string>` ::
721 Only list stores which support this content type.
723 `--enabled` `<boolean>` ('default =' `0`)::
725 Only list stores which are enabled (not disabled in config).
727 `--format` `<boolean>` ('default =' `0`)::
729 Include information about formats
731 `--storage` `<string>` ::
733 Only list status for specified storage
735 `--target` `<string>` ::
737 If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
741 An alias for 'pvesm scan zfs'.