<!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>keystone Package — keystone 2012.1-dev 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: '2012.1-dev', 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="keystone 2012.1-dev documentation" href="index.html" /> <link rel="up" title="keystone" href="modules.html" /> <link rel="next" title="catalog Package" href="keystone.catalog.html" /> <link rel="prev" title="keystone" href="modules.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="keystone-package"> <h1>keystone Package<a class="headerlink" href="#keystone-package" title="Permalink to this headline">¶</a></h1> <div class="section" id="module-keystone.clean"> <span id="clean-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">clean</span></tt> Module<a class="headerlink" href="#module-keystone.clean" title="Permalink to this headline">¶</a></h2> <dl class="function"> <dt id="keystone.clean.check_length"> <tt class="descclassname">keystone.clean.</tt><tt class="descname">check_length</tt><big>(</big><em>property_name</em>, <em>value</em>, <em>min_length=1</em>, <em>max_length=64</em><big>)</big><a class="headerlink" href="#keystone.clean.check_length" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="function"> <dt id="keystone.clean.check_type"> <tt class="descclassname">keystone.clean.</tt><tt class="descname">check_type</tt><big>(</big><em>property_name</em>, <em>value</em>, <em>expected_type</em>, <em>display_expected_type</em><big>)</big><a class="headerlink" href="#keystone.clean.check_type" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="function"> <dt id="keystone.clean.tenant_name"> <tt class="descclassname">keystone.clean.</tt><tt class="descname">tenant_name</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#keystone.clean.tenant_name" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="function"> <dt id="keystone.clean.user_name"> <tt class="descclassname">keystone.clean.</tt><tt class="descname">user_name</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#keystone.clean.user_name" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </div> <div class="section" id="cli-module"> <h2><tt class="xref py py-mod docutils literal"><span class="pre">cli</span></tt> Module<a class="headerlink" href="#cli-module" title="Permalink to this headline">¶</a></h2> </div> <div class="section" id="module-keystone.config"> <span id="config-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">config</span></tt> Module<a class="headerlink" href="#module-keystone.config" title="Permalink to this headline">¶</a></h2> <dl class="function"> <dt id="keystone.config.register_bool"> <tt class="descclassname">keystone.config.</tt><tt class="descname">register_bool</tt><big>(</big><em>*args</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#keystone.config.register_bool" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="function"> <dt id="keystone.config.register_cli_bool"> <tt class="descclassname">keystone.config.</tt><tt class="descname">register_cli_bool</tt><big>(</big><em>*args</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#keystone.config.register_cli_bool" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="function"> <dt id="keystone.config.register_cli_int"> <tt class="descclassname">keystone.config.</tt><tt class="descname">register_cli_int</tt><big>(</big><em>*args</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#keystone.config.register_cli_int" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="function"> <dt id="keystone.config.register_cli_str"> <tt class="descclassname">keystone.config.</tt><tt class="descname">register_cli_str</tt><big>(</big><em>*args</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#keystone.config.register_cli_str" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="function"> <dt id="keystone.config.register_int"> <tt class="descclassname">keystone.config.</tt><tt class="descname">register_int</tt><big>(</big><em>*args</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#keystone.config.register_int" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="function"> <dt id="keystone.config.register_str"> <tt class="descclassname">keystone.config.</tt><tt class="descname">register_str</tt><big>(</big><em>*args</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#keystone.config.register_str" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="function"> <dt id="keystone.config.setup_logging"> <tt class="descclassname">keystone.config.</tt><tt class="descname">setup_logging</tt><big>(</big><em>conf</em><big>)</big><a class="headerlink" href="#keystone.config.setup_logging" title="Permalink to this definition">¶</a></dt> <dd><p>Sets up the logging options for a log with supplied name</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>conf</strong> – a cfg.ConfOpts object</td> </tr> </tbody> </table> </dd></dl> </div> <div class="section" id="module-keystone.exception"> <span id="exception-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">exception</span></tt> Module<a class="headerlink" href="#module-keystone.exception" title="Permalink to this headline">¶</a></h2> <dl class="exception"> <dt id="keystone.exception.Conflict"> <em class="property">exception </em><tt class="descclassname">keystone.exception.</tt><tt class="descname">Conflict</tt><big>(</big><em>message=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#keystone.exception.Conflict" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#keystone.exception.Error" title="keystone.exception.Error"><tt class="xref py py-class docutils literal"><span class="pre">keystone.exception.Error</span></tt></a></p> <p>Conflict occurred attempting to store %(type)s.</p> <p>%(details)s</p> <dl class="attribute"> <dt id="keystone.exception.Conflict.code"> <tt class="descname">code</tt><em class="property"> = 409</em><a class="headerlink" href="#keystone.exception.Conflict.code" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="attribute"> <dt id="keystone.exception.Conflict.title"> <tt class="descname">title</tt><em class="property"> = 'Conflict'</em><a class="headerlink" href="#keystone.exception.Conflict.title" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> <dl class="exception"> <dt id="keystone.exception.EndpointNotFound"> <em class="property">exception </em><tt class="descclassname">keystone.exception.</tt><tt class="descname">EndpointNotFound</tt><big>(</big><em>message=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#keystone.exception.EndpointNotFound" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#keystone.exception.NotFound" title="keystone.exception.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">keystone.exception.NotFound</span></tt></a></p> <p>Could not find endpoint: %(endpoint_id)s</p> </dd></dl> <dl class="exception"> <dt id="keystone.exception.Error"> <em class="property">exception </em><tt class="descclassname">keystone.exception.</tt><tt class="descname">Error</tt><big>(</big><em>message=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#keystone.exception.Error" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.StandardError</span></tt></p> <p>Base error class.</p> <p>Child classes should define an HTTP status code, title, and a doc string.</p> <dl class="attribute"> <dt id="keystone.exception.Error.code"> <tt class="descname">code</tt><em class="property"> = None</em><a class="headerlink" href="#keystone.exception.Error.code" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="attribute"> <dt id="keystone.exception.Error.title"> <tt class="descname">title</tt><em class="property"> = None</em><a class="headerlink" href="#keystone.exception.Error.title" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> <dl class="exception"> <dt id="keystone.exception.Forbidden"> <em class="property">exception </em><tt class="descclassname">keystone.exception.</tt><tt class="descname">Forbidden</tt><big>(</big><em>message=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#keystone.exception.Forbidden" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#keystone.exception.Error" title="keystone.exception.Error"><tt class="xref py py-class docutils literal"><span class="pre">keystone.exception.Error</span></tt></a></p> <p>You are not authorized to perform the requested action.</p> <dl class="attribute"> <dt id="keystone.exception.Forbidden.code"> <tt class="descname">code</tt><em class="property"> = 403</em><a class="headerlink" href="#keystone.exception.Forbidden.code" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="attribute"> <dt id="keystone.exception.Forbidden.title"> <tt class="descname">title</tt><em class="property"> = 'Not Authorized'</em><a class="headerlink" href="#keystone.exception.Forbidden.title" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> <dl class="exception"> <dt id="keystone.exception.ForbiddenAction"> <em class="property">exception </em><tt class="descclassname">keystone.exception.</tt><tt class="descname">ForbiddenAction</tt><big>(</big><em>message=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#keystone.exception.ForbiddenAction" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#keystone.exception.Forbidden" title="keystone.exception.Forbidden"><tt class="xref py py-class docutils literal"><span class="pre">keystone.exception.Forbidden</span></tt></a></p> <p>You are not authorized to perform the requested action: %(action)s</p> </dd></dl> <dl class="exception"> <dt id="keystone.exception.MalformedEndpoint"> <em class="property">exception </em><tt class="descclassname">keystone.exception.</tt><tt class="descname">MalformedEndpoint</tt><big>(</big><em>message=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#keystone.exception.MalformedEndpoint" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#keystone.exception.UnexpectedError" title="keystone.exception.UnexpectedError"><tt class="xref py py-class docutils literal"><span class="pre">keystone.exception.UnexpectedError</span></tt></a></p> <p>Malformed endpoint URL (see ERROR log for details): %(endpoint)s</p> </dd></dl> <dl class="exception"> <dt id="keystone.exception.MetadataNotFound"> <em class="property">exception </em><tt class="descclassname">keystone.exception.</tt><tt class="descname">MetadataNotFound</tt><big>(</big><em>message=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#keystone.exception.MetadataNotFound" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#keystone.exception.NotFound" title="keystone.exception.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">keystone.exception.NotFound</span></tt></a></p> <p>An unhandled exception has occurred: Could not find metadata.</p> </dd></dl> <dl class="exception"> <dt id="keystone.exception.NotFound"> <em class="property">exception </em><tt class="descclassname">keystone.exception.</tt><tt class="descname">NotFound</tt><big>(</big><em>message=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#keystone.exception.NotFound" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#keystone.exception.Error" title="keystone.exception.Error"><tt class="xref py py-class docutils literal"><span class="pre">keystone.exception.Error</span></tt></a></p> <p>Could not find: %(target)s</p> <dl class="attribute"> <dt id="keystone.exception.NotFound.code"> <tt class="descname">code</tt><em class="property"> = 404</em><a class="headerlink" href="#keystone.exception.NotFound.code" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="attribute"> <dt id="keystone.exception.NotFound.title"> <tt class="descname">title</tt><em class="property"> = 'Not Found'</em><a class="headerlink" href="#keystone.exception.NotFound.title" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> <dl class="exception"> <dt id="keystone.exception.NotImplemented"> <em class="property">exception </em><tt class="descclassname">keystone.exception.</tt><tt class="descname">NotImplemented</tt><big>(</big><em>message=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#keystone.exception.NotImplemented" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#keystone.exception.Error" title="keystone.exception.Error"><tt class="xref py py-class docutils literal"><span class="pre">keystone.exception.Error</span></tt></a></p> <p>The action you have requested has not been implemented.</p> <dl class="attribute"> <dt id="keystone.exception.NotImplemented.code"> <tt class="descname">code</tt><em class="property"> = 501</em><a class="headerlink" href="#keystone.exception.NotImplemented.code" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="attribute"> <dt id="keystone.exception.NotImplemented.title"> <tt class="descname">title</tt><em class="property"> = 'Not Implemented'</em><a class="headerlink" href="#keystone.exception.NotImplemented.title" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> <dl class="exception"> <dt id="keystone.exception.RoleNotFound"> <em class="property">exception </em><tt class="descclassname">keystone.exception.</tt><tt class="descname">RoleNotFound</tt><big>(</big><em>message=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#keystone.exception.RoleNotFound" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#keystone.exception.NotFound" title="keystone.exception.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">keystone.exception.NotFound</span></tt></a></p> <p>Could not find role: %(role_id)s</p> </dd></dl> <dl class="exception"> <dt id="keystone.exception.ServiceNotFound"> <em class="property">exception </em><tt class="descclassname">keystone.exception.</tt><tt class="descname">ServiceNotFound</tt><big>(</big><em>message=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#keystone.exception.ServiceNotFound" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#keystone.exception.NotFound" title="keystone.exception.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">keystone.exception.NotFound</span></tt></a></p> <p>Could not find service: %(service_id)s</p> </dd></dl> <dl class="exception"> <dt id="keystone.exception.TenantNotFound"> <em class="property">exception </em><tt class="descclassname">keystone.exception.</tt><tt class="descname">TenantNotFound</tt><big>(</big><em>message=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#keystone.exception.TenantNotFound" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#keystone.exception.NotFound" title="keystone.exception.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">keystone.exception.NotFound</span></tt></a></p> <p>Could not find tenant: %(tenant_id)s</p> </dd></dl> <dl class="exception"> <dt id="keystone.exception.TokenNotFound"> <em class="property">exception </em><tt class="descclassname">keystone.exception.</tt><tt class="descname">TokenNotFound</tt><big>(</big><em>message=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#keystone.exception.TokenNotFound" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#keystone.exception.NotFound" title="keystone.exception.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">keystone.exception.NotFound</span></tt></a></p> <p>Could not find token: %(token_id)s</p> </dd></dl> <dl class="exception"> <dt id="keystone.exception.Unauthorized"> <em class="property">exception </em><tt class="descclassname">keystone.exception.</tt><tt class="descname">Unauthorized</tt><big>(</big><em>message=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#keystone.exception.Unauthorized" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#keystone.exception.Error" title="keystone.exception.Error"><tt class="xref py py-class docutils literal"><span class="pre">keystone.exception.Error</span></tt></a></p> <p>The request you have made requires authentication.</p> <dl class="attribute"> <dt id="keystone.exception.Unauthorized.code"> <tt class="descname">code</tt><em class="property"> = 401</em><a class="headerlink" href="#keystone.exception.Unauthorized.code" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="attribute"> <dt id="keystone.exception.Unauthorized.title"> <tt class="descname">title</tt><em class="property"> = 'Not Authorized'</em><a class="headerlink" href="#keystone.exception.Unauthorized.title" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> <dl class="exception"> <dt id="keystone.exception.UnexpectedError"> <em class="property">exception </em><tt class="descclassname">keystone.exception.</tt><tt class="descname">UnexpectedError</tt><big>(</big><em>message=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#keystone.exception.UnexpectedError" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#keystone.exception.Error" title="keystone.exception.Error"><tt class="xref py py-class docutils literal"><span class="pre">keystone.exception.Error</span></tt></a></p> <p>An unexpected error prevented the server from fulfilling your request.</p> <p>%(exception)s</p> <dl class="attribute"> <dt id="keystone.exception.UnexpectedError.code"> <tt class="descname">code</tt><em class="property"> = 500</em><a class="headerlink" href="#keystone.exception.UnexpectedError.code" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="attribute"> <dt id="keystone.exception.UnexpectedError.title"> <tt class="descname">title</tt><em class="property"> = 'Internal Server Error'</em><a class="headerlink" href="#keystone.exception.UnexpectedError.title" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> <dl class="exception"> <dt id="keystone.exception.UserNotFound"> <em class="property">exception </em><tt class="descclassname">keystone.exception.</tt><tt class="descname">UserNotFound</tt><big>(</big><em>message=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#keystone.exception.UserNotFound" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#keystone.exception.NotFound" title="keystone.exception.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">keystone.exception.NotFound</span></tt></a></p> <p>Could not find user: %(user_id)s</p> </dd></dl> <dl class="exception"> <dt id="keystone.exception.ValidationError"> <em class="property">exception </em><tt class="descclassname">keystone.exception.</tt><tt class="descname">ValidationError</tt><big>(</big><em>message=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#keystone.exception.ValidationError" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#keystone.exception.Error" title="keystone.exception.Error"><tt class="xref py py-class docutils literal"><span class="pre">keystone.exception.Error</span></tt></a></p> <p>Expecting to find %(attribute)s in %(target)s.</p> <p>The server could not comply with the request since it is either malformed or otherwise incorrect.</p> <p>The client is assumed to be in error.</p> <dl class="attribute"> <dt id="keystone.exception.ValidationError.code"> <tt class="descname">code</tt><em class="property"> = 400</em><a class="headerlink" href="#keystone.exception.ValidationError.code" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="attribute"> <dt id="keystone.exception.ValidationError.title"> <tt class="descname">title</tt><em class="property"> = 'Bad Request'</em><a class="headerlink" href="#keystone.exception.ValidationError.title" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> <dl class="exception"> <dt id="keystone.exception.ValidationSizeError"> <em class="property">exception </em><tt class="descclassname">keystone.exception.</tt><tt class="descname">ValidationSizeError</tt><big>(</big><em>message=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#keystone.exception.ValidationSizeError" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#keystone.exception.Error" title="keystone.exception.Error"><tt class="xref py py-class docutils literal"><span class="pre">keystone.exception.Error</span></tt></a></p> <p>Request attribute %(attribute)s must be less than or equal to %(size)i.</p> <p>The server could not comply with the request because the attribute size is invalid (too large).</p> <p>The client is assumed to be in error.</p> <dl class="attribute"> <dt id="keystone.exception.ValidationSizeError.code"> <tt class="descname">code</tt><em class="property"> = 400</em><a class="headerlink" href="#keystone.exception.ValidationSizeError.code" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="attribute"> <dt id="keystone.exception.ValidationSizeError.title"> <tt class="descname">title</tt><em class="property"> = 'Bad Request'</em><a class="headerlink" href="#keystone.exception.ValidationSizeError.title" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> </div> <div class="section" id="service-module"> <h2><tt class="xref py py-mod docutils literal"><span class="pre">service</span></tt> Module<a class="headerlink" href="#service-module" title="Permalink to this headline">¶</a></h2> </div> <div class="section" id="test-module"> <h2><tt class="xref py py-mod docutils literal"><span class="pre">test</span></tt> Module<a class="headerlink" href="#test-module" title="Permalink to this headline">¶</a></h2> </div> <div class="section" id="subpackages"> <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="keystone.catalog.html">catalog Package</a><ul> <li class="toctree-l2"><a class="reference internal" href="keystone.catalog.html#id1"><tt class="docutils literal"><span class="pre">catalog</span></tt> Package</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.catalog.html#core-module"><tt class="docutils literal"><span class="pre">core</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.catalog.html#subpackages">Subpackages</a><ul> <li class="toctree-l3"><a class="reference internal" href="keystone.catalog.backends.html">backends Package</a><ul> <li class="toctree-l4"><a class="reference internal" href="keystone.catalog.backends.html#kvs-module"><tt class="docutils literal"><span class="pre">kvs</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.catalog.backends.html#sql-module"><tt class="docutils literal"><span class="pre">sql</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.catalog.backends.html#templated-module"><tt class="docutils literal"><span class="pre">templated</span></tt> Module</a></li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="keystone.common.html">common Package</a><ul> <li class="toctree-l2"><a class="reference internal" href="keystone.common.html#bufferedhttp-module"><tt class="docutils literal"><span class="pre">bufferedhttp</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.common.html#module-keystone.common.cms"><tt class="docutils literal"><span class="pre">cms</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.common.html#module-keystone.common.kvs"><tt class="docutils literal"><span class="pre">kvs</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.common.html#module-keystone.common.logging"><tt class="docutils literal"><span class="pre">logging</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.common.html#module-keystone.common.manager"><tt class="docutils literal"><span class="pre">manager</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.common.html#module-keystone.common.models"><tt class="docutils literal"><span class="pre">models</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.common.html#module-keystone.common.openssl"><tt class="docutils literal"><span class="pre">openssl</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.common.html#policy-module"><tt class="docutils literal"><span class="pre">policy</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.common.html#serializer-module"><tt class="docutils literal"><span class="pre">serializer</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.common.html#module-keystone.common.systemd"><tt class="docutils literal"><span class="pre">systemd</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.common.html#utils-module"><tt class="docutils literal"><span class="pre">utils</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.common.html#wsgi-module"><tt class="docutils literal"><span class="pre">wsgi</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.common.html#subpackages">Subpackages</a><ul> <li class="toctree-l3"><a class="reference internal" href="keystone.common.ldap.html">ldap Package</a><ul> <li class="toctree-l4"><a class="reference internal" href="keystone.common.ldap.html#id1"><tt class="docutils literal"><span class="pre">ldap</span></tt> Package</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.common.ldap.html#core-module"><tt class="docutils literal"><span class="pre">core</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.common.ldap.html#fakeldap-module"><tt class="docutils literal"><span class="pre">fakeldap</span></tt> Module</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="keystone.common.sql.html">sql Package</a><ul> <li class="toctree-l4"><a class="reference internal" href="keystone.common.sql.html#id1"><tt class="docutils literal"><span class="pre">sql</span></tt> Package</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.common.sql.html#core-module"><tt class="docutils literal"><span class="pre">core</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.common.sql.html#legacy-module"><tt class="docutils literal"><span class="pre">legacy</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.common.sql.html#migration-module"><tt class="docutils literal"><span class="pre">migration</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.common.sql.html#nova-module"><tt class="docutils literal"><span class="pre">nova</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.common.sql.html#util-module"><tt class="docutils literal"><span class="pre">util</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.common.sql.html#subpackages">Subpackages</a><ul> <li class="toctree-l5"><a class="reference internal" href="keystone.common.sql.migrate_repo.html">migrate_repo Package</a><ul> <li class="toctree-l6"><a class="reference internal" href="keystone.common.sql.migrate_repo.html#manage-module"><tt class="docutils literal"><span class="pre">manage</span></tt> Module</a></li> <li class="toctree-l6"><a class="reference internal" href="keystone.common.sql.migrate_repo.html#subpackages">Subpackages</a><ul> <li class="toctree-l7"><a class="reference internal" href="keystone.common.sql.migrate_repo.versions.html">versions Package</a><ul> <li class="toctree-l8"><a class="reference internal" href="keystone.common.sql.migrate_repo.versions.html#add-initial-tables-module"><tt class="docutils literal"><span class="pre">001_add_initial_tables</span></tt> Module</a></li> <li class="toctree-l8"><a class="reference internal" href="keystone.common.sql.migrate_repo.versions.html#token-id-hash-module"><tt class="docutils literal"><span class="pre">002_token_id_hash</span></tt> Module</a></li> <li class="toctree-l8"><a class="reference internal" href="keystone.common.sql.migrate_repo.versions.html#token-valid-module"><tt class="docutils literal"><span class="pre">003_token_valid</span></tt> Module</a></li> <li class="toctree-l8"><a class="reference internal" href="keystone.common.sql.migrate_repo.versions.html#undo-token-id-hash-module"><tt class="docutils literal"><span class="pre">004_undo_token_id_hash</span></tt> Module</a></li> </ul> </li> </ul> </li> </ul> </li> </ul> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="keystone.contrib.html">contrib Package</a><ul> <li class="toctree-l2"><a class="reference internal" href="keystone.contrib.html#subpackages">Subpackages</a><ul> <li class="toctree-l3"><a class="reference internal" href="keystone.contrib.admin_crud.html">admin_crud Package</a><ul> <li class="toctree-l4"><a class="reference internal" href="keystone.contrib.admin_crud.html#id1"><tt class="docutils literal"><span class="pre">admin_crud</span></tt> Package</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.contrib.admin_crud.html#core-module"><tt class="docutils literal"><span class="pre">core</span></tt> Module</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="keystone.contrib.ec2.html">ec2 Package</a><ul> <li class="toctree-l4"><a class="reference internal" href="keystone.contrib.ec2.html#id1"><tt class="docutils literal"><span class="pre">ec2</span></tt> Package</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.contrib.ec2.html#core-module"><tt class="docutils literal"><span class="pre">core</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.contrib.ec2.html#subpackages">Subpackages</a><ul> <li class="toctree-l5"><a class="reference internal" href="keystone.contrib.ec2.backends.html">backends Package</a><ul> <li class="toctree-l6"><a class="reference internal" href="keystone.contrib.ec2.backends.html#kvs-module"><tt class="docutils literal"><span class="pre">kvs</span></tt> Module</a></li> <li class="toctree-l6"><a class="reference internal" href="keystone.contrib.ec2.backends.html#sql-module"><tt class="docutils literal"><span class="pre">sql</span></tt> Module</a></li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="keystone.contrib.s3.html">s3 Package</a><ul> <li class="toctree-l4"><a class="reference internal" href="keystone.contrib.s3.html#id1"><tt class="docutils literal"><span class="pre">s3</span></tt> Package</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.contrib.s3.html#core-module"><tt class="docutils literal"><span class="pre">core</span></tt> Module</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="keystone.contrib.stats.html">stats Package</a><ul> <li class="toctree-l4"><a class="reference internal" href="keystone.contrib.stats.html#id1"><tt class="docutils literal"><span class="pre">stats</span></tt> Package</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.contrib.stats.html#core-module"><tt class="docutils literal"><span class="pre">core</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.contrib.stats.html#subpackages">Subpackages</a><ul> <li class="toctree-l5"><a class="reference internal" href="keystone.contrib.stats.backends.html">backends Package</a><ul> <li class="toctree-l6"><a class="reference internal" href="keystone.contrib.stats.backends.html#kvs-module"><tt class="docutils literal"><span class="pre">kvs</span></tt> Module</a></li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="keystone.contrib.user_crud.html">user_crud Package</a><ul> <li class="toctree-l4"><a class="reference internal" href="keystone.contrib.user_crud.html#id1"><tt class="docutils literal"><span class="pre">user_crud</span></tt> Package</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.contrib.user_crud.html#core-module"><tt class="docutils literal"><span class="pre">core</span></tt> Module</a></li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="keystone.identity.html">identity Package</a><ul> <li class="toctree-l2"><a class="reference internal" href="keystone.identity.html#id1"><tt class="docutils literal"><span class="pre">identity</span></tt> Package</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.identity.html#core-module"><tt class="docutils literal"><span class="pre">core</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.identity.html#subpackages">Subpackages</a><ul> <li class="toctree-l3"><a class="reference internal" href="keystone.identity.backends.html">backends Package</a><ul> <li class="toctree-l4"><a class="reference internal" href="keystone.identity.backends.html#kvs-module"><tt class="docutils literal"><span class="pre">kvs</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.identity.backends.html#pam-module"><tt class="docutils literal"><span class="pre">pam</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.identity.backends.html#sql-module"><tt class="docutils literal"><span class="pre">sql</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.identity.backends.html#subpackages">Subpackages</a><ul> <li class="toctree-l5"><a class="reference internal" href="keystone.identity.backends.ldap.html">ldap Package</a><ul> <li class="toctree-l6"><a class="reference internal" href="keystone.identity.backends.ldap.html#id1"><tt class="docutils literal"><span class="pre">ldap</span></tt> Package</a></li> <li class="toctree-l6"><a class="reference internal" href="keystone.identity.backends.ldap.html#core-module"><tt class="docutils literal"><span class="pre">core</span></tt> Module</a></li> </ul> </li> </ul> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="keystone.middleware.html">middleware Package</a><ul> <li class="toctree-l2"><a class="reference internal" href="keystone.middleware.html#id1"><tt class="docutils literal"><span class="pre">middleware</span></tt> Package</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.middleware.html#auth-token-module"><tt class="docutils literal"><span class="pre">auth_token</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.middleware.html#core-module"><tt class="docutils literal"><span class="pre">core</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.middleware.html#ec2-token-module"><tt class="docutils literal"><span class="pre">ec2_token</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.middleware.html#s3-token-module"><tt class="docutils literal"><span class="pre">s3_token</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.middleware.html#swift-auth-module"><tt class="docutils literal"><span class="pre">swift_auth</span></tt> Module</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="keystone.openstack.html">openstack Package</a><ul> <li class="toctree-l2"><a class="reference internal" href="keystone.openstack.html#subpackages">Subpackages</a><ul> <li class="toctree-l3"><a class="reference internal" href="keystone.openstack.common.html">common Package</a><ul> <li class="toctree-l4"><a class="reference internal" href="keystone.openstack.common.html#module-keystone.openstack.common.cfg"><tt class="docutils literal"><span class="pre">cfg</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.openstack.common.html#module-keystone.openstack.common.importutils"><tt class="docutils literal"><span class="pre">importutils</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.openstack.common.html#module-keystone.openstack.common.iniparser"><tt class="docutils literal"><span class="pre">iniparser</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.openstack.common.html#jsonutils-module"><tt class="docutils literal"><span class="pre">jsonutils</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.openstack.common.html#module-keystone.openstack.common.setup"><tt class="docutils literal"><span class="pre">setup</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.openstack.common.html#timeutils-module"><tt class="docutils literal"><span class="pre">timeutils</span></tt> Module</a></li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="keystone.policy.html">policy Package</a><ul> <li class="toctree-l2"><a class="reference internal" href="keystone.policy.html#id1"><tt class="docutils literal"><span class="pre">policy</span></tt> Package</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.policy.html#module-keystone.policy.core"><tt class="docutils literal"><span class="pre">core</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.policy.html#subpackages">Subpackages</a><ul> <li class="toctree-l3"><a class="reference internal" href="keystone.policy.backends.html">backends Package</a><ul> <li class="toctree-l4"><a class="reference internal" href="keystone.policy.backends.html#rules-module"><tt class="docutils literal"><span class="pre">rules</span></tt> Module</a></li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="keystone.token.html">token Package</a><ul> <li class="toctree-l2"><a class="reference internal" href="keystone.token.html#id1"><tt class="docutils literal"><span class="pre">token</span></tt> Package</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.token.html#core-module"><tt class="docutils literal"><span class="pre">core</span></tt> Module</a></li> <li class="toctree-l2"><a class="reference internal" href="keystone.token.html#subpackages">Subpackages</a><ul> <li class="toctree-l3"><a class="reference internal" href="keystone.token.backends.html">backends Package</a><ul> <li class="toctree-l4"><a class="reference internal" href="keystone.token.backends.html#kvs-module"><tt class="docutils literal"><span class="pre">kvs</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.token.backends.html#memcache-module"><tt class="docutils literal"><span class="pre">memcache</span></tt> Module</a></li> <li class="toctree-l4"><a class="reference internal" href="keystone.token.backends.html#sql-module"><tt class="docutils literal"><span class="pre">sql</span></tt> Module</a></li> </ul> </li> </ul> </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 internal" href="#">keystone Package</a><ul> <li><a class="reference internal" href="#module-keystone.clean"><tt class="docutils literal"><span class="pre">clean</span></tt> Module</a></li> <li><a class="reference internal" href="#cli-module"><tt class="docutils literal"><span class="pre">cli</span></tt> Module</a></li> <li><a class="reference internal" href="#module-keystone.config"><tt class="docutils literal"><span class="pre">config</span></tt> Module</a></li> <li><a class="reference internal" href="#module-keystone.exception"><tt class="docutils literal"><span class="pre">exception</span></tt> Module</a></li> <li><a class="reference internal" href="#service-module"><tt class="docutils literal"><span class="pre">service</span></tt> Module</a></li> <li><a class="reference internal" href="#test-module"><tt class="docutils literal"><span class="pre">test</span></tt> Module</a></li> <li><a class="reference internal" href="#subpackages">Subpackages</a><ul> </ul> </li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="modules.html" title="previous chapter">keystone</a></p> <h4>Next topic</h4> <p class="topless"><a href="keystone.catalog.html" title="next chapter">catalog Package</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="_sources/keystone.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="keystone.catalog.html" title="catalog Package" accesskey="N">next</a> |</li> <li class="right" > <a href="modules.html" title="keystone" accesskey="P">previous</a> |</li> <li><a href="index.html">keystone 2012.1-dev documentation</a> »</li> <li><a href="modules.html" accesskey="U">keystone</a> »</li> </ul> </div> <div class="footer"> © Copyright 2012, OpenStack, LLC. Last updated on Jun 22, 2013. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>