Sophie

Sophie

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

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>bcfg2-reports &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="Man Pages" href="index.html" />
    <link rel="next" title="bcfg2-server" href="bcfg2-server.html" />
    <link rel="prev" title="bcfg2-lint.conf" href="bcfg2-lint.conf.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-server.html" title="bcfg2-server"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="bcfg2-lint.conf.html" title="bcfg2-lint.conf"
             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">Man Pages</a> &raquo;</li> 
      </ul>
    </div>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="bcfg2-reports">
<h1>bcfg2-reports<a class="headerlink" href="#bcfg2-reports" 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-reports</strong> [-a] [-b <em>NAME</em>] [-c] [-d] [-e <em>NAME</em>] [-h]
[-m <em>NAME</em>] [-s <em>NAME</em>] [-x <em>NAME</em>] [&#8211;badentry=<em>KIND,NAME</em>]
[&#8211;extraentry=<em>KIND,NAME</em>] [&#8211;fields=<em>ARG1,ARG2,...</em>]
[&#8211;modifiedentry=<em>KIND,NAME</em>] [&#8211;sort=<em>ARG1,ARG2,...</em>] [&#8211;stale] [-v]</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-reports</strong> allows you to retrieve data from the database
about clients, and the states of their current interactions. It also
allows you to change the expired/unexpired states. The utility runs as a
standalone application. It does, however, use the models from
<tt class="docutils literal"><span class="pre">src/lib/Bcfg2/Reporting/models.py</span></tt>.</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">-h</span></kbd></td>
<td>Print usage information.</td></tr>
</tbody>
</table>
</div>
<div class="section" id="modes">
<h2>Modes<a class="headerlink" href="#modes" title="Permalink to this headline">¶</a></h2>
<p>The following are various modes available for <strong class="program">bcfg2-reports</strong>.</p>
<div class="section" id="single-host-modes">
<h3>Single-Host Modes<a class="headerlink" href="#single-host-modes" 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" colspan="2">
<kbd><span class="option">-b</span>, <span class="option">--bad <var>hostname</var></span></kbd></td>
</tr>
<tr><td>&nbsp;</td><td>Shows bad entries from the current
interaction of <em>hostname</em>.</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">-e</span>, <span class="option">--extra <var>hostname</var></span></kbd></td>
</tr>
<tr><td>&nbsp;</td><td>Shows extra entries from the current
interaction of <em>hostname</em>.</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">-m</span>, <span class="option">--modified <var>hostname</var></span></kbd></td>
</tr>
<tr><td>&nbsp;</td><td>Shows modified entries from the current
interaction of <em>hostname</em>.</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">-s</span>, <span class="option">--show <var>hostname</var></span></kbd></td>
</tr>
<tr><td>&nbsp;</td><td>Shows bad, modified, and extra entries from
the current interaction of <em>hostname</em>.</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">-t</span>, <span class="option">--total <var>hostname</var></span></kbd></td>
</tr>
<tr><td>&nbsp;</td><td>Shows total number of managed and good
entries from the current interaction of
<em>hostname</em>.</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">-x</span>, <span class="option">--expire <var>hostname</var></span></kbd></td>
</tr>
<tr><td>&nbsp;</td><td>Toggles expired/unexpired state of
<em>hostname</em>.</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-a</span>, <span class="option">--all</span></kbd></td>
<td>Show all hosts, including expired hosts.</td></tr>
</tbody>
</table>
</div>
<div class="section" id="host-selection-modes">
<h3>Host Selection Modes<a class="headerlink" href="#host-selection-modes" 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">-a</span>, <span class="option">--all</span></kbd></td>
<td>Show all hosts, including expired hosts.</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-c</span>, <span class="option">--clean</span></kbd></td>
<td>Show only clean hosts.</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-d</span>, <span class="option">--dirty</span></kbd></td>
<td>Show only dirty hosts.</td></tr>
<tr><td class="option-group">
<kbd><span class="option">--stale</span></kbd></td>
<td>Show hosts that haven&#8217;t run in the last 24 hours.</td></tr>
</tbody>
</table>
</div>
<div class="section" id="entry-modes">
<h3>Entry Modes<a class="headerlink" href="#entry-modes" title="Permalink to this headline">¶</a></h3>
<p>The following mode flags require either a comma-delimited list of any
number of <em>&lt;entry type&gt;:&lt;entry name&gt;</em> arguments describing entries, or
the <em>&#8211;file</em> option.</p>
<table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group" colspan="2">
<kbd><span class="option">--badentry=<var>entrylist</var></span></kbd></td>
</tr>
<tr><td>&nbsp;</td><td>Shows only hosts whose current interaction
has bad entries matching the given entry or
entries.</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">--extraentry=<var>entrylist</var></span></kbd></td>
</tr>
<tr><td>&nbsp;</td><td>Shows only hosts whose current interaction
has extra entries matching the given entry
or entries.</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">--entrystatus=<var>entry</var></span></kbd></td>
</tr>
<tr><td>&nbsp;</td><td>Shows the status of the single entry (given
by <em>&lt;entry type&gt;:&lt;entry name&gt;</em>) on all
hosts.</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">--modifiedentry=<var>entrylist</var></span></kbd></td>
</tr>
<tr><td>&nbsp;</td><td>Shows only hosts whose current interaction
has modified entries matching the given
entry or entries.</td></tr>
</tbody>
</table>
<div class="section" id="entry-options">
<h4>Entry Options<a class="headerlink" href="#entry-options" title="Permalink to this headline">¶</a></h4>
<p>The following options can be used with the above Entry Modes.</p>
<table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group" colspan="2">
<kbd><span class="option">--fields=<var>fields</var></span></kbd></td>
</tr>
<tr><td>&nbsp;</td><td>Only display the listed fields.  Takes a
comma-delimited list of field names</td></tr>
<tr><td class="option-group">
<kbd><span class="option">--file=<var>file</var></span></kbd></td>
<td>Read <em>&lt;entry type&gt;:&lt;entry name&gt;</em> pairs from the
specified file instead of the command line.</td></tr>
</tbody>
</table>
</div>
</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(1)</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-reports</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="#single-host-modes">Single-Host Modes</a></li>
<li><a class="reference internal" href="#host-selection-modes">Host Selection Modes</a></li>
<li><a class="reference internal" href="#entry-modes">Entry Modes</a><ul>
<li><a class="reference internal" href="#entry-options">Entry Options</a></li>
</ul>
</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-lint.conf.html"
                        title="previous chapter">bcfg2-lint.conf</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="bcfg2-server.html"
                        title="next chapter">bcfg2-server</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/man/bcfg2-reports.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-server.html" title="bcfg2-server"
             >next</a> |</li>
        <li class="right" >
          <a href="bcfg2-lint.conf.html" title="bcfg2-lint.conf"
             >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" >Man Pages</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>