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