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