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
|
<!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>The cloudservers Python API — 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="next" title="API Reference" href="ref/index.html" />
<link rel="prev" title="The cloudservers shell utility" href="shell.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="ref/index.html" title="API Reference"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="shell.html" title="The cloudservers shell utility"
accesskey="P">previous</a> |</li>
<li><a href="index.html">python-cloudservers v1.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-cloudservers">
<span id="the-cloudservers-python-api"></span><h1>The <a class="reference external" href="ref/exceptions.html#module-cloudservers"><tt class="xref py py-mod docutils literal"><span class="pre">cloudservers</span></tt></a> Python API<a class="headerlink" href="#module-cloudservers" title="Permalink to this headline">¶</a></h1>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>First create an instance of <a title="cloudservers.CloudServers" class="reference internal" href="#cloudservers.CloudServers"><tt class="xref py py-class docutils literal"><span class="pre">CloudServers</span></tt></a> with your credentials:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">cloudservers</span> <span class="kn">import</span> <span class="n">CloudServers</span>
<span class="gp">>>> </span><span class="n">cloudservers</span> <span class="o">=</span> <span class="n">CloudServers</span><span class="p">(</span><span class="n">USERNAME</span><span class="p">,</span> <span class="n">API_KEY</span><span class="p">)</span>
</pre></div>
</div>
<p>Then call methods on the <a title="cloudservers.CloudServers" class="reference internal" href="#cloudservers.CloudServers"><tt class="xref py py-class docutils literal"><span class="pre">CloudServers</span></tt></a> object:</p>
<dl class="class">
<dt id="cloudservers.CloudServers">
<em class="property">class </em><tt class="descclassname">cloudservers.</tt><tt class="descname">CloudServers</tt><a class="headerlink" href="#cloudservers.CloudServers" title="Permalink to this definition">¶</a></dt>
<dd><dl class="attribute">
<dt id="cloudservers.CloudServers.backup_schedules">
<tt class="descname">backup_schedules</tt><a class="headerlink" href="#cloudservers.CloudServers.backup_schedules" title="Permalink to this definition">¶</a></dt>
<dd>A <a title="cloudservers.BackupScheduleManager" class="reference external" href="ref/backup_schedules.html#cloudservers.BackupScheduleManager"><tt class="xref py py-class docutils literal"><span class="pre">BackupScheduleManager</span></tt></a> – manage automatic backup images.</dd></dl>
<dl class="attribute">
<dt id="cloudservers.CloudServers.flavors">
<tt class="descname">flavors</tt><a class="headerlink" href="#cloudservers.CloudServers.flavors" title="Permalink to this definition">¶</a></dt>
<dd>A <a title="cloudservers.FlavorManager" class="reference external" href="ref/flavors.html#cloudservers.FlavorManager"><tt class="xref py py-class docutils literal"><span class="pre">FlavorManager</span></tt></a> – query available “flavors” (hardware
configurations).</dd></dl>
<dl class="attribute">
<dt id="cloudservers.CloudServers.images">
<tt class="descname">images</tt><a class="headerlink" href="#cloudservers.CloudServers.images" title="Permalink to this definition">¶</a></dt>
<dd>An <a title="cloudservers.ImageManager" class="reference external" href="ref/images.html#cloudservers.ImageManager"><tt class="xref py py-class docutils literal"><span class="pre">ImageManager</span></tt></a> – query and create server disk images.</dd></dl>
<dl class="attribute">
<dt id="cloudservers.CloudServers.ipgroups">
<tt class="descname">ipgroups</tt><a class="headerlink" href="#cloudservers.CloudServers.ipgroups" title="Permalink to this definition">¶</a></dt>
<dd>A <a title="cloudservers.IPGroupManager" class="reference external" href="ref/ipgroups.html#cloudservers.IPGroupManager"><tt class="xref py py-class docutils literal"><span class="pre">IPGroupManager</span></tt></a> – manage shared public IP addresses.</dd></dl>
<dl class="attribute">
<dt id="cloudservers.CloudServers.servers">
<tt class="descname">servers</tt><a class="headerlink" href="#cloudservers.CloudServers.servers" title="Permalink to this definition">¶</a></dt>
<dd>A <a title="cloudservers.ServerManager" class="reference external" href="ref/servers.html#cloudservers.ServerManager"><tt class="xref py py-class docutils literal"><span class="pre">ServerManager</span></tt></a> – start, stop, and manage virtual machines.</dd></dl>
<dl class="method">
<dt id="cloudservers.CloudServers.authenticate">
<tt class="descname">authenticate</tt><big>(</big><big>)</big><a class="headerlink" href="#cloudservers.CloudServers.authenticate" title="Permalink to this definition">¶</a></dt>
<dd><p>Authenticate against the server.</p>
<p>Normally this is called automatically when you first access the API,
but you can call this method to force authentication right now.</p>
<p>Returns on success; raises <a title="cloudservers.Unauthorized" class="reference external" href="ref/exceptions.html#cloudservers.Unauthorized"><tt class="xref py py-exc docutils literal"><span class="pre">cloudservers.Unauthorized</span></tt></a> if the
credentials are wrong.</p>
</dd></dl>
</dd></dl>
<p>For example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">cloudservers</span><span class="o">.</span><span class="n">servers</span><span class="o">.</span><span class="n">list</span><span class="p">()</span>
<span class="go">[<Server: buildslave-ubuntu-9.10>]</span>
<span class="gp">>>> </span><span class="n">cloudservers</span><span class="o">.</span><span class="n">flavors</span><span class="o">.</span><span class="n">list</span><span class="p">()</span>
<span class="go">[<Flavor: 256 server>,</span>
<span class="go"> <Flavor: 512 server>,</span>
<span class="go"> <Flavor: 1GB server>,</span>
<span class="go"> <Flavor: 2GB server>,</span>
<span class="go"> <Flavor: 4GB server>,</span>
<span class="go"> <Flavor: 8GB server>,</span>
<span class="go"> <Flavor: 15.5GB server>]</span>
<span class="gp">>>> </span><span class="n">fl</span> <span class="o">=</span> <span class="n">cloudservers</span><span class="o">.</span><span class="n">flavors</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">ram</span><span class="o">=</span><span class="mi">512</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">cloudservers</span><span class="o">.</span><span class="n">servers</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="s">"my-server"</span><span class="p">,</span> <span class="n">flavor</span><span class="o">=</span><span class="n">fl</span><span class="p">)</span>
<span class="go"><Server: my-server></span>
</pre></div>
</div>
<p>For more information, see the reference:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference external" href="ref/index.html">API Reference</a><ul>
<li class="toctree-l2"><a class="reference external" href="ref/backup_schedules.html">Backup schedules</a></li>
<li class="toctree-l2"><a class="reference external" href="ref/exceptions.html">Exceptions</a></li>
<li class="toctree-l2"><a class="reference external" href="ref/flavors.html">Flavors</a></li>
<li class="toctree-l2"><a class="reference external" href="ref/images.html">Images</a></li>
<li class="toctree-l2"><a class="reference external" href="ref/ipgroups.html">Shared IP addresses</a></li>
<li class="toctree-l2"><a class="reference external" href="ref/servers.html">Servers</a></li>
</ul>
</li>
</ul>
</div>
</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="#">The <tt class="docutils literal"><span class="pre">cloudservers</span></tt> Python API</a><ul>
<li><a class="reference external" href="#usage">Usage</a><ul>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="shell.html"
title="previous chapter">The <strong class="program">cloudservers</strong> shell utility</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="ref/index.html"
title="next chapter">API Reference</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/api.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="ref/index.html" title="API Reference"
>next</a> |</li>
<li class="right" >
<a href="shell.html" title="The cloudservers shell utility"
>previous</a> |</li>
<li><a href="index.html">python-cloudservers v1.0 documentation</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>
|
