1 *pvesm* `<COMMAND> [ARGS] [OPTIONS]`
3 *pvesm add* `<type> <storage>` `[OPTIONS]`
7 `<type>`: `<cifs | dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | 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 `--is_mountpoint` `<string>` ('default =' `no`)::
63 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.
65 `--iscsiprovider` `<string>` ::
69 `--krbd` `<boolean>` ::
71 Access rbd through krbd kernel module.
73 `--maxfiles` `<integer> (0 - N)` ::
75 Maximal number of backup files per VM. Use '0' for unlimted.
77 `--mkdir` `<boolean>` ('default =' `yes`)::
79 Create the directory if it doesn't exist.
81 `--monhost` `<string>` ::
83 IP addresses of monitors (for external clusters).
85 `--nodes` `<string>` ::
87 List of cluster node names.
89 `--nowritecache` `<boolean>` ::
91 disable write caching on the target
93 `--options` `<string>` ::
95 NFS mount options (see 'man nfs')
99 Password for CIFS share.
101 `--path` `<string>` ::
105 `--pool` `<string>` ::
109 `--portal` `<string>` ::
111 iSCSI portal (IP or DNS name with optional port).
113 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
115 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.
117 `--saferemove` `<boolean>` ::
119 Zero-out data when removing LVs.
121 `--saferemove_throughput` `<string>` ::
123 Wipe throughput (cstream -t parameter value).
125 `--server` `<string>` ::
127 Server IP or DNS name.
129 `--server2` `<string>` ::
131 Backup volfile server IP or DNS name.
133 NOTE: Requires option(s): `server`
135 `--share` `<string>` ::
139 `--shared` `<boolean>` ::
141 Mark storage as shared.
143 `--smbversion` `<string>` ::
145 no description available
147 `--sparse` `<boolean>` ::
151 `--tagged_only` `<boolean>` ::
153 Only use logical volumes tagged with 'pve-vm-ID'.
155 `--target` `<string>` ::
159 `--thinpool` `<string>` ::
161 LVM thin pool LV name.
163 `--transport` `<rdma | tcp | unix>` ::
165 Gluster transport: tcp or rdma
167 `--username` `<string>` ::
171 `--vgname` `<string>` ::
175 `--volume` `<string>` ::
179 *pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
181 Allocate disk images.
183 `<storage>`: `<string>` ::
185 The storage identifier.
187 `<vmid>`: `<integer> (1 - N)` ::
191 `<filename>`: `<string>` ::
193 The name of the file to create.
195 `<size>`: `\d+[MG]?` ::
197 Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
199 `--format` `<qcow2 | raw | subvol>` ::
201 no description available
203 NOTE: Requires option(s): `size`
205 *pvesm cifsscan* `<server>` `[OPTIONS]`
207 Scan remote CIFS server.
209 `<server>`: `<string>` ::
211 no description available
213 `--domain` `<string>` ::
215 no description available
219 no description available
221 `--username` `<string>` ::
223 no description available
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 `--storage` `<string>` ::
271 The storage identifier.
273 *pvesm glusterfsscan* `<server>`
275 Scan remote GlusterFS server.
277 `<server>`: `<string>` ::
279 no description available
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>` ::
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
321 *pvesm iscsiscan* `--portal <string>` `[OPTIONS]`
323 Scan remote iSCSI server.
325 `--portal` `<string>` ::
327 no description available
329 *pvesm list* `<storage>` `[OPTIONS]`
331 List storage content.
333 `<storage>`: `<string>` ::
335 The storage identifier.
337 `--content` `<string>` ::
339 Only list content of this type.
341 `--vmid` `<integer> (1 - N)` ::
343 Only list images for this VM
347 List local LVM volume groups.
349 *pvesm lvmthinscan* `<vg>`
351 List local LVM Thin Pools.
353 `<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
355 no description available
357 *pvesm nfsscan* `<server>`
359 Scan remote NFS server.
361 `<server>`: `<string>` ::
363 no description available
365 *pvesm path* `<volume>`
367 Get filesystem path for specified volume
369 `<volume>`: `<string>` ::
373 *pvesm remove* `<storage>`
375 Delete storage configuration.
377 `<storage>`: `<string>` ::
379 The storage identifier.
381 *pvesm set* `<storage>` `[OPTIONS]`
383 Update storage configuration.
385 `<storage>`: `<string>` ::
387 The storage identifier.
389 `--blocksize` `<string>` ::
393 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
395 Set bandwidth/io limits various operations.
397 `--comstar_hg` `<string>` ::
399 host group for comstar views
401 `--comstar_tg` `<string>` ::
403 target group for comstar views
405 `--content` `<string>` ::
407 Allowed content types.
409 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
411 `--delete` `<string>` ::
413 A list of settings you want to delete.
415 `--digest` `<string>` ::
417 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
419 `--disable` `<boolean>` ::
421 Flag to disable the storage.
423 `--domain` `<string>` ::
427 `--format` `<string>` ::
429 Default image format.
431 `--is_mountpoint` `<string>` ('default =' `no`)::
433 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.
435 `--krbd` `<boolean>` ::
437 Access rbd through krbd kernel module.
439 `--maxfiles` `<integer> (0 - N)` ::
441 Maximal number of backup files per VM. Use '0' for unlimted.
443 `--mkdir` `<boolean>` ('default =' `yes`)::
445 Create the directory if it doesn't exist.
447 `--monhost` `<string>` ::
449 IP addresses of monitors (for external clusters).
451 `--nodes` `<string>` ::
453 List of cluster node names.
455 `--nowritecache` `<boolean>` ::
457 disable write caching on the target
459 `--options` `<string>` ::
461 NFS mount options (see 'man nfs')
465 Password for CIFS share.
467 `--pool` `<string>` ::
471 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
473 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.
475 `--saferemove` `<boolean>` ::
477 Zero-out data when removing LVs.
479 `--saferemove_throughput` `<string>` ::
481 Wipe throughput (cstream -t parameter value).
483 `--server` `<string>` ::
485 Server IP or DNS name.
487 `--server2` `<string>` ::
489 Backup volfile server IP or DNS name.
491 NOTE: Requires option(s): `server`
493 `--shared` `<boolean>` ::
495 Mark storage as shared.
497 `--smbversion` `<string>` ::
499 no description available
501 `--sparse` `<boolean>` ::
505 `--tagged_only` `<boolean>` ::
507 Only use logical volumes tagged with 'pve-vm-ID'.
509 `--transport` `<rdma | tcp | unix>` ::
511 Gluster transport: tcp or rdma
513 `--username` `<string>` ::
517 *pvesm status* `[OPTIONS]`
519 Get status for all datastores.
521 `--content` `<string>` ::
523 Only list stores which support this content type.
525 `--enabled` `<boolean>` ('default =' `0`)::
527 Only list stores which are enabled (not disabled in config).
529 `--format` `<boolean>` ('default =' `0`)::
531 Include information about formats
533 `--storage` `<string>` ::
535 Only list status for specified storage
537 `--target` `<string>` ::
539 If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
543 Scan zfs pool list on local node.