]>
Commit | Line | Data |
---|---|---|
1f554f76 DM |
1 | *pvesm* `<COMMAND> [ARGS] [OPTIONS]` |
2 | ||
3 | *pvesm add* `<type> <storage>` `[OPTIONS]` | |
4 | ||
5 | Create a new storage. | |
6 | ||
7 | `<type>` `(dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool)` :: | |
8 | ||
9 | Storage type. | |
10 | ||
11 | `<storage>` `string` :: | |
12 | ||
13 | The storage identifier. | |
14 | ||
15 | `-authsupported` `string` :: | |
16 | ||
17 | Authsupported. | |
18 | ||
19 | `-base` `string` :: | |
20 | ||
21 | Base volume. This volume is automatically activated. | |
22 | ||
23 | `-blocksize` `string` :: | |
24 | ||
25 | block size | |
26 | ||
27 | `-comstar_hg` `string` :: | |
28 | ||
29 | host group for comstar views | |
30 | ||
31 | `-comstar_tg` `string` :: | |
32 | ||
33 | target group for comstar views | |
34 | ||
35 | `-content` `string` :: | |
36 | ||
04ce4dfa DM |
37 | Allowed content types. |
38 | + | |
39 | NOTE: the value 'rootdir' is used for Containers, and value 'images' for | |
40 | VMs. | |
1f554f76 DM |
41 | |
42 | `-disable` `boolean` :: | |
43 | ||
44 | Flag to disable the storage. | |
45 | ||
46 | `-export` `string` :: | |
47 | ||
48 | NFS export path. | |
49 | ||
50 | `-format` `string` :: | |
51 | ||
04ce4dfa | 52 | Default image format. |
1f554f76 DM |
53 | |
54 | `-iscsiprovider` `string` :: | |
55 | ||
56 | iscsi provider | |
57 | ||
58 | `-krbd` `boolean` :: | |
59 | ||
60 | Access rbd through krbd kernel module. | |
61 | ||
62 | `-maxfiles` `integer (0 - N)` :: | |
63 | ||
64 | Maximal number of backup files per VM. Use '0' for unlimted. | |
65 | ||
66 | `-monhost` `string` :: | |
67 | ||
68 | Monitors daemon ips. | |
69 | ||
70 | `-nodes` `string` :: | |
71 | ||
72 | List of cluster node names. | |
73 | ||
74 | `-nowritecache` `boolean` :: | |
75 | ||
76 | disable write caching on the target | |
77 | ||
78 | `-options` `string` :: | |
79 | ||
80 | NFS mount options (see 'man nfs') | |
81 | ||
82 | `-path` `string` :: | |
83 | ||
84 | File system path. | |
85 | ||
86 | `-pool` `string` :: | |
87 | ||
88 | Pool. | |
89 | ||
90 | `-portal` `string` :: | |
91 | ||
92 | iSCSI portal (IP or DNS name with optional port). | |
93 | ||
94 | `-redundancy` `integer (1 - 16)` (default=`2`):: | |
95 | ||
96 | The redundancy count specifies the number of nodes to which the resource | |
97 | should be deployed. It must be at least 1 and at most the number of nodes | |
98 | in the cluster. | |
99 | ||
100 | `-saferemove` `boolean` :: | |
101 | ||
102 | Zero-out data when removing LVs. | |
103 | ||
104 | `-saferemove_throughput` `string` :: | |
105 | ||
106 | Wipe throughput (cstream -t parameter value). | |
107 | ||
108 | `-server` `string` :: | |
109 | ||
110 | Server IP or DNS name. | |
111 | ||
7aacca6f | 112 | `-server2` `string` :: |
1f554f76 DM |
113 | |
114 | Backup volfile server IP or DNS name. | |
115 | + | |
116 | NOTE: Requires option(s): `server` | |
117 | ||
118 | `-shared` `boolean` :: | |
119 | ||
120 | Mark storage as shared. | |
121 | ||
122 | `-sparse` `boolean` :: | |
123 | ||
124 | use sparse volumes | |
125 | ||
126 | `-target` `string` :: | |
127 | ||
128 | iSCSI target. | |
129 | ||
130 | `-thinpool` `string` :: | |
131 | ||
132 | LVM thin pool LV name. | |
133 | ||
134 | `-transport` `(rdma | tcp | unix)` :: | |
135 | ||
136 | Gluster transport: tcp or rdma | |
137 | ||
138 | `-username` `string` :: | |
139 | ||
140 | RBD Id. | |
141 | ||
142 | `-vgname` `string` :: | |
143 | ||
144 | Volume group name. | |
145 | ||
146 | `-volume` `string` :: | |
147 | ||
148 | Glusterfs Volume. | |
149 | ||
150 | ||
151 | ||
152 | ||
153 | *pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]` | |
154 | ||
155 | Allocate disk images. | |
156 | ||
157 | `<storage>` `string` :: | |
158 | ||
159 | The storage identifier. | |
160 | ||
161 | `<vmid>` `integer (1 - N)` :: | |
162 | ||
163 | Specify owner VM | |
164 | ||
165 | `<filename>` `string` :: | |
166 | ||
167 | The name of the file to create. | |
168 | ||
169 | `<size>` `\d+[MG]?` :: | |
170 | ||
171 | Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and | |
172 | 'G' (gigabyte, 1024M) | |
173 | ||
174 | `-format` `(qcow2 | raw | subvol)` :: | |
175 | ||
176 | no description available | |
177 | + | |
178 | NOTE: Requires option(s): `size` | |
179 | ||
180 | ||
181 | ||
182 | *pvesm free* `<volume>` `[OPTIONS]` | |
183 | ||
184 | Delete volume | |
185 | ||
186 | `<volume>` `string` :: | |
187 | ||
188 | Volume identifier | |
189 | ||
190 | `-storage` `string` :: | |
191 | ||
192 | The storage identifier. | |
193 | ||
194 | ||
195 | ||
196 | ||
197 | *pvesm glusterfsscan* `<server>` | |
198 | ||
199 | Scan remote GlusterFS server. | |
200 | ||
201 | `<server>` `string` :: | |
202 | ||
203 | no description available | |
204 | ||
205 | ||
206 | ||
207 | ||
208 | *pvesm help* `[<cmd>]` `[OPTIONS]` | |
209 | ||
210 | Get help about specified command. | |
211 | ||
212 | `<cmd>` `string` :: | |
213 | ||
214 | Command name | |
215 | ||
216 | `-verbose` `boolean` :: | |
217 | ||
218 | Verbose output format. | |
219 | ||
220 | ||
221 | ||
222 | ||
223 | *pvesm iscsiscan* `-portal <string>` `[OPTIONS]` | |
224 | ||
225 | Scan remote iSCSI server. | |
226 | ||
227 | `-portal` `string` :: | |
228 | ||
229 | no description available | |
230 | ||
231 | ||
232 | ||
233 | ||
234 | *pvesm list* `<storage>` `[OPTIONS]` | |
235 | ||
236 | List storage content. | |
237 | ||
238 | `<storage>` `string` :: | |
239 | ||
240 | The storage identifier. | |
241 | ||
242 | `-content` `string` :: | |
243 | ||
244 | Only list content of this type. | |
245 | ||
246 | `-vmid` `integer (1 - N)` :: | |
247 | ||
248 | Only list images for this VM | |
249 | ||
250 | ||
251 | ||
252 | ||
253 | *pvesm lvmscan* | |
254 | ||
255 | List local LVM volume groups. | |
256 | ||
257 | ||
258 | ||
9b3e4991 DM |
259 | *pvesm lvmthinscan* `<vg>` |
260 | ||
261 | List local LVM Thin Pools. | |
262 | ||
263 | `<vg>` `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` :: | |
264 | ||
265 | no description available | |
266 | ||
267 | ||
268 | ||
1f554f76 DM |
269 | *pvesm nfsscan* `<server>` |
270 | ||
271 | Scan remote NFS server. | |
272 | ||
273 | `<server>` `string` :: | |
274 | ||
275 | no description available | |
276 | ||
277 | ||
278 | ||
279 | ||
280 | *pvesm path* `<volume>` | |
281 | ||
282 | Get filesystem path for specified volume | |
283 | ||
284 | `<volume>` `string` :: | |
285 | ||
286 | Volume identifier | |
287 | ||
288 | ||
289 | ||
290 | ||
291 | *pvesm remove* `<storage>` | |
292 | ||
293 | Delete storage configuration. | |
294 | ||
295 | `<storage>` `string` :: | |
296 | ||
297 | The storage identifier. | |
298 | ||
299 | ||
300 | ||
301 | *pvesm set* `<storage>` `[OPTIONS]` | |
302 | ||
303 | Update storage configuration. | |
304 | ||
305 | `<storage>` `string` :: | |
306 | ||
307 | The storage identifier. | |
308 | ||
309 | `-blocksize` `string` :: | |
310 | ||
311 | block size | |
312 | ||
313 | `-comstar_hg` `string` :: | |
314 | ||
315 | host group for comstar views | |
316 | ||
317 | `-comstar_tg` `string` :: | |
318 | ||
319 | target group for comstar views | |
320 | ||
321 | `-content` `string` :: | |
322 | ||
04ce4dfa DM |
323 | Allowed content types. |
324 | + | |
325 | NOTE: the value 'rootdir' is used for Containers, and value 'images' for | |
326 | VMs. | |
1f554f76 DM |
327 | |
328 | `-delete` `string` :: | |
329 | ||
330 | A list of settings you want to delete. | |
331 | ||
332 | `-digest` `string` :: | |
333 | ||
334 | Prevent changes if current configuration file has different SHA1 digest. | |
335 | This can be used to prevent concurrent modifications. | |
336 | ||
337 | `-disable` `boolean` :: | |
338 | ||
339 | Flag to disable the storage. | |
340 | ||
341 | `-format` `string` :: | |
342 | ||
04ce4dfa | 343 | Default image format. |
1f554f76 DM |
344 | |
345 | `-krbd` `boolean` :: | |
346 | ||
347 | Access rbd through krbd kernel module. | |
348 | ||
349 | `-maxfiles` `integer (0 - N)` :: | |
350 | ||
351 | Maximal number of backup files per VM. Use '0' for unlimted. | |
352 | ||
353 | `-nodes` `string` :: | |
354 | ||
355 | List of cluster node names. | |
356 | ||
357 | `-nowritecache` `boolean` :: | |
358 | ||
359 | disable write caching on the target | |
360 | ||
361 | `-options` `string` :: | |
362 | ||
363 | NFS mount options (see 'man nfs') | |
364 | ||
365 | `-pool` `string` :: | |
366 | ||
367 | Pool. | |
368 | ||
369 | `-redundancy` `integer (1 - 16)` (default=`2`):: | |
370 | ||
371 | The redundancy count specifies the number of nodes to which the resource | |
372 | should be deployed. It must be at least 1 and at most the number of nodes | |
373 | in the cluster. | |
374 | ||
375 | `-saferemove` `boolean` :: | |
376 | ||
377 | Zero-out data when removing LVs. | |
378 | ||
379 | `-saferemove_throughput` `string` :: | |
380 | ||
381 | Wipe throughput (cstream -t parameter value). | |
382 | ||
383 | `-server` `string` :: | |
384 | ||
385 | Server IP or DNS name. | |
386 | ||
7aacca6f | 387 | `-server2` `string` :: |
1f554f76 DM |
388 | |
389 | Backup volfile server IP or DNS name. | |
390 | + | |
391 | NOTE: Requires option(s): `server` | |
392 | ||
393 | `-shared` `boolean` :: | |
394 | ||
395 | Mark storage as shared. | |
396 | ||
397 | `-sparse` `boolean` :: | |
398 | ||
399 | use sparse volumes | |
400 | ||
401 | `-transport` `(rdma | tcp | unix)` :: | |
402 | ||
403 | Gluster transport: tcp or rdma | |
404 | ||
405 | `-username` `string` :: | |
406 | ||
407 | RBD Id. | |
408 | ||
409 | ||
410 | ||
411 | ||
412 | *pvesm status* `[OPTIONS]` | |
413 | ||
414 | Get status for all datastores. | |
415 | ||
416 | `-content` `string` :: | |
417 | ||
418 | Only list stores which support this content type. | |
419 | ||
420 | `-enabled` `boolean` (default=`0`):: | |
421 | ||
422 | Only list stores which are enabled (not disabled in config). | |
423 | ||
424 | `-storage` `string` :: | |
425 | ||
426 | Only list status for specified storage | |
427 | ||
428 | `-target` `string` :: | |
429 | ||
430 | If target is different to 'node', we only lists shared storages which | |
431 | content is accessible on this 'node' and the specified 'target' node. | |
432 | ||
433 | ||
434 | ||
435 | ||
436 | *pvesm zfsscan* | |
437 | ||
438 | Scan zfs pool list on local node. | |
439 | ||
440 | ||
441 | ||
442 |