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 `--storage` `<string>` ::
267 The storage identifier.
269 *pvesm glusterfsscan*
271 An alias for 'pvesm scan glusterfs'.
273 *pvesm help* `[OPTIONS]`
275 Get help about specified command.
277 `--extra-args` `<array>` ::
279 Shows help for a specific command
281 `--verbose` `<boolean>` ::
283 Verbose output format.
285 *pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
289 `<volume>`: `<string>` ::
293 `<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
297 `<filename>`: `<string>` ::
299 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.
301 `--base` `(?^:[a-z0-9_\-]{1,40})` ::
303 Base snapshot of an incremental stream
305 `--delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` ::
307 A snapshot to delete on success
309 `--with-snapshots` `<boolean>` ('default =' `0`)::
311 Whether the stream includes intermediate snapshots
315 An alias for 'pvesm scan iscsi'.
317 *pvesm list* `<storage>` `[OPTIONS]`
319 List storage content.
321 `<storage>`: `<string>` ::
323 The storage identifier.
325 `--content` `<string>` ::
327 Only list content of this type.
329 `--vmid` `<integer> (1 - N)` ::
331 Only list images for this VM
335 An alias for 'pvesm scan lvm'.
339 An alias for 'pvesm scan lvmthin'.
343 An alias for 'pvesm scan nfs'.
345 *pvesm path* `<volume>`
347 Get filesystem path for specified volume
349 `<volume>`: `<string>` ::
353 *pvesm remove* `<storage>`
355 Delete storage configuration.
357 `<storage>`: `<string>` ::
359 The storage identifier.
361 *pvesm scan cifs* `<server>` `[OPTIONS]`
363 Scan remote CIFS server.
365 `<server>`: `<string>` ::
367 The server address (name or IP).
369 `--domain` `<string>` ::
371 SMB domain (Workgroup).
373 `--password` `<password>` ::
377 `--username` `<string>` ::
381 *pvesm scan glusterfs* `<server>`
383 Scan remote GlusterFS server.
385 `<server>`: `<string>` ::
387 The server address (name or IP).
389 *pvesm scan iscsi* `<portal>`
391 Scan remote iSCSI server.
393 `<portal>`: `<string>` ::
395 The iSCSI portal (IP or DNS name with optional port).
399 List local LVM volume groups.
401 *pvesm scan lvmthin* `<vg>`
403 List local LVM Thin Pools.
405 `<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
407 no description available
409 *pvesm scan nfs* `<server>`
411 Scan remote NFS server.
413 `<server>`: `<string>` ::
415 The server address (name or IP).
419 Scan zfs pool list on local node.
421 *pvesm set* `<storage>` `[OPTIONS]`
423 Update storage configuration.
425 `<storage>`: `<string>` ::
427 The storage identifier.
429 `--blocksize` `<string>` ::
433 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
435 Set bandwidth/io limits various operations.
437 `--comstar_hg` `<string>` ::
439 host group for comstar views
441 `--comstar_tg` `<string>` ::
443 target group for comstar views
445 `--content` `<string>` ::
447 Allowed content types.
449 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
451 `--delete` `<string>` ::
453 A list of settings you want to delete.
455 `--digest` `<string>` ::
457 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
459 `--disable` `<boolean>` ::
461 Flag to disable the storage.
463 `--domain` `<string>` ::
467 `--format` `<string>` ::
469 Default image format.
471 `--fuse` `<boolean>` ::
473 Mount CephFS through FUSE.
475 `--is_mountpoint` `<string>` ('default =' `no`)::
477 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.
479 `--krbd` `<boolean>` ::
481 Always access rbd through krbd kernel module.
483 `--lio_tpg` `<string>` ::
485 target portal group for Linux LIO targets
487 `--maxfiles` `<integer> (0 - N)` ::
489 Maximal number of backup files per VM. Use '0' for unlimted.
491 `--mkdir` `<boolean>` ('default =' `yes`)::
493 Create the directory if it doesn't exist.
495 `--monhost` `<string>` ::
497 IP addresses of monitors (for external clusters).
499 `--nodes` `<string>` ::
501 List of cluster node names.
503 `--nowritecache` `<boolean>` ::
505 disable write caching on the target
507 `--options` `<string>` ::
509 NFS mount options (see 'man nfs')
511 `--password` `<string>` ::
513 Password for CIFS share.
515 `--pool` `<string>` ::
519 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
521 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.
523 `--saferemove` `<boolean>` ::
525 Zero-out data when removing LVs.
527 `--saferemove_throughput` `<string>` ::
529 Wipe throughput (cstream -t parameter value).
531 `--server` `<string>` ::
533 Server IP or DNS name.
535 `--server2` `<string>` ::
537 Backup volfile server IP or DNS name.
539 NOTE: Requires option(s): `server`
541 `--shared` `<boolean>` ::
543 Mark storage as shared.
545 `--smbversion` `<2.0 | 2.1 | 3.0>` ::
549 `--sparse` `<boolean>` ::
553 `--subdir` `<string>` ::
557 `--tagged_only` `<boolean>` ::
559 Only use logical volumes tagged with 'pve-vm-ID'.
561 `--transport` `<rdma | tcp | unix>` ::
563 Gluster transport: tcp or rdma
565 `--username` `<string>` ::
569 *pvesm status* `[OPTIONS]`
571 Get status for all datastores.
573 `--content` `<string>` ::
575 Only list stores which support this content type.
577 `--enabled` `<boolean>` ('default =' `0`)::
579 Only list stores which are enabled (not disabled in config).
581 `--format` `<boolean>` ('default =' `0`)::
583 Include information about formats
585 `--storage` `<string>` ::
587 Only list status for specified storage
589 `--target` `<string>` ::
591 If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
595 An alias for 'pvesm scan zfs'.