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