Statistics
| Branch: | Tag: | Revision:

one / share / man / oneimage.1 @ 27e61bae

History | View | Annotate | Download (6.72 KB)

1
.\" generated with Ronn/v0.7.3
2
.\" http://github.com/rtomayko/ronn/tree/0.7.3
3
.
4
.TH "ONEIMAGE" "1" "July 2017" "" "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 (for
28
                           others, check the documentation)
29
 \-\-vcenter_disk_type vcenter_disk_type The vCenter Disk Type of the image
30
                           for vCenter: THIN, THICK, ZEROEDTHICK (for
31
                           others, check the documentation)
32
 \-\-vcenter_adapter_type vcenter_adapter_type Controller that will handle
33
                           this image in vCenter (lsiLogic, ide, busLogic)\.
34
                           For other values check the documentation
35
 \-\-source source           Source to be used\. Useful for not file\-based
36
                           images
37
 \-\-size size               Size in MB\. Used for DATABLOCK type or SOURCE
38
                           based images\.
39
 \-\-dry                     Just print the template
40
 \-a, \-\-append              Append new attributes to the current template
41
 \-l, \-\-list x,y,z          Selects columns to display with list command
42
 \-c, \-\-listconf conf       Selects a predefined column list
43
 \-d, \-\-delay x             Sets the delay in seconds for top command
44
 \-f, \-\-filter x,y,z        Filter data\. An array is specified with
45
                           column=value pairs\.
46
 \-\-csv                     Write table in csv format
47
 \-x, \-\-xml                 Show the resource in xml format
48
 \-n, \-\-numeric             Do not translate user and group IDs
49
 \-\-describe                Describe list columns
50
 \-v, \-\-verbose             Verbose mode
51
 \-h, \-\-help                Show this message
52
 \-V, \-\-version             Show version and copyright information
53
 \-\-user name               User name used to connect to OpenNebula
54
 \-\-password password       Password to authenticate with OpenNebula
55
 \-\-endpoint endpoint       URL of OpenNebula xmlrpc frontend
56
.
57
.fi
58
.
59
.SH "COMMANDS"
60
.
61
.IP "\(bu" 4
62
create [\fIfile\fR] Creates a new Image Examples:
63
.
64
.IP "" 4
65
.
66
.nf
67

    
68
  \- using a template description file:
69

    
70
    oneimage create \-d default centOS\.tmpl
71

    
72
  \- new image "arch" using a path:
73

    
74
    oneimage create \-d default \-\-name arch \-\-path /tmp/arch\.img
75

    
76
  \- new persistent image, OS type and qcow2 format:
77

    
78
    oneimage create \-d 1 \-\-name ubuntu \-\-path /tmp/ubuntu\.qcow2 \e
79
                    \-\-prefix sd \-\-type OS \-\-driver qcow2 \e
80
                    \-\-description "A OS plain installation \e
81
                    \-\-persistent"
82

    
83
  \- a datablock image of 400MB:
84

    
85
    oneimage create \-d 1 \-\-name data \-\-type DATABLOCK \-\-size 400
86
valid options: datastore, name, description, type, persistent, prefix, target, path, driver, disk_type, vcenter_disk_type, vcenter_adapter_type, source, size, dry
87
.
88
.fi
89
.
90
.IP "" 0
91

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