1 *pvesm* `<COMMAND> [ARGS] [OPTIONS]`
3 *pvesm add* `<type> <storage>` `[OPTIONS]`
7 `<type>`: `<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 `--comstar_hg` `<string>` ::
29 host group for comstar views
31 `--comstar_tg` `<string>` ::
33 target group for comstar views
35 `--content` `<string>` ::
37 Allowed content types.
39 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
41 `--disable` `<boolean>` ::
43 Flag to disable the storage.
45 `--export` `<string>` ::
49 `--format` `<string>` ::
53 `--is_mountpoint` `<string>` ('default =' `no`)::
55 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.
57 `--iscsiprovider` `<string>` ::
61 `--krbd` `<boolean>` ::
63 Access rbd through krbd kernel module.
65 `--maxfiles` `<integer> (0 - N)` ::
67 Maximal number of backup files per VM. Use '0' for unlimted.
69 `--mkdir` `<boolean>` ('default =' `yes`)::
71 Create the directory if it doesn't exist.
73 `--monhost` `<string>` ::
75 IP addresses of monitors (for external clusters).
77 `--nodes` `<string>` ::
79 List of cluster node names.
81 `--nowritecache` `<boolean>` ::
83 disable write caching on the target
85 `--options` `<string>` ::
87 NFS mount options (see 'man nfs')
89 `--path` `<string>` ::
93 `--pool` `<string>` ::
97 `--portal` `<string>` ::
99 iSCSI portal (IP or DNS name with optional port).
101 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
103 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.
105 `--saferemove` `<boolean>` ::
107 Zero-out data when removing LVs.
109 `--saferemove_throughput` `<string>` ::
111 Wipe throughput (cstream -t parameter value).
113 `--server` `<string>` ::
115 Server IP or DNS name.
117 `--server2` `<string>` ::
119 Backup volfile server IP or DNS name.
121 NOTE: Requires option(s): `server`
123 `--shared` `<boolean>` ::
125 Mark storage as shared.
127 `--sparse` `<boolean>` ::
131 `--tagged_only` `<boolean>` ::
133 Only use logical volumes tagged with 'pve-vm-ID'.
135 `--target` `<string>` ::
139 `--thinpool` `<string>` ::
141 LVM thin pool LV name.
143 `--transport` `<rdma | tcp | unix>` ::
145 Gluster transport: tcp or rdma
147 `--username` `<string>` ::
151 `--vgname` `<string>` ::
155 `--volume` `<string>` ::
159 *pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
161 Allocate disk images.
163 `<storage>`: `<string>` ::
165 The storage identifier.
167 `<vmid>`: `<integer> (1 - N)` ::
171 `<filename>`: `<string>` ::
173 The name of the file to create.
175 `<size>`: `\d+[MG]?` ::
177 Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
179 `--format` `<qcow2 | raw | subvol>` ::
181 no description available
183 NOTE: Requires option(s): `size`
185 *pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
189 `<volume>`: `<string>` ::
193 `<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
197 `<filename>`: `<string>` ::
199 Destination file name
201 `--base` `(?^:[a-z0-9_\-]{1,40})` ::
203 Snapshot to start an incremental stream from
205 `--snapshot` `(?^:[a-z0-9_\-]{1,40})` ::
209 `--with-snapshots` `<boolean>` ('default =' `0`)::
211 Whether to include intermediate snapshots in the stream
213 *pvesm extractconfig* `<volume>`
215 Extract configuration from vzdump backup archive.
217 `<volume>`: `<string>` ::
221 *pvesm free* `<volume>` `[OPTIONS]`
225 `<volume>`: `<string>` ::
229 `--storage` `<string>` ::
231 The storage identifier.
233 *pvesm glusterfsscan* `<server>`
235 Scan remote GlusterFS server.
237 `<server>`: `<string>` ::
239 no description available
241 *pvesm help* `[OPTIONS]`
243 Get help about specified command.
245 `--extra-args` `<array>` ::
247 Shows help for a specific command
249 `--verbose` `<boolean>` ::
251 Verbose output format.
253 *pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
257 `<volume>`: `<string>` ::
261 `<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
265 `<filename>`: `<string>` ::
269 `--base` `(?^:[a-z0-9_\-]{1,40})` ::
271 Base snapshot of an incremental stream
273 `--delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` ::
275 A snapshot to delete on success
277 `--with-snapshots` `<boolean>` ('default =' `0`)::
279 Whether the stream includes intermediate snapshots
281 *pvesm iscsiscan* `--portal <string>` `[OPTIONS]`
283 Scan remote iSCSI server.
285 `--portal` `<string>` ::
287 no description available
289 *pvesm list* `<storage>` `[OPTIONS]`
291 List storage content.
293 `<storage>`: `<string>` ::
295 The storage identifier.
297 `--content` `<string>` ::
299 Only list content of this type.
301 `--vmid` `<integer> (1 - N)` ::
303 Only list images for this VM
307 List local LVM volume groups.
309 *pvesm lvmthinscan* `<vg>`
311 List local LVM Thin Pools.
313 `<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
315 no description available
317 *pvesm nfsscan* `<server>`
319 Scan remote NFS server.
321 `<server>`: `<string>` ::
323 no description available
325 *pvesm path* `<volume>`
327 Get filesystem path for specified volume
329 `<volume>`: `<string>` ::
333 *pvesm remove* `<storage>`
335 Delete storage configuration.
337 `<storage>`: `<string>` ::
339 The storage identifier.
341 *pvesm set* `<storage>` `[OPTIONS]`
343 Update storage configuration.
345 `<storage>`: `<string>` ::
347 The storage identifier.
349 `--blocksize` `<string>` ::
353 `--comstar_hg` `<string>` ::
355 host group for comstar views
357 `--comstar_tg` `<string>` ::
359 target group for comstar views
361 `--content` `<string>` ::
363 Allowed content types.
365 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
367 `--delete` `<string>` ::
369 A list of settings you want to delete.
371 `--digest` `<string>` ::
373 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
375 `--disable` `<boolean>` ::
377 Flag to disable the storage.
379 `--format` `<string>` ::
381 Default image format.
383 `--is_mountpoint` `<string>` ('default =' `no`)::
385 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.
387 `--krbd` `<boolean>` ::
389 Access rbd through krbd kernel module.
391 `--maxfiles` `<integer> (0 - N)` ::
393 Maximal number of backup files per VM. Use '0' for unlimted.
395 `--mkdir` `<boolean>` ('default =' `yes`)::
397 Create the directory if it doesn't exist.
399 `--monhost` `<string>` ::
401 IP addresses of monitors (for external clusters).
403 `--nodes` `<string>` ::
405 List of cluster node names.
407 `--nowritecache` `<boolean>` ::
409 disable write caching on the target
411 `--options` `<string>` ::
413 NFS mount options (see 'man nfs')
415 `--pool` `<string>` ::
419 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
421 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.
423 `--saferemove` `<boolean>` ::
425 Zero-out data when removing LVs.
427 `--saferemove_throughput` `<string>` ::
429 Wipe throughput (cstream -t parameter value).
431 `--server` `<string>` ::
433 Server IP or DNS name.
435 `--server2` `<string>` ::
437 Backup volfile server IP or DNS name.
439 NOTE: Requires option(s): `server`
441 `--shared` `<boolean>` ::
443 Mark storage as shared.
445 `--sparse` `<boolean>` ::
449 `--tagged_only` `<boolean>` ::
451 Only use logical volumes tagged with 'pve-vm-ID'.
453 `--transport` `<rdma | tcp | unix>` ::
455 Gluster transport: tcp or rdma
457 `--username` `<string>` ::
461 *pvesm status* `[OPTIONS]`
463 Get status for all datastores.
465 `--content` `<string>` ::
467 Only list stores which support this content type.
469 `--enabled` `<boolean>` ('default =' `0`)::
471 Only list stores which are enabled (not disabled in config).
473 `--format` `<boolean>` ('default =' `0`)::
475 Include information about formats
477 `--storage` `<string>` ::
479 Only list status for specified storage
481 `--target` `<string>` ::
483 If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
487 Scan zfs pool list on local node.