Statistics
| Branch: | Tag: | Revision:

one / share / man / oneimage.1 @ f3d57119

History | View | Annotate | Download (6.23 KB)

1
.\" generated with Ronn/v0.7.3
2
.\" http://github.com/rtomayko/ronn/tree/0.7.3
3
.
4
.TH "ONEIMAGE" "1" "August 2015" "" "oneimage(1) -- manages OpenNebula images"
5
.
6
.SH "NAME"
7
\fBoneimage\fR \- manages OpenNebula images
8
.
9
.SH "SYNOPSIS"
10
\fBoneimage\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
11
.
12
.SH "OPTIONS"
13
.
14
.nf
15

    
16
 \-d, \-\-datastore id|name   Selects the datastore
17
 \-\-name name               Name of the new image
18
 \-\-description description Description for the new Image
19
 \-\-type type               Type of the new Image: OS, CDROM, DATABLOCK,
20
                           KERNEL, RAMDISK, CONTEXT
21
 \-\-persistent              Tells if the image will be persistent
22
 \-\-prefix prefix           Device prefix for the disk (eg\. hd, sd, xvd or
23
                           vd)
24
 \-\-target target           Device the disk will be attached to
25
 \-\-path path               Path of the image file
26
 \-\-driver driver           Driver to use image (raw, qcow2, tap:aio:\.\.\.)
27
 \-\-disk_type disk_type     Type of the image (BLOCK, CDROM, RBD or FILE)
28
 \-\-source source           Source to be used\. Useful for not file\-based
29
                           images
30
 \-\-size size               Size in MB\. Used for DATABLOCK type or SOURCE
31
                           based images\.
32
 \-\-fstype fstype           Type of file system to be built\. This can be any
33
                           value understood by mkfs unix command\.
34
 \-\-dry                     Just print the template
35
 \-a, \-\-append              Append new attributes to the current template
36
 \-l, \-\-list x,y,z          Selects columns to display with list command
37
 \-d, \-\-delay x             Sets the delay in seconds for top command
38
 \-f, \-\-filter x,y,z        Filter data\. An array is specified with
39
                           column=value pairs\.
40
 \-\-csv                     Write table in csv format
41
 \-x, \-\-xml                 Show the resource in xml format
42
 \-n, \-\-numeric             Do not translate user and group IDs
43
 \-\-describe                Describe list columns
44
 \-v, \-\-verbose             Verbose mode
45
 \-h, \-\-help                Show this message
46
 \-V, \-\-version             Show version and copyright information
47
 \-\-user name               User name used to connect to OpenNebula
48
 \-\-password password       Password to authenticate with OpenNebula
49
 \-\-endpoint endpoint       URL of OpenNebula xmlrpc frontend
50
.
51
.fi
52
.
53
.SH "COMMANDS"
54
.
55
.IP "\(bu" 4
56
create [\fIfile\fR] Creates a new Image Examples:
57
.
58
.IP "" 4
59
.
60
.nf
61

    
62
  \- using a template description file:
63

    
64
    oneimage create \-d default centOS\.tmpl
65

    
66
  \- new image "arch" using a path:
67

    
68
    oneimage create \-d default \-\-name arch \-\-path /tmp/arch\.img
69

    
70
  \- new persistent image, OS type and qcow2 format:
71

    
72
    oneimage create \-d 1 \-\-name ubuntu \-\-path /tmp/ubuntu\.qcow2 \e
73
                    \-\-prefix sd \-\-type OS \-\-driver qcow2 \e
74
                    \-\-description "A OS plain installation"
75

    
76
  \- a datablock image of 400MB:
77

    
78
    oneimage create \-d 1 \-\-name data \-\-type DATABLOCK \-\-size 400 \e
79
                    \-\-fstype ext2
80
valid options: datastore, name, description, type, persistent, prefix, target, path, driver, disk_type, source, size, fstype, dry
81
.
82
.fi
83
.
84
.IP "" 0
85

    
86
.
87
.IP "\(bu" 4
88
clone \fIimageid\fR \fIname\fR Creates a new Image from an existing one valid options: datastore
89
.
90
.IP "\(bu" 4
91
delete \fIrange|imageid_list\fR Deletes the given Image
92
.
93
.IP "\(bu" 4
94
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\.
95
.
96
.IP "\(bu" 4
97
nonpersistent \fIrange|imageid_list\fR Makes the given Image non persistent\. See \'oneimage persistent\'
98
.
99
.IP "\(bu" 4
100
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\. valid options: append
101
.
102
.IP "\(bu" 4
103
enable \fIrange|imageid_list\fR Enables the given Image
104
.
105
.IP "\(bu" 4
106
chtype \fIrange|imageid_list\fR \fItype\fR Changes the Image\'s type
107
.
108
.IP "\(bu" 4
109
disable \fIrange|imageid_list\fR Disables the given Image
110
.
111
.IP "\(bu" 4
112
chgrp \fIrange|imageid_list\fR \fIgroupid\fR Changes the Image group
113
.
114
.IP "\(bu" 4
115
chown \fIrange|imageid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the Image owner and group
116
.
117
.IP "\(bu" 4
118
chmod \fIrange|imageid_list\fR \fIoctet\fR Changes the Image permissions
119
.
120
.IP "\(bu" 4
121
rename \fIimageid\fR \fIname\fR Renames the Image
122
.
123
.IP "\(bu" 4
124
snapshot\-delete \fIimageid\fR \fIsnapshot_id\fR Deletes a snapshot from the image
125
.
126
.IP "\(bu" 4
127
snapshot\-revert \fIimageid\fR \fIsnapshot_id\fR Reverts image state to a snapshot
128
.
129
.IP "\(bu" 4
130
snapshot\-flatten \fIimageid\fR \fIsnapshot_id\fR Flattens the snapshot and removes all other snapshots in the image
131
.
132
.IP "\(bu" 4
133
list [\fIfilterflag\fR] Lists Images in the pool valid options: list, delay, filter, csv, xml, numeric, describe
134
.
135
.IP "\(bu" 4
136
show \fIimageid\fR Shows information for the given Image valid options: xml
137
.
138
.IP "\(bu" 4
139
top [\fIfilterflag\fR] Lists Images continuously valid options: list, delay, filter, csv, xml, numeric, describe
140
.
141
.IP "" 0
142
.
143
.SH "ARGUMENT FORMATS"
144
.
145
.IP "\(bu" 4
146
file Path to a file
147
.
148
.IP "\(bu" 4
149
range List of id\'s in the form 1,8\.\.15
150
.
151
.IP "\(bu" 4
152
text String
153
.
154
.IP "\(bu" 4
155
groupid OpenNebula GROUP name or id
156
.
157
.IP "\(bu" 4
158
userid OpenNebula USER name or id
159
.
160
.IP "\(bu" 4
161
imageid OpenNebula IMAGE name or id
162
.
163
.IP "\(bu" 4
164
imageid_list Comma\-separated list of OpenNebula IMAGE names or ids
165
.
166
.IP "\(bu" 4
167
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
168
.
169
.IP "\(bu" 4
170
type Image type: OS, CDROM, DATABLOCK, KERNEL, RAMDISK, CONTEXT
171
.
172
.IP "" 0
173
.
174
.SH "LICENSE"
175
OpenNebula 4\.13\.80 Copyright 2002\-2015, OpenNebula Project (OpenNebula\.org), C12G Labs
176
.
177
.P
178
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