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