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