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