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