<!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>bcfg2 — 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="Man Pages" href="index.html" /> <link rel="next" title="bcfg2-admin" href="bcfg2-admin.html" /> <link rel="prev" title="Man Pages" 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="bcfg2-admin.html" title="bcfg2-admin" accesskey="N">next</a> |</li> <li class="right" > <a href="index.html" title="Man Pages" accesskey="P">previous</a> |</li> <li><a href="../index.html">home</a> | </li> <!--<li><a href="../search.html">search</a> | </li>--> <li><a href="../help/index.html">help</a> | </li> <li><a href="../contents.html">documentation </a> »</li> <li><a href="../contents.html" >Bcfg2 documentation 1.3.0</a> »</li> <li><a href="index.html" accesskey="U">Man Pages</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="bcfg2"> <h1>bcfg2<a class="headerlink" href="#bcfg2" title="Permalink to this headline">¶</a></h1> <div class="section" id="synopsis"> <h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2> <p><strong>bcfg2</strong> [<em>options</em>]</p> </div> <div class="section" id="description"> <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2> <p><strong class="program">bcfg2</strong> runs the Bcfg2 configuration process on the current host. This process consists of the following steps.</p> <ul class="simple"> <li>Fetch and execute probes</li> <li>Upload probe results</li> <li>Fetch the client configuration</li> <li>Check the current client state</li> <li>Attempt to install the desired configuration</li> <li>Upload statistics about the Bcfg2 execution and client state</li> </ul> </div> <div class="section" id="options"> <h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2> <table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> <tr><td class="option-group"> <kbd><span class="option">-B</span></kbd></td> <td>Configure everything except the given bundle(s).</td></tr> <tr><td class="option-group"> <kbd><span class="option">-C <var>configfile</var></span></kbd></td> <td>Specify alternate bcfg2.conf location.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-D <var>drivers</var></span></kbd></td> <td>Specify a comma-delimited set of Bcfg2 tool drivers. <em>NOTE: only drivers listed will be loaded. (e.g., if you do not include POSIX, you will be unable to verify/install Path entries).</em></td></tr> <tr><td class="option-group"> <kbd><span class="option">-E <var>encoding</var></span></kbd></td> <td>Specify the encoding of config files.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-I</span></kbd></td> <td>Run bcfg2 in interactive mode. The user will be prompted before each change.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-O</span></kbd></td> <td>Omit lock check.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-P</span></kbd></td> <td>Run bcfg2 in paranoid mode. Diffs will be logged for configuration files marked as paranoid by the Bcfg2 server.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-Q</span></kbd></td> <td>Run bcfg2 in “bundle quick” mode, where only entries in a bundle are verified or installed. This runs much faster than -q, but doesn’t provide statistics to the server at all. In order for this option to work, the -b option must also be provided. This option is incompatible with -r.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-R <var>retrycount</var></span></kbd></td> <td>Specify the number of times that the client will attempt to retry network communication.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-S <var>server</var></span></kbd></td> <td>Manually specify the server location (as opposed to using the value in bcfg2.conf). This should be in the format “<a class="reference external" href="https://server:port">https://server:port</a>“</td></tr> <tr><td class="option-group"> <kbd><span class="option">-Z</span></kbd></td> <td>Do not configure independent entries.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-b <var>bundles</var></span></kbd></td> <td>Run only the specified colon-delimited set of bundles.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-c <var>cachefile</var></span></kbd></td> <td>Cache a copy of the configuration in cachefile.</td></tr> <tr><td class="option-group" colspan="2"> <kbd><span class="option">--ca-cert=<var>cacert</var></span></kbd></td> </tr> <tr><td> </td><td>Specifiy the path to the SSL CA certificate.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-d</span></kbd></td> <td>Enable debugging output.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-e</span></kbd></td> <td>When in verbose mode, display extra entry information.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-f <var>path</var></span></kbd></td> <td>Configure from a file rather than querying the server.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-h</span></kbd></td> <td>Print usage information.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-k</span></kbd></td> <td>Run in bulletproof mode. This currently only affects behavior in the debian toolset; it calls apt-get update and clean and dpkg –configure –pending.</td></tr> <tr><td class="option-group" colspan="2"> <kbd><span class="option">-l <var>decisionmode</var></span></kbd></td> </tr> <tr><td> </td><td>Run the client in the specified decision list mode (“whitelist” or “blacklist”), or “none”, which can be used in order to override the decision list mode specified in bcfg2.conf). This approach is needed when particular changes are deemed “high risk”. It gives the ability tocentrally specify these changes, but only install them on clients when administrator supervision is available. Because collaborative configuration is one of the remaining hard issues in configuration management, these issues typically crop up in environments with several administrators and much configuration variety. (This setting will be ignored if the -f option is also specified).</td></tr> <tr><td class="option-group"> <kbd><span class="option">-n</span></kbd></td> <td>Run bcfg2 in dry-run mode. No changes will be made to the system.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-o <var>logfile</var></span></kbd></td> <td>Writes a log to the specified path.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-p <var>profile</var></span></kbd></td> <td>Assert a profile for the current client.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-q</span></kbd></td> <td>Run bcfg2 in quick mode. Package checksum verification won’t be performed. This mode relaxes the constraints of correctness, and thus should only be used in safe conditions.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-r <var>mode</var></span></kbd></td> <td>Cause bcfg2 to remove extra configuration elements it detects. Mode is one of “all”, “Services”, or “Packages”. “all” removes all entries. Likewise, “Services” and “Packages” remove only the extra configuration elements of the respective type.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-s <var>servicemode</var></span></kbd></td> <td>Set bcfg2 interaction level for services. Default behavior is to modify all services affected by reconfiguration. “build” mode attempts to stop all services started. “disabled” suppresses all attempts to modify services.</td></tr> <tr><td class="option-group" colspan="2"> <kbd><span class="option">--ssl-cert=<var>cert</var></span></kbd></td> </tr> <tr><td> </td><td>Specify the path to the SSL certificate.</td></tr> <tr><td class="option-group"> <kbd><span class="option">--ssl-cns=<var>CNs</var></span></kbd></td> <td>Colon-delimited list of acceptable SSL server Common Names.</td></tr> <tr><td class="option-group"> <kbd><span class="option">--ssl-key=<var>key</var></span></kbd></td> <td>Specify the path to the SSL key.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-u <var>user</var></span></kbd></td> <td>Attempt to authenticate as ‘user’.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-t <var>timeout</var></span></kbd></td> <td>Set the timeout (in seconds) for client communication. Default is 90 seconds.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-v</span></kbd></td> <td>Run bcfg2 in verbose mode.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-x <var>password</var></span></kbd></td> <td>Use ‘password’ for client communication.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-z</span></kbd></td> <td>Only configure independent entries, ignore bundles.</td></tr> </tbody> </table> </div> <div class="section" id="see-also"> <h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2> <p><em class="manpage">bcfg2-server(8)</em>, <em class="manpage">bcfg2-info(8)</em></p> </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="#">bcfg2</a><ul> <li><a class="reference internal" href="#synopsis">Synopsis</a></li> <li><a class="reference internal" href="#description">Description</a></li> <li><a class="reference internal" href="#options">Options</a></li> <li><a class="reference internal" href="#see-also">See Also</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="index.html" title="previous chapter">Man Pages</a></p> <h4>Next topic</h4> <p class="topless"><a href="bcfg2-admin.html" title="next chapter">bcfg2-admin</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../_sources/man/bcfg2.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="bcfg2-admin.html" title="bcfg2-admin" >next</a> |</li> <li class="right" > <a href="index.html" title="Man Pages" >previous</a> |</li> <li><a href="../index.html">home</a> | </li> <!--<li><a href="../search.html">search</a> | </li>--> <li><a href="../help/index.html">help</a> | </li> <li><a href="../contents.html">documentation </a> »</li> <li><a href="../contents.html" >Bcfg2 documentation 1.3.0</a> »</li> <li><a href="index.html" >Man Pages</a> »</li> </ul> </div> <div class="footer"> © 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>