1 *pvesm* `<COMMAND> [ARGS] [OPTIONS]`
3 *pvesm add* `<type> <storage>` `[OPTIONS]`
7 `<type>`: `<cephfs | cifs | dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | pbs | 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 `--datastore` `<string>` ::
47 Proxmox backup server datastore name.
49 `--disable` `<boolean>` ::
51 Flag to disable the storage.
53 `--domain` `<string>` ::
57 `--encryption-key` `<filepath>` ::
59 Encryption key. Use 'autogen' to generate one automatically without passphrase.
61 `--export` `<string>` ::
65 `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
67 Certificate SHA 256 fingerprint.
69 `--format` `<string>` ::
73 `--fuse` `<boolean>` ::
75 Mount CephFS through FUSE.
77 `--is_mountpoint` `<string>` ('default =' `no`)::
79 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.
81 `--iscsiprovider` `<string>` ::
85 `--krbd` `<boolean>` ::
87 Always access rbd through krbd kernel module.
89 `--lio_tpg` `<string>` ::
91 target portal group for Linux LIO targets
93 `--maxfiles` `<integer> (0 - N)` ::
95 Maximal number of backup files per VM. Use '0' for unlimted.
97 `--mkdir` `<boolean>` ('default =' `yes`)::
99 Create the directory if it doesn't exist.
101 `--monhost` `<string>` ::
103 IP addresses of monitors (for external clusters).
105 `--mountpoint` `<string>` ::
109 `--nodes` `<string>` ::
111 List of cluster node names.
113 `--nowritecache` `<boolean>` ::
115 disable write caching on the target
117 `--options` `<string>` ::
119 NFS mount options (see 'man nfs')
121 `--password` `<password>` ::
123 Password for accessing the share/datastore.
125 `--path` `<string>` ::
129 `--pool` `<string>` ::
133 `--portal` `<string>` ::
135 iSCSI portal (IP or DNS name with optional port).
137 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
139 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.
141 `--saferemove` `<boolean>` ::
143 Zero-out data when removing LVs.
145 `--saferemove_throughput` `<string>` ::
147 Wipe throughput (cstream -t parameter value).
149 `--server` `<string>` ::
151 Server IP or DNS name.
153 `--server2` `<string>` ::
155 Backup volfile server IP or DNS name.
157 NOTE: Requires option(s): `server`
159 `--share` `<string>` ::
163 `--shared` `<boolean>` ::
165 Mark storage as shared.
167 `--smbversion` `<2.0 | 2.1 | 3.0>` ::
171 `--sparse` `<boolean>` ::
175 `--subdir` `<string>` ::
179 `--tagged_only` `<boolean>` ::
181 Only use logical volumes tagged with 'pve-vm-ID'.
183 `--target` `<string>` ::
187 `--thinpool` `<string>` ::
189 LVM thin pool LV name.
191 `--transport` `<rdma | tcp | unix>` ::
193 Gluster transport: tcp or rdma
195 `--username` `<string>` ::
199 `--vgname` `<string>` ::
203 `--volume` `<string>` ::
207 *pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
209 Allocate disk images.
211 `<storage>`: `<string>` ::
213 The storage identifier.
215 `<vmid>`: `<integer> (1 - N)` ::
219 `<filename>`: `<string>` ::
221 The name of the file to create.
223 `<size>`: `\d+[MG]?` ::
225 Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
227 `--format` `<qcow2 | raw | subvol>` ::
229 no description available
231 NOTE: Requires option(s): `size`
235 Returns APIVER and APIAGE.
239 An alias for 'pvesm scan cifs'.
241 *pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
243 Used internally to export a volume.
245 `<volume>`: `<string>` ::
249 `<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
253 `<filename>`: `<string>` ::
255 Destination file name
257 `--base` `(?^:[a-z0-9_\-]{1,40})` ::
259 Snapshot to start an incremental stream from
261 `--snapshot` `(?^:[a-z0-9_\-]{1,40})` ::
265 `--with-snapshots` `<boolean>` ('default =' `0`)::
267 Whether to include intermediate snapshots in the stream
269 *pvesm extractconfig* `<volume>`
271 Extract configuration from vzdump backup archive.
273 `<volume>`: `<string>` ::
277 *pvesm free* `<volume>` `[OPTIONS]`
281 `<volume>`: `<string>` ::
285 `--delay` `<integer> (1 - 30)` ::
287 Time to wait for the task to finish. We return 'null' if the task finish within that time.
289 `--storage` `<string>` ::
291 The storage identifier.
293 *pvesm glusterfsscan*
295 An alias for 'pvesm scan glusterfs'.
297 *pvesm help* `[OPTIONS]`
299 Get help about specified command.
301 `--extra-args` `<array>` ::
303 Shows help for a specific command
305 `--verbose` `<boolean>` ::
307 Verbose output format.
309 *pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
311 Used internally to import a volume.
313 `<volume>`: `<string>` ::
317 `<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
321 `<filename>`: `<string>` ::
323 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.
325 `--allow-rename` `<boolean>` ('default =' `0`)::
327 Choose a new volume ID if the requested volume ID already exists, instead of throwing an error.
329 `--base` `(?^:[a-z0-9_\-]{1,40})` ::
331 Base snapshot of an incremental stream
333 `--delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` ::
335 A snapshot to delete on success
337 `--with-snapshots` `<boolean>` ('default =' `0`)::
339 Whether the stream includes intermediate snapshots
343 An alias for 'pvesm scan iscsi'.
345 *pvesm list* `<storage>` `[OPTIONS]`
347 List storage content.
349 `<storage>`: `<string>` ::
351 The storage identifier.
353 `--content` `<string>` ::
355 Only list content of this type.
357 `--vmid` `<integer> (1 - N)` ::
359 Only list images for this VM
363 An alias for 'pvesm scan lvm'.
367 An alias for 'pvesm scan lvmthin'.
371 An alias for 'pvesm scan nfs'.
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 scan cifs* `<server>` `[OPTIONS]`
391 Scan remote CIFS server.
393 `<server>`: `<string>` ::
395 The server address (name or IP).
397 `--domain` `<string>` ::
399 SMB domain (Workgroup).
401 `--password` `<password>` ::
405 `--username` `<string>` ::
409 *pvesm scan glusterfs* `<server>`
411 Scan remote GlusterFS server.
413 `<server>`: `<string>` ::
415 The server address (name or IP).
417 *pvesm scan iscsi* `<portal>`
419 Scan remote iSCSI server.
421 `<portal>`: `<string>` ::
423 The iSCSI portal (IP or DNS name with optional port).
427 List local LVM volume groups.
429 *pvesm scan lvmthin* `<vg>`
431 List local LVM Thin Pools.
433 `<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
435 no description available
437 *pvesm scan nfs* `<server>`
439 Scan remote NFS server.
441 `<server>`: `<string>` ::
443 The server address (name or IP).
447 Scan zfs pool list on local node.
449 *pvesm set* `<storage>` `[OPTIONS]`
451 Update storage configuration.
453 `<storage>`: `<string>` ::
455 The storage identifier.
457 `--blocksize` `<string>` ::
461 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
463 Set bandwidth/io limits various operations.
465 `--comstar_hg` `<string>` ::
467 host group for comstar views
469 `--comstar_tg` `<string>` ::
471 target group for comstar views
473 `--content` `<string>` ::
475 Allowed content types.
477 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
479 `--delete` `<string>` ::
481 A list of settings you want to delete.
483 `--digest` `<string>` ::
485 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
487 `--disable` `<boolean>` ::
489 Flag to disable the storage.
491 `--domain` `<string>` ::
495 `--encryption-key` `<filepath>` ::
497 Encryption key. Use 'autogen' to generate one automatically without passphrase.
499 `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
501 Certificate SHA 256 fingerprint.
503 `--format` `<string>` ::
505 Default image format.
507 `--fuse` `<boolean>` ::
509 Mount CephFS through FUSE.
511 `--is_mountpoint` `<string>` ('default =' `no`)::
513 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.
515 `--krbd` `<boolean>` ::
517 Always access rbd through krbd kernel module.
519 `--lio_tpg` `<string>` ::
521 target portal group for Linux LIO targets
523 `--maxfiles` `<integer> (0 - N)` ::
525 Maximal number of backup files per VM. Use '0' for unlimted.
527 `--mkdir` `<boolean>` ('default =' `yes`)::
529 Create the directory if it doesn't exist.
531 `--monhost` `<string>` ::
533 IP addresses of monitors (for external clusters).
535 `--mountpoint` `<string>` ::
539 `--nodes` `<string>` ::
541 List of cluster node names.
543 `--nowritecache` `<boolean>` ::
545 disable write caching on the target
547 `--options` `<string>` ::
549 NFS mount options (see 'man nfs')
551 `--password` `<password>` ::
553 Password for accessing the share/datastore.
555 `--pool` `<string>` ::
559 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
561 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.
563 `--saferemove` `<boolean>` ::
565 Zero-out data when removing LVs.
567 `--saferemove_throughput` `<string>` ::
569 Wipe throughput (cstream -t parameter value).
571 `--server` `<string>` ::
573 Server IP or DNS name.
575 `--server2` `<string>` ::
577 Backup volfile server IP or DNS name.
579 NOTE: Requires option(s): `server`
581 `--shared` `<boolean>` ::
583 Mark storage as shared.
585 `--smbversion` `<2.0 | 2.1 | 3.0>` ::
589 `--sparse` `<boolean>` ::
593 `--subdir` `<string>` ::
597 `--tagged_only` `<boolean>` ::
599 Only use logical volumes tagged with 'pve-vm-ID'.
601 `--transport` `<rdma | tcp | unix>` ::
603 Gluster transport: tcp or rdma
605 `--username` `<string>` ::
609 *pvesm status* `[OPTIONS]`
611 Get status for all datastores.
613 `--content` `<string>` ::
615 Only list stores which support this content type.
617 `--enabled` `<boolean>` ('default =' `0`)::
619 Only list stores which are enabled (not disabled in config).
621 `--format` `<boolean>` ('default =' `0`)::
623 Include information about formats
625 `--storage` `<string>` ::
627 Only list status for specified storage
629 `--target` `<string>` ::
631 If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
635 An alias for 'pvesm scan zfs'.