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
|
<!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 shell utility — 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="The cloudservers Python API" href="api.html" />
<link rel="prev" title="Python bindings to the Rackspace Cloud Servers API" href="index.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="api.html" title="The cloudservers Python API"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Python bindings to the Rackspace Cloud Servers API"
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="the-cloudservers-shell-utility">
<h1>The <strong class="program">cloudservers</strong> shell utility<a class="headerlink" href="#the-cloudservers-shell-utility" title="Permalink to this headline">¶</a></h1>
<p>The <strong class="program">cloudservers</strong> shell utility interacts with Rackspace Cloud servers
from the command line. It supports the entirety of the Cloud Servers API,
including some commands not available from the Rackspace web console.</p>
<p>First, you’ll need a Rackspace Cloud Servers account and an API key. At the time
of this writing getting an API key is non-obvious: you need to sign up for
<em>both</em> Cloud Servers <em>and</em> Cloud Files; only then can you grab an API key from
the Rackspace web console.</p>
<p>You’ll need to provide <strong class="program">cloudservers</strong> with your Rackspace username and
API key. You can do this with the <em class="xref std std-option">--username</em> and <em class="xref std std-option">--apikey</em>
options, but it’s easier to just set them as environment variables by setting
two environment variables:</p>
<dl class="envvar">
<dt id="envvar-CLOUD_SERVERS_USERNAME">
<tt class="descname">CLOUD_SERVERS_USERNAME</tt><a class="headerlink" href="#envvar-CLOUD_SERVERS_USERNAME" title="Permalink to this definition">¶</a></dt>
<dd>Your Rackspace Cloud username.</dd></dl>
<dl class="envvar">
<dt id="envvar-CLOUD_SERVERS_API_KEY">
<tt class="descname">CLOUD_SERVERS_API_KEY</tt><a class="headerlink" href="#envvar-CLOUD_SERVERS_API_KEY" title="Permalink to this definition">¶</a></dt>
<dd>Your API key.</dd></dl>
<p>For example, in Bash you’d use:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nb">export </span><span class="nv">CLOUD_SERVERS_USERNAME</span><span class="o">=</span>yourname
<span class="nb">export </span><span class="nv">CLOUD_SERVERS_API_KEY</span><span class="o">=</span>yadayadayada
</pre></div>
</div>
<p>From there, all shell commands take the form:</p>
<div class="highlight-bash"><div class="highlight"><pre>cloudservers <<span class="nb">command</span>> <span class="o">[</span>arguments...<span class="o">]</span>
</pre></div>
</div>
<p>Run <strong class="program">cloudservers help</strong> to get a full list of all possible commands,
and run <strong class="program">cloudservers help <command></strong> to get detailed help for that
command.</p>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Python bindings to the Rackspace Cloud Servers API</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="api.html"
title="next chapter">The <tt class="docutils literal docutils literal"><span class="pre">cloudservers</span></tt> Python API</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/shell.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="api.html" title="The cloudservers Python API"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Python bindings to the Rackspace Cloud Servers API"
>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>
|
