5a71906311410773811026056d8fab464ad89d78
[pve-docs.git] / pvesm.1-synopsis.adoc
1 *pvesm* `<COMMAND> [ARGS] [OPTIONS]`
2
3 *pvesm add* `<type> <storage>` `[OPTIONS]`
4
5 Create a new storage.
6
7 `<type>`: `<cephfs | cifs | dir | drbd | fake | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool>` ::
8
9 Storage type.
10
11 `<storage>`: `<string>` ::
12
13 The storage identifier.
14
15 `--authsupported` `<string>` ::
16
17 Authsupported.
18
19 `--base` `<string>` ::
20
21 Base volume. This volume is automatically activated.
22
23 `--blocksize` `<string>` ::
24
25 block size
26
27 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
28
29 Set bandwidth/io limits various operations.
30
31 `--comstar_hg` `<string>` ::
32
33 host group for comstar views
34
35 `--comstar_tg` `<string>` ::
36
37 target group for comstar views
38
39 `--content` `<string>` ::
40
41 Allowed content types.
42 +
43 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
44
45 `--disable` `<boolean>` ::
46
47 Flag to disable the storage.
48
49 `--domain` `<string>` ::
50
51 CIFS domain.
52
53 `--export` `<string>` ::
54
55 NFS export path.
56
57 `--format` `<string>` ::
58
59 Default image format.
60
61 `--fuse` `<boolean>` ::
62
63 Mount CephFS through FUSE.
64
65 `--is_mountpoint` `<string>` ('default =' `no`)::
66
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.
68
69 `--iscsiprovider` `<string>` ::
70
71 iscsi provider
72
73 `--krbd` `<boolean>` ::
74
75 Always access rbd through krbd kernel module.
76
77 `--lio_tpg` `<string>` ::
78
79 target portal group for Linux LIO targets
80
81 `--maxfiles` `<integer> (0 - N)` ::
82
83 Maximal number of backup files per VM. Use '0' for unlimted.
84
85 `--mkdir` `<boolean>` ('default =' `yes`)::
86
87 Create the directory if it doesn't exist.
88
89 `--monhost` `<string>` ::
90
91 IP addresses of monitors (for external clusters).
92
93 `--nodes` `<string>` ::
94
95 List of cluster node names.
96
97 `--nowritecache` `<boolean>` ::
98
99 disable write caching on the target
100
101 `--options` `<string>` ::
102
103 NFS mount options (see 'man nfs')
104
105 `--password` `<password>` ::
106
107 Password for CIFS share.
108
109 `--path` `<string>` ::
110
111 File system path.
112
113 `--pool` `<string>` ::
114
115 Pool.
116
117 `--portal` `<string>` ::
118
119 iSCSI portal (IP or DNS name with optional port).
120
121 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
122
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.
124
125 `--saferemove` `<boolean>` ::
126
127 Zero-out data when removing LVs.
128
129 `--saferemove_throughput` `<string>` ::
130
131 Wipe throughput (cstream -t parameter value).
132
133 `--server` `<string>` ::
134
135 Server IP or DNS name.
136
137 `--server2` `<string>` ::
138
139 Backup volfile server IP or DNS name.
140 +
141 NOTE: Requires option(s): `server`
142
143 `--share` `<string>` ::
144
145 CIFS share.
146
147 `--shared` `<boolean>` ::
148
149 Mark storage as shared.
150
151 `--smbversion` `<2.0 | 2.1 | 3.0>` ::
152
153 SMB protocol version
154
155 `--sparse` `<boolean>` ::
156
157 use sparse volumes
158
159 `--subdir` `<string>` ::
160
161 Subdir to mount.
162
163 `--tagged_only` `<boolean>` ::
164
165 Only use logical volumes tagged with 'pve-vm-ID'.
166
167 `--target` `<string>` ::
168
169 iSCSI target.
170
171 `--thinpool` `<string>` ::
172
173 LVM thin pool LV name.
174
175 `--transport` `<rdma | tcp | unix>` ::
176
177 Gluster transport: tcp or rdma
178
179 `--username` `<string>` ::
180
181 RBD Id.
182
183 `--vgname` `<string>` ::
184
185 Volume group name.
186
187 `--volume` `<string>` ::
188
189 Glusterfs Volume.
190
191 *pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
192
193 Allocate disk images.
194
195 `<storage>`: `<string>` ::
196
197 The storage identifier.
198
199 `<vmid>`: `<integer> (1 - N)` ::
200
201 Specify owner VM
202
203 `<filename>`: `<string>` ::
204
205 The name of the file to create.
206
207 `<size>`: `\d+[MG]?` ::
208
209 Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
210
211 `--format` `<qcow2 | raw | subvol>` ::
212
213 no description available
214 +
215 NOTE: Requires option(s): `size`
216
217 *pvesm cifsscan*
218
219 An alias for 'pvesm scan cifs'.
220
221 *pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
222
223 Export a volume.
224
225 `<volume>`: `<string>` ::
226
227 Volume identifier
228
229 `<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
230
231 Export stream format
232
233 `<filename>`: `<string>` ::
234
235 Destination file name
236
237 `--base` `(?^:[a-z0-9_\-]{1,40})` ::
238
239 Snapshot to start an incremental stream from
240
241 `--snapshot` `(?^:[a-z0-9_\-]{1,40})` ::
242
243 Snapshot to export
244
245 `--with-snapshots` `<boolean>` ('default =' `0`)::
246
247 Whether to include intermediate snapshots in the stream
248
249 *pvesm extractconfig* `<volume>`
250
251 Extract configuration from vzdump backup archive.
252
253 `<volume>`: `<string>` ::
254
255 Volume identifier
256
257 *pvesm free* `<volume>` `[OPTIONS]`
258
259 Delete volume
260
261 `<volume>`: `<string>` ::
262
263 Volume identifier
264
265 `--storage` `<string>` ::
266
267 The storage identifier.
268
269 *pvesm glusterfsscan*
270
271 An alias for 'pvesm scan glusterfs'.
272
273 *pvesm help* `[OPTIONS]`
274
275 Get help about specified command.
276
277 `--extra-args` `<array>` ::
278
279 Shows help for a specific command
280
281 `--verbose` `<boolean>` ::
282
283 Verbose output format.
284
285 *pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
286
287 Import a volume.
288
289 `<volume>`: `<string>` ::
290
291 Volume identifier
292
293 `<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
294
295 Import stream format
296
297 `<filename>`: `<string>` ::
298
299 Source file name
300
301 `--base` `(?^:[a-z0-9_\-]{1,40})` ::
302
303 Base snapshot of an incremental stream
304
305 `--delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` ::
306
307 A snapshot to delete on success
308
309 `--with-snapshots` `<boolean>` ('default =' `0`)::
310
311 Whether the stream includes intermediate snapshots
312
313 *pvesm iscsiscan*
314
315 An alias for 'pvesm scan iscsi'.
316
317 *pvesm list* `<storage>` `[OPTIONS]`
318
319 List storage content.
320
321 `<storage>`: `<string>` ::
322
323 The storage identifier.
324
325 `--content` `<string>` ::
326
327 Only list content of this type.
328
329 `--vmid` `<integer> (1 - N)` ::
330
331 Only list images for this VM
332
333 *pvesm lvmscan*
334
335 An alias for 'pvesm scan lvm'.
336
337 *pvesm lvmthinscan*
338
339 An alias for 'pvesm scan lvmthin'.
340
341 *pvesm nfsscan*
342
343 An alias for 'pvesm scan nfs'.
344
345 *pvesm path* `<volume>`
346
347 Get filesystem path for specified volume
348
349 `<volume>`: `<string>` ::
350
351 Volume identifier
352
353 *pvesm remove* `<storage>`
354
355 Delete storage configuration.
356
357 `<storage>`: `<string>` ::
358
359 The storage identifier.
360
361 *pvesm scan cifs* `<server>` `[OPTIONS]`
362
363 Scan remote CIFS server.
364
365 `<server>`: `<string>` ::
366
367 The server address (name or IP).
368
369 `--domain` `<string>` ::
370
371 SMB domain (Workgroup).
372
373 `--password` `<password>` ::
374
375 User password.
376
377 `--username` `<string>` ::
378
379 User name.
380
381 *pvesm scan glusterfs* `<server>`
382
383 Scan remote GlusterFS server.
384
385 `<server>`: `<string>` ::
386
387 The server address (name or IP).
388
389 *pvesm scan iscsi* `<portal>`
390
391 Scan remote iSCSI server.
392
393 `<portal>`: `<string>` ::
394
395 The iSCSI portal (IP or DNS name with optional port).
396
397 *pvesm scan lvm*
398
399 List local LVM volume groups.
400
401 *pvesm scan lvmthin* `<vg>`
402
403 List local LVM Thin Pools.
404
405 `<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
406
407 no description available
408
409 *pvesm scan nfs* `<server>`
410
411 Scan remote NFS server.
412
413 `<server>`: `<string>` ::
414
415 The server address (name or IP).
416
417 *pvesm scan zfs*
418
419 Scan zfs pool list on local node.
420
421 *pvesm set* `<storage>` `[OPTIONS]`
422
423 Update storage configuration.
424
425 `<storage>`: `<string>` ::
426
427 The storage identifier.
428
429 `--blocksize` `<string>` ::
430
431 block size
432
433 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
434
435 Set bandwidth/io limits various operations.
436
437 `--comstar_hg` `<string>` ::
438
439 host group for comstar views
440
441 `--comstar_tg` `<string>` ::
442
443 target group for comstar views
444
445 `--content` `<string>` ::
446
447 Allowed content types.
448 +
449 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
450
451 `--delete` `<string>` ::
452
453 A list of settings you want to delete.
454
455 `--digest` `<string>` ::
456
457 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
458
459 `--disable` `<boolean>` ::
460
461 Flag to disable the storage.
462
463 `--domain` `<string>` ::
464
465 CIFS domain.
466
467 `--format` `<string>` ::
468
469 Default image format.
470
471 `--fuse` `<boolean>` ::
472
473 Mount CephFS through FUSE.
474
475 `--is_mountpoint` `<string>` ('default =' `no`)::
476
477 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.
478
479 `--krbd` `<boolean>` ::
480
481 Always access rbd through krbd kernel module.
482
483 `--lio_tpg` `<string>` ::
484
485 target portal group for Linux LIO targets
486
487 `--maxfiles` `<integer> (0 - N)` ::
488
489 Maximal number of backup files per VM. Use '0' for unlimted.
490
491 `--mkdir` `<boolean>` ('default =' `yes`)::
492
493 Create the directory if it doesn't exist.
494
495 `--monhost` `<string>` ::
496
497 IP addresses of monitors (for external clusters).
498
499 `--nodes` `<string>` ::
500
501 List of cluster node names.
502
503 `--nowritecache` `<boolean>` ::
504
505 disable write caching on the target
506
507 `--options` `<string>` ::
508
509 NFS mount options (see 'man nfs')
510
511 `--password` `<string>` ::
512
513 Password for CIFS share.
514
515 `--pool` `<string>` ::
516
517 Pool.
518
519 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
520
521 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.
522
523 `--saferemove` `<boolean>` ::
524
525 Zero-out data when removing LVs.
526
527 `--saferemove_throughput` `<string>` ::
528
529 Wipe throughput (cstream -t parameter value).
530
531 `--server` `<string>` ::
532
533 Server IP or DNS name.
534
535 `--server2` `<string>` ::
536
537 Backup volfile server IP or DNS name.
538 +
539 NOTE: Requires option(s): `server`
540
541 `--shared` `<boolean>` ::
542
543 Mark storage as shared.
544
545 `--smbversion` `<2.0 | 2.1 | 3.0>` ::
546
547 SMB protocol version
548
549 `--sparse` `<boolean>` ::
550
551 use sparse volumes
552
553 `--subdir` `<string>` ::
554
555 Subdir to mount.
556
557 `--tagged_only` `<boolean>` ::
558
559 Only use logical volumes tagged with 'pve-vm-ID'.
560
561 `--transport` `<rdma | tcp | unix>` ::
562
563 Gluster transport: tcp or rdma
564
565 `--username` `<string>` ::
566
567 RBD Id.
568
569 *pvesm status* `[OPTIONS]`
570
571 Get status for all datastores.
572
573 `--content` `<string>` ::
574
575 Only list stores which support this content type.
576
577 `--enabled` `<boolean>` ('default =' `0`)::
578
579 Only list stores which are enabled (not disabled in config).
580
581 `--format` `<boolean>` ('default =' `0`)::
582
583 Include information about formats
584
585 `--storage` `<string>` ::
586
587 Only list status for  specified storage
588
589 `--target` `<string>` ::
590
591 If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
592
593 *pvesm zfsscan*
594
595 An alias for 'pvesm scan zfs'.
596
597