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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
|
<!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>Images — python-cloudservers v1.0 documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.0',
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="python-cloudservers v1.0 documentation" href="../index.html" />
<link rel="up" title="API Reference" href="index.html" />
<link rel="next" title="Shared IP addresses" href="ipgroups.html" />
<link rel="prev" title="Flavors" href="flavors.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="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="ipgroups.html" title="Shared IP addresses"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="flavors.html" title="Flavors"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">python-cloudservers v1.0 documentation</a> »</li>
<li><a href="index.html" accesskey="U">API Reference</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="images">
<h1>Images<a class="headerlink" href="#images" title="Permalink to this headline">¶</a></h1>
<p>An “image” is a snapshot from which you can create new server instances.</p>
<p>From Rackspace’s own API documentation:</p>
<blockquote>
An image is a collection of files used to create or rebuild a server.
Rackspace provides a number of pre-built OS images by default. You may
also create custom images from cloud servers you have launched. These
custom images are useful for backup purposes or for producing “gold”
server images if you plan to deploy a particular server configuration
frequently.</blockquote>
<div class="section" id="classes">
<h2>Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="cloudservers.ImageManager">
<em class="property">class </em><tt class="descclassname">cloudservers.</tt><tt class="descname">ImageManager</tt><big>(</big><em>api</em><big>)</big><a class="headerlink" href="#cloudservers.ImageManager" title="Permalink to this definition">¶</a></dt>
<dd><p>Manage <a title="cloudservers.Image" class="reference internal" href="#cloudservers.Image"><tt class="xref py py-class docutils literal"><span class="pre">Image</span></tt></a> resources.</p>
<dl class="method">
<dt id="cloudservers.ImageManager.get">
<tt class="descname">get</tt><big>(</big><em>image</em><big>)</big><a class="headerlink" href="#cloudservers.ImageManager.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Get an image.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>image</strong> – The ID of the image to get.</li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><pending_xref py:class=”ImageManager” py:module=”cloudservers” refdoc=”ref/images” refdomain=”py” refexplicit=”False” reftarget=”Image” reftype=”class”><literal classes=”xref py py-class”>Image</literal></pending_xref></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="cloudservers.ImageManager.list">
<tt class="descname">list</tt><big>(</big><big>)</big><a class="headerlink" href="#cloudservers.ImageManager.list" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of all images.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">list of <a title="cloudservers.Image" class="reference internal" href="#cloudservers.Image"><tt class="xref py py-class docutils literal"><span class="pre">Image</span></tt></a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="cloudservers.ImageManager.find">
<tt class="descname">find</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#cloudservers.ImageManager.find" title="Permalink to this definition">¶</a></dt>
<dd><p>Find a single item with attributes matching <tt class="docutils literal"><span class="pre">**kwargs</span></tt>.</p>
<p>This isn’t very efficient: it loads the entire list then filters on
the Python side.</p>
</dd></dl>
<dl class="method">
<dt id="cloudservers.ImageManager.findall">
<tt class="descname">findall</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#cloudservers.ImageManager.findall" title="Permalink to this definition">¶</a></dt>
<dd><p>Find all items with attributes matching <tt class="docutils literal"><span class="pre">**kwargs</span></tt>.</p>
<p>This isn’t very efficient: it loads the entire list then filters on
the Python side.</p>
</dd></dl>
<dl class="method">
<dt id="cloudservers.ImageManager.create">
<tt class="descname">create</tt><big>(</big><em>name</em>, <em>server</em><big>)</big><a class="headerlink" href="#cloudservers.ImageManager.create" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new image by snapshotting a running <a title="cloudservers.Server" class="reference external" href="servers.html#cloudservers.Server"><tt class="xref py py-class docutils literal"><span class="pre">Server</span></tt></a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> – An (arbitrary) name for the new image.</li>
<li><strong>server</strong> – The <a title="cloudservers.Server" class="reference external" href="servers.html#cloudservers.Server"><tt class="xref py py-class docutils literal"><span class="pre">Server</span></tt></a> (or its ID) to make a snapshot of.</li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><pending_xref py:class=”ImageManager” py:module=”cloudservers” refdoc=”ref/images” refdomain=”py” refexplicit=”False” reftarget=”Image” reftype=”class”><literal classes=”xref py py-class”>Image</literal></pending_xref></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="cloudservers.ImageManager.delete">
<tt class="descname">delete</tt><big>(</big><em>image</em><big>)</big><a class="headerlink" href="#cloudservers.ImageManager.delete" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete an image.</p>
<p>It should go without saying that you can’t delete an image
that you didn’t create.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>image</strong> – The <a title="cloudservers.Image" class="reference internal" href="#cloudservers.Image"><tt class="xref py py-class docutils literal"><span class="pre">Image</span></tt></a> (or its ID) to delete.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="cloudservers.Image">
<em class="property">class </em><tt class="descclassname">cloudservers.</tt><tt class="descname">Image</tt><big>(</big><em>manager</em>, <em>info</em><big>)</big><a class="headerlink" href="#cloudservers.Image" title="Permalink to this definition">¶</a></dt>
<dd><p>An image is a collection of files used to create or rebuild a server.</p>
<dl class="attribute">
<dt id="cloudservers.Image.id">
<tt class="descname">id</tt><a class="headerlink" href="#cloudservers.Image.id" title="Permalink to this definition">¶</a></dt>
<dd>This image’s ID.</dd></dl>
<dl class="attribute">
<dt id="cloudservers.Image.name">
<tt class="descname">name</tt><a class="headerlink" href="#cloudservers.Image.name" title="Permalink to this definition">¶</a></dt>
<dd>This image’s name.</dd></dl>
<dl class="attribute">
<dt id="cloudservers.Image.created">
<tt class="descname">created</tt><a class="headerlink" href="#cloudservers.Image.created" title="Permalink to this definition">¶</a></dt>
<dd>The date/time this image was created.</dd></dl>
<dl class="attribute">
<dt id="cloudservers.Image.updated">
<tt class="descname">updated</tt><a class="headerlink" href="#cloudservers.Image.updated" title="Permalink to this definition">¶</a></dt>
<dd>The date/time this instance was updated.</dd></dl>
<dl class="attribute">
<dt id="cloudservers.Image.status">
<tt class="descname">status</tt><a class="headerlink" href="#cloudservers.Image.status" title="Permalink to this definition">¶</a></dt>
<dd>The status of this image (usually <tt class="docutils literal"><span class="pre">"SAVING"</span></tt> or <tt class="docutils literal"><span class="pre">ACTIVE</span></tt>).</dd></dl>
<dl class="attribute">
<dt id="cloudservers.Image.progress">
<tt class="descname">progress</tt><a class="headerlink" href="#cloudservers.Image.progress" title="Permalink to this definition">¶</a></dt>
<dd>During saving of an image this’ll be set to something between
0 and 100, representing a rough percentage done.</dd></dl>
<dl class="attribute">
<dt id="cloudservers.Image.serverId">
<tt class="descname">serverId</tt><a class="headerlink" href="#cloudservers.Image.serverId" title="Permalink to this definition">¶</a></dt>
<dd>If this image was created from a <a title="cloudservers.Server" class="reference external" href="servers.html#cloudservers.Server"><tt class="xref py py-class docutils literal"><span class="pre">Server</span></tt></a> then this attribute
will be set to the ID of the server whence this image came.</dd></dl>
<dl class="method">
<dt id="cloudservers.Image.delete">
<tt class="descname">delete</tt><big>(</big><big>)</big><a class="headerlink" href="#cloudservers.Image.delete" title="Permalink to this definition">¶</a></dt>
<dd>Delete this image.</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href="#">Images</a><ul>
<li><a class="reference external" href="#classes">Classes</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="flavors.html"
title="previous chapter">Flavors</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="ipgroups.html"
title="next chapter">Shared IP addresses</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/ref/images.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" size="18" />
<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="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="ipgroups.html" title="Shared IP addresses"
>next</a> |</li>
<li class="right" >
<a href="flavors.html" title="Flavors"
>previous</a> |</li>
<li><a href="../index.html">python-cloudservers v1.0 documentation</a> »</li>
<li><a href="index.html" >API Reference</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009, Jacob Kaplan-Moss.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0pre.
</div>
</body>
</html>
|
