Revision d937cc33 share/man/oneimage.1

View differences:

share/man/oneimage.1
1 1
.\" generated with Ronn/v0.7.3
2 2
.\" http://github.com/rtomayko/ronn/tree/0.7.3
3 3
.
4
.TH "ONEIMAGE" "1" "January 2013" "" "oneimage(1) -- manages OpenNebula images"
4
.TH "ONEIMAGE" "1" "March 2013" "" "oneimage(1) -- manages OpenNebula images"
5 5
.
6 6
.SH "NAME"
7 7
\fBoneimage\fR
......
16 16
 \-d, \-\-datastore id|name   Selects the datastore
17 17
 \-\-name name               Name of the new image
18 18
 \-\-description description Description for the new Image
19
 \-\-type type               Type of the new Image: OS, CDROM, DATABLOCK, KERNEL, RAMDISK, CONTEXT
19
 \-\-type type               Type of the new Image: OS, CDROM, DATABLOCK,
20
                           KERNEL, RAMDISK, CONTEXT
20 21
 \-\-persistent              Tells if the image will be persistent
21
 \-\-prefix prefix           Device prefix for the disk (eg\. hd, sd, xvd
22
                           or vd)
22
 \-\-prefix prefix           Device prefix for the disk (eg\. hd, sd, xvd or
23
                           vd)
23 24
 \-\-target target           Device the disk will be attached to
24 25
 \-\-path path               Path of the image file
25 26
 \-\-driver driver           Driver to use image (raw, qcow2, tap:aio:\.\.\.)
26
 \-\-disk_type disk_type     Type of the image (BLOCK, CDROM or FILE)
27
 \-\-disk_type disk_type     Type of the image (BLOCK, CDROM, RBD or FILE)
27 28
 \-\-source source           Source to be used\. Useful for not file\-based
28 29
                           images
29 30
 \-\-size size               Size in MB\. Used for DATABLOCK type
30
 \-\-fstype fstype           Type of file system to be built\. This can be
31
                           any value understood by mkfs unix command\.
31
 \-\-fstype fstype           Type of file system to be built\. This can be any
32
                           value understood by mkfs unix command\.
32 33
 \-\-dry                     Just print the template
33 34
 \-l, \-\-list x,y,z          Selects columns to display with list command
34 35
 \-d, \-\-delay x             Sets the delay in seconds for top command
......
49 50
.SH "COMMANDS"
50 51
.
51 52
.IP "\(bu" 4
52
create [\fIfile\fR]
53
create [\fIfile\fR] Creates a new Image Examples:
53 54
.
54 55
.IP "" 4
55 56
.
56 57
.nf
57 58

  
58
Creates a new Image
59
Examples:
60 59
  \- using a template description file:
61 60

  
62 61
    oneimage create \-d default centOS\.tmpl
......
83 82

  
84 83
.
85 84
.IP "\(bu" 4
86
clone \fIimageid\fR \fIname\fR
87
.
88
.IP "" 4
89
.
90
.nf
91

  
92
Creates a new Image from an existing one
93
.
94
.fi
95
.
96
.IP "" 0
97

  
85
clone \fIimageid\fR \fIname\fR Creates a new Image from an existing one
98 86
.
99 87
.IP "\(bu" 4
100
delete \fIrange|imageid_list\fR
101
.
102
.IP "" 4
103
.
104
.nf
105

  
106
Deletes the given Image
107
.
108
.fi
109
.
110
.IP "" 0
111

  
88
delete \fIrange|imageid_list\fR Deletes the given Image
112 89
.
113 90
.IP "\(bu" 4
114
publish \fIrange|imageid_list\fR
115
.
116
.IP "" 4
117
.
118
.nf
119

  
120
DEPRECATED, use chmod instead\. Publishes the given Image\. A public Image
121
can be seen and used by other users in the Image\'s group\.
122
.
123
.fi
124
.
125
.IP "" 0
126

  
91
publish \fIrange|imageid_list\fR DEPRECATED, use chmod instead\. Publishes the given Image\. A public Image can be seen and used by other users in the Image\'s group\.
127 92
.
128 93
.IP "\(bu" 4
129
unpublish \fIrange|imageid_list\fR
130
.
131
.IP "" 4
132
.
133
.nf
134

  
135
DEPRECATED, use chmod instead\. Unpublishes the given Image\. A private
136
Image can\'t be used by any other user\.
137
.
138
.fi
139
.
140
.IP "" 0
141

  
94
unpublish \fIrange|imageid_list\fR DEPRECATED, use chmod instead\. Unpublishes the given Image\. A private Image can\'t be used by any other user\.
142 95
.
143 96
.IP "\(bu" 4
144
persistent \fIrange|imageid_list\fR
145
.
146
.IP "" 4
147
.
148
.nf
149

  
150
Makes the given Image persistent\. A persistent Image saves the changes
151
made to the contents after the VM instance is shutdown (or in real time
152
if a shared FS is used)\. Persistent Images can be used by only
153
one VM instance at a time\.
154
.
155
.fi
156
.
157
.IP "" 0
158

  
97
persistent \fIrange|imageid_list\fR Makes the given Image persistent\. A persistent Image saves the changes made to the contents after the VM instance is shutdown (or in real time if a shared FS is used)\. Persistent Images can be used by only one VM instance at a time\.
159 98
.
160 99
.IP "\(bu" 4
161
nonpersistent \fIrange|imageid_list\fR
162
.
163
.IP "" 4
164
.
165
.nf
166

  
167
Makes the given Image non persistent\. See \'oneimage persistent\'
168
.
169
.fi
170
.
171
.IP "" 0
172

  
100
nonpersistent \fIrange|imageid_list\fR Makes the given Image non persistent\. See \'oneimage persistent\'
173 101
.
174 102
.IP "\(bu" 4
175
update \fIimageid\fR [\fIfile\fR]
176
.
177
.IP "" 4
178
.
179
.nf
180

  
181
Update the template contents\. If a path is not provided the editor will
182
be launched to modify the current content\.
183
.
184
.fi
185
.
186
.IP "" 0
187

  
103
update \fIimageid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\.
188 104
.
189 105
.IP "\(bu" 4
190
enable \fIrange|imageid_list\fR
191
.
192
.IP "" 4
193
.
194
.nf
195

  
196
Enables the given Image
197
.
198
.fi
199
.
200
.IP "" 0
201

  
106
enable \fIrange|imageid_list\fR Enables the given Image
202 107
.
203 108
.IP "\(bu" 4
204
chtype \fIrange|imageid_list\fR \fItype\fR
205
.
206
.IP "" 4
207
.
208
.nf
209

  
210
Changes the Image\'s type
211
.
212
.fi
213
.
214
.IP "" 0
215

  
109
chtype \fIrange|imageid_list\fR \fItype\fR Changes the Image\'s type
216 110
.
217 111
.IP "\(bu" 4
218
disable \fIrange|imageid_list\fR
219
.
220
.IP "" 4
221
.
222
.nf
223

  
224
Disables the given Image
225
.
226
.fi
227
.
228
.IP "" 0
229

  
112
disable \fIrange|imageid_list\fR Disables the given Image
230 113
.
231 114
.IP "\(bu" 4
232
chgrp \fIrange|imageid_list\fR \fIgroupid\fR
233
.
234
.IP "" 4
235
.
236
.nf
237

  
238
Changes the Image group
239
.
240
.fi
241
.
242
.IP "" 0
243

  
115
chgrp \fIrange|imageid_list\fR \fIgroupid\fR Changes the Image group
244 116
.
245 117
.IP "\(bu" 4
246
chown \fIrange|imageid_list\fR \fIuserid\fR [\fIgroupid\fR]
247
.
248
.IP "" 4
249
.
250
.nf
251

  
252
Changes the Image owner and group
253
.
254
.fi
255
.
256
.IP "" 0
257

  
118
chown \fIrange|imageid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the Image owner and group
258 119
.
259 120
.IP "\(bu" 4
260
chmod \fIrange|imageid_list\fR \fIoctet\fR
261
.
262
.IP "" 4
263
.
264
.nf
265

  
266
Changes the Image permissions
267
.
268
.fi
269
.
270
.IP "" 0
271

  
121
chmod \fIrange|imageid_list\fR \fIoctet\fR Changes the Image permissions
272 122
.
273 123
.IP "\(bu" 4
274
rename \fIimageid\fR \fIname\fR
275
.
276
.IP "" 4
277
.
278
.nf
279

  
280
Renames the Image
281
.
282
.fi
283
.
284
.IP "" 0
285

  
124
rename \fIimageid\fR \fIname\fR Renames the Image
286 125
.
287 126
.IP "\(bu" 4
288
list [\fIfilterflag\fR]
289
.
290
.IP "" 4
291
.
292
.nf
293

  
294
Lists Images in the pool
295
valid options: list, delay, filter, xml, numeric, describe
296
.
297
.fi
298
.
299
.IP "" 0
300

  
127
list [\fIfilterflag\fR] Lists Images in the pool valid options: list, delay, filter, xml, numeric, describe
301 128
.
302 129
.IP "\(bu" 4
303
show \fIimageid\fR
304
.
305
.IP "" 4
306
.
307
.nf
308

  
309
Shows information for the given Image
310
valid options: xml
311
.
312
.fi
313
.
314
.IP "" 0
315

  
130
show \fIimageid\fR Shows information for the given Image valid options: xml
316 131
.
317 132
.IP "\(bu" 4
318
top [\fIfilterflag\fR]
319
.
320
.IP "" 4
321
.
322
.nf
323

  
324
Lists Images continuously
325
valid options: list, delay, filter, xml, numeric, describe
326
.
327
.fi
328
.
329
.IP "" 0
330

  
133
top [\fIfilterflag\fR] Lists Images continuously valid options: list, delay, filter, xml, numeric, describe
331 134
.
332 135
.IP "" 0
333 136
.
334 137
.SH "ARGUMENT FORMATS"
335 138
.
336 139
.IP "\(bu" 4
337
file
338
.
339
.IP "" 4
340
.
341
.nf
342

  
343
Path to a file
344
.
345
.fi
346
.
347
.IP "" 0
348

  
140
file Path to a file
349 141
.
350 142
.IP "\(bu" 4
351
range
352
.
353
.IP "" 4
354
.
355
.nf
356

  
357
List of id\'s in the form 1,8\.\.15
358
.
359
.fi
360
.
361
.IP "" 0
362

  
143
range List of id\'s in the form 1,8\.\.15
363 144
.
364 145
.IP "\(bu" 4
365
text
366
.
367
.IP "" 4
368
.
369
.nf
370

  
371
String
372
.
373
.fi
374
.
375
.IP "" 0
376

  
146
text String
377 147
.
378 148
.IP "\(bu" 4
379
groupid
380
.
381
.IP "" 4
382
.
383
.nf
384

  
385
OpenNebula GROUP name or id
386
.
387
.fi
388
.
389
.IP "" 0
390

  
149
groupid OpenNebula GROUP name or id
391 150
.
392 151
.IP "\(bu" 4
393
userid
394
.
395
.IP "" 4
396
.
397
.nf
398

  
399
OpenNebula USER name or id
400
.
401
.fi
402
.
403
.IP "" 0
404

  
152
userid OpenNebula USER name or id
405 153
.
406 154
.IP "\(bu" 4
407
imageid
408
.
409
.IP "" 4
410
.
411
.nf
412

  
413
OpenNebula IMAGE name or id
414
.
415
.fi
416
.
417
.IP "" 0
418

  
155
imageid OpenNebula IMAGE name or id
419 156
.
420 157
.IP "\(bu" 4
421
imageid_list
422
.
423
.IP "" 4
424
.
425
.nf
426

  
427
Comma\-separated list of OpenNebula IMAGE names or ids
428
.
429
.fi
430
.
431
.IP "" 0
432

  
158
imageid_list Comma\-separated list of OpenNebula IMAGE names or ids
433 159
.
434 160
.IP "\(bu" 4
435
filterflag
436
.
437
.IP "" 4
438
.
439
.nf
440

  
441
a, all       all the known IMAGEs
442
m, mine      the IMAGE belonging to the user in ONE_AUTH
443
g, group     \'mine\' plus the IMAGE belonging to the groups
444
             the user is member of
445
uid          IMAGE of the user identified by this uid
446
user         IMAGE of the user identified by the username
447
.
448
.fi
449
.
450
.IP "" 0
451

  
161
filterflag a, all all the known IMAGEs m, mine the IMAGE belonging to the user in ONE_AUTH g, group \'mine\' plus the IMAGE belonging to the groups the user is member of uid IMAGE of the user identified by this uid user IMAGE of the user identified by the username
452 162
.
453 163
.IP "\(bu" 4
454
type
455
.
456
.IP "" 4
457
.
458
.nf
459

  
460
Image type: OS, CDROM, DATABLOCK, KERNEL, RAMDISK, CONTEXT
461
.
462
.fi
463
.
464
.IP "" 0
465

  
164
type Image type: OS, CDROM, DATABLOCK, KERNEL, RAMDISK, CONTEXT
466 165
.
467 166
.IP "" 0
468 167
.
469 168
.SH "LICENSE"
470
OpenNebula 3\.9\.0 Copyright 2002\-2013, OpenNebula Project (OpenNebula\.org), C12G Labs
169
OpenNebula 3\.9\.80 Copyright 2002\-2013, OpenNebula Project (OpenNebula\.org), C12G Labs
471 170
.
472 171
.P
473 172
Licensed under the Apache License, Version 2\.0 (the "License"); you may not use this file except in compliance with the License\. You may obtain a copy of the License at http://www\.apache\.org/licenses/LICENSE\-2\.0

Also available in: Unified diff