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