<!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-admin — 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-build-reports" href="bcfg2-build-reports.html" /> <link rel="prev" title="bcfg2" href="bcfg2.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-build-reports.html" title="bcfg2-build-reports" accesskey="N">next</a> |</li> <li class="right" > <a href="bcfg2.html" title="bcfg2" 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-admin"> <h1>bcfg2-admin<a class="headerlink" href="#bcfg2-admin" 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-admin</strong> [-C <em>configfile</em>] <em>mode</em> [<em>mode args</em>] [<em>mode 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-admin</strong> is used to perform Bcfg2 repository administration.</p> </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">-C <var>configfile</var></span></kbd></td> <td>Specify alternate bcfg2.conf location.</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">-Q <var>path</var></span></kbd></td> <td>Specify the path to the server repository.</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">-d</span></kbd></td> <td>Enable debugging output.</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">-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">--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">-v</span></kbd></td> <td>Enable verbose output.</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> </tbody> </table> </div> <div class="section" id="modes"> <h2>Modes<a class="headerlink" href="#modes" title="Permalink to this headline">¶</a></h2> <dl class="docutils"> <dt>backup</dt> <dd>Create an archive of the entire Bcfg2 repository.</dd> <dt>bundle <em>action</em></dt> <dd>Display details about the available bundles (See BUNDLE OPTIONS below).</dd> <dt>client <em>action</em> <em>client</em> [attribute=value]</dt> <dd>Add, edit, or remove clients entries in metadata (See CLIENT OPTIONS below).</dd> <dt>compare <em>old</em> <em>new</em></dt> <dd>Compare two client configurations. Can be used to verify consistent behavior between releases. Determine differences between files or directories (See COMPARE OPTIONS below).</dd> <dt>init</dt> <dd>Initialize a new repository (interactive).</dd> <dt>minestruct <em>client</em> [-f xml-file] [-g groups]</dt> <dd>Build structure entries based on client statistics extra entries (See MINESTRUCT OPTIONS below).</dd> <dt>perf</dt> <dd>Query server for performance data.</dd> <dt>pull <em>client</em> <em>entry-type</em> <em>entry-name</em></dt> <dd>Install configuration information into repo based on client bad entries (See PULL OPTIONS below).</dd> <dt>reports [init|load_stats|purge|scrub|update]</dt> <dd>Interact with the dynamic reporting system (See REPORTS OPTIONS below).</dd> <dt>snapshots [init|dump|query|reports]</dt> <dd>Interact with the Snapshots database (See SNAPSHOTS OPTIONS below).</dd> <dt>syncdb</dt> <dd>Sync the Django ORM with the configured database.</dd> <dt>tidy</dt> <dd>Remove unused files from repository.</dd> <dt>viz [-H] [-b] [-k] [-o png-file]</dt> <dd>Create a graphviz diagram of client, group and bundle information (See VIZ OPTIONS below).</dd> <dt>xcmd</dt> <dd>Provides a XML-RPC Command Interface to the bcfg2-server.</dd> </dl> <div class="section" id="bundle-options"> <h3>BUNDLE OPTIONS<a class="headerlink" href="#bundle-options" title="Permalink to this headline">¶</a></h3> <dl class="docutils"> <dt>mode</dt> <dd><p class="first">One of the following.</p> <dl class="last docutils"> <dt><em>list-xml</em></dt> <dd>List all available xml bundles</dd> <dt><em>list-genshi</em></dt> <dd>List all available genshi bundles</dd> <dt><em>show</em></dt> <dd>Interactive dialog to get details about the available bundles</dd> </dl> </dd> </dl> </div> <div class="section" id="client-options"> <h3>CLIENT OPTIONS<a class="headerlink" href="#client-options" title="Permalink to this headline">¶</a></h3> <dl class="docutils"> <dt>mode</dt> <dd><p class="first">One of the following.</p> <dl class="last docutils"> <dt><em>add</em></dt> <dd>Add a client</dd> <dt><em>del</em></dt> <dd>Delete a client</dd> <dt><em>list</em></dt> <dd>List all client entries</dd> </dl> </dd> <dt>client</dt> <dd>Specify the client’s name.</dd> <dt>attribute=value</dt> <dd>Set attribute values when adding a new client. Allowed attributes are ‘profile’, ‘uuid’, ‘password’, ‘location’, ‘secure, and ‘address’.</dd> </dl> </div> <div class="section" id="compare-options"> <h3>COMPARE OPTIONS<a class="headerlink" href="#compare-options" title="Permalink to this headline">¶</a></h3> <dl class="docutils"> <dt>old</dt> <dd>Specify the location of the old configuration file.</dd> <dt>new</dt> <dd>Specify the location of the new configuration file.</dd> </dl> </div> <div class="section" id="minestruct-options"> <h3>MINESTRUCT OPTIONS<a class="headerlink" href="#minestruct-options" title="Permalink to this headline">¶</a></h3> <dl class="docutils"> <dt>client</dt> <dd>Client whose metadata is to be searched for extra entries.</dd> <dt>-g <em>groups</em></dt> <dd>Hierarchy of groups in which to place the extra entries in.</dd> <dt>-f <em>outputfile</em></dt> <dd>Specify the xml file in which to write the extra entries.</dd> </dl> </div> <div class="section" id="pull-options"> <h3>PULL OPTIONS<a class="headerlink" href="#pull-options" title="Permalink to this headline">¶</a></h3> <dl class="docutils"> <dt>client</dt> <dd>Specify the name of the client to search for.</dd> <dt>entry type</dt> <dd>Specify the type of the entry to pull.</dd> <dt>entry name</dt> <dd>Specify the name of the entry to pull.</dd> </dl> </div> <div class="section" id="reports-options"> <h3>REPORTS OPTIONS<a class="headerlink" href="#reports-options" title="Permalink to this headline">¶</a></h3> <dl class="docutils"> <dt>load_stats [-s] [-c] [-03]</dt> <dd>Load statistics data.</dd> <dt>purge [–client [n]] [–days [n]] [–expired]</dt> <dd>Purge historic and expired data.</dd> <dt>scrub</dt> <dd>Scrub the database for duplicate reasons and orphaned entries.</dd> <dt>update</dt> <dd>Apply any updates to the reporting database.</dd> </dl> </div> <div class="section" id="snapshots-options"> <h3>SNAPSHOTS OPTIONS<a class="headerlink" href="#snapshots-options" title="Permalink to this headline">¶</a></h3> <dl class="docutils"> <dt>init</dt> <dd>Initialize the snapshots database.</dd> <dt>query</dt> <dd>Query the snapshots database.</dd> <dt>dump</dt> <dd>Dump some of the contents of the snapshots database.</dd> <dt>reports [-a] [-b] [-e] [–date=MM-DD-YYYY]</dt> <dd>Generate reports for clients in the snapshots database.</dd> </dl> </div> <div class="section" id="viz-options"> <h3>VIZ OPTIONS<a class="headerlink" href="#viz-options" title="Permalink to this headline">¶</a></h3> <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">-H</span></kbd></td> <td>Include hosts in diagram.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-b</span></kbd></td> <td>Include bundles in diagram.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-o <var><outfile></var></span></kbd></td> <td>Write to outfile file instead of stdout.</td></tr> <tr><td class="option-group"> <kbd><span class="option">-k</span></kbd></td> <td>Add a shape/color key.</td></tr> </tbody> </table> </div> </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-info(8)</em>, <em class="manpage">bcfg2-server(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-admin</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="#modes">Modes</a><ul> <li><a class="reference internal" href="#bundle-options">BUNDLE OPTIONS</a></li> <li><a class="reference internal" href="#client-options">CLIENT OPTIONS</a></li> <li><a class="reference internal" href="#compare-options">COMPARE OPTIONS</a></li> <li><a class="reference internal" href="#minestruct-options">MINESTRUCT OPTIONS</a></li> <li><a class="reference internal" href="#pull-options">PULL OPTIONS</a></li> <li><a class="reference internal" href="#reports-options">REPORTS OPTIONS</a></li> <li><a class="reference internal" href="#snapshots-options">SNAPSHOTS OPTIONS</a></li> <li><a class="reference internal" href="#viz-options">VIZ OPTIONS</a></li> </ul> </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="bcfg2.html" title="previous chapter">bcfg2</a></p> <h4>Next topic</h4> <p class="topless"><a href="bcfg2-build-reports.html" title="next chapter">bcfg2-build-reports</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../_sources/man/bcfg2-admin.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-build-reports.html" title="bcfg2-build-reports" >next</a> |</li> <li class="right" > <a href="bcfg2.html" title="bcfg2" >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>