make update-static
[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 | 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 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* `<server>` `[OPTIONS]`
218
219 Scan remote CIFS server.
220
221 `<server>`: `<string>` ::
222
223 The server address (name or IP).
224
225 `--domain` `<string>` ::
226
227 SMB domain (Workgroup).
228
229 `--password` `<password>` ::
230
231 User password.
232
233 `--username` `<string>` ::
234
235 User name.
236
237 *pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
238
239 Export a volume.
240
241 `<volume>`: `<string>` ::
242
243 Volume identifier
244
245 `<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
246
247 Export stream format
248
249 `<filename>`: `<string>` ::
250
251 Destination file name
252
253 `--base` `(?^:[a-z0-9_\-]{1,40})` ::
254
255 Snapshot to start an incremental stream from
256
257 `--snapshot` `(?^:[a-z0-9_\-]{1,40})` ::
258
259 Snapshot to export
260
261 `--with-snapshots` `<boolean>` ('default =' `0`)::
262
263 Whether to include intermediate snapshots in the stream
264
265 *pvesm extractconfig* `<volume>`
266
267 Extract configuration from vzdump backup archive.
268
269 `<volume>`: `<string>` ::
270
271 Volume identifier
272
273 *pvesm free* `<volume>` `[OPTIONS]`
274
275 Delete volume
276
277 `<volume>`: `<string>` ::
278
279 Volume identifier
280
281 `--storage` `<string>` ::
282
283 The storage identifier.
284
285 *pvesm glusterfsscan* `<server>`
286
287 Scan remote GlusterFS server.
288
289 `<server>`: `<string>` ::
290
291 The server address (name or IP).
292
293 *pvesm help* `[OPTIONS]`
294
295 Get help about specified command.
296
297 `--extra-args` `<array>` ::
298
299 Shows help for a specific command
300
301 `--verbose` `<boolean>` ::
302
303 Verbose output format.
304
305 *pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
306
307 Import a volume.
308
309 `<volume>`: `<string>` ::
310
311 Volume identifier
312
313 `<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
314
315 Import stream format
316
317 `<filename>`: `<string>` ::
318
319 Source file name
320
321 `--base` `(?^:[a-z0-9_\-]{1,40})` ::
322
323 Base snapshot of an incremental stream
324
325 `--delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` ::
326
327 A snapshot to delete on success
328
329 `--with-snapshots` `<boolean>` ('default =' `0`)::
330
331 Whether the stream includes intermediate snapshots
332
333 *pvesm iscsiscan* `<portal>`
334
335 Scan remote iSCSI server.
336
337 `<portal>`: `<string>` ::
338
339 The iSCSI portal (IP or DNS name with optional port).
340
341 *pvesm list* `<storage>` `[OPTIONS]`
342
343 List storage content.
344
345 `<storage>`: `<string>` ::
346
347 The storage identifier.
348
349 `--content` `<string>` ::
350
351 Only list content of this type.
352
353 `--vmid` `<integer> (1 - N)` ::
354
355 Only list images for this VM
356
357 *pvesm lvmscan*
358
359 List local LVM volume groups.
360
361 *pvesm lvmthinscan* `<vg>`
362
363 List local LVM Thin Pools.
364
365 `<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
366
367 no description available
368
369 *pvesm nfsscan* `<server>`
370
371 Scan remote NFS server.
372
373 `<server>`: `<string>` ::
374
375 The server address (name or IP).
376
377 *pvesm path* `<volume>`
378
379 Get filesystem path for specified volume
380
381 `<volume>`: `<string>` ::
382
383 Volume identifier
384
385 *pvesm remove* `<storage>`
386
387 Delete storage configuration.
388
389 `<storage>`: `<string>` ::
390
391 The storage identifier.
392
393 *pvesm set* `<storage>` `[OPTIONS]`
394
395 Update storage configuration.
396
397 `<storage>`: `<string>` ::
398
399 The storage identifier.
400
401 `--blocksize` `<string>` ::
402
403 block size
404
405 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
406
407 Set bandwidth/io limits various operations.
408
409 `--comstar_hg` `<string>` ::
410
411 host group for comstar views
412
413 `--comstar_tg` `<string>` ::
414
415 target group for comstar views
416
417 `--content` `<string>` ::
418
419 Allowed content types.
420 +
421 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
422
423 `--delete` `<string>` ::
424
425 A list of settings you want to delete.
426
427 `--digest` `<string>` ::
428
429 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
430
431 `--disable` `<boolean>` ::
432
433 Flag to disable the storage.
434
435 `--domain` `<string>` ::
436
437 CIFS domain.
438
439 `--format` `<string>` ::
440
441 Default image format.
442
443 `--fuse` `<boolean>` ::
444
445 Mount CephFS through FUSE.
446
447 `--is_mountpoint` `<string>` ('default =' `no`)::
448
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.
450
451 `--krbd` `<boolean>` ::
452
453 Access rbd through krbd kernel module.
454
455 `--lio_tpg` `<string>` ::
456
457 target portal group for Linux LIO targets
458
459 `--maxfiles` `<integer> (0 - N)` ::
460
461 Maximal number of backup files per VM. Use '0' for unlimted.
462
463 `--mkdir` `<boolean>` ('default =' `yes`)::
464
465 Create the directory if it doesn't exist.
466
467 `--monhost` `<string>` ::
468
469 IP addresses of monitors (for external clusters).
470
471 `--nodes` `<string>` ::
472
473 List of cluster node names.
474
475 `--nowritecache` `<boolean>` ::
476
477 disable write caching on the target
478
479 `--options` `<string>` ::
480
481 NFS mount options (see 'man nfs')
482
483 `--password` `<string>` ::
484
485 Password for CIFS share.
486
487 `--pool` `<string>` ::
488
489 Pool.
490
491 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
492
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.
494
495 `--saferemove` `<boolean>` ::
496
497 Zero-out data when removing LVs.
498
499 `--saferemove_throughput` `<string>` ::
500
501 Wipe throughput (cstream -t parameter value).
502
503 `--server` `<string>` ::
504
505 Server IP or DNS name.
506
507 `--server2` `<string>` ::
508
509 Backup volfile server IP or DNS name.
510 +
511 NOTE: Requires option(s): `server`
512
513 `--shared` `<boolean>` ::
514
515 Mark storage as shared.
516
517 `--smbversion` `<2.0 | 2.1 | 3.0>` ::
518
519 SMB protocol version
520
521 `--sparse` `<boolean>` ::
522
523 use sparse volumes
524
525 `--subdir` `<string>` ::
526
527 Subdir to mount.
528
529 `--tagged_only` `<boolean>` ::
530
531 Only use logical volumes tagged with 'pve-vm-ID'.
532
533 `--transport` `<rdma | tcp | unix>` ::
534
535 Gluster transport: tcp or rdma
536
537 `--username` `<string>` ::
538
539 RBD Id.
540
541 *pvesm status* `[OPTIONS]`
542
543 Get status for all datastores.
544
545 `--content` `<string>` ::
546
547 Only list stores which support this content type.
548
549 `--enabled` `<boolean>` ('default =' `0`)::
550
551 Only list stores which are enabled (not disabled in config).
552
553 `--format` `<boolean>` ('default =' `0`)::
554
555 Include information about formats
556
557 `--storage` `<string>` ::
558
559 Only list status for  specified storage
560
561 `--target` `<string>` ::
562
563 If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
564
565 *pvesm zfsscan*
566
567 Scan zfs pool list on local node.
568
569