/usr/share/doc/python3-certbot-apache/html/_modules/certbot_apache/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 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 | <!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 — 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="Module code" href="../index.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>
<li class="toctree-l1"><a class="reference internal" href="../../api.html">API Documentation</a></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> »</li>
<li><a href="../index.html">Module code</a> »</li>
<li>certbot_apache.augeas_configurator</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for certbot_apache.augeas_configurator</h1><div class="highlight"><pre>
<span></span><span class="sd">"""Class of Augeas Configurators."""</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">from</span> <span class="nn">certbot</span> <span class="k">import</span> <span class="n">errors</span>
<span class="kn">from</span> <span class="nn">certbot.plugins</span> <span class="k">import</span> <span class="n">common</span>
<span class="kn">from</span> <span class="nn">certbot_apache</span> <span class="k">import</span> <span class="n">constants</span>
<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
<div class="viewcode-block" id="AugeasConfigurator"><a class="viewcode-back" href="../../api/augeas_configurator.html#certbot_apache.augeas_configurator.AugeasConfigurator">[docs]</a><span class="k">class</span> <span class="nc">AugeasConfigurator</span><span class="p">(</span><span class="n">common</span><span class="o">.</span><span class="n">Installer</span><span class="p">):</span>
<span class="sd">"""Base Augeas Configurator class.</span>
<span class="sd"> :ivar config: Configuration.</span>
<span class="sd"> :type config: :class:`~certbot.interfaces.IConfig`</span>
<span class="sd"> :ivar aug: Augeas object</span>
<span class="sd"> :type aug: :class:`augeas.Augeas`</span>
<span class="sd"> :ivar str save_notes: Human-readable configuration change notes</span>
<span class="sd"> :ivar reverter: saves and reverts checkpoints</span>
<span class="sd"> :type reverter: :class:`certbot.reverter.Reverter`</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">AugeasConfigurator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="c1"># Placeholder for augeas</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span> <span class="o">=</span> <span class="s2">""</span>
<div class="viewcode-block" id="AugeasConfigurator.init_augeas"><a class="viewcode-back" href="../../api/augeas_configurator.html#certbot_apache.augeas_configurator.AugeasConfigurator.init_augeas">[docs]</a> <span class="k">def</span> <span class="nf">init_augeas</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""" Initialize the actual Augeas instance """</span>
<span class="kn">import</span> <span class="nn">augeas</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span> <span class="o">=</span> <span class="n">augeas</span><span class="o">.</span><span class="n">Augeas</span><span class="p">(</span>
<span class="c1"># specify a directory to load our preferred lens from</span>
<span class="n">loadpath</span><span class="o">=</span><span class="n">constants</span><span class="o">.</span><span class="n">AUGEAS_LENS_DIR</span><span class="p">,</span>
<span class="c1"># Do not save backup (we do it ourselves), do not load</span>
<span class="c1"># anything by default</span>
<span class="n">flags</span><span class="o">=</span><span class="p">(</span><span class="n">augeas</span><span class="o">.</span><span class="n">Augeas</span><span class="o">.</span><span class="n">NONE</span> <span class="o">|</span>
<span class="n">augeas</span><span class="o">.</span><span class="n">Augeas</span><span class="o">.</span><span class="n">NO_MODL_AUTOLOAD</span> <span class="o">|</span>
<span class="n">augeas</span><span class="o">.</span><span class="n">Augeas</span><span class="o">.</span><span class="n">ENABLE_SPAN</span><span class="p">))</span>
<span class="c1"># See if any temporary changes need to be recovered</span>
<span class="c1"># This needs to occur before VirtualHost objects are setup...</span>
<span class="c1"># because this will change the underlying configuration and potential</span>
<span class="c1"># vhosts</span>
<span class="bp">self</span><span class="o">.</span><span class="n">recovery_routine</span><span class="p">()</span></div>
<div class="viewcode-block" id="AugeasConfigurator.check_parsing_errors"><a class="viewcode-back" href="../../api/augeas_configurator.html#certbot_apache.augeas_configurator.AugeasConfigurator.check_parsing_errors">[docs]</a> <span class="k">def</span> <span class="nf">check_parsing_errors</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">lens</span><span class="p">):</span>
<span class="sd">"""Verify Augeas can parse all of the lens files.</span>
<span class="sd"> :param str lens: lens to check for errors</span>
<span class="sd"> :raises .errors.PluginError: If there has been an error in parsing with</span>
<span class="sd"> the specified lens.</span>
<span class="sd"> """</span>
<span class="n">error_files</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s2">"/augeas//error"</span><span class="p">)</span>
<span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">error_files</span><span class="p">:</span>
<span class="c1"># Check to see if it was an error resulting from the use of</span>
<span class="c1"># the httpd lens</span>
<span class="n">lens_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span> <span class="o">+</span> <span class="s2">"/lens"</span><span class="p">)</span>
<span class="c1"># As aug.get may return null</span>
<span class="k">if</span> <span class="n">lens_path</span> <span class="ow">and</span> <span class="n">lens</span> <span class="ow">in</span> <span class="n">lens_path</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
<span class="s2">"There has been an error in parsing the file </span><span class="si">{0}</span><span class="s2"> on line </span><span class="si">{1}</span><span class="s2">: "</span>
<span class="s2">"</span><span class="si">{2}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="c1"># Strip off /augeas/files and /error</span>
<span class="n">path</span><span class="p">[</span><span class="mi">13</span><span class="p">:</span><span class="nb">len</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> <span class="o">-</span> <span class="mi">6</span><span class="p">],</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span> <span class="o">+</span> <span class="s2">"/line"</span><span class="p">),</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span> <span class="o">+</span> <span class="s2">"/message"</span><span class="p">)))</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span></div>
<div class="viewcode-block" id="AugeasConfigurator.ensure_augeas_state"><a class="viewcode-back" href="../../api/augeas_configurator.html#certbot_apache.augeas_configurator.AugeasConfigurator.ensure_augeas_state">[docs]</a> <span class="k">def</span> <span class="nf">ensure_augeas_state</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Makes sure that all Augeas dom changes are written to files to avoid</span>
<span class="sd"> loss of configuration directives when doing additional augeas parsing,</span>
<span class="sd"> causing a possible augeas.load() resulting dom reset</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">unsaved_files</span><span class="p">():</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span> <span class="o">+=</span> <span class="s2">"(autosave)"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save</span><span class="p">()</span></div>
<div class="viewcode-block" id="AugeasConfigurator.unsaved_files"><a class="viewcode-back" href="../../api/augeas_configurator.html#certbot_apache.augeas_configurator.AugeasConfigurator.unsaved_files">[docs]</a> <span class="k">def</span> <span class="nf">unsaved_files</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Lists files that have modified Augeas DOM but the changes have not</span>
<span class="sd"> been written to the filesystem yet, used by `self.save()` and</span>
<span class="sd"> ApacheConfigurator to check the file state.</span>
<span class="sd"> :raises .errors.PluginError: If there was an error in Augeas, in</span>
<span class="sd"> an attempt to save the configuration, or an error creating a</span>
<span class="sd"> checkpoint</span>
<span class="sd"> :returns: `set` of unsaved files</span>
<span class="sd"> """</span>
<span class="n">save_state</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"/augeas/save"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">"/augeas/save"</span><span class="p">,</span> <span class="s2">"noop"</span><span class="p">)</span>
<span class="c1"># Existing Errors</span>
<span class="n">ex_errs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s2">"/augeas//error"</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># This is a noop save</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
<span class="k">except</span> <span class="p">(</span><span class="ne">RuntimeError</span><span class="p">,</span> <span class="ne">IOError</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_log_save_errors</span><span class="p">(</span><span class="n">ex_errs</span><span class="p">)</span>
<span class="c1"># Erase Save Notes</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span> <span class="o">=</span> <span class="s2">""</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span>
<span class="s2">"Error saving files, check logs for more info."</span><span class="p">)</span>
<span class="c1"># Return the original save method</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">"/augeas/save"</span><span class="p">,</span> <span class="n">save_state</span><span class="p">)</span>
<span class="c1"># Retrieve list of modified files</span>
<span class="c1"># Note: Noop saves can cause the file to be listed twice, I used a</span>
<span class="c1"># set to remove this possibility. This is a known augeas 0.10 error.</span>
<span class="n">save_paths</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s2">"/augeas/events/saved"</span><span class="p">)</span>
<span class="n">save_files</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="k">if</span> <span class="n">save_paths</span><span class="p">:</span>
<span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">save_paths</span><span class="p">:</span>
<span class="n">save_files</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">)[</span><span class="mi">6</span><span class="p">:])</span>
<span class="k">return</span> <span class="n">save_files</span></div>
<div class="viewcode-block" id="AugeasConfigurator.save"><a class="viewcode-back" href="../../api/augeas_configurator.html#certbot_apache.augeas_configurator.AugeasConfigurator.save">[docs]</a> <span class="k">def</span> <span class="nf">save</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">temporary</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""Saves all changes to the configuration files.</span>
<span class="sd"> This function first checks for save errors, if none are found,</span>
<span class="sd"> all configuration changes made will be saved. According to the</span>
<span class="sd"> function parameters. If an exception is raised, a new checkpoint</span>
<span class="sd"> was not created.</span>
<span class="sd"> :param str title: The title of the save. If a title is given, the</span>
<span class="sd"> configuration will be saved as a new checkpoint and put in a</span>
<span class="sd"> timestamped directory.</span>
<span class="sd"> :param bool temporary: Indicates whether the changes made will</span>
<span class="sd"> be quickly reversed in the future (ie. challenges)</span>
<span class="sd"> """</span>
<span class="n">save_files</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">unsaved_files</span><span class="p">()</span>
<span class="k">if</span> <span class="n">save_files</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_to_checkpoint</span><span class="p">(</span><span class="n">save_files</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span><span class="p">,</span> <span class="n">temporary</span><span class="o">=</span><span class="n">temporary</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span> <span class="o">=</span> <span class="s2">""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
<span class="c1"># Force reload if files were modified</span>
<span class="c1"># This is needed to recalculate augeas directive span</span>
<span class="k">if</span> <span class="n">save_files</span><span class="p">:</span>
<span class="k">for</span> <span class="n">sf</span> <span class="ow">in</span> <span class="n">save_files</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="s2">"/files/"</span><span class="o">+</span><span class="n">sf</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="k">if</span> <span class="n">title</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">temporary</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">finalize_checkpoint</span><span class="p">(</span><span class="n">title</span><span class="p">)</span></div>
<div class="viewcode-block" id="AugeasConfigurator._log_save_errors"><a class="viewcode-back" href="../../api/augeas_configurator.html#certbot_apache.augeas_configurator.AugeasConfigurator._log_save_errors">[docs]</a> <span class="k">def</span> <span class="nf">_log_save_errors</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ex_errs</span><span class="p">):</span>
<span class="sd">"""Log errors due to bad Augeas save.</span>
<span class="sd"> :param list ex_errs: Existing errors before save</span>
<span class="sd"> """</span>
<span class="c1"># Check for the root of save problems</span>
<span class="n">new_errs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s2">"/augeas//error"</span><span class="p">)</span>
<span class="c1"># logger.error("During Save - %s", mod_conf)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"Unable to save files: </span><span class="si">%s</span><span class="s2">. Attempted Save Notes: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span>
<span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">err</span><span class="p">[</span><span class="mi">13</span><span class="p">:</span><span class="nb">len</span><span class="p">(</span><span class="n">err</span><span class="p">)</span> <span class="o">-</span> <span class="mi">6</span><span class="p">]</span> <span class="k">for</span> <span class="n">err</span> <span class="ow">in</span> <span class="n">new_errs</span>
<span class="c1"># Only new errors caused by recent save</span>
<span class="k">if</span> <span class="n">err</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">ex_errs</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span><span class="p">)</span></div>
<span class="c1"># Wrapper functions for Reverter class</span>
<div class="viewcode-block" id="AugeasConfigurator.recovery_routine"><a class="viewcode-back" href="../../api/augeas_configurator.html#certbot_apache.augeas_configurator.AugeasConfigurator.recovery_routine">[docs]</a> <span class="k">def</span> <span class="nf">recovery_routine</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Revert all previously modified files.</span>
<span class="sd"> Reverts all modified files that have not been saved as a checkpoint</span>
<span class="sd"> :raises .errors.PluginError: If unable to recover the configuration</span>
<span class="sd"> """</span>
<span class="nb">super</span><span class="p">(</span><span class="n">AugeasConfigurator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">recovery_routine</span><span class="p">()</span>
<span class="c1"># Need to reload configuration after these changes take effect</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">load</span><span class="p">()</span></div>
<div class="viewcode-block" id="AugeasConfigurator.revert_challenge_config"><a class="viewcode-back" href="../../api/augeas_configurator.html#certbot_apache.augeas_configurator.AugeasConfigurator.revert_challenge_config">[docs]</a> <span class="k">def</span> <span class="nf">revert_challenge_config</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Used to cleanup challenge configurations.</span>
<span class="sd"> :raises .errors.PluginError: If unable to revert the challenge config.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">revert_temporary_config</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">load</span><span class="p">()</span></div>
<div class="viewcode-block" id="AugeasConfigurator.rollback_checkpoints"><a class="viewcode-back" href="../../api/augeas_configurator.html#certbot_apache.augeas_configurator.AugeasConfigurator.rollback_checkpoints">[docs]</a> <span class="k">def</span> <span class="nf">rollback_checkpoints</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">rollback</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
<span class="sd">"""Rollback saved checkpoints.</span>
<span class="sd"> :param int rollback: Number of checkpoints to revert</span>
<span class="sd"> :raises .errors.PluginError: If there is a problem with the input or</span>
<span class="sd"> the function is unable to correctly revert the configuration</span>
<span class="sd"> """</span>
<span class="nb">super</span><span class="p">(</span><span class="n">AugeasConfigurator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">rollback_checkpoints</span><span class="p">(</span><span class="n">rollback</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">load</span><span class="p">()</span></div></div>
</pre></div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2014-2018, Let'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>
|