Sophie

Sophie

distrib > Fedora > 17 > i386 > media > updates > by-pkgid > b50d8ee6d7871fcc13c0677a9364ed59 > files > 344

bcfg2-doc-1.3.0-1.fc17.noarch.rpm



<!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>Client modes &mdash; Bcfg2 1.3.0 documentation</title>
    
    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '1.3.0',
        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/sidebar.js"></script>
    <link rel="shortcut icon" href="../_static/favicon.ico"/>
    <link rel="top" title="Bcfg2 1.3.0 documentation" href="../index.html" />
    <link rel="up" title="The Bcfg2 Client" href="index.html" />
    <link rel="next" title="Client Tool Drivers" href="tools.html" />
    <link rel="prev" title="The Bcfg2 Client" href="index.html" />
 
<link rel="stylesheet" href="../_static/bcfg2.css" type=""/>

  </head>
  <body>

<div style="text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/bcfg2_logo.png" border="0" alt="sampledoc"/></a>
</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="tools.html" title="Client Tool Drivers"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="index.html" title="The Bcfg2 Client"
             accesskey="P">previous</a> |</li>
	<li><a href="../index.html">home</a> |&nbsp;</li>
	<!--<li><a href="../search.html">search</a> |&nbsp;</li>-->
	<li><a href="../help/index.html">help</a> |&nbsp;</li>
	<li><a href="../contents.html">documentation </a> &raquo;</li>

          <li><a href="../contents.html" >Bcfg2 documentation 1.3.0</a> &raquo;</li>
          <li><a href="index.html" accesskey="U">The Bcfg2 Client</a> &raquo;</li> 
      </ul>
    </div>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="client-modes">
<span id="id1"></span><h1>Client modes<a class="headerlink" href="#client-modes" title="Permalink to this headline">¶</a></h1>
<div class="section" id="dryrun-mode">
<h2>Dryrun mode<a class="headerlink" href="#dryrun-mode" title="Permalink to this headline">¶</a></h2>
<p>Dryrun mode (-n) prevents the client from making changes, but gives you
some insight into the state of the machine. This mode is also useful if
you simply want to gather data from the client into the reporting
system.</p>
</div>
<div class="section" id="interactive-mode">
<h2>Interactive mode<a class="headerlink" href="#interactive-mode" title="Permalink to this headline">¶</a></h2>
<p>The client can be run interactively (-I) so that you are able to step
through each operation in order to see what the client is doing.</p>
</div>
<div class="section" id="paranoid-mode">
<span id="client-modes-paranoid"></span><h2>Paranoid mode<a class="headerlink" href="#paranoid-mode" title="Permalink to this headline">¶</a></h2>
<p>Paranoid mode creates a backup of a local configuration file before
Bcfg2 replaces the file. This allows for easier recovery by the local
administrator.</p>
<div class="section" id="how-do-i-use-it">
<h3>How do I use it?<a class="headerlink" href="#how-do-i-use-it" title="Permalink to this headline">¶</a></h3>
<ol class="arabic simple">
<li>In the Bcfg2 repository, put <cite>paranoid=&#8217;true&#8217;</cite> in the <tt class="docutils literal"><span class="pre">info.xml</span></tt>
file (this is the default setting).</li>
<li>On the client, create <tt class="docutils literal"><span class="pre">/var/cache/bcfg2</span></tt> (or specify an alternate
path in the [paranoid] section of <tt class="docutils literal"><span class="pre">/etc/bcfg2.conf</span></tt>).</li>
<li>On the client, run <cite>bcfg2</cite> with the <cite>-P</cite> option (alternatively, you
can set <em>paranoid</em> to <em>true</em> in the <strong>[client]</strong> section of
<tt class="docutils literal"><span class="pre">bcfg2.conf</span></tt>).</li>
</ol>
<p>This will save a copy of the replaced file in <tt class="docutils literal"><span class="pre">/var/cache/bcfg2</span></tt>,
but it&#8217;ll be named as the path to the file with /&#8217;s replaced
by _&#8217;s. For example, the old <tt class="docutils literal"><span class="pre">/etc/hosts</span></tt> will be named
<tt class="docutils literal"><span class="pre">/var/cache/bcfg2/etc_hosts</span></tt>.</p>
</div>
<div class="section" id="extra-configuration">
<h3>Extra configuration<a class="headerlink" href="#extra-configuration" title="Permalink to this headline">¶</a></h3>
<p class="versionadded">
<span class="versionmodified">New in version 1.0.0.</span></p>
<p>Here is an example of how to use some of the extra paranoid features
available. For the following section in <tt class="docutils literal"><span class="pre">bcfg2.conf</span></tt> (client-side):</p>
<div class="highlight-python"><pre>[paranoid]
path = /my/custom/backup/path
max_copies = 5</pre>
</div>
<p>You will have the file backups store in <tt class="docutils literal"><span class="pre">/my/custom/backup/path</span></tt>. This
will also keep the five most recent backups of files.</p>
</div>
<div class="section" id="altering-the-global-metadata-to-enable-paranoid-mode-for-all-files">
<h3>Altering the global metadata to enable paranoid mode for all files<a class="headerlink" href="#altering-the-global-metadata-to-enable-paranoid-mode-for-all-files" title="Permalink to this headline">¶</a></h3>
<p>You may also want to just globally enable the <em>paranoid</em> attribute for
all files distributed to clients from your Bcfg2 server. You can
accomplish this by adding a global metadata override in your
<tt class="docutils literal"><span class="pre">bcfg2.conf</span></tt> (server-side) with the following syntax:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">[</span><span class="n">mdata</span><span class="p">]</span>
<span class="n">paranoid</span><span class="o">=</span><span class="n">true</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This is the default setting.</p>
</div>
</div>
</div>
<div class="section" id="overall-client-service-mode">
<h2>Overall client service mode<a class="headerlink" href="#overall-client-service-mode" title="Permalink to this headline">¶</a></h2>
<p class="versionadded">
<span class="versionmodified">New in version 1.0.0.</span></p>
<p>Overall client service mode. Specified on the client using <tt class="docutils literal"><span class="pre">-s</span> <span class="pre">&lt;service</span>
<span class="pre">mode&gt;</span></tt>.</p>
<ul class="simple">
<li>default<ul>
<li>perform all service manipulations</li>
</ul>
</li>
<li>disabled<ul>
<li>perform no service manipulations</li>
</ul>
</li>
<li>build<ul>
<li>attempt to stop all services started</li>
<li>deprecates/replaces -B</li>
</ul>
</li>
</ul>
</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="#">Client modes</a><ul>
<li><a class="reference internal" href="#dryrun-mode">Dryrun mode</a></li>
<li><a class="reference internal" href="#interactive-mode">Interactive mode</a></li>
<li><a class="reference internal" href="#paranoid-mode">Paranoid mode</a><ul>
<li><a class="reference internal" href="#how-do-i-use-it">How do I use it?</a></li>
<li><a class="reference internal" href="#extra-configuration">Extra configuration</a></li>
<li><a class="reference internal" href="#altering-the-global-metadata-to-enable-paranoid-mode-for-all-files">Altering the global metadata to enable paranoid mode for all files</a></li>
</ul>
</li>
<li><a class="reference internal" href="#overall-client-service-mode">Overall client service mode</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="index.html"
                        title="previous chapter">The Bcfg2 Client</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="tools.html"
                        title="next chapter">Client Tool Drivers</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/client/modes.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" />
      <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"
             >index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="tools.html" title="Client Tool Drivers"
             >next</a> |</li>
        <li class="right" >
          <a href="index.html" title="The Bcfg2 Client"
             >previous</a> |</li>
	<li><a href="../index.html">home</a> |&nbsp;</li>
	<!--<li><a href="../search.html">search</a> |&nbsp;</li>-->
	<li><a href="../help/index.html">help</a> |&nbsp;</li>
	<li><a href="../contents.html">documentation </a> &raquo;</li>

          <li><a href="../contents.html" >Bcfg2 documentation 1.3.0</a> &raquo;</li>
          <li><a href="index.html" >The Bcfg2 Client</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2009-2013, Narayan Desai.
      Last updated on Mar 20, 2013.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    </div>
  </body>
</html>