1 *pvesm* `<COMMAND> [ARGS] [OPTIONS]`
3 *pvesm add* `<type> <storage>` `[OPTIONS]`
7 `<type>`: `<cephfs | cifs | dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | 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 `--disable` `<boolean>` ::
47 Flag to disable the storage.
49 `--domain` `<string>` ::
53 `--export` `<string>` ::
57 `--format` `<string>` ::
61 `--fuse` `<boolean>` ::
63 Mount CephFS through FUSE.
65 `--is_mountpoint` `<string>` ('default =' `no`)::
67 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.
69 `--iscsiprovider` `<string>` ::
73 `--krbd` `<boolean>` ::
75 Always access rbd through krbd kernel module.
77 `--lio_tpg` `<string>` ::
79 target portal group for Linux LIO targets
81 `--maxfiles` `<integer> (0 - N)` ::
83 Maximal number of backup files per VM. Use '0' for unlimted.
85 `--mkdir` `<boolean>` ('default =' `yes`)::
87 Create the directory if it doesn't exist.
89 `--monhost` `<string>` ::
91 IP addresses of monitors (for external clusters).
93 `--nodes` `<string>` ::
95 List of cluster node names.
97 `--nowritecache` `<boolean>` ::
99 disable write caching on the target
101 `--options` `<string>` ::
103 NFS mount options (see 'man nfs')
105 `--password` `<password>` ::
107 Password for CIFS share.
109 `--path` `<string>` ::
113 `--pool` `<string>` ::
117 `--portal` `<string>` ::
119 iSCSI portal (IP or DNS name with optional port).
121 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
123 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.
125 `--saferemove` `<boolean>` ::
127 Zero-out data when removing LVs.
129 `--saferemove_throughput` `<string>` ::
131 Wipe throughput (cstream -t parameter value).
133 `--server` `<string>` ::
135 Server IP or DNS name.
137 `--server2` `<string>` ::
139 Backup volfile server IP or DNS name.
141 NOTE: Requires option(s): `server`
143 `--share` `<string>` ::
147 `--shared` `<boolean>` ::
149 Mark storage as shared.
151 `--smbversion` `<2.0 | 2.1 | 3.0>` ::
155 `--sparse` `<boolean>` ::
159 `--subdir` `<string>` ::
163 `--tagged_only` `<boolean>` ::
165 Only use logical volumes tagged with 'pve-vm-ID'.
167 `--target` `<string>` ::
171 `--thinpool` `<string>` ::
173 LVM thin pool LV name.
175 `--transport` `<rdma | tcp | unix>` ::
177 Gluster transport: tcp or rdma
179 `--username` `<string>` ::
183 `--vgname` `<string>` ::
187 `--volume` `<string>` ::
191 *pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
193 Allocate disk images.
195 `<storage>`: `<string>` ::
197 The storage identifier.
199 `<vmid>`: `<integer> (1 - N)` ::
203 `<filename>`: `<string>` ::
205 The name of the file to create.
207 `<size>`: `\d+[MG]?` ::
209 Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
211 `--format` `<qcow2 | raw | subvol>` ::
213 no description available
215 NOTE: Requires option(s): `size`
219 An alias for 'pvesm scan cifs'.
221 *pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
225 `<volume>`: `<string>` ::
229 `<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
233 `<filename>`: `<string>` ::
235 Destination file name
237 `--base` `(?^:[a-z0-9_\-]{1,40})` ::
239 Snapshot to start an incremental stream from
241 `--snapshot` `(?^:[a-z0-9_\-]{1,40})` ::
245 `--with-snapshots` `<boolean>` ('default =' `0`)::
247 Whether to include intermediate snapshots in the stream
249 *pvesm extractconfig* `<volume>`
251 Extract configuration from vzdump backup archive.
253 `<volume>`: `<string>` ::
257 *pvesm free* `<volume>` `[OPTIONS]`
261 `<volume>`: `<string>` ::
265 `--delay` `<integer> (1 - 30)` ::
267 Time to wait for the task to finish. We return 'null' if the task finish within that time.
269 `--storage` `<string>` ::
271 The storage identifier.
273 *pvesm glusterfsscan*
275 An alias for 'pvesm scan glusterfs'.
277 *pvesm help* `[OPTIONS]`
279 Get help about specified command.
281 `--extra-args` `<array>` ::
283 Shows help for a specific command
285 `--verbose` `<boolean>` ::
287 Verbose output format.
289 *pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
293 `<volume>`: `<string>` ::
297 `<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
301 `<filename>`: `<string>` ::
303 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.
305 `--base` `(?^:[a-z0-9_\-]{1,40})` ::
307 Base snapshot of an incremental stream
309 `--delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` ::
311 A snapshot to delete on success
313 `--with-snapshots` `<boolean>` ('default =' `0`)::
315 Whether the stream includes intermediate snapshots
319 An alias for 'pvesm scan iscsi'.
321 *pvesm list* `<storage>` `[OPTIONS]`
323 List storage content.
325 `<storage>`: `<string>` ::
327 The storage identifier.
329 `--content` `<string>` ::
331 Only list content of this type.
333 `--vmid` `<integer> (1 - N)` ::
335 Only list images for this VM
339 An alias for 'pvesm scan lvm'.
343 An alias for 'pvesm scan lvmthin'.
347 An alias for 'pvesm scan nfs'.
349 *pvesm path* `<volume>`
351 Get filesystem path for specified volume
353 `<volume>`: `<string>` ::
357 *pvesm remove* `<storage>`
359 Delete storage configuration.
361 `<storage>`: `<string>` ::
363 The storage identifier.
365 *pvesm scan cifs* `<server>` `[OPTIONS]`
367 Scan remote CIFS server.
369 `<server>`: `<string>` ::
371 The server address (name or IP).
373 `--domain` `<string>` ::
375 SMB domain (Workgroup).
377 `--password` `<password>` ::
381 `--username` `<string>` ::
385 *pvesm scan glusterfs* `<server>`
387 Scan remote GlusterFS server.
389 `<server>`: `<string>` ::
391 The server address (name or IP).
393 *pvesm scan iscsi* `<portal>`
395 Scan remote iSCSI server.
397 `<portal>`: `<string>` ::
399 The iSCSI portal (IP or DNS name with optional port).
403 List local LVM volume groups.
405 *pvesm scan lvmthin* `<vg>`
407 List local LVM Thin Pools.
409 `<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
411 no description available
413 *pvesm scan nfs* `<server>`
415 Scan remote NFS server.
417 `<server>`: `<string>` ::
419 The server address (name or IP).
423 Scan zfs pool list on local node.
425 *pvesm set* `<storage>` `[OPTIONS]`
427 Update storage configuration.
429 `<storage>`: `<string>` ::
431 The storage identifier.
433 `--blocksize` `<string>` ::
437 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
439 Set bandwidth/io limits various operations.
441 `--comstar_hg` `<string>` ::
443 host group for comstar views
445 `--comstar_tg` `<string>` ::
447 target group for comstar views
449 `--content` `<string>` ::
451 Allowed content types.
453 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
455 `--delete` `<string>` ::
457 A list of settings you want to delete.
459 `--digest` `<string>` ::
461 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
463 `--disable` `<boolean>` ::
465 Flag to disable the storage.
467 `--domain` `<string>` ::
471 `--format` `<string>` ::
473 Default image format.
475 `--fuse` `<boolean>` ::
477 Mount CephFS through FUSE.
479 `--is_mountpoint` `<string>` ('default =' `no`)::
481 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.
483 `--krbd` `<boolean>` ::
485 Always access rbd through krbd kernel module.
487 `--lio_tpg` `<string>` ::
489 target portal group for Linux LIO targets
491 `--maxfiles` `<integer> (0 - N)` ::
493 Maximal number of backup files per VM. Use '0' for unlimted.
495 `--mkdir` `<boolean>` ('default =' `yes`)::
497 Create the directory if it doesn't exist.
499 `--monhost` `<string>` ::
501 IP addresses of monitors (for external clusters).
503 `--nodes` `<string>` ::
505 List of cluster node names.
507 `--nowritecache` `<boolean>` ::
509 disable write caching on the target
511 `--options` `<string>` ::
513 NFS mount options (see 'man nfs')
515 `--password` `<string>` ::
517 Password for CIFS share.
519 `--pool` `<string>` ::
523 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
525 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.
527 `--saferemove` `<boolean>` ::
529 Zero-out data when removing LVs.
531 `--saferemove_throughput` `<string>` ::
533 Wipe throughput (cstream -t parameter value).
535 `--server` `<string>` ::
537 Server IP or DNS name.
539 `--server2` `<string>` ::
541 Backup volfile server IP or DNS name.
543 NOTE: Requires option(s): `server`
545 `--shared` `<boolean>` ::
547 Mark storage as shared.
549 `--smbversion` `<2.0 | 2.1 | 3.0>` ::
553 `--sparse` `<boolean>` ::
557 `--subdir` `<string>` ::
561 `--tagged_only` `<boolean>` ::
563 Only use logical volumes tagged with 'pve-vm-ID'.
565 `--transport` `<rdma | tcp | unix>` ::
567 Gluster transport: tcp or rdma
569 `--username` `<string>` ::
573 *pvesm status* `[OPTIONS]`
575 Get status for all datastores.
577 `--content` `<string>` ::
579 Only list stores which support this content type.
581 `--enabled` `<boolean>` ('default =' `0`)::
583 Only list stores which are enabled (not disabled in config).
585 `--format` `<boolean>` ('default =' `0`)::
587 Include information about formats
589 `--storage` `<string>` ::
591 Only list status for specified storage
593 `--target` `<string>` ::
595 If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
599 An alias for 'pvesm scan zfs'.