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