Revision d937cc33 share/man/onetemplate.1

View differences:

share/man/onetemplate.1
1 1
.\" generated with Ronn/v0.7.3
2 2
.\" http://github.com/rtomayko/ronn/tree/0.7.3
3 3
.
4
.TH "ONETEMPLATE" "1" "January 2013" "" "onetemplate(1) -- manages OpenNebula templates"
4
.TH "ONETEMPLATE" "1" "March 2013" "" "onetemplate(1) -- manages OpenNebula templates"
5 5
.
6 6
.SH "NAME"
7 7
\fBonetemplate\fR
......
13 13
.
14 14
.nf
15 15

  
16
 \-\-name name               Name of the new VM or TEMPLATE\. When instantiating
17
                           multiple VMs you can use the"%i" wildcard to produce
18
                           different names such as vm\-0, vm\-1\.\.\.
16
 \-\-name name               Name of the new VM or TEMPLATE\. When
17
                           instantiating multiple VMs you can use the "%i"
18
                           wildcard to produce different names such as
19
                           vm\-0, vm\-1\.\.\.
19 20
 \-\-cpu cpu                 CPU percentage reserved for the VM (1=100% one
20 21
                           CPU)
21 22
 \-\-vcpu vcpu               Number of virtualized CPUs
22 23
 \-\-arch arch               Architecture of the VM, e\.g\.: i386 or x86_64
23 24
 \-\-memory memory           Memory ammount given to the VM
24
 \-\-disk disk0,disk1        Disks to attach\. To use a disk owned by other
25
 \-\-disk image0,image1      Disks to attach\. To use an image owned by other
25 26
                           user use user[disk]
26
 \-\-network network0,network1 Networks to attach\. To use a network owned by
27
 \-\-nic network0,network1   Networks to attach\. To use a network owned by
27 28
                           other user use user[network]
28 29
 \-\-raw string              Raw string to add to the template\. Not to be
29 30
                           confused with the RAW attribute
30 31
 \-\-vnc                     Add VNC server to the VM
31
 \-\-ssh [file]              Add an ssh public key to the context\. If the
32
                           file is omited then the user variable
33
                           SSH_PUBLIC_KEY will be used\.
32
 \-\-ssh [file]              Add an ssh public key to the context\. If the file
33
                           is omited then the user variable SSH_PUBLIC_KEY
34
                           will be used\.
34 35
 \-\-net_context             Add network contextualization parameters
35 36
 \-\-context line1,line2,line3 Lines to add to the context section
36 37
 \-\-boot device             Select boot device (hd|fd|cdrom|network)
37 38
 \-\-dry                     Just print the template
38 39
 \-m, \-\-multiple x          Instance multiple VMs
39
 \-\-hold                    Creates the new VM on hold state instead of pending
40
 \-\-hold                    Creates the new VM on hold state instead of
41
                           pending
40 42
 \-l, \-\-list x,y,z          Selects columns to display with list command
41 43
 \-d, \-\-delay x             Sets the delay in seconds for top command
42 44
 \-f, \-\-filter x,y,z        Filter data\. An array is specified with
......
56 58
.SH "COMMANDS"
57 59
.
58 60
.IP "\(bu" 4
59
create [\fIfile\fR]
61
create [\fIfile\fR] Creates a new VM Template from the given description
60 62
.
61 63
.IP "" 4
62 64
.
63 65
.nf
64 66

  
65
Creates a new VM Template from the given description
66

  
67 67
Examples:
68 68
  \- using a VM Template description file:
69 69

  
......
71 71

  
72 72
  \- new VM Template named "arch vm" with a disk and a nic:
73 73

  
74
    onetemplate create \-\-name "arch vm" \-\-memory 128 \-\-cpu 1 \-\-disk arch \e
75
                 \-\-network private_lan
74
    onetemplate create \-\-name "arch vm" \-\-memory 128 \-\-cpu 1 \e
75
                       \-\-disk arch \-\-network private_lan
76 76

  
77 77
  \- using two disks:
78 78

  
79
    onetempate create \-\-name "test vm" \-\-memory 128 \-\-cpu 1 \-\-disk arch,data
80
valid options: name, cpu, vcpu, arch, memory, disk, network, raw, vnc, ssh, net_context, context, boot, dry
79
    onetempate create \-\-name "test vm" \-\-memory 128 \-\-cpu 1 \e
80
                      \-\-disk arch,data
81
valid options: name, cpu, vcpu, arch, memory, disk, nic, raw, vnc, ssh, net_context, context, boot, dry
81 82
.
82 83
.fi
83 84
.
......
85 86

  
86 87
.
87 88
.IP "\(bu" 4
88
clone \fItemplateid\fR \fIname\fR
89
.
90
.IP "" 4
91
.
92
.nf
93

  
94
Creates a new Template from an existing one
95
.
96
.fi
97
.
98
.IP "" 0
99

  
89
clone \fItemplateid\fR \fIname\fR Creates a new Template from an existing one
100 90
.
101 91
.IP "\(bu" 4
102
delete \fIrange|templateid_list\fR
103
.
104
.IP "" 4
105
.
106
.nf
107

  
108
Deletes the given Image
109
.
110
.fi
111
.
112
.IP "" 0
113

  
92
delete \fIrange|templateid_list\fR Deletes the given Image
114 93
.
115 94
.IP "\(bu" 4
116
instantiate \fItemplateid\fR
117
.
118
.IP "" 4
119
.
120
.nf
121

  
122
Creates a new VM instance from the given Template\. This VM can be
123
managed with the \'onevm\' command
124
valid options: name, multiple, hold
125
.
126
.fi
127
.
128
.IP "" 0
129

  
95
instantiate \fItemplateid\fR [\fIfile\fR] Creates a new VM instance from the given Template\. This VM can be managed with the \'onevm\' command valid options: name, multiple, hold, cpu, vcpu, arch, memory, disk, nic, raw, vnc, ssh, net_context, context, boot
130 96
.
131 97
.IP "\(bu" 4
132
publish \fIrange|templateid_list\fR
133
.
134
.IP "" 4
135
.
136
.nf
137

  
138
DEPRECATED, use chmod instead\. Publishes the given Template\. A public
139
Template can be seen and instantiated by other users in the Template\'s
140
group\.
141
.
142
.fi
143
.
144
.IP "" 0
145

  
98
publish \fIrange|templateid_list\fR DEPRECATED, use chmod instead\. Publishes the given Template\. A public Template can be seen and instantiated by other users in the Template\'s group\.
146 99
.
147 100
.IP "\(bu" 4
148
unpublish \fIrange|templateid_list\fR
149
.
150
.IP "" 4
151
.
152
.nf
153

  
154
DEPRECATED, use chmod instead\. Unpublishes the given Template\. A private
155
Template can\'t be instantiated by any other user\.
156
.
157
.fi
158
.
159
.IP "" 0
160

  
101
unpublish \fIrange|templateid_list\fR DEPRECATED, use chmod instead\. Unpublishes the given Template\. A private Template can\'t be instantiated by any other user\.
161 102
.
162 103
.IP "\(bu" 4
163
chgrp \fIrange|templateid_list\fR \fIgroupid\fR
164
.
165
.IP "" 4
166
.
167
.nf
168

  
169
Changes the Template group
170
.
171
.fi
172
.
173
.IP "" 0
174

  
104
chgrp \fIrange|templateid_list\fR \fIgroupid\fR Changes the Template group
175 105
.
176 106
.IP "\(bu" 4
177
chown \fIrange|templateid_list\fR \fIuserid\fR [\fIgroupid\fR]
178
.
179
.IP "" 4
180
.
181
.nf
182

  
183
Changes the Template owner and group
184
.
185
.fi
186
.
187
.IP "" 0
188

  
107
chown \fIrange|templateid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the Template owner and group
189 108
.
190 109
.IP "\(bu" 4
191
chmod \fIrange|templateid_list\fR \fIoctet\fR
192
.
193
.IP "" 4
194
.
195
.nf
196

  
197
Changes the Template permissions
198
.
199
.fi
200
.
201
.IP "" 0
202

  
110
chmod \fIrange|templateid_list\fR \fIoctet\fR Changes the Template permissions
203 111
.
204 112
.IP "\(bu" 4
205
update \fItemplateid\fR [\fIfile\fR]
206
.
207
.IP "" 4
208
.
209
.nf
210

  
211
Update the template contents\. If a path is not provided the editor will
212
be launched to modify the current content\.
213
.
214
.fi
215
.
216
.IP "" 0
217

  
113
update \fItemplateid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\.
218 114
.
219 115
.IP "\(bu" 4
220
rename \fItemplateid\fR \fIname\fR
221
.
222
.IP "" 4
223
.
224
.nf
225

  
226
Renames the Template
227
.
228
.fi
229
.
230
.IP "" 0
231

  
116
rename \fItemplateid\fR \fIname\fR Renames the Template
232 117
.
233 118
.IP "\(bu" 4
234
list [\fIfilterflag\fR]
235
.
236
.IP "" 4
237
.
238
.nf
239

  
240
Lists Templates in the pool
241
valid options: list, delay, filter, xml, numeric, describe
242
.
243
.fi
244
.
245
.IP "" 0
246

  
119
list [\fIfilterflag\fR] Lists Templates in the pool valid options: list, delay, filter, xml, numeric, describe
247 120
.
248 121
.IP "\(bu" 4
249
show \fItemplateid\fR
250
.
251
.IP "" 4
252
.
253
.nf
254

  
255
Shows information for the given Template
256
valid options: xml
257
.
258
.fi
259
.
260
.IP "" 0
261

  
122
show \fItemplateid\fR Shows information for the given Template valid options: xml
262 123
.
263 124
.IP "\(bu" 4
264
top [\fIfilterflag\fR]
265
.
266
.IP "" 4
267
.
268
.nf
269

  
270
Lists Templates continuously
271
valid options: list, delay, filter, xml, numeric, describe
272
.
273
.fi
274
.
275
.IP "" 0
276

  
125
top [\fIfilterflag\fR] Lists Templates continuously valid options: list, delay, filter, xml, numeric, describe
277 126
.
278 127
.IP "" 0
279 128
.
280 129
.SH "ARGUMENT FORMATS"
281 130
.
282 131
.IP "\(bu" 4
283
file
284
.
285
.IP "" 4
286
.
287
.nf
288

  
289
Path to a file
290
.
291
.fi
292
.
293
.IP "" 0
294

  
132
file Path to a file
295 133
.
296 134
.IP "\(bu" 4
297
range
298
.
299
.IP "" 4
300
.
301
.nf
302

  
303
List of id\'s in the form 1,8\.\.15
304
.
305
.fi
306
.
307
.IP "" 0
308

  
135
range List of id\'s in the form 1,8\.\.15
309 136
.
310 137
.IP "\(bu" 4
311
text
312
.
313
.IP "" 4
314
.
315
.nf
316

  
317
String
318
.
319
.fi
320
.
321
.IP "" 0
322

  
138
text String
323 139
.
324 140
.IP "\(bu" 4
325
groupid
326
.
327
.IP "" 4
328
.
329
.nf
330

  
331
OpenNebula GROUP name or id
332
.
333
.fi
334
.
335
.IP "" 0
336

  
141
groupid OpenNebula GROUP name or id
337 142
.
338 143
.IP "\(bu" 4
339
userid
340
.
341
.IP "" 4
342
.
343
.nf
344

  
345
OpenNebula USER name or id
346
.
347
.fi
348
.
349
.IP "" 0
350

  
144
userid OpenNebula USER name or id
351 145
.
352 146
.IP "\(bu" 4
353
templateid
354
.
355
.IP "" 4
356
.
357
.nf
358

  
359
OpenNebula VMTEMPLATE name or id
360
.
361
.fi
362
.
363
.IP "" 0
364

  
147
templateid OpenNebula VMTEMPLATE name or id
365 148
.
366 149
.IP "\(bu" 4
367
templateid_list
368
.
369
.IP "" 4
370
.
371
.nf
372

  
373
Comma\-separated list of OpenNebula VMTEMPLATE names or ids
374
.
375
.fi
376
.
377
.IP "" 0
378

  
150
templateid_list Comma\-separated list of OpenNebula VMTEMPLATE names or ids
379 151
.
380 152
.IP "\(bu" 4
381
filterflag
382
.
383
.IP "" 4
384
.
385
.nf
386

  
387
a, all       all the known VMTEMPLATEs
388
m, mine      the VMTEMPLATE belonging to the user in ONE_AUTH
389
g, group     \'mine\' plus the VMTEMPLATE belonging to the groups
390
             the user is member of
391
uid          VMTEMPLATE of the user identified by this uid
392
user         VMTEMPLATE of the user identified by the username
393
.
394
.fi
395
.
396
.IP "" 0
397

  
153
filterflag a, all all the known VMTEMPLATEs m, mine the VMTEMPLATE belonging to the user in ONE_AUTH g, group \'mine\' plus the VMTEMPLATE belonging to the groups the user is member of uid VMTEMPLATE of the user identified by this uid user VMTEMPLATE of the user identified by the username
398 154
.
399 155
.IP "" 0
400 156
.
401 157
.SH "LICENSE"
402
OpenNebula 3\.9\.0 Copyright 2002\-2013, OpenNebula Project (OpenNebula\.org), C12G Labs
158
OpenNebula 3\.9\.80 Copyright 2002\-2013, OpenNebula Project (OpenNebula\.org), C12G Labs
403 159
.
404 160
.P
405 161
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