forked from ungleich/python-oca
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtemplate.html
More file actions
225 lines (201 loc) · 10.2 KB
/
Copy pathtemplate.html
File metadata and controls
225 lines (201 loc) · 10.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>oca.template — oca 4.10.0-a1 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '4.10.0-a1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="oca 4.10.0-a1 documentation" href="../index.html" />
<link rel="up" title="API Documentation" href="../api.html" />
<link rel="next" title="oca.virtualmachine" href="vm.html" />
<link rel="prev" title="oca.group" href="group.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="vm.html" title="oca.virtualmachine"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="group.html" title="oca.group"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">oca 4.10.0-a1 documentation</a> »</li>
<li><a href="../api.html" accesskey="U">API Documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="oca-template">
<span id="template-module"></span><h1><tt class="xref py py-mod docutils literal"><span class="pre">oca.template</span></tt><a class="headerlink" href="#oca-template" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="oca.VmTemplate">
<em class="property">class </em><tt class="descclassname">oca.</tt><tt class="descname">VmTemplate</tt><big>(</big><em>xml</em>, <em>client</em><big>)</big><a class="headerlink" href="#oca.VmTemplate" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">oca.pool.PoolElement</span></tt></p>
<dl class="attribute">
<dt id="oca.VmTemplate.ELEMENT_NAME">
<tt class="descname">ELEMENT_NAME</tt><em class="property"> = 'VMTEMPLATE'</em><a class="headerlink" href="#oca.VmTemplate.ELEMENT_NAME" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="oca.VmTemplate.METHODS">
<tt class="descname">METHODS</tt><em class="property"> = {'info': 'template.info', 'instantiate': 'template.instantiate', 'update': 'template.update', 'publish': 'template.publish', 'chown': 'template.chown', 'allocate': 'template.allocate', 'delete': 'template.delete'}</em><a class="headerlink" href="#oca.VmTemplate.METHODS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="oca.VmTemplate.XML_TYPES">
<tt class="descname">XML_TYPES</tt><em class="property"> = {'uname': <type 'str'>, 'gid': <type 'int'>, 'uid': <type 'int'>, 'template': ['TEMPLATE', <class 'oca.pool.Template'>], 'gname': <type 'str'>, 'id': <type 'int'>, 'regtime': <type 'int'>, 'name': <type 'str'>}</em><a class="headerlink" href="#oca.VmTemplate.XML_TYPES" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="oca.VmTemplate.allocate">
<em class="property">static </em><tt class="descname">allocate</tt><big>(</big><em>client</em>, <em>template</em><big>)</big><a class="headerlink" href="#oca.VmTemplate.allocate" title="Permalink to this definition">¶</a></dt>
<dd><p>Allocates a new template in OpenNebula</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">client</span></tt></dt>
<dd>oca.Client object</dd>
<dt><tt class="docutils literal"><span class="pre">group</span></tt></dt>
<dd>a string containing the group name</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="oca.VmTemplate.chown">
<tt class="descname">chown</tt><big>(</big><em>uid=-1</em>, <em>gid=-1</em><big>)</big><a class="headerlink" href="#oca.VmTemplate.chown" title="Permalink to this definition">¶</a></dt>
<dd><p>Changes the ownership of a template.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">uid</span></tt></dt>
<dd>The User ID of the new owner. If set to -1, the owner is not changed.</dd>
<dt><tt class="docutils literal"><span class="pre">gid</span></tt></dt>
<dd>The Group ID of the new group. If set to -1, the group is not changed.</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="oca.VmTemplate.delete">
<tt class="descname">delete</tt><big>(</big><big>)</big><a class="headerlink" href="#oca.VmTemplate.delete" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes current object from the pool</p>
</dd></dl>
<dl class="method">
<dt id="oca.VmTemplate.info">
<tt class="descname">info</tt><big>(</big><em>*args</em><big>)</big><a class="headerlink" href="#oca.VmTemplate.info" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="oca.VmTemplate.instantiate">
<tt class="descname">instantiate</tt><big>(</big><em>name=''</em><big>)</big><a class="headerlink" href="#oca.VmTemplate.instantiate" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a VM instance from a VmTemplate</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">name</span></tt></dt>
<dd>name of the VM instance</dd>
</dl>
</dd></dl>
<dl class="classmethod">
<dt id="oca.VmTemplate.new_with_id">
<em class="property">classmethod </em><tt class="descname">new_with_id</tt><big>(</big><em>client</em>, <em>element_id</em><big>)</big><a class="headerlink" href="#oca.VmTemplate.new_with_id" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrives object which id equals <tt class="docutils literal"><span class="pre">`id`</span></tt>.</p>
<p>Arguments</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">`client`</span></tt></dt>
<dd>oca.Client object.</dd>
<dt><tt class="docutils literal"><span class="pre">`element_id</span></tt></dt>
<dd>object id.</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="oca.VmTemplate.publish">
<tt class="descname">publish</tt><big>(</big><big>)</big><a class="headerlink" href="#oca.VmTemplate.publish" title="Permalink to this definition">¶</a></dt>
<dd><p>Publishes a template.</p>
</dd></dl>
<dl class="method">
<dt id="oca.VmTemplate.unpublish">
<tt class="descname">unpublish</tt><big>(</big><big>)</big><a class="headerlink" href="#oca.VmTemplate.unpublish" title="Permalink to this definition">¶</a></dt>
<dd><p>Unpublishes a template.</p>
</dd></dl>
<dl class="method">
<dt id="oca.VmTemplate.update">
<tt class="descname">update</tt><big>(</big><em>template</em><big>)</big><a class="headerlink" href="#oca.VmTemplate.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Replaces the template contents.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">template</span></tt></dt>
<dd>The new template contents.</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="oca.VmTemplatePool">
<em class="property">class </em><tt class="descclassname">oca.</tt><tt class="descname">VmTemplatePool</tt><big>(</big><em>client</em><big>)</big><a class="headerlink" href="#oca.VmTemplatePool" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">oca.pool.Pool</span></tt></p>
<dl class="attribute">
<dt id="oca.VmTemplatePool.METHODS">
<tt class="descname">METHODS</tt><em class="property"> = {'info': 'templatepool.info'}</em><a class="headerlink" href="#oca.VmTemplatePool.METHODS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="group.html"
title="previous chapter"><tt class="docutils literal"><span class="pre">oca.group</span></tt></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="vm.html"
title="next chapter"><tt class="docutils literal"><span class="pre">oca.virtualmachine</span></tt></a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/template.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="vm.html" title="oca.virtualmachine"
>next</a> |</li>
<li class="right" >
<a href="group.html" title="oca.group"
>previous</a> |</li>
<li><a href="../index.html">oca 4.10.0-a1 documentation</a> »</li>
<li><a href="../api.html" >API Documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010-2015, Python OCA authors.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>