<!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>Python bindings to the OpenStack Nova API — python-novaclient 2.20.0 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/tweaks.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.20.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-novaclient 2.20.0 documentation" href="#" />
<link rel="next" title="The nova shell utility" href="shell.html" />
</head>
<body>
<div id="header">
<h1 id="logo"><a href="http://www.openstack.org/">OpenStack</a></h1>
<ul id="navigation">
<li><a href="http://www.openstack.org/" title="Go to the Home page" class="link">Home</a></li>
<li><a href="http://www.openstack.org/projects/" title="Go to the OpenStack Projects page">Projects</a></li>
<li><a href="http://www.openstack.org/user-stories/" title="Go to the User Stories page" class="link">User Stories</a></li>
<li><a href="http://www.openstack.org/community/" title="Go to the Community page" class="link">Community</a></li>
<li><a href="http://www.openstack.org/blog/" title="Go to the OpenStack Blog">Blog</a></li>
<li><a href="http://wiki.openstack.org/" title="Go to the OpenStack Wiki">Wiki</a></li>
<li><a href="http://docs.openstack.org/" title="Go to OpenStack Documentation" class="current">Documentation</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="python-bindings-to-the-openstack-nova-api">
<h1>Python bindings to the OpenStack Nova API<a class="headerlink" href="#python-bindings-to-the-openstack-nova-api" title="Permalink to this headline">¶</a></h1>
<p>This is a client for OpenStack Nova API. There’s <a class="reference internal" href="api.html"><em>a Python API</em></a> (the <a class="reference internal" href="api.html#module-novaclient" title="novaclient: A client for the OpenStack Nova API."><tt class="xref py py-mod docutils literal"><span class="pre">novaclient</span></tt></a> module), and a <a class="reference internal" href="shell.html"><em>command-line script</em></a> (installed as <strong class="program">nova</strong>). Each implements the entire
OpenStack Nova API.</p>
<p>You’ll need credentials for an OpenStack cloud that implements the
Compute API, such as TryStack, HP, or Rackspace, in order to use the nova client.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">You may want to read the <a class="reference external" href="http://docs.openstack.org/api/openstack-compute/2/content/">OpenStack Compute Developer Guide</a> – the overview, at
least – to get an idea of the concepts. By understanding the concepts
this library should make more sense.</p>
</div>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="shell.html">The <strong class="program">nova</strong> shell utility</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">The <tt class="docutils literal"><span class="pre">novaclient</span></tt> Python API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#reference">Reference</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="ref/index.html">Exceptions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="ref/exceptions.html">Exceptions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="ref/v1_1/index.html">Version 1.1, Version 2 API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/flavors.html">Flavors</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/images.html">Images</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/servers.html">Servers</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/hosts.html">Hosts</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/agents.html">Agents</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/aggregates.html">Aggregates</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/availability_zones.html">Availability_zones</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/certs.html">Certs</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/fixed_ips.html">Fixed_ips</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/floating_ip_pools.html">Floating_ip_pools</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/floating_ips.html">Floating_ips</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/hypervisors.html">Hypervisors</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/keypairs.html">Keypairs</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/limits.html">Limits</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/networks.html">Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/quota_classes.html">Quota_classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/quotas.html">Quotas</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/security_group_rules.html">Security_group_rules</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/security_groups.html">Security_groups</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/services.html">Services</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/virtual_interfaces.html">Virtual_interfaces</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/volume_snapshots.html">Volume_snapshots</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/volumes.html">Volumes</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v1_1/volume_types.html">Volume_types</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="ref/v3/index.html">Version 3 API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="ref/v3/flavors.html">Flavors</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v3/hosts.html">Hosts</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v3/agents.html">Agents</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v3/aggregates.html">Aggregates</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v3/availability_zones.html">Availability_zones</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v3/certs.html">Certs</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v3/hypervisors.html">Hypervisors</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v3/images.html">Images</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v3/keypairs.html">Keypairs</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v3/quotas.html">Quotas</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v3/quotas_classes.html">Quotas_classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v3/servers.html">Servers</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref/v3/services.html">Services</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="contributing">
<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h1>
<p>Code is hosted at <a class="reference external" href="https://git.openstack.org/cgit/openstack/python-novaclient">git.openstack.org</a>. Submit bugs to the Nova project on
<a class="reference external" href="https://launchpad.net/nova">Launchpad</a>. Submit code to the openstack/python-novaclient project using
<a class="reference external" href="http://wiki.openstack.org/GerritWorkflow">Gerrit</a>.</p>
<p>Run tests with <tt class="docutils literal"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">test</span></tt>.</p>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Python bindings to the OpenStack Nova API</a></li>
<li><a class="reference internal" href="#contributing">Contributing</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="shell.html"
title="next chapter">The <strong class="program">nova</strong> shell utility</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.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"
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="shell.html" title="The nova shell utility"
accesskey="N">next</a> |</li>
<li><a href="#">python-novaclient 2.20.0 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright OpenStack Contributors.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>