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