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