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