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