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>` ::
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` `<boolean>` ('default =' `no`)::
55 Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline.
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>` ::
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')
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>` ::
162 *pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
164 Allocate disk images.
166 `<storage>`: `<string>` ::
168 The storage identifier.
170 `<vmid>`: `<integer> (1 - N)` ::
174 `<filename>`: `<string>` ::
176 The name of the file to create.
178 `<size>`: `\d+[MG]?` ::
180 Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
182 `-format` `<qcow2 | raw | subvol>` ::
184 no description available
186 NOTE: Requires option(s): `size`
191 *pvesm extractconfig* `<volume>`
193 Extract configuration from vzdump backup archive.
195 `<volume>`: `<string>` ::
202 *pvesm free* `<volume>` `[OPTIONS]`
206 `<volume>`: `<string>` ::
210 `-storage` `<string>` ::
212 The storage identifier.
217 *pvesm glusterfsscan* `<server>`
219 Scan remote GlusterFS server.
221 `<server>`: `<string>` ::
223 no description available
228 *pvesm help* `[<cmd>]` `[OPTIONS]`
230 Get help about specified command.
232 `<cmd>`: `<string>` ::
236 `-verbose` `<boolean>` ::
238 Verbose output format.
243 *pvesm iscsiscan* `-portal <string>` `[OPTIONS]`
245 Scan remote iSCSI server.
247 `-portal` `<string>` ::
249 no description available
254 *pvesm list* `<storage>` `[OPTIONS]`
256 List storage content.
258 `<storage>`: `<string>` ::
260 The storage identifier.
262 `-content` `<string>` ::
264 Only list content of this type.
266 `-vmid` `<integer> (1 - N)` ::
268 Only list images for this VM
275 List local LVM volume groups.
279 *pvesm lvmthinscan* `<vg>`
281 List local LVM Thin Pools.
283 `<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
285 no description available
289 *pvesm nfsscan* `<server>`
291 Scan remote NFS server.
293 `<server>`: `<string>` ::
295 no description available
300 *pvesm path* `<volume>`
302 Get filesystem path for specified volume
304 `<volume>`: `<string>` ::
311 *pvesm remove* `<storage>`
313 Delete storage configuration.
315 `<storage>`: `<string>` ::
317 The storage identifier.
321 *pvesm set* `<storage>` `[OPTIONS]`
323 Update storage configuration.
325 `<storage>`: `<string>` ::
327 The storage identifier.
329 `-blocksize` `<string>` ::
333 `-comstar_hg` `<string>` ::
335 host group for comstar views
337 `-comstar_tg` `<string>` ::
339 target group for comstar views
341 `-content` `<string>` ::
343 Allowed content types.
345 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
347 `-delete` `<string>` ::
349 A list of settings you want to delete.
351 `-digest` `<string>` ::
353 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
355 `-disable` `<boolean>` ::
357 Flag to disable the storage.
359 `-format` `<string>` ::
361 Default image format.
363 `-is_mountpoint` `<boolean>` ('default =' `no`)::
365 Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline.
367 `-krbd` `<boolean>` ::
369 Access rbd through krbd kernel module.
371 `-maxfiles` `<integer> (0 - N)` ::
373 Maximal number of backup files per VM. Use '0' for unlimted.
375 `-mkdir` `<boolean>` ('default =' `yes`)::
377 Create the directory if it doesn't exist.
379 `-nodes` `<string>` ::
381 List of cluster node names.
383 `-nowritecache` `<boolean>` ::
385 disable write caching on the target
387 `-options` `<string>` ::
389 NFS mount options (see 'man nfs')
391 `-pool` `<string>` ::
395 `-redundancy` `<integer> (1 - 16)` ('default =' `2`)::
397 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.
399 `-saferemove` `<boolean>` ::
401 Zero-out data when removing LVs.
403 `-saferemove_throughput` `<string>` ::
405 Wipe throughput (cstream -t parameter value).
407 `-server` `<string>` ::
409 Server IP or DNS name.
411 `-server2` `<string>` ::
413 Backup volfile server IP or DNS name.
415 NOTE: Requires option(s): `server`
417 `-shared` `<boolean>` ::
419 Mark storage as shared.
421 `-sparse` `<boolean>` ::
425 `-tagged_only` `<boolean>` ::
427 Only use logical volumes tagged with 'pve-vm-ID'.
429 `-transport` `<rdma | tcp | unix>` ::
431 Gluster transport: tcp or rdma
433 `-username` `<string>` ::
440 *pvesm status* `[OPTIONS]`
442 Get status for all datastores.
444 `-content` `<string>` ::
446 Only list stores which support this content type.
448 `-enabled` `<boolean>` ('default =' `0`)::
450 Only list stores which are enabled (not disabled in config).
452 `-storage` `<string>` ::
454 Only list status for specified storage
456 `-target` `<string>` ::
458 If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
465 Scan zfs pool list on local node.