<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>certbot.errors — Certbot 0.14.2 documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Certbot 0.14.2 documentation" href="../index.html"/>
<link rel="up" title="API Documentation" href="../api.html"/>
<link rel="next" title="certbot" href="index.html"/>
<link rel="prev" title="certbot.display" href="display.html"/>
<script src="../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../index.html" class="icon icon-home"> Certbot
</a>
<div class="version">
0.14
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../install.html">Get Certbot</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using.html">User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Developer Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../packaging.html">Packaging Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../resources.html">Resources</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="account.html"><code class="docutils literal"><span class="pre">certbot.account</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="achallenges.html"><code class="docutils literal"><span class="pre">certbot.achallenges</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="auth_handler.html"><code class="docutils literal"><span class="pre">certbot.auth_handler</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">certbot.client</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html"><code class="docutils literal"><span class="pre">certbot.configuration</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="constants.html"><code class="docutils literal"><span class="pre">certbot.constants</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="crypto_util.html"><code class="docutils literal"><span class="pre">certbot.crypto_util</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="display.html"><code class="docutils literal"><span class="pre">certbot.display</span></code></a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">certbot.errors</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">certbot</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="interfaces.html"><code class="docutils literal"><span class="pre">certbot.interfaces</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/common.html"><code class="docutils literal"><span class="pre">certbot.plugins.common</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/disco.html"><code class="docutils literal"><span class="pre">certbot.plugins.disco</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/manual.html"><code class="docutils literal"><span class="pre">certbot.plugins.manual</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/standalone.html"><code class="docutils literal"><span class="pre">certbot.plugins.standalone</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/util.html"><code class="docutils literal"><span class="pre">certbot.plugins.util</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/webroot.html"><code class="docutils literal"><span class="pre">certbot.plugins.webroot</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="reporter.html"><code class="docutils literal"><span class="pre">certbot.reporter</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="reverter.html"><code class="docutils literal"><span class="pre">certbot.reverter</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="storage.html"><code class="docutils literal"><span class="pre">certbot.storage</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="util.html"><code class="docutils literal"><span class="pre">certbot.util</span></code></a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Certbot</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> »</li>
<li><a href="../api.html">API Documentation</a> »</li>
<li><code class="docutils literal"><span class="pre">certbot.errors</span></code></li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/errors.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-certbot.errors">
<span id="certbot-errors"></span><h1><a class="reference internal" href="#module-certbot.errors" title="certbot.errors"><code class="xref py py-mod docutils literal"><span class="pre">certbot.errors</span></code></a><a class="headerlink" href="#module-certbot.errors" title="Permalink to this headline">¶</a></h1>
<p>Certbot client errors.</p>
<dl class="exception">
<dt id="certbot.errors.Error">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">Error</code><a class="reference internal" href="../_modules/certbot/errors.html#Error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.Error" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="../python/library/exceptions.html#exceptions.Exception" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></code></a></p>
<p>Generic Certbot client error.</p>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.AccountStorageError">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">AccountStorageError</code><a class="reference internal" href="../_modules/certbot/errors.html#AccountStorageError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.AccountStorageError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.Error" title="certbot.errors.Error"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.Error</span></code></a></p>
<p>Generic <a class="reference internal" href="interfaces.html#certbot.interfaces.AccountStorage" title="certbot.interfaces.AccountStorage"><code class="xref py py-obj docutils literal"><span class="pre">AccountStorage</span></code></a> error.</p>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.AccountNotFound">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">AccountNotFound</code><a class="reference internal" href="../_modules/certbot/errors.html#AccountNotFound"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.AccountNotFound" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.AccountStorageError" title="certbot.errors.AccountStorageError"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.AccountStorageError</span></code></a></p>
<p>Account not found error.</p>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.ReverterError">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">ReverterError</code><a class="reference internal" href="../_modules/certbot/errors.html#ReverterError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.ReverterError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.Error" title="certbot.errors.Error"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.Error</span></code></a></p>
<p>Certbot Reverter error.</p>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.SubprocessError">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">SubprocessError</code><a class="reference internal" href="../_modules/certbot/errors.html#SubprocessError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.SubprocessError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.Error" title="certbot.errors.Error"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.Error</span></code></a></p>
<p>Subprocess handling error.</p>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.CertStorageError">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">CertStorageError</code><a class="reference internal" href="../_modules/certbot/errors.html#CertStorageError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.CertStorageError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.Error" title="certbot.errors.Error"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.Error</span></code></a></p>
<p>Generic <code class="xref py py-obj docutils literal"><span class="pre">CertStorage</span></code> error.</p>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.HookCommandNotFound">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">HookCommandNotFound</code><a class="reference internal" href="../_modules/certbot/errors.html#HookCommandNotFound"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.HookCommandNotFound" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.Error" title="certbot.errors.Error"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.Error</span></code></a></p>
<p>Failed to find a hook command in the PATH.</p>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.SignalExit">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">SignalExit</code><a class="reference internal" href="../_modules/certbot/errors.html#SignalExit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.SignalExit" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.Error" title="certbot.errors.Error"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.Error</span></code></a></p>
<p>A Unix signal was received while in the ErrorHandler context manager.</p>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.LockError">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">LockError</code><a class="reference internal" href="../_modules/certbot/errors.html#LockError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.LockError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.Error" title="certbot.errors.Error"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.Error</span></code></a></p>
<p>File locking error.</p>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.AuthorizationError">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">AuthorizationError</code><a class="reference internal" href="../_modules/certbot/errors.html#AuthorizationError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.AuthorizationError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.Error" title="certbot.errors.Error"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.Error</span></code></a></p>
<p>Authorization error.</p>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.FailedChallenges">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">FailedChallenges</code><span class="sig-paren">(</span><em>failed_achalls</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/errors.html#FailedChallenges"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.FailedChallenges" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.AuthorizationError" title="certbot.errors.AuthorizationError"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.AuthorizationError</span></code></a></p>
<p>Failed challenges error.</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">Variables:</th><td class="field-body"><strong>failed_achalls</strong> (<a class="reference external" href="python/library/stdtypes.html#set" title="(in Python v2.7)"><em>set</em></a>) – Failed <code class="xref py py-obj docutils literal"><span class="pre">AnnotatedChallenge</span></code> instances.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.PluginError">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">PluginError</code><a class="reference internal" href="../_modules/certbot/errors.html#PluginError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.PluginError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.Error" title="certbot.errors.Error"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.Error</span></code></a></p>
<p>Certbot Plugin error.</p>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.PluginEnhancementAlreadyPresent">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">PluginEnhancementAlreadyPresent</code><a class="reference internal" href="../_modules/certbot/errors.html#PluginEnhancementAlreadyPresent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.PluginEnhancementAlreadyPresent" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.Error" title="certbot.errors.Error"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.Error</span></code></a></p>
<p>Enhancement was already set</p>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.PluginSelectionError">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">PluginSelectionError</code><a class="reference internal" href="../_modules/certbot/errors.html#PluginSelectionError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.PluginSelectionError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.Error" title="certbot.errors.Error"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.Error</span></code></a></p>
<p>A problem with plugin/configurator selection or setup</p>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.NoInstallationError">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">NoInstallationError</code><a class="reference internal" href="../_modules/certbot/errors.html#NoInstallationError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.NoInstallationError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.PluginError" title="certbot.errors.PluginError"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.PluginError</span></code></a></p>
<p>Certbot No Installation error.</p>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.MisconfigurationError">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">MisconfigurationError</code><a class="reference internal" href="../_modules/certbot/errors.html#MisconfigurationError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.MisconfigurationError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.PluginError" title="certbot.errors.PluginError"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.PluginError</span></code></a></p>
<p>Certbot Misconfiguration error.</p>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.NotSupportedError">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">NotSupportedError</code><a class="reference internal" href="../_modules/certbot/errors.html#NotSupportedError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.NotSupportedError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.PluginError" title="certbot.errors.PluginError"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.PluginError</span></code></a></p>
<p>Certbot Plugin function not supported error.</p>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.StandaloneBindError">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">StandaloneBindError</code><span class="sig-paren">(</span><em>socket_error</em>, <em>port</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot/errors.html#StandaloneBindError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.StandaloneBindError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.Error" title="certbot.errors.Error"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.Error</span></code></a></p>
<p>Standalone plugin bind error.</p>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.ConfigurationError">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">ConfigurationError</code><a class="reference internal" href="../_modules/certbot/errors.html#ConfigurationError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.ConfigurationError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.Error" title="certbot.errors.Error"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.Error</span></code></a></p>
<p>Configuration sanity error.</p>
</dd></dl>
<dl class="exception">
<dt id="certbot.errors.MissingCommandlineFlag">
<em class="property">exception </em><code class="descclassname">certbot.errors.</code><code class="descname">MissingCommandlineFlag</code><a class="reference internal" href="../_modules/certbot/errors.html#MissingCommandlineFlag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot.errors.MissingCommandlineFlag" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#certbot.errors.Error" title="certbot.errors.Error"><code class="xref py py-class docutils literal"><span class="pre">certbot.errors.Error</span></code></a></p>
<p>A command line argument was missing in noninteractive usage</p>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="index.html" class="btn btn-neutral float-right" title="certbot" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="display.html" class="btn btn-neutral" title="certbot.display" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2014-2016 - The Certbot software and documentation are licensed under the Apache 2.0 license as described at https://eff.org/cb-license .
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.14.2',
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/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
