python-certbot-apache-doc 0.23.0-1 / usr / share / doc / python3-certbot-apache / html / api / augeas_configurator.html

This file is indexed.

/usr/share/doc/python3-certbot-apache/html/api/augeas_configurator.html is in python-certbot-apache-doc 0.23.0-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
<!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_apache.augeas_configurator &mdash; certbot-apache 0 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-apache 0 documentation" href="../index.html"/>
        <link rel="up" title="API Documentation" href="../api.html"/>
        <link rel="next" title="certbot_apache.configurator" href="configurator.html"/>
        <link rel="prev" title="API Documentation" href="../api.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-apache
          

          
          </a>

          
            
            
              <div class="version">
                0
              </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 class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">certbot_apache.augeas_configurator</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configurator.html"><code class="docutils literal"><span class="pre">certbot_apache.configurator</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="display_ops.html"><code class="docutils literal"><span class="pre">certbot_apache.display_ops</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="obj.html"><code class="docutils literal"><span class="pre">certbot_apache.obj</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="parser.html"><code class="docutils literal"><span class="pre">certbot_apache.parser</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="tls_sni_01.html"><code class="docutils literal"><span class="pre">certbot_apache.tls_sni_01</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-apache</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> &raquo;</li>
        
          <li><a href="../api.html">API Documentation</a> &raquo;</li>
        
      <li><code class="docutils literal"><span class="pre">certbot_apache.augeas_configurator</span></code></li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="../_sources/api/augeas_configurator.rst.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_apache.augeas_configurator">
<span id="certbot-apache-augeas-configurator"></span><h1><a class="reference internal" href="#module-certbot_apache.augeas_configurator" title="certbot_apache.augeas_configurator"><code class="xref py py-mod docutils literal"><span class="pre">certbot_apache.augeas_configurator</span></code></a><a class="headerlink" href="#module-certbot_apache.augeas_configurator" title="Permalink to this headline"></a></h1>
<p>Class of Augeas Configurators.</p>
<dl class="class">
<dt id="certbot_apache.augeas_configurator.AugeasConfigurator">
<em class="property">class </em><code class="descclassname">certbot_apache.augeas_configurator.</code><code class="descname">AugeasConfigurator</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/augeas_configurator.html#AugeasConfigurator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.augeas_configurator.AugeasConfigurator" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">certbot.plugins.common.Installer</span></code></p>
<p>Base Augeas Configurator class.</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"><ul class="first last simple">
<li><strong>config</strong> – Configuration.</li>
<li><strong>aug</strong> – Augeas object</li>
<li><strong>save_notes</strong> (<em>str</em>) – Human-readable configuration change notes</li>
<li><strong>reverter</strong> – saves and reverts checkpoints</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="certbot_apache.augeas_configurator.AugeasConfigurator.init_augeas">
<code class="descname">init_augeas</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/augeas_configurator.html#AugeasConfigurator.init_augeas"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.augeas_configurator.AugeasConfigurator.init_augeas" title="Permalink to this definition"></a></dt>
<dd><p>Initialize the actual Augeas instance</p>
</dd></dl>

<dl class="method">
<dt id="certbot_apache.augeas_configurator.AugeasConfigurator.check_parsing_errors">
<code class="descname">check_parsing_errors</code><span class="sig-paren">(</span><em>lens</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/augeas_configurator.html#AugeasConfigurator.check_parsing_errors"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.augeas_configurator.AugeasConfigurator.check_parsing_errors" title="Permalink to this definition"></a></dt>
<dd><p>Verify Augeas can parse all of the lens files.</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>lens</strong> (<em>str</em>) – lens to check for errors</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>errors.PluginError</strong> – If there has been an error in parsing with
the specified lens.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="certbot_apache.augeas_configurator.AugeasConfigurator.ensure_augeas_state">
<code class="descname">ensure_augeas_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/augeas_configurator.html#AugeasConfigurator.ensure_augeas_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.augeas_configurator.AugeasConfigurator.ensure_augeas_state" title="Permalink to this definition"></a></dt>
<dd><p>Makes sure that all Augeas dom changes are written to files to avoid
loss of configuration directives when doing additional augeas parsing,
causing a possible augeas.load() resulting dom reset</p>
</dd></dl>

<dl class="method">
<dt id="certbot_apache.augeas_configurator.AugeasConfigurator.unsaved_files">
<code class="descname">unsaved_files</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/augeas_configurator.html#AugeasConfigurator.unsaved_files"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.augeas_configurator.AugeasConfigurator.unsaved_files" title="Permalink to this definition"></a></dt>
<dd><p>Lists files that have modified Augeas DOM but the changes have not
been written to the filesystem yet, used by <code class="xref py py-obj docutils literal"><span class="pre">self.save()</span></code> and
ApacheConfigurator to check the file state.</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">Raises:</th><td class="field-body"><strong>errors.PluginError</strong> – If there was an error in Augeas, in
an attempt to save the configuration, or an error creating a
checkpoint</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">set</span></code> of unsaved files</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="certbot_apache.augeas_configurator.AugeasConfigurator.save">
<code class="descname">save</code><span class="sig-paren">(</span><em>title=None</em>, <em>temporary=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/augeas_configurator.html#AugeasConfigurator.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.augeas_configurator.AugeasConfigurator.save" title="Permalink to this definition"></a></dt>
<dd><p>Saves all changes to the configuration files.</p>
<p>This function first checks for save errors, if none are found,
all configuration changes made will be saved. According to the
function parameters. If an exception is raised, a new checkpoint
was not created.</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"><ul class="first last simple">
<li><strong>title</strong> (<em>str</em>) – The title of the save. If a title is given, the
configuration will be saved as a new checkpoint and put in a
timestamped directory.</li>
<li><strong>temporary</strong> (<em>bool</em>) – Indicates whether the changes made will
be quickly reversed in the future (ie. challenges)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="certbot_apache.augeas_configurator.AugeasConfigurator._log_save_errors">
<code class="descname">_log_save_errors</code><span class="sig-paren">(</span><em>ex_errs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/augeas_configurator.html#AugeasConfigurator._log_save_errors"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.augeas_configurator.AugeasConfigurator._log_save_errors" title="Permalink to this definition"></a></dt>
<dd><p>Log errors due to bad Augeas save.</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>ex_errs</strong> (<em>list</em>) – Existing errors before save</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="certbot_apache.augeas_configurator.AugeasConfigurator.recovery_routine">
<code class="descname">recovery_routine</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/augeas_configurator.html#AugeasConfigurator.recovery_routine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.augeas_configurator.AugeasConfigurator.recovery_routine" title="Permalink to this definition"></a></dt>
<dd><p>Revert all previously modified files.</p>
<p>Reverts all modified files that have not been saved as a checkpoint</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">Raises:</th><td class="field-body"><strong>errors.PluginError</strong> – If unable to recover the configuration</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="certbot_apache.augeas_configurator.AugeasConfigurator.revert_challenge_config">
<code class="descname">revert_challenge_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/augeas_configurator.html#AugeasConfigurator.revert_challenge_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.augeas_configurator.AugeasConfigurator.revert_challenge_config" title="Permalink to this definition"></a></dt>
<dd><p>Used to cleanup challenge configurations.</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">Raises:</th><td class="field-body"><strong>errors.PluginError</strong> – If unable to revert the challenge config.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="certbot_apache.augeas_configurator.AugeasConfigurator.rollback_checkpoints">
<code class="descname">rollback_checkpoints</code><span class="sig-paren">(</span><em>rollback=1</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/augeas_configurator.html#AugeasConfigurator.rollback_checkpoints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.augeas_configurator.AugeasConfigurator.rollback_checkpoints" title="Permalink to this definition"></a></dt>
<dd><p>Rollback saved checkpoints.</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>rollback</strong> (<em>int</em>) – Number of checkpoints to revert</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>errors.PluginError</strong> – If there is a problem with the input or
the function is unable to correctly revert the configuration</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

</div>


           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="configurator.html" class="btn btn-neutral float-right" title="certbot_apache.configurator" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="../api.html" class="btn btn-neutral" title="API Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2014-2018, Let&#39;s Encrypt Project.

    </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',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </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>

APT Browse - Built by Thomas Orozco.