]>
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 | ||
013dc89f | 15 | `-authsupported` `<string>` :: |
1f554f76 DM |
16 | |
17 | Authsupported. | |
18 | ||
013dc89f | 19 | `-base` `<string>` :: |
1f554f76 DM |
20 | |
21 | Base volume. This volume is automatically activated. | |
22 | ||
013dc89f | 23 | `-blocksize` `<string>` :: |
1f554f76 DM |
24 | |
25 | block size | |
26 | ||
013dc89f | 27 | `-comstar_hg` `<string>` :: |
1f554f76 DM |
28 | |
29 | host group for comstar views | |
30 | ||
013dc89f | 31 | `-comstar_tg` `<string>` :: |
1f554f76 DM |
32 | |
33 | target group for comstar views | |
34 | ||
013dc89f | 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 | |
013dc89f | 41 | `-disable` `<boolean>` :: |
1f554f76 DM |
42 | |
43 | Flag to disable the storage. | |
44 | ||
013dc89f | 45 | `-export` `<string>` :: |
1f554f76 DM |
46 | |
47 | NFS export path. | |
48 | ||
013dc89f | 49 | `-format` `<string>` :: |
1f554f76 | 50 | |
04ce4dfa | 51 | Default image format. |
1f554f76 | 52 | |
013dc89f | 53 | `-is_mountpoint` `<boolean>` ('default =' `no`):: |
2c0dde61 DM |
54 | |
55 | Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline. | |
56 | ||
013dc89f | 57 | `-iscsiprovider` `<string>` :: |
1f554f76 DM |
58 | |
59 | iscsi provider | |
60 | ||
013dc89f | 61 | `-krbd` `<boolean>` :: |
1f554f76 DM |
62 | |
63 | Access rbd through krbd kernel module. | |
64 | ||
013dc89f | 65 | `-maxfiles` `<integer> (0 - N)` :: |
1f554f76 DM |
66 | |
67 | Maximal number of backup files per VM. Use '0' for unlimted. | |
68 | ||
013dc89f | 69 | `-mkdir` `<boolean>` ('default =' `yes`):: |
2c0dde61 DM |
70 | |
71 | Create the directory if it doesn't exist. | |
72 | ||
013dc89f | 73 | `-monhost` `<string>` :: |
1f554f76 DM |
74 | |
75 | Monitors daemon ips. | |
76 | ||
013dc89f | 77 | `-nodes` `<string>` :: |
1f554f76 DM |
78 | |
79 | List of cluster node names. | |
80 | ||
013dc89f | 81 | `-nowritecache` `<boolean>` :: |
1f554f76 DM |
82 | |
83 | disable write caching on the target | |
84 | ||
013dc89f | 85 | `-options` `<string>` :: |
1f554f76 DM |
86 | |
87 | NFS mount options (see 'man nfs') | |
88 | ||
013dc89f | 89 | `-path` `<string>` :: |
1f554f76 DM |
90 | |
91 | File system path. | |
92 | ||
013dc89f | 93 | `-pool` `<string>` :: |
1f554f76 DM |
94 | |
95 | Pool. | |
96 | ||
013dc89f | 97 | `-portal` `<string>` :: |
1f554f76 DM |
98 | |
99 | iSCSI portal (IP or DNS name with optional port). | |
100 | ||
013dc89f | 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 | |
013dc89f | 105 | `-saferemove` `<boolean>` :: |
1f554f76 DM |
106 | |
107 | Zero-out data when removing LVs. | |
108 | ||
013dc89f | 109 | `-saferemove_throughput` `<string>` :: |
1f554f76 DM |
110 | |
111 | Wipe throughput (cstream -t parameter value). | |
112 | ||
013dc89f | 113 | `-server` `<string>` :: |
1f554f76 DM |
114 | |
115 | Server IP or DNS name. | |
116 | ||
013dc89f | 117 | `-server2` `<string>` :: |
1f554f76 DM |
118 | |
119 | Backup volfile server IP or DNS name. | |
120 | + | |
121 | NOTE: Requires option(s): `server` | |
122 | ||
013dc89f | 123 | `-shared` `<boolean>` :: |
1f554f76 DM |
124 | |
125 | Mark storage as shared. | |
126 | ||
013dc89f | 127 | `-sparse` `<boolean>` :: |
1f554f76 DM |
128 | |
129 | use sparse volumes | |
130 | ||
013dc89f | 131 | `-tagged_only` `<boolean>` :: |
2c0dde61 DM |
132 | |
133 | Only use logical volumes tagged with 'pve-vm-ID'. | |
134 | ||
013dc89f | 135 | `-target` `<string>` :: |
1f554f76 DM |
136 | |
137 | iSCSI target. | |
138 | ||
013dc89f | 139 | `-thinpool` `<string>` :: |
1f554f76 DM |
140 | |
141 | LVM thin pool LV name. | |
142 | ||
013dc89f | 143 | `-transport` `<rdma | tcp | unix>` :: |
1f554f76 DM |
144 | |
145 | Gluster transport: tcp or rdma | |
146 | ||
013dc89f | 147 | `-username` `<string>` :: |
1f554f76 DM |
148 | |
149 | RBD Id. | |
150 | ||
013dc89f | 151 | `-vgname` `<string>` :: |
1f554f76 DM |
152 | |
153 | Volume group name. | |
154 | ||
013dc89f | 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 | |
013dc89f | 182 | `-format` `<qcow2 | raw | subvol>` :: |
1f554f76 DM |
183 | |
184 | no description available | |
185 | + | |
186 | NOTE: Requires option(s): `size` | |
187 | ||
188 | ||
189 | ||
2c0dde61 DM |
190 | |
191 | *pvesm extractconfig* `<volume>` | |
192 | ||
193 | Extract configuration from vzdump backup archive. | |
194 | ||
013dc89f | 195 | `<volume>`: `<string>` :: |
2c0dde61 DM |
196 | |
197 | Volume identifier | |
198 | ||
199 | ||
200 | ||
201 | ||
1f554f76 DM |
202 | *pvesm free* `<volume>` `[OPTIONS]` |
203 | ||
204 | Delete volume | |
205 | ||
013dc89f | 206 | `<volume>`: `<string>` :: |
1f554f76 DM |
207 | |
208 | Volume identifier | |
209 | ||
013dc89f | 210 | `-storage` `<string>` :: |
1f554f76 DM |
211 | |
212 | The storage identifier. | |
213 | ||
214 | ||
215 | ||
216 | ||
217 | *pvesm glusterfsscan* `<server>` | |
218 | ||
219 | Scan remote GlusterFS server. | |
220 | ||
013dc89f | 221 | `<server>`: `<string>` :: |
1f554f76 DM |
222 | |
223 | no description available | |
224 | ||
225 | ||
226 | ||
227 | ||
228 | *pvesm help* `[<cmd>]` `[OPTIONS]` | |
229 | ||
230 | Get help about specified command. | |
231 | ||
013dc89f | 232 | `<cmd>`: `<string>` :: |
1f554f76 DM |
233 | |
234 | Command name | |
235 | ||
013dc89f | 236 | `-verbose` `<boolean>` :: |
1f554f76 DM |
237 | |
238 | Verbose output format. | |
239 | ||
240 | ||
241 | ||
242 | ||
243 | *pvesm iscsiscan* `-portal <string>` `[OPTIONS]` | |
244 | ||
245 | Scan remote iSCSI server. | |
246 | ||
013dc89f | 247 | `-portal` `<string>` :: |
1f554f76 DM |
248 | |
249 | no description available | |
250 | ||
251 | ||
252 | ||
253 | ||
254 | *pvesm list* `<storage>` `[OPTIONS]` | |
255 | ||
256 | List storage content. | |
257 | ||
013dc89f | 258 | `<storage>`: `<string>` :: |
1f554f76 DM |
259 | |
260 | The storage identifier. | |
261 | ||
013dc89f | 262 | `-content` `<string>` :: |
1f554f76 DM |
263 | |
264 | Only list content of this type. | |
265 | ||
013dc89f | 266 | `-vmid` `<integer> (1 - N)` :: |
1f554f76 DM |
267 | |
268 | Only list images for this VM | |
269 | ||
270 | ||
271 | ||
272 | ||
273 | *pvesm lvmscan* | |
274 | ||
275 | List local LVM volume groups. | |
276 | ||
277 | ||
278 | ||
9b3e4991 DM |
279 | *pvesm lvmthinscan* `<vg>` |
280 | ||
281 | List local LVM Thin Pools. | |
282 | ||
013dc89f | 283 | `<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` :: |
9b3e4991 DM |
284 | |
285 | no description available | |
286 | ||
287 | ||
288 | ||
1f554f76 DM |
289 | *pvesm nfsscan* `<server>` |
290 | ||
291 | Scan remote NFS server. | |
292 | ||
013dc89f | 293 | `<server>`: `<string>` :: |
1f554f76 DM |
294 | |
295 | no description available | |
296 | ||
297 | ||
298 | ||
299 | ||
300 | *pvesm path* `<volume>` | |
301 | ||
302 | Get filesystem path for specified volume | |
303 | ||
013dc89f | 304 | `<volume>`: `<string>` :: |
1f554f76 DM |
305 | |
306 | Volume identifier | |
307 | ||
308 | ||
309 | ||
310 | ||
311 | *pvesm remove* `<storage>` | |
312 | ||
313 | Delete storage configuration. | |
314 | ||
013dc89f | 315 | `<storage>`: `<string>` :: |
1f554f76 DM |
316 | |
317 | The storage identifier. | |
318 | ||
319 | ||
320 | ||
321 | *pvesm set* `<storage>` `[OPTIONS]` | |
322 | ||
323 | Update storage configuration. | |
324 | ||
013dc89f | 325 | `<storage>`: `<string>` :: |
1f554f76 DM |
326 | |
327 | The storage identifier. | |
328 | ||
013dc89f | 329 | `-blocksize` `<string>` :: |
1f554f76 DM |
330 | |
331 | block size | |
332 | ||
013dc89f | 333 | `-comstar_hg` `<string>` :: |
1f554f76 DM |
334 | |
335 | host group for comstar views | |
336 | ||
013dc89f | 337 | `-comstar_tg` `<string>` :: |
1f554f76 DM |
338 | |
339 | target group for comstar views | |
340 | ||
013dc89f | 341 | `-content` `<string>` :: |
1f554f76 | 342 | |
04ce4dfa DM |
343 | Allowed content types. |
344 | + | |
c2993fe5 | 345 | NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. |
1f554f76 | 346 | |
013dc89f | 347 | `-delete` `<string>` :: |
1f554f76 DM |
348 | |
349 | A list of settings you want to delete. | |
350 | ||
013dc89f | 351 | `-digest` `<string>` :: |
1f554f76 | 352 | |
c2993fe5 | 353 | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
1f554f76 | 354 | |
013dc89f | 355 | `-disable` `<boolean>` :: |
1f554f76 DM |
356 | |
357 | Flag to disable the storage. | |
358 | ||
013dc89f | 359 | `-format` `<string>` :: |
1f554f76 | 360 | |
04ce4dfa | 361 | Default image format. |
1f554f76 | 362 | |
013dc89f | 363 | `-is_mountpoint` `<boolean>` ('default =' `no`):: |
2c0dde61 DM |
364 | |
365 | Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline. | |
366 | ||
013dc89f | 367 | `-krbd` `<boolean>` :: |
1f554f76 DM |
368 | |
369 | Access rbd through krbd kernel module. | |
370 | ||
013dc89f | 371 | `-maxfiles` `<integer> (0 - N)` :: |
1f554f76 DM |
372 | |
373 | Maximal number of backup files per VM. Use '0' for unlimted. | |
374 | ||
013dc89f | 375 | `-mkdir` `<boolean>` ('default =' `yes`):: |
2c0dde61 DM |
376 | |
377 | Create the directory if it doesn't exist. | |
378 | ||
013dc89f | 379 | `-nodes` `<string>` :: |
1f554f76 DM |
380 | |
381 | List of cluster node names. | |
382 | ||
013dc89f | 383 | `-nowritecache` `<boolean>` :: |
1f554f76 DM |
384 | |
385 | disable write caching on the target | |
386 | ||
013dc89f | 387 | `-options` `<string>` :: |
1f554f76 DM |
388 | |
389 | NFS mount options (see 'man nfs') | |
390 | ||
013dc89f | 391 | `-pool` `<string>` :: |
1f554f76 DM |
392 | |
393 | Pool. | |
394 | ||
013dc89f | 395 | `-redundancy` `<integer> (1 - 16)` ('default =' `2`):: |
1f554f76 | 396 | |
c2993fe5 | 397 | 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 | 398 | |
013dc89f | 399 | `-saferemove` `<boolean>` :: |
1f554f76 DM |
400 | |
401 | Zero-out data when removing LVs. | |
402 | ||
013dc89f | 403 | `-saferemove_throughput` `<string>` :: |
1f554f76 DM |
404 | |
405 | Wipe throughput (cstream -t parameter value). | |
406 | ||
013dc89f | 407 | `-server` `<string>` :: |
1f554f76 DM |
408 | |
409 | Server IP or DNS name. | |
410 | ||
013dc89f | 411 | `-server2` `<string>` :: |
1f554f76 DM |
412 | |
413 | Backup volfile server IP or DNS name. | |
414 | + | |
415 | NOTE: Requires option(s): `server` | |
416 | ||
013dc89f | 417 | `-shared` `<boolean>` :: |
1f554f76 DM |
418 | |
419 | Mark storage as shared. | |
420 | ||
013dc89f | 421 | `-sparse` `<boolean>` :: |
1f554f76 DM |
422 | |
423 | use sparse volumes | |
424 | ||
013dc89f | 425 | `-tagged_only` `<boolean>` :: |
2c0dde61 DM |
426 | |
427 | Only use logical volumes tagged with 'pve-vm-ID'. | |
428 | ||
013dc89f | 429 | `-transport` `<rdma | tcp | unix>` :: |
1f554f76 DM |
430 | |
431 | Gluster transport: tcp or rdma | |
432 | ||
013dc89f | 433 | `-username` `<string>` :: |
1f554f76 DM |
434 | |
435 | RBD Id. | |
436 | ||
437 | ||
438 | ||
439 | ||
440 | *pvesm status* `[OPTIONS]` | |
441 | ||
442 | Get status for all datastores. | |
443 | ||
013dc89f | 444 | `-content` `<string>` :: |
1f554f76 DM |
445 | |
446 | Only list stores which support this content type. | |
447 | ||
013dc89f | 448 | `-enabled` `<boolean>` ('default =' `0`):: |
1f554f76 DM |
449 | |
450 | Only list stores which are enabled (not disabled in config). | |
451 | ||
013dc89f | 452 | `-storage` `<string>` :: |
1f554f76 DM |
453 | |
454 | Only list status for specified storage | |
455 | ||
013dc89f | 456 | `-target` `<string>` :: |
1f554f76 | 457 | |
c2993fe5 | 458 | 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 |
459 | |
460 | ||
461 | ||
462 | ||
463 | *pvesm zfsscan* | |
464 | ||
465 | Scan zfs pool list on local node. | |
466 | ||
467 | ||
468 | ||
469 |