Statistics
| Branch: | Tag: | Revision:

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

History | View | Annotate | Download (8.75 KB)

1
.\" generated with Ronn/v0.7.3
2
.\" http://github.com/rtomayko/ronn/tree/0.7.3
3
.
4
.TH "ONETEMPLATE" "1" "July 2017" "" "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
 \-\-vnc\-keymap keymap       VNC keyboard layout
44
 \-\-spice                   Add spice server to the VM
45
 \-\-spice\-password password spice password
46
 \-\-spice\-listen ip         spice IP where to listen for connections\. By
47
                           default is 0\.0\.0\.0 (all interfaces)\.
48
 \-\-spice\-keymap keymap     spice keyboard layout
49
 \-\-ssh [file]              Add an ssh public key to the context\. If the file
50
                           is omited then the user variable SSH_PUBLIC_KEY
51
                           will be used\.
52
 \-\-net_context             Add network contextualization parameters
53
 \-\-context line1,line2,line3 Lines to add to the context section
54
 \-\-boot device_list        Set boot device list e\.g\. disk0,disk2,nic0
55
 \-\-files_ds file1,file2    Add files to the contextualization CD from
56
                           thefiles datastore
57
 \-\-init script1,script2    Script or scripts to start in context
58
 \-\-startscript [file]      Start script to be executed
59
 \-\-report_ready            Sends READY=YES to OneGate, useful for OneFlow
60
 \-\-vcenter_vm_folder path  In a vCenter environment sets the the VMs and
61
                           Template folder where the VM will be placed in\.
62
                           The path uses slashes to separate folders\. For
63
                           example: \-\-vcenter_vm_folder "/Management/VMs"
64
 \-\-dry                     Just print the template
65
 \-\-recursive               Applies the action to the template plus any image
66
                           defined in DISK
67
 \-m, \-\-multiple x          Instance multiple VMs
68
 \-\-userdata userdata       Integrate userdata into the EC2 section
69
 \-\-hold                    Creates the new VM on hold state instead of
70
                           pending
71
 \-\-persistent              Creates a private persistent copy of the template
72
                           plus any image defined in DISK, and instantiates
73
                           that copy
74
 \-a, \-\-append              Append new attributes to the current template
75
 \-l, \-\-list x,y,z          Selects columns to display with list command
76
 \-c, \-\-listconf conf       Selects a predefined column list
77
 \-d, \-\-delay x             Sets the delay in seconds for top command
78
 \-f, \-\-filter x,y,z        Filter data\. An array is specified with
79
                           column=value pairs\.
80
 \-\-csv                     Write table in csv format
81
 \-x, \-\-xml                 Show the resource in xml format
82
 \-n, \-\-numeric             Do not translate user and group IDs
83
 \-\-describe                Describe list columns
84
 \-\-extended                Process the template and included extended
85
                           information, such as the SIZE for each DISK
86
 \-v, \-\-verbose             Verbose mode
87
 \-h, \-\-help                Show this message
88
 \-V, \-\-version             Show version and copyright information
89
 \-\-user name               User name used to connect to OpenNebula
90
 \-\-password password       Password to authenticate with OpenNebula
91
 \-\-endpoint endpoint       URL of OpenNebula xmlrpc frontend
92
.
93
.fi
94
.
95
.SH "COMMANDS"
96
.
97
.IP "\(bu" 4
98
create [\fIfile\fR] Creates a new VM Template from the given description
99
.
100
.IP "" 4
101
.
102
.nf
103

    
104
Examples:
105
  \- using a VM Template description file:
106

    
107
    onetemplate create vm_description\.tmpl
108

    
109
  \- new VM Template named "arch vm" with a disk and a nic:
110

    
111
    onetemplate create \-\-name "arch vm" \-\-memory 128 \-\-cpu 1 \e
112
                       \-\-disk arch \-\-network private_lan
113

    
114
  \- using two disks:
115

    
116
    onetempate create \-\-name "test vm" \-\-memory 128 \-\-cpu 1 \e
117
                      \-\-disk arch,data
118
valid options: name, cpu, vcpu, arch, memory, disk, nic, raw, vnc, vnc_password, vnc_listen, vnc_keymap, spice, spice_password, spice_listen, spice_keymap, ssh, net_context, context, boot, files_ds, init, startscript, report_ready, vcenter_vm_folder, dry
119
.
120
.fi
121
.
122
.IP "" 0
123

    
124
.
125
.IP "\(bu" 4
126
clone \fItemplateid\fR \fIname\fR Creates a new Template from an existing one valid options: recursive
127
.
128
.IP "\(bu" 4
129
delete \fIrange|templateid_list\fR Deletes the given Template valid options: recursive
130
.
131
.IP "\(bu" 4
132
instantiate \fItemplateid\fR [\fIfile\fR] Creates a new VM instance from the given Template\. This VM can be managed with the \'onevm\' command\.
133
.
134
.IP "" 4
135
.
136
.nf
137

    
138
The source Template can be modified adding or replacing attributes with
139
the optional file argument, or with the options\.
140
valid options: name, multiple, userdata, hold, persistent, cpu, vcpu, arch, memory, disk, nic, raw, vnc, vnc_password, vnc_listen, vnc_keymap, spice, spice_password, spice_listen, spice_keymap, ssh, net_context, context, boot, files_ds, init, startscript, report_ready, vcenter_vm_folder
141
.
142
.fi
143
.
144
.IP "" 0
145

    
146
.
147
.IP "\(bu" 4
148
chgrp \fIrange|templateid_list\fR \fIgroupid\fR Changes the Template group
149
.
150
.IP "\(bu" 4
151
chown \fIrange|templateid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the Template owner and group
152
.
153
.IP "\(bu" 4
154
chmod \fIrange|templateid_list\fR \fIoctet\fR Changes the Template permissions valid options: recursive
155
.
156
.IP "\(bu" 4
157
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
158
.
159
.IP "\(bu" 4
160
rename \fItemplateid\fR \fIname\fR Renames the Template
161
.
162
.IP "\(bu" 4
163
list [\fIfilterflag\fR] Lists Templates in the pool valid options: list, listconf, delay, filter, csv, xml, numeric, describe
164
.
165
.IP "\(bu" 4
166
show \fItemplateid\fR Shows information for the given Template valid options: xml, extended
167
.
168
.IP "\(bu" 4
169
top [\fIfilterflag\fR] Lists Templates continuously valid options: list, listconf, delay, filter, csv, xml, numeric, describe
170
.
171
.IP "" 0
172
.
173
.SH "ARGUMENT FORMATS"
174
.
175
.IP "\(bu" 4
176
file Path to a file
177
.
178
.IP "\(bu" 4
179
range List of id\'s in the form 1,8\.\.15
180
.
181
.IP "\(bu" 4
182
text String
183
.
184
.IP "\(bu" 4
185
groupid OpenNebula GROUP name or id
186
.
187
.IP "\(bu" 4
188
userid OpenNebula USER name or id
189
.
190
.IP "\(bu" 4
191
templateid OpenNebula VMTEMPLATE name or id
192
.
193
.IP "\(bu" 4
194
templateid_list Comma\-separated list of OpenNebula VMTEMPLATE names or ids
195
.
196
.IP "\(bu" 4
197
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 G, primary group the VMTEMPLATE owned the user\'s primary group uid VMTEMPLATE of the user identified by this uid user VMTEMPLATE of the user identified by the username
198
.
199
.IP "" 0
200
.
201
.SH "LICENSE"
202
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
203
.
204
.P
205
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