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>`: `<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 `-comstar_hg` `<string>` ::
28
29 host group for comstar views
30
31 `-comstar_tg` `<string>` ::
32
33 target group for comstar views
34
35 `-content` `<string>` ::
36
37 Allowed content types.
38 +
39 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
40
41 `-disable` `<boolean>` ::
42
43 Flag to disable the storage.
44
45 `-export` `<string>` ::
46
47 NFS export path.
48
49 `-format` `<string>` ::
50
51 Default image format.
52
53 `-is_mountpoint` `<boolean>` ('default =' `no`)::
54
55 Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline.
56
57 `-iscsiprovider` `<string>` ::
58
59 iscsi provider
60
61 `-krbd` `<boolean>` ::
62
63 Access rbd through krbd kernel module.
64
65 `-maxfiles` `<integer> (0 - N)` ::
66
67 Maximal number of backup files per VM. Use '0' for unlimted.
68
69 `-mkdir` `<boolean>` ('default =' `yes`)::
70
71 Create the directory if it doesn't exist.
72
73 `-monhost` `<string>` ::
74
75 Monitors daemon ips.
76
77 `-nodes` `<string>` ::
78
79 List of cluster node names.
80
81 `-nowritecache` `<boolean>` ::
82
83 disable write caching on the target
84
85 `-options` `<string>` ::
86
87 NFS mount options (see 'man nfs')
88
89 `-path` `<string>` ::
90
91 File system path.
92
93 `-pool` `<string>` ::
94
95 Pool.
96
97 `-portal` `<string>` ::
98
99 iSCSI portal (IP or DNS name with optional port).
100
101 `-redundancy` `<integer> (1 - 16)` ('default =' `2`)::
102
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.
104
105 `-saferemove` `<boolean>` ::
106
107 Zero-out data when removing LVs.
108
109 `-saferemove_throughput` `<string>` ::
110
111 Wipe throughput (cstream -t parameter value).
112
113 `-server` `<string>` ::
114
115 Server IP or DNS name.
116
117 `-server2` `<string>` ::
118
119 Backup volfile server IP or DNS name.
120 +
121 NOTE: Requires option(s): `server`
122
123 `-shared` `<boolean>` ::
124
125 Mark storage as shared.
126
127 `-sparse` `<boolean>` ::
128
129 use sparse volumes
130
131 `-tagged_only` `<boolean>` ::
132
133 Only use logical volumes tagged with 'pve-vm-ID'.
134
135 `-target` `<string>` ::
136
137 iSCSI target.
138
139 `-thinpool` `<string>` ::
140
141 LVM thin pool LV name.
142
143 `-transport` `<rdma | tcp | unix>` ::
144
145 Gluster transport: tcp or rdma
146
147 `-username` `<string>` ::
148
149 RBD Id.
150
151 `-vgname` `<string>` ::
152
153 Volume group name.
154
155 `-volume` `<string>` ::
156
157 Glusterfs Volume.
158
159
160
161
162 *pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
163
164 Allocate disk images.
165
166 `<storage>`: `<string>` ::
167
168 The storage identifier.
169
170 `<vmid>`: `<integer> (1 - N)` ::
171
172 Specify owner VM
173
174 `<filename>`: `<string>` ::
175
176 The name of the file to create.
177
178 `<size>`: `\d+[MG]?` ::
179
180 Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
181
182 `-format` `<qcow2 | raw | subvol>` ::
183
184 no description available
185 +
186 NOTE: Requires option(s): `size`
187
188
189
190
191 *pvesm extractconfig* `<volume>`
192
193 Extract configuration from vzdump backup archive.
194
195 `<volume>`: `<string>` ::
196
197 Volume identifier
198
199
200
201
202 *pvesm free* `<volume>` `[OPTIONS]`
203
204 Delete volume
205
206 `<volume>`: `<string>` ::
207
208 Volume identifier
209
210 `-storage` `<string>` ::
211
212 The storage identifier.
213
214
215
216
217 *pvesm glusterfsscan* `<server>`
218
219 Scan remote GlusterFS server.
220
221 `<server>`: `<string>` ::
222
223 no description available
224
225
226
227
228 *pvesm help* `[<cmd>]` `[OPTIONS]`
229
230 Get help about specified command.
231
232 `<cmd>`: `<string>` ::
233
234 Command name
235
236 `-verbose` `<boolean>` ::
237
238 Verbose output format.
239
240
241
242
243 *pvesm iscsiscan* `-portal <string>` `[OPTIONS]`
244
245 Scan remote iSCSI server.
246
247 `-portal` `<string>` ::
248
249 no description available
250
251
252
253
254 *pvesm list* `<storage>` `[OPTIONS]`
255
256 List storage content.
257
258 `<storage>`: `<string>` ::
259
260 The storage identifier.
261
262 `-content` `<string>` ::
263
264 Only list content of this type.
265
266 `-vmid` `<integer> (1 - N)` ::
267
268 Only list images for this VM
269
270
271
272
273 *pvesm lvmscan*
274
275 List local LVM volume groups.
276
277
278
279 *pvesm lvmthinscan* `<vg>`
280
281 List local LVM Thin Pools.
282
283 `<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
284
285 no description available
286
287
288
289 *pvesm nfsscan* `<server>`
290
291 Scan remote NFS server.
292
293 `<server>`: `<string>` ::
294
295 no description available
296
297
298
299
300 *pvesm path* `<volume>`
301
302 Get filesystem path for specified volume
303
304 `<volume>`: `<string>` ::
305
306 Volume identifier
307
308
309
310
311 *pvesm remove* `<storage>`
312
313 Delete storage configuration.
314
315 `<storage>`: `<string>` ::
316
317 The storage identifier.
318
319
320
321 *pvesm set* `<storage>` `[OPTIONS]`
322
323 Update storage configuration.
324
325 `<storage>`: `<string>` ::
326
327 The storage identifier.
328
329 `-blocksize` `<string>` ::
330
331 block size
332
333 `-comstar_hg` `<string>` ::
334
335 host group for comstar views
336
337 `-comstar_tg` `<string>` ::
338
339 target group for comstar views
340
341 `-content` `<string>` ::
342
343 Allowed content types.
344 +
345 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
346
347 `-delete` `<string>` ::
348
349 A list of settings you want to delete.
350
351 `-digest` `<string>` ::
352
353 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
354
355 `-disable` `<boolean>` ::
356
357 Flag to disable the storage.
358
359 `-format` `<string>` ::
360
361 Default image format.
362
363 `-is_mountpoint` `<boolean>` ('default =' `no`)::
364
365 Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline.
366
367 `-krbd` `<boolean>` ::
368
369 Access rbd through krbd kernel module.
370
371 `-maxfiles` `<integer> (0 - N)` ::
372
373 Maximal number of backup files per VM. Use '0' for unlimted.
374
375 `-mkdir` `<boolean>` ('default =' `yes`)::
376
377 Create the directory if it doesn't exist.
378
379 `-nodes` `<string>` ::
380
381 List of cluster node names.
382
383 `-nowritecache` `<boolean>` ::
384
385 disable write caching on the target
386
387 `-options` `<string>` ::
388
389 NFS mount options (see 'man nfs')
390
391 `-pool` `<string>` ::
392
393 Pool.
394
395 `-redundancy` `<integer> (1 - 16)` ('default =' `2`)::
396
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.
398
399 `-saferemove` `<boolean>` ::
400
401 Zero-out data when removing LVs.
402
403 `-saferemove_throughput` `<string>` ::
404
405 Wipe throughput (cstream -t parameter value).
406
407 `-server` `<string>` ::
408
409 Server IP or DNS name.
410
411 `-server2` `<string>` ::
412
413 Backup volfile server IP or DNS name.
414 +
415 NOTE: Requires option(s): `server`
416
417 `-shared` `<boolean>` ::
418
419 Mark storage as shared.
420
421 `-sparse` `<boolean>` ::
422
423 use sparse volumes
424
425 `-tagged_only` `<boolean>` ::
426
427 Only use logical volumes tagged with 'pve-vm-ID'.
428
429 `-transport` `<rdma | tcp | unix>` ::
430
431 Gluster transport: tcp or rdma
432
433 `-username` `<string>` ::
434
435 RBD Id.
436
437
438
439
440 *pvesm status* `[OPTIONS]`
441
442 Get status for all datastores.
443
444 `-content` `<string>` ::
445
446 Only list stores which support this content type.
447
448 `-enabled` `<boolean>` ('default =' `0`)::
449
450 Only list stores which are enabled (not disabled in config).
451
452 `-storage` `<string>` ::
453
454 Only list status for  specified storage
455
456 `-target` `<string>` ::
457
458 If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
459
460
461
462
463 *pvesm zfsscan*
464
465 Scan zfs pool list on local node.
466
467
468
469