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