325 lines
19 KiB
HTML
325 lines
19 KiB
HTML
|
|
|
|
<!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 nova-manage command — nova v2010.1 documentation</title>
|
|
<link rel="stylesheet" href="../_static/sphinxdoc.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: '2010.1',
|
|
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>
|
|
<script type="text/javascript" src="../_static/jquery.tweet.js"></script>
|
|
<link rel="top" title="nova v2010.1 documentation" href="../index.html" />
|
|
<link rel="up" title="Administration Guide" href="index.html" />
|
|
<link rel="next" title="Euca2ools" href="euca2ools.html" />
|
|
<link rel="prev" title="Administration Guide" href="index.html" />
|
|
<script type='text/javascript'>
|
|
$(document).ready(function(){
|
|
$("#twitter_feed").tweet({
|
|
username: "openstack",
|
|
query: "from:openstack",
|
|
avatar_size: 32,
|
|
count: 10,
|
|
loading_text: "loading tweets..."
|
|
});
|
|
});
|
|
</script>
|
|
|
|
</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="euca2ools.html" title="Euca2ools"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="index.html" title="Administration Guide"
|
|
accesskey="P">previous</a> |</li>
|
|
<li><a href="../index.html">nova v2010.1 documentation</a> »</li>
|
|
<li><a href="index.html" accesskey="U">Administration Guide</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="sphinxsidebar">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h3><a href="../index.html">Table Of Contents</a></h3>
|
|
<ul>
|
|
<li><a class="reference internal" href="#">The nova-manage command</a><ul>
|
|
<li><a class="reference internal" href="#introduction">Introduction</a></li>
|
|
<li><a class="reference internal" href="#nova-user">Nova User</a></li>
|
|
<li><a class="reference internal" href="#nova-project">Nova Project</a></li>
|
|
<li><a class="reference internal" href="#nova-role">Nova Role</a></li>
|
|
<li><a class="reference internal" href="#nova-shell">Nova Shell</a></li>
|
|
<li><a class="reference internal" href="#nova-vpn">Nova VPN</a></li>
|
|
<li><a class="reference internal" href="#nova-floating-ips">Nova Floating IPs</a><ul>
|
|
<li><a class="reference internal" href="#concept-flags">Concept: Flags</a></li>
|
|
<li><a class="reference internal" href="#concept-plugins">Concept: Plugins</a></li>
|
|
<li><a class="reference internal" href="#concept-ipc-rpc">Concept: IPC/RPC</a></li>
|
|
<li><a class="reference internal" href="#concept-fakes">Concept: Fakes</a></li>
|
|
<li><a class="reference internal" href="#concept-scheduler">Concept: Scheduler</a></li>
|
|
<li><a class="reference internal" href="#concept-security-groups">Concept: Security Groups</a></li>
|
|
<li><a class="reference internal" href="#concept-certificate-authority">Concept: Certificate Authority</a></li>
|
|
<li><a class="reference internal" href="#concept-images">Concept: Images</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="index.html"
|
|
title="previous chapter">Administration Guide</a></p>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="euca2ools.html"
|
|
title="next chapter">Euca2ools</a></p>
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="../_sources/adminguide/nova.manage.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="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body">
|
|
|
|
<div class="section" id="the-nova-manage-command">
|
|
<h1>The nova-manage command<a class="headerlink" href="#the-nova-manage-command" title="Permalink to this headline">¶</a></h1>
|
|
<div class="section" id="introduction">
|
|
<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
|
|
<p>The nova-manage command is used to perform many essential functions for
|
|
administration and ongoing maintenance of nova, such as user creation,
|
|
vpn management, and much more.</p>
|
|
<p>The standard pattern for executing a nova-manage command is:
|
|
<tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre"><category></span> <span class="pre"><command></span> <span class="pre">[<args>]</span></tt></p>
|
|
<p>For example, to obtain a list of all projects:
|
|
<tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">project</span> <span class="pre">list</span></tt></p>
|
|
<p>Run without arguments to see a list of available command categories:
|
|
<tt class="docutils literal"><span class="pre">nova-manage</span></tt></p>
|
|
<p>Categories are user, project, role, shell, vpn, and floating. Detailed descriptions are below.</p>
|
|
<p>You can also run with a category argument such as user to see a list of all commands in that category:
|
|
<tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">user</span></tt></p>
|
|
<p>These sections describe the available categories and arguments for nova-manage.</p>
|
|
</div>
|
|
<div class="section" id="nova-user">
|
|
<h2>Nova User<a class="headerlink" href="#nova-user" title="Permalink to this headline">¶</a></h2>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">user</span> <span class="pre">admin</span> <span class="pre"><username></span></tt></p>
|
|
<blockquote>
|
|
Create an admin user with the name <username>.</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">user</span> <span class="pre">create</span> <span class="pre"><username></span></tt></p>
|
|
<blockquote>
|
|
Create a normal user with the name <username>.</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">user</span> <span class="pre">delete</span> <span class="pre"><username></span></tt></p>
|
|
<blockquote>
|
|
Delete the user with the name <username>.</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">user</span> <span class="pre">exports</span> <span class="pre"><username></span></tt></p>
|
|
<blockquote>
|
|
Outputs a list of access key and secret keys for user to the screen</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">user</span> <span class="pre">list</span></tt></p>
|
|
<blockquote>
|
|
Outputs a list of all the user names to the screen.</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">user</span> <span class="pre">modify</span> <span class="pre"><accesskey></span> <span class="pre"><secretkey></span> <span class="pre"><admin?T/F></span></tt></p>
|
|
<blockquote>
|
|
Updates the indicated user keys, indicating with T or F if the user is an admin user. Leave any argument blank if you do not want to update it.</blockquote>
|
|
</div>
|
|
<div class="section" id="nova-project">
|
|
<h2>Nova Project<a class="headerlink" href="#nova-project" title="Permalink to this headline">¶</a></h2>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">project</span> <span class="pre">add</span> <span class="pre"><projectname></span></tt></p>
|
|
<blockquote>
|
|
Add a nova project with the name <projectname> to the database.</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">project</span> <span class="pre">create</span> <span class="pre"><projectname></span></tt></p>
|
|
<blockquote>
|
|
Create a new nova project with the name <projectname> (you still need to do nova-manage project add <projectname> to add it to the database).</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">project</span> <span class="pre">delete</span> <span class="pre"><projectname></span></tt></p>
|
|
<blockquote>
|
|
Delete a nova project with the name <projectname>.</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">project</span> <span class="pre">environment</span> <span class="pre"><projectname></span> <span class="pre"><username></span></tt></p>
|
|
<blockquote>
|
|
Exports environment variables for the named project to a file named novarc.</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">project</span> <span class="pre">list</span></tt></p>
|
|
<blockquote>
|
|
Outputs a list of all the projects to the screen.</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">project</span> <span class="pre">quota</span> <span class="pre"><projectname></span></tt></p>
|
|
<blockquote>
|
|
Outputs the size and specs of the project’s instances including gigabytes, instances, floating IPs, volumes, and cores.</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">project</span> <span class="pre">remove</span> <span class="pre"><projectname></span></tt></p>
|
|
<blockquote>
|
|
Deletes the project with the name <projectname>.</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">project</span> <span class="pre">zipfile</span></tt></p>
|
|
<blockquote>
|
|
Compresses all related files for a created project into a zip file nova.zip.</blockquote>
|
|
</div>
|
|
<div class="section" id="nova-role">
|
|
<h2>Nova Role<a class="headerlink" href="#nova-role" title="Permalink to this headline">¶</a></h2>
|
|
<p>nova-manage role <action> [<argument>]
|
|
<tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">role</span> <span class="pre">add</span> <span class="pre"><username></span> <span class="pre"><rolename></span> <span class="pre"><(optional)</span> <span class="pre">projectname></span></tt></p>
|
|
<blockquote>
|
|
Add a user to either a global or project-based role with the indicated <rolename> assigned to the named user. Role names can be one of the following five roles: admin, itsec, projectmanager, netadmin, developer. If you add the project name as the last argument then the role is assigned just for that project, otherwise the user is assigned the named role for all projects.</blockquote>
|
|
<dl class="docutils">
|
|
<dt><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">role</span> <span class="pre">has</span> <span class="pre"><username></span> <span class="pre"><projectname></span></tt></dt>
|
|
<dd>Checks the user or project and responds with True if the user has a global role with a particular project.</dd>
|
|
<dt><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">role</span> <span class="pre">remove</span> <span class="pre"><username></span> <span class="pre"><rolename></span></tt></dt>
|
|
<dd>Remove the indicated role from the user.</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="nova-shell">
|
|
<h2>Nova Shell<a class="headerlink" href="#nova-shell" title="Permalink to this headline">¶</a></h2>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">shell</span> <span class="pre">bpython</span></tt></p>
|
|
<blockquote>
|
|
Starts a new bpython shell.</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">shell</span> <span class="pre">ipython</span></tt></p>
|
|
<blockquote>
|
|
Starts a new ipython shell.</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">shell</span> <span class="pre">python</span></tt></p>
|
|
<blockquote>
|
|
Starts a new python shell.</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">shell</span> <span class="pre">run</span></tt></p>
|
|
<blockquote>
|
|
Starts a new shell using python.</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">shell</span> <span class="pre">script</span> <span class="pre"><path/scriptname></span></tt></p>
|
|
<blockquote>
|
|
Runs the named script from the specified path with flags set.</blockquote>
|
|
</div>
|
|
<div class="section" id="nova-vpn">
|
|
<h2>Nova VPN<a class="headerlink" href="#nova-vpn" title="Permalink to this headline">¶</a></h2>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">vpn</span> <span class="pre">list</span></tt></p>
|
|
<blockquote>
|
|
Displays a list of projects, their IP prot numbers, and what state they’re in.</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">vpn</span> <span class="pre">run</span> <span class="pre"><projectname></span></tt></p>
|
|
<blockquote>
|
|
Starts the VPN for the named project.</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">vpn</span> <span class="pre">spawn</span></tt></p>
|
|
<blockquote>
|
|
Runs all VPNs.</blockquote>
|
|
</div>
|
|
<div class="section" id="nova-floating-ips">
|
|
<h2>Nova Floating IPs<a class="headerlink" href="#nova-floating-ips" title="Permalink to this headline">¶</a></h2>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">floating</span> <span class="pre">create</span> <span class="pre"><host></span> <span class="pre"><ip_range></span></tt></p>
|
|
<blockquote>
|
|
<dl class="docutils">
|
|
<dt>Creates floating IP addresses for the named host by the given range.</dt>
|
|
<dd>floating delete <ip_range> Deletes floating IP addresses in the range given.</dd>
|
|
</dl>
|
|
</blockquote>
|
|
<p><tt class="docutils literal"><span class="pre">nova-manage</span> <span class="pre">floating</span> <span class="pre">list</span></tt></p>
|
|
<blockquote>
|
|
Displays a list of all floating IP addresses.</blockquote>
|
|
<div class="section" id="concept-flags">
|
|
<h3>Concept: Flags<a class="headerlink" href="#concept-flags" title="Permalink to this headline">¶</a></h3>
|
|
<p>python-gflags</p>
|
|
</div>
|
|
<div class="section" id="concept-plugins">
|
|
<h3>Concept: Plugins<a class="headerlink" href="#concept-plugins" title="Permalink to this headline">¶</a></h3>
|
|
<ul class="simple">
|
|
<li>Managers/Drivers: utils.import_object from string flag</li>
|
|
<li>virt/connections: conditional loading from string flag</li>
|
|
<li>db: LazyPluggable via string flag</li>
|
|
<li>auth_manager: utils.import_class based on string flag</li>
|
|
<li>Volumes: moving to pluggable driver instead of manager</li>
|
|
<li>Network: pluggable managers</li>
|
|
<li>Compute: same driver used, but pluggable at connection</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="concept-ipc-rpc">
|
|
<h3>Concept: IPC/RPC<a class="headerlink" href="#concept-ipc-rpc" title="Permalink to this headline">¶</a></h3>
|
|
<p>Rabbit!</p>
|
|
</div>
|
|
<div class="section" id="concept-fakes">
|
|
<h3>Concept: Fakes<a class="headerlink" href="#concept-fakes" title="Permalink to this headline">¶</a></h3>
|
|
<ul class="simple">
|
|
<li>auth</li>
|
|
<li>ldap</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="concept-scheduler">
|
|
<h3>Concept: Scheduler<a class="headerlink" href="#concept-scheduler" title="Permalink to this headline">¶</a></h3>
|
|
<ul class="simple">
|
|
<li>simple</li>
|
|
<li>random</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="concept-security-groups">
|
|
<h3>Concept: Security Groups<a class="headerlink" href="#concept-security-groups" title="Permalink to this headline">¶</a></h3>
|
|
<p>Security groups</p>
|
|
</div>
|
|
<div class="section" id="concept-certificate-authority">
|
|
<h3>Concept: Certificate Authority<a class="headerlink" href="#concept-certificate-authority" title="Permalink to this headline">¶</a></h3>
|
|
<p>Nova does a small amount of certificate management. These certificates are used for <em class="xref std std-ref">project vpns</em> and decrypting bundled images.</p>
|
|
</div>
|
|
<div class="section" id="concept-images">
|
|
<h3>Concept: Images<a class="headerlink" href="#concept-images" title="Permalink to this headline">¶</a></h3>
|
|
<ul class="simple">
|
|
<li>launching</li>
|
|
<li>bundling</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</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="euca2ools.html" title="Euca2ools"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="index.html" title="Administration Guide"
|
|
>previous</a> |</li>
|
|
<li><a href="../index.html">nova v2010.1 documentation</a> »</li>
|
|
<li><a href="index.html" >Administration Guide</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer">
|
|
© Copyright 2010, United States Government as represented by the Administrator of the National Aeronautics and Space Administration..
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4.
|
|
</div>
|
|
</body>
|
|
</html> |