Statistics
| Branch: | Tag: | Revision:

one / share / man / onetemplate.1 @ f3d57119

History | View | Annotate | Download (7.55 KB)

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

    
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\.\.\.
20
 \-\-cpu cpu                 CPU percentage reserved for the VM (1=100% one
21
                           CPU)
22
 \-\-vcpu vcpu               Number of virtualized CPUs
23
 \-\-arch arch               Architecture of the VM, e\.g\.: i386 or x86_64
24
 \-\-memory memory           Memory amount given to the VM\. By default the
25
                           unit is megabytes\. To use gigabytes add a \'g\',
26
                           floats can be used: 8g=8192, 0\.5g=512
27
 \-\-disk image0,image1      Disks to attach\. To use an image owned by other
28
                           user use user[disk]\. Add any additional
29
                           attributes separated by \':\' and in the shape of
30
                           KEY=VALUE\. For example, if the disk must be
31
                           resized, use image0:size=1000 \. Or
32
                           image0:size=1000:target=vda,image1:target=vdb
33
 \-\-nic network0,network1   Networks to attach\. To use a network owned by
34
                           other user use user[network]\. Additional
35
                           attributes are supported like with the \-\-disk
36
                           option\.
37
 \-\-raw string              Raw string to add to the template\. Not to be
38
                           confused with the RAW attribute
39
 \-\-vnc                     Add VNC server to the VM
40
 \-\-vnc\-password password   VNC password
41
 \-\-vnc\-listen ip           VNC IP where to listen for connections\. By
42
                           default is 0\.0\.0\.0 (all interfaces)\.
43
 \-\-spice                   Add spice server to the VM
44
 \-\-spice\-password password spice password
45
 \-\-spice\-listen ip         spice IP where to listen for connections\. By
46
                           default is 0\.0\.0\.0 (all interfaces)\.
47
 \-\-ssh [file]              Add an ssh public key to the context\. If the file
48
                           is omited then the user variable SSH_PUBLIC_KEY
49
                           will be used\.
50
 \-\-net_context             Add network contextualization parameters
51
 \-\-context line1,line2,line3 Lines to add to the context section
52
 \-\-boot device             Select boot device (hd|fd|cdrom|network)
53
 \-\-files_ds file1,file2    Add files to the contextualization CD from
54
                           thefiles datastore
55
 \-\-init script1,script2    Script or scripts to start in context
56
 \-\-dry                     Just print the template
57
 \-m, \-\-multiple x          Instance multiple VMs
58
 \-\-userdata userdata       Integrate userdata into the EC2 section
59
 \-\-hold                    Creates the new VM on hold state instead of
60
                           pending
61
 \-a, \-\-append              Append new attributes to the current template
62
 \-l, \-\-list x,y,z          Selects columns to display with list command
63
 \-d, \-\-delay x             Sets the delay in seconds for top command
64
 \-f, \-\-filter x,y,z        Filter data\. An array is specified with
65
                           column=value pairs\.
66
 \-\-csv                     Write table in csv format
67
 \-x, \-\-xml                 Show the resource in xml format
68
 \-n, \-\-numeric             Do not translate user and group IDs
69
 \-\-describe                Describe list columns
70
 \-\-extended                Process the template and included extended
71
                           information, such as the SIZE for each DISK
72
 \-v, \-\-verbose             Verbose mode
73
 \-h, \-\-help                Show this message
74
 \-V, \-\-version             Show version and copyright information
75
 \-\-user name               User name used to connect to OpenNebula
76
 \-\-password password       Password to authenticate with OpenNebula
77
 \-\-endpoint endpoint       URL of OpenNebula xmlrpc frontend
78
.
79
.fi
80
.
81
.SH "COMMANDS"
82
.
83
.IP "\(bu" 4
84
create [\fIfile\fR] Creates a new VM Template from the given description
85
.
86
.IP "" 4
87
.
88
.nf
89

    
90
Examples:
91
  \- using a VM Template description file:
92

    
93
    onetemplate create vm_description\.tmpl
94

    
95
  \- new VM Template named "arch vm" with a disk and a nic:
96

    
97
    onetemplate create \-\-name "arch vm" \-\-memory 128 \-\-cpu 1 \e
98
                       \-\-disk arch \-\-network private_lan
99

    
100
  \- using two disks:
101

    
102
    onetempate create \-\-name "test vm" \-\-memory 128 \-\-cpu 1 \e
103
                      \-\-disk arch,data
104
valid options: name, cpu, vcpu, arch, memory, disk, nic, raw, vnc, vnc_password, vnc_listen, spice, spice_password, spice_listen, ssh, net_context, context, boot, files_ds, init, dry
105
.
106
.fi
107
.
108
.IP "" 0
109

    
110
.
111
.IP "\(bu" 4
112
clone \fItemplateid\fR \fIname\fR Creates a new Template from an existing one
113
.
114
.IP "\(bu" 4
115
delete \fIrange|templateid_list\fR Deletes the given Image
116
.
117
.IP "\(bu" 4
118
instantiate \fItemplateid\fR [\fIfile\fR] Creates a new VM instance from the given Template\. This VM can be managed with the \'onevm\' command\.
119
.
120
.IP "" 4
121
.
122
.nf
123

    
124
The source Template can be modified adding or replacing attributes with
125
the optional file argument, or with the options\.
126
valid options: name, multiple, userdata, hold, cpu, vcpu, arch, memory, disk, nic, raw, vnc, vnc_password, vnc_listen, spice, spice_password, spice_listen, ssh, net_context, context, boot, files_ds, init
127
.
128
.fi
129
.
130
.IP "" 0
131

    
132
.
133
.IP "\(bu" 4
134
chgrp \fIrange|templateid_list\fR \fIgroupid\fR Changes the Template group
135
.
136
.IP "\(bu" 4
137
chown \fIrange|templateid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the Template owner and group
138
.
139
.IP "\(bu" 4
140
chmod \fIrange|templateid_list\fR \fIoctet\fR Changes the Template permissions
141
.
142
.IP "\(bu" 4
143
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\. valid options: append
144
.
145
.IP "\(bu" 4
146
rename \fItemplateid\fR \fIname\fR Renames the Template
147
.
148
.IP "\(bu" 4
149
list [\fIfilterflag\fR] Lists Templates in the pool valid options: list, delay, filter, csv, xml, numeric, describe
150
.
151
.IP "\(bu" 4
152
show \fItemplateid\fR Shows information for the given Template valid options: xml, extended
153
.
154
.IP "\(bu" 4
155
top [\fIfilterflag\fR] Lists Templates continuously valid options: list, delay, filter, csv, xml, numeric, describe
156
.
157
.IP "" 0
158
.
159
.SH "ARGUMENT FORMATS"
160
.
161
.IP "\(bu" 4
162
file Path to a file
163
.
164
.IP "\(bu" 4
165
range List of id\'s in the form 1,8\.\.15
166
.
167
.IP "\(bu" 4
168
text String
169
.
170
.IP "\(bu" 4
171
groupid OpenNebula GROUP name or id
172
.
173
.IP "\(bu" 4
174
userid OpenNebula USER name or id
175
.
176
.IP "\(bu" 4
177
templateid OpenNebula VMTEMPLATE name or id
178
.
179
.IP "\(bu" 4
180
templateid_list Comma\-separated list of OpenNebula VMTEMPLATE names or ids
181
.
182
.IP "\(bu" 4
183
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
184
.
185
.IP "" 0
186
.
187
.SH "LICENSE"
188
OpenNebula 4\.13\.80 Copyright 2002\-2015, OpenNebula Project (OpenNebula\.org), C12G Labs
189
.
190
.P
191
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