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