<!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.conf — 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="Unsorted Docs" href="../unsorted/index.html" />
<link rel="prev" title="bcfg2-server" href="bcfg2-server.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="../unsorted/index.html" title="Unsorted Docs"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="bcfg2-server.html" title="bcfg2-server"
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-conf">
<h1>bcfg2.conf<a class="headerlink" href="#bcfg2-conf" title="Permalink to this headline">¶</a></h1>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>bcfg2.conf includes configuration parameters for the Bcfg2 server and
client.</p>
</div>
<div class="section" id="file-format">
<h2>File format<a class="headerlink" href="#file-format" title="Permalink to this headline">¶</a></h2>
<p>The file is INI-style and consists of sections and options. A section
begins with the name of the sections in square brackets and continues
until the next section begins.</p>
<p>Options are specified in the form “name=value”.</p>
<p>The file is line-based each newline-terminated line represents either a
comment, a section name or an option.</p>
<p>Any line beginning with a hash (#) is ignored, as are lines containing
only whitespace.</p>
</div>
<div class="section" id="server-options">
<h2>Server options<a class="headerlink" href="#server-options" title="Permalink to this headline">¶</a></h2>
<p>These options are only necessary on the Bcfg2 server. They are specified
in the <strong>[server]</strong> section of the configuration file.</p>
<dl class="docutils">
<dt>repository</dt>
<dd>Specifies the path to the Bcfg2 repository containing all of the
configuration specifications. The repository should be created using
the <cite>bcfg2-admin init</cite> command.</dd>
<dt>filemonitor</dt>
<dd><p class="first">The file monitor used to watch for changes in the repository. The
default is the best available monitor. The following values are
valid:</p>
<div class="last highlight-python"><div class="highlight"><pre><span class="n">inotify</span>
<span class="n">gamin</span>
<span class="n">fam</span>
<span class="n">pseudo</span>
</pre></div>
</div>
</dd>
<dt>ignore_files</dt>
<dd><p class="first">A comma-separated list of globs that should be ignored by the file
monitor. Default values are:</p>
<div class="last highlight-python"><pre>*~
*#
#*
*.swp
*.swpx
*.swx
SCCS
.svn
4913
.gitignore</pre>
</div>
</dd>
<dt>listen_all</dt>
<dd>This setting tells the server to listen on all available interfaces.
The default is to only listen on those interfaces specified by the
bcfg2 setting in the components section of <tt class="docutils literal"><span class="pre">bcfg2.conf</span></tt>.</dd>
<dt>plugins</dt>
<dd><p class="first">A comma-delimited list of enabled server plugins. Currently
available plugins are:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">Account</span>
<span class="n">Base</span>
<span class="n">Bundler</span>
<span class="n">Bzr</span>
<span class="n">Cfg</span>
<span class="n">Cvs</span>
<span class="n">Darcs</span>
<span class="n">DBStats</span>
<span class="n">Decisions</span>
<span class="n">Deps</span>
<span class="n">Editor</span>
<span class="n">FileProbes</span>
<span class="n">Fossil</span>
<span class="n">Git</span>
<span class="n">GroupPatterns</span>
<span class="n">Guppy</span>
<span class="n">Hg</span>
<span class="n">Hostbase</span>
<span class="n">Ldap</span>
<span class="n">Metadata</span>
<span class="n">NagiosGen</span>
<span class="n">Ohai</span>
<span class="n">Packages</span>
<span class="n">Pkgmgr</span>
<span class="n">POSIXCompat</span>
<span class="n">Probes</span>
<span class="n">Properties</span>
<span class="n">PuppetENC</span>
<span class="n">Reporting</span>
<span class="n">Rules</span>
<span class="n">SEModules</span>
<span class="n">ServiceCompat</span>
<span class="n">Snapshots</span>
<span class="n">SSHbase</span>
<span class="n">SSLCA</span>
<span class="n">Statistics</span>
<span class="n">Svn</span>
<span class="n">TCheetah</span>
<span class="n">TemplateHelper</span>
<span class="n">TGenshi</span>
<span class="n">Trigger</span>
</pre></div>
</div>
<p class="last">Descriptions of each plugin can be found in their respective
sections below.</p>
</dd>
<dt>prefix</dt>
<dd>Specifies a prefix if the Bcfg2 installation isn’t placed in the
default location (e.g. <tt class="docutils literal"><span class="pre">/usr/local</span></tt>).</dd>
<dt>backend</dt>
<dd><p class="first">Specifies which server core backend to use. Current available
options are:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">cherrypy</span>
<span class="n">builtin</span>
<span class="n">best</span>
</pre></div>
</div>
<p class="last">The default is <em>best</em>, which is currently an alias for <em>builtin</em>.
More details on the backends can be found in the official
documentation.</p>
</dd>
<dt>user</dt>
<dd>The username or UID to run the daemon as. Default is <em>0</em>.</dd>
<dt>group</dt>
<dd>The group name or GID to run the daemon as. Default is <em>0</em>.</dd>
<dt>vcs_root</dt>
<dd>Specifies the path to the root of the VCS working copy that holds
your Bcfg2 specification, if it is different from <em>repository</em>.
E.g., if the VCS repository does not hold the bcfg2 data at the top
level, you may need to set this option.</dd>
<dt>umask</dt>
<dd>The umask to set for the server. Default is <em>0077</em>.</dd>
</dl>
</div>
<div class="section" id="server-plugins">
<h2>Server Plugins<a class="headerlink" href="#server-plugins" title="Permalink to this headline">¶</a></h2>
<p>This section has a listing of all the plugins currently provided with
Bcfg2.</p>
<div class="section" id="account-plugin">
<h3>Account Plugin<a class="headerlink" href="#account-plugin" title="Permalink to this headline">¶</a></h3>
<p>The account plugin manages authentication data, including the following.</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">/etc/passwd</span></tt></li>
<li><tt class="docutils literal"><span class="pre">/etc/group</span></tt></li>
<li><tt class="docutils literal"><span class="pre">/etc/security/limits.conf</span></tt></li>
<li><tt class="docutils literal"><span class="pre">/etc/sudoers</span></tt></li>
<li><tt class="docutils literal"><span class="pre">/root/.ssh/authorized_keys</span></tt></li>
</ul>
</div>
<div class="section" id="base-plugin">
<h3>Base Plugin<a class="headerlink" href="#base-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Base plugin is a structure plugin that provides the ability
to add lists of unrelated entries into client configuration entry
inventories. Base works much like Bundler in its file format. This
structure plugin is good for the pile of independent configs needed for
most actual systems.</p>
</div>
<div class="section" id="bundler-plugin">
<h3>Bundler Plugin<a class="headerlink" href="#bundler-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Bundler plugin is used to describe groups of inter-dependent
configuration entries, such as the combination of packages, configuration
files, and service activations that comprise typical Unix daemons. Bundles
are used to add groups of configuration entries to the inventory of
client configurations, as opposed to describing particular versions of
those entries.</p>
</div>
<div class="section" id="bzr-plugin">
<h3>Bzr Plugin<a class="headerlink" href="#bzr-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Bzr plugin allows you to track changes to your Bcfg2 repository
using a GNU Bazaar version control backend. Currently, it enables you to
get revision information out of your repository for reporting purposes.</p>
</div>
<div class="section" id="cfg-plugin">
<h3>Cfg Plugin<a class="headerlink" href="#cfg-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Cfg plugin provides a repository to describe configuration file
contents for clients. In its simplest form, the Cfg repository is just a
directory tree modeled off of the directory tree on your client
machines.</p>
</div>
<div class="section" id="cvs-plugin-experimental">
<h3>Cvs Plugin (experimental)<a class="headerlink" href="#cvs-plugin-experimental" title="Permalink to this headline">¶</a></h3>
<p>The Cvs plugin allows you to track changes to your Bcfg2 repository
using a Concurrent version control backend. Currently, it enables you to
get revision information out of your repository for reporting purposes.</p>
</div>
<div class="section" id="darcs-plugin-experimental">
<h3>Darcs Plugin (experimental)<a class="headerlink" href="#darcs-plugin-experimental" title="Permalink to this headline">¶</a></h3>
<p>The Darcs plugin allows you to track changes to your Bcfg2 repository
using a Darcs version control backend. Currently, it enables you to get
revision information out of your repository for reporting purposes.</p>
</div>
<div class="section" id="dbstats-plugin">
<h3>DBStats Plugin<a class="headerlink" href="#dbstats-plugin" title="Permalink to this headline">¶</a></h3>
<p>Direct to database statistics plugin.</p>
</div>
<div class="section" id="decisions-plugin">
<h3>Decisions Plugin<a class="headerlink" href="#decisions-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Decisions plugin has support for a centralized set of per-entry
installation decisions. This approach is needed when particular changes
are deemed “<em>high risk</em>”; this gives the ability to centrally specify
these changes, but only install them on clients when administrator
supervision is available.</p>
</div>
<div class="section" id="defaults-plugin">
<h3>Defaults Plugin<a class="headerlink" href="#defaults-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Defaults plugin can be used to populate default attributes for
entries. Defaults is <em>not</em> a Generator plugin, so it does not actually
bind an entry; Defaults are applied after an entry has been bound,
and only populate attributes that are not yet set.</p>
</div>
<div class="section" id="deps-plugin">
<h3>Deps Plugin<a class="headerlink" href="#deps-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Deps plugin allows you to make a series of assertions like “Package
X requires Package Y (and optionally also Package Z etc.)”</p>
</div>
<div class="section" id="editor-plugin">
<h3>Editor Plugin<a class="headerlink" href="#editor-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Editor plugin attempts to allow you to partially manage
configuration for a file. Its use is not recommended and not well
documented.</p>
</div>
<div class="section" id="fileprobes-plugin">
<h3>FileProbes Plugin<a class="headerlink" href="#fileprobes-plugin" title="Permalink to this headline">¶</a></h3>
<p>The FileProbes plugin allows you to probe a client for a file, which is
then added to the Cfg specification. If the file changes on the client,
FileProbes can either update it in the specification or allow Cfg to
replace it.</p>
</div>
<div class="section" id="fossil-plugin">
<h3>Fossil Plugin<a class="headerlink" href="#fossil-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Fossil plugin allows you to track changes to your Bcfg2 repository
using a Fossil SCM version control backend. Currently, it enables you to
get revision information out of your repository for reporting purposes.</p>
</div>
<div class="section" id="git-plugin">
<h3>Git Plugin<a class="headerlink" href="#git-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Git plugin allows you to track changes to your Bcfg2 repository
using a Git version control backend. Currently, it enables you to get
revision information out of your repository for reporting purposes.</p>
</div>
<div class="section" id="grouppatterns-plugin">
<h3>GroupPatterns Plugin<a class="headerlink" href="#grouppatterns-plugin" title="Permalink to this headline">¶</a></h3>
<p>The GroupPatterns plugin is a connector that can assign clients group
membership based on patterns in client hostnames.</p>
</div>
<div class="section" id="guppy-plugin">
<h3>Guppy Plugin<a class="headerlink" href="#guppy-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Guppy plugin is used to trace memory leaks within the bcfg2-server
process using Guppy.</p>
</div>
<div class="section" id="hg-plugin-experimental">
<h3>Hg Plugin (experimental)<a class="headerlink" href="#hg-plugin-experimental" title="Permalink to this headline">¶</a></h3>
<p>The Hg plugin allows you to track changes to your Bcfg2 repository using
a Mercurial version control backend. Currently, it enables you to get
revision information out of your repository for reporting purposes.</p>
</div>
<div class="section" id="hostbase-plugin">
<h3>Hostbase Plugin<a class="headerlink" href="#hostbase-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Hostbase plugin is an IP management system built on top of Bcfg2.</p>
</div>
<div class="section" id="ldap-plugin">
<h3>Ldap Plugin<a class="headerlink" href="#ldap-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Ldap plugin makes it possible to fetch data from an LDAP directory,
process it and attach it to your metadata.</p>
</div>
<div class="section" id="metadata-plugin">
<h3>Metadata Plugin<a class="headerlink" href="#metadata-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Metadata plugin is the primary method of specifying Bcfg2 server
metadata.</p>
</div>
<div class="section" id="nagiosgen-plugin">
<h3>NagiosGen Plugin<a class="headerlink" href="#nagiosgen-plugin" title="Permalink to this headline">¶</a></h3>
<p>The NagiosGen plugin dynamically generates Nagios configuration files
based on Bcfg2 data.</p>
</div>
<div class="section" id="ohai-plugin-experimental">
<h3>Ohai Plugin (experimental)<a class="headerlink" href="#ohai-plugin-experimental" title="Permalink to this headline">¶</a></h3>
<p>The Ohai plugin is used to detect information about the client operating
system. The data is reported back to the server using JSON.</p>
</div>
<div class="section" id="packages-plugin">
<h3>Packages Plugin<a class="headerlink" href="#packages-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Packages plugin is an alternative to Pkgmgr for specifying package
entries for clients. Where Pkgmgr explicitly specifies package entry
information, Packages delegates control of package version information
to the underlying package manager, installing the latest version
available from through those channels.</p>
</div>
<div class="section" id="pkgmgr-plugin">
<h3>Pkgmgr Plugin<a class="headerlink" href="#pkgmgr-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Pkgmgr plugin resolves the Abstract Configuration Entity “Package”
to a package specification that the client can use to detect, verify and
install the specified package.</p>
</div>
<div class="section" id="posixcompat-plugin">
<h3>POSIXCompat Plugin<a class="headerlink" href="#posixcompat-plugin" title="Permalink to this headline">¶</a></h3>
<p>The POSIXCompat plugin provides a compatibility layer for 1.3 POSIX
Entries so that they are compatible with older clients.</p>
</div>
<div class="section" id="probes-plugin">
<h3>Probes Plugin<a class="headerlink" href="#probes-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Probes plugin gives you the ability to gather information from a
client machine before you generate its configuration. This information
can be used with the various templating systems to generate
configuration based on the results.</p>
</div>
<div class="section" id="properties-plugin">
<h3>Properties Plugin<a class="headerlink" href="#properties-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Properties plugin is a connector plugin that adds information from
properties files into client metadata instances.</p>
</div>
<div class="section" id="puppetenc-plugin">
<h3>PuppetENC Plugin<a class="headerlink" href="#puppetenc-plugin" title="Permalink to this headline">¶</a></h3>
<p>The PuppetENC plugin is a connector plugin that adds support for Puppet
External Node Classifiers.</p>
</div>
<div class="section" id="reporting-plugin">
<h3>Reporting Plugin<a class="headerlink" href="#reporting-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Reporting plugin enables the collection of data for use with Bcfg2’s
dynamic reporting system.</p>
</div>
<div class="section" id="rules-plugin">
<h3>Rules Plugin<a class="headerlink" href="#rules-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Rules plugin provides literal configuration entries that resolve the
abstract configuration entries normally found in the Bundler and Base
plugins. The literal entries in Rules are suitable for consumption by
the appropriate client drivers.</p>
</div>
<div class="section" id="semodules-plugin">
<h3>SEModules Plugin<a class="headerlink" href="#semodules-plugin" title="Permalink to this headline">¶</a></h3>
<p>The SEModules plugin provides a way to distribute SELinux modules via
Bcfg2.</p>
</div>
<div class="section" id="servicecompat-plugin">
<h3>ServiceCompat Plugin<a class="headerlink" href="#servicecompat-plugin" title="Permalink to this headline">¶</a></h3>
<p>The ServiceCompat plugin converts service entries for older clients.</p>
</div>
<div class="section" id="snapshots-plugin">
<h3>Snapshots Plugin<a class="headerlink" href="#snapshots-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Snapshots plugin stores various aspects of a client’s state when the
client checks in to the server.</p>
</div>
<div class="section" id="sshbase-plugin">
<h3>SSHbase Plugin<a class="headerlink" href="#sshbase-plugin" title="Permalink to this headline">¶</a></h3>
<p>The SSHbase generator plugin manages ssh host keys (both v1 and v2) for
hosts. It also manages the ssh_known_hosts file. It can integrate host
keys from other management domains and similarly export its keys.</p>
</div>
<div class="section" id="sslca-plugin">
<h3>SSLCA Plugin<a class="headerlink" href="#sslca-plugin" title="Permalink to this headline">¶</a></h3>
<p>The SSLCA plugin is designed to handle creation of SSL privatekeys and
certificates on request.</p>
</div>
<div class="section" id="statistics">
<h3>Statistics<a class="headerlink" href="#statistics" title="Permalink to this headline">¶</a></h3>
<p>The Statistics plugin is deprecated (see Reporting).</p>
</div>
<div class="section" id="svn-plugin">
<h3>Svn Plugin<a class="headerlink" href="#svn-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Svn plugin allows you to track changes to your Bcfg2 repository
using a Subversion backend. Currently, it enables you to get revision
information out of your repository for reporting purposes.</p>
</div>
<div class="section" id="tcheetah-plugin">
<h3>TCheetah Plugin<a class="headerlink" href="#tcheetah-plugin" title="Permalink to this headline">¶</a></h3>
<p>The TCheetah plugin allows you to use the cheetah templating system to
create files. It also allows you to include the results of probes
executed on the client in the created files.</p>
</div>
<div class="section" id="tgenshi-plugin">
<h3>TGenshi Plugin<a class="headerlink" href="#tgenshi-plugin" title="Permalink to this headline">¶</a></h3>
<p>The TGenshi plugin allows you to use the Genshi templating system to
create files. It also allows you to include the results of probes
executed on the client in the created files.</p>
</div>
<div class="section" id="trigger-plugin">
<h3>Trigger Plugin<a class="headerlink" href="#trigger-plugin" title="Permalink to this headline">¶</a></h3>
<p>The Trigger plugin provides a method for calling external scripts when
clients are configured.</p>
</div>
</div>
<div class="section" id="caching-options">
<h2>Caching options<a class="headerlink" href="#caching-options" title="Permalink to this headline">¶</a></h2>
<p>These options are specified in the <strong>[caching]</strong> section.</p>
<blockquote>
<div><dl class="docutils">
<dt>client_metadata</dt>
<dd><p class="first">The following four caching modes are available for client
metadata:</p>
<ul class="last simple">
<li>off: No caching of client metadata objects is performed. This
is the default.</li>
<li>initial: Only initial metadata objects are cached. Initial
metadata objects are created only from the data in the
Metadata plugin, before additional groups from other plugins
are merged in.</li>
<li>cautious: Final metadata objects are cached, but each client’s
cache is cleared at the start of each client run, immediately
after probe data is received. Cache is also cleared as in
aggressive mode. <em>on</em> is a synonym for cautious.</li>
<li>aggressive: Final metadata objects are cached. Each plugin is
responsible for clearing cache when appropriate.</li>
</ul>
</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="client-options">
<h2>Client options<a class="headerlink" href="#client-options" title="Permalink to this headline">¶</a></h2>
<p>These options only affect client functionality. They can be specified in
the <strong>[client]</strong> section.</p>
<blockquote>
<div><dl class="docutils">
<dt>decision</dt>
<dd>Specify the server decision list mode (whitelist or blacklist).
(This settiing will be ignored if the client is called with the
-f option).</dd>
<dt>drivers</dt>
<dd>Specify tool driver set to use. This option can be used to
explicitly specify the client tool drivers you want to use when
the client is run.</dd>
<dt>paranoid</dt>
<dd>Run the client in paranoid mode.</dd>
<dt>profile</dt>
<dd>Assert the given profile for the host.</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="communication-options">
<h2>Communication options<a class="headerlink" href="#communication-options" title="Permalink to this headline">¶</a></h2>
<p>Specified in the <strong>[communication]</strong> section. These options define
settings used for client-server communication.</p>
<blockquote>
<div><dl class="docutils">
<dt>ca</dt>
<dd>The path to a file containing the CA certificate. This file is
required on the server, and optional on clients. However, if the
cacert is not present on clients, the server cannot be verified.</dd>
<dt>certificate</dt>
<dd>The path to a file containing a PEM formatted certificate which
signs the key with the ca certificate. This setting is required
on the server in all cases, and required on clients if using
client certificates.</dd>
<dt>key</dt>
<dd>Specifies the path to a file containing the SSL Key. This is
required on the server in all cases, and required on clients if
using client certificates.</dd>
<dt>password</dt>
<dd>Required on both the server and clients. On the server, sets
the password clients need to use to communicate. On a client,
sets the password to use to connect to the server.</dd>
<dt>protocol</dt>
<dd>Communication protocol to use. Defaults to xmlrpc/ssl.</dd>
<dt>retries</dt>
<dd>A client-only option. Number of times to retry network
communication. Default is 3 retries.</dd>
<dt>retry_delay</dt>
<dd>A client-only option. Number of seconds to wait in between
retrying network communication. Default is 1 second.</dd>
<dt>serverCommonNames</dt>
<dd>A client-only option. A colon-separated list of Common Names the
client will accept in the SSL certificate presented by the server.</dd>
<dt>timeout</dt>
<dd>A client-only option. The network communication timeout.</dd>
<dt>user</dt>
<dd>A client-only option. The UUID of the client.</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="component-options">
<h2>Component options<a class="headerlink" href="#component-options" title="Permalink to this headline">¶</a></h2>
<p>Specified in the <strong>[components]</strong> section.</p>
<blockquote>
<div><dl class="docutils">
<dt>bcfg2</dt>
<dd><p class="first">URL of the server. On the server this specifies which interface
and port the server listens on. On the client, this specifies
where the client will attempt to contact the server.</p>
<p class="last">e.g. <em>bcfg2 = https://10.3.1.6:6789</em></p>
</dd>
<dt>encoding</dt>
<dd>Text encoding of configuration files. Defaults to UTF-8.</dd>
<dt>lockfile</dt>
<dd>The path to the client lock file, which is used to ensure that
only one Bcfg2 client runs at a time on a single client.</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="logging-options">
<h2>Logging options<a class="headerlink" href="#logging-options" title="Permalink to this headline">¶</a></h2>
<p>Specified in the <strong>[logging]</strong> section. These options control the server
logging functionality.</p>
<blockquote>
<div><dl class="docutils">
<dt>debug</dt>
<dd>Whether or not to enable debug-level log output. Default is false.</dd>
<dt>path</dt>
<dd>Server log file path.</dd>
<dt>syslog</dt>
<dd>Whether or not to send logging data to syslog. Default is true.</dd>
<dt>verbose</dt>
<dd>Whether or not to enable verbose log output. Default is false.</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="mdata-options">
<h2>MDATA options<a class="headerlink" href="#mdata-options" title="Permalink to this headline">¶</a></h2>
<p>Specified in the <strong>[mdata]</strong> section. These options affect the default
metadata settings for Paths with type=’file’.</p>
<blockquote>
<div><dl class="docutils">
<dt>owner</dt>
<dd>Global owner for Paths (defaults to root)</dd>
<dt>group</dt>
<dd>Global group for Paths (defaults to root)</dd>
<dt>mode</dt>
<dd>Global permissions for Paths (defaults to 644)</dd>
<dt>secontext</dt>
<dd>Global SELinux context for Path entries (defaults to
<em>__default__</em>, which restores the expected context)</dd>
<dt>paranoid</dt>
<dd>Global paranoid settings for Paths (defaults to false)</dd>
<dt>sensitive</dt>
<dd>Global sensitive settings for Paths (defaults to false)</dd>
<dt>important</dt>
<dd>Global important settings for Paths. Defaults to false.</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="packages-options">
<h2>Packages options<a class="headerlink" href="#packages-options" title="Permalink to this headline">¶</a></h2>
<p>The following options are specified in the <strong>[packages]</strong> section.</p>
<blockquote>
<div><dl class="docutils">
<dt>resolver</dt>
<dd>Enable dependency resolution. Default is 1 (true).</dd>
<dt>metadata</dt>
<dd>Enable metadata processing. Default is 1 (true). If metadata is
disabled, it’s implied that resolver is also disabled.</dd>
<dt>yum_config</dt>
<dd>The path at which to generate Yum configs. No default.</dd>
<dt>apt_config</dt>
<dd>The path at which to generate APT configs. No default.</dd>
<dt>gpg_keypath</dt>
<dd>The path on the client where RPM GPG keys will be copied before
they are imported on the client. Default is <tt class="docutils literal"><span class="pre">/etc/pki/rpm-gpg</span></tt>.</dd>
<dt>version</dt>
<dd>Set the version attribute used when binding Packages. Default is
auto.</dd>
</dl>
</div></blockquote>
<p>The following options are specified in the <strong>[packages:yum]</strong> section.</p>
<blockquote>
<div><dl class="docutils">
<dt>use_yum_libraries</dt>
<dd>By default, Bcfg2 uses an internal implementation of Yum’s
dependency resolution and other routines so that the Bcfg2 server
can be run on a host that does not support Yum itself. If you
run the Bcfg2 server on a machine that does have Yum libraries,
however, you can enable use of those native libraries in Bcfg2
by setting this to 1.</dd>
<dt>helper</dt>
<dd>Path to bcfg2-yum-helper. By default, Bcfg2 looks first in $PATH
and then in <tt class="docutils literal"><span class="pre">/usr/sbin/bcfg2-yum-helper</span></tt> for the helper.</dd>
</dl>
</div></blockquote>
<p>The following options are specified in the <strong>[packages:pulp]</strong> section.</p>
<blockquote>
<div><dl class="docutils">
<dt>username</dt>
<dd>The username of a Pulp user that will be used to register new
clients and bind them to repositories.</dd>
<dt>password</dt>
<dd>The password of a Pulp user that will be used to register new
clients and bind them to repositories.</dd>
</dl>
</div></blockquote>
<p>All other options in the <strong>[packages:yum]</strong> section will be passed along
verbatim to the Yum configuration if you are using the native Yum
library support.</p>
</div>
<div class="section" id="paranoid-options">
<h2>Paranoid options<a class="headerlink" href="#paranoid-options" title="Permalink to this headline">¶</a></h2>
<p>These options allow for finer-grained control of the paranoid mode on
the Bcfg2 client. They are specified in the <strong>[paranoid]</strong> section of
the configuration file.</p>
<blockquote>
<div><dl class="docutils">
<dt>path</dt>
<dd>Custom path for backups created in paranoid mode. The default is
in <tt class="docutils literal"><span class="pre">/var/cache/bcfg2</span></tt>.</dd>
<dt>max_copies</dt>
<dd>Specify a maximum number of copies for the server to keep when
running in paranoid mode. Only the most recent versions of these
copies will be kept.</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="snapshots-options">
<h2>Snapshots options<a class="headerlink" href="#snapshots-options" title="Permalink to this headline">¶</a></h2>
<p>Specified in the <strong>[snapshots]</strong> section. These options control the
server snapshots functionality.</p>
<blockquote>
<div><dl class="docutils">
<dt>driver</dt>
<dd>sqlite</dd>
<dt>database</dt>
<dd><p class="first">The name of the database to use for statistics data.</p>
<p class="last">e.g.: <tt class="docutils literal"><span class="pre">$REPOSITORY_DIR/etc/bcfg2.sqlite</span></tt></p>
</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="sslca-options">
<h2>SSLCA options<a class="headerlink" href="#sslca-options" title="Permalink to this headline">¶</a></h2>
<p>These options are necessary to configure the SSLCA plugin and can be
found in the <strong>[sslca_default]</strong> section of the configuration file.</p>
<blockquote>
<div><dl class="docutils">
<dt>config</dt>
<dd>Specifies the location of the openssl configuration file for
your CA.</dd>
<dt>passphrase</dt>
<dd>Specifies the passphrase for the CA’s private key (if
necessary). If no passphrase exists, it is assumed that the
private key is stored unencrypted.</dd>
<dt>chaincert</dt>
<dd>Specifies the location of your ssl chaining certificate. This is
used when pre-existing certifcate hostfiles are found, so that
they can be validated and only regenerated if they no longer
meet the specification. If you’re using a self signing CA this
would be the CA cert that you generated.</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="database-options">
<h2>Database options<a class="headerlink" href="#database-options" title="Permalink to this headline">¶</a></h2>
<p>Server-only, specified in the <strong>[database]</strong> section. These options
control the database connection of the server.</p>
<blockquote>
<div><dl class="docutils">
<dt>engine</dt>
<dd><p class="first">The database engine used by the statistics module. One of the
following:</p>
<div class="last highlight-python"><div class="highlight"><pre><span class="n">postgresql</span>
<span class="n">mysql</span>
<span class="n">sqlite3</span>
<span class="n">ado_mssql</span>
</pre></div>
</div>
</dd>
<dt>name</dt>
<dd>The name of the database to use for statistics data. If
‘database_engine’ is set to ‘sqlite3’ this is a file path to
the sqlite file and defaults to <tt class="docutils literal"><span class="pre">$REPOSITORY_DIR/etc/brpt.sqlite</span></tt>.</dd>
<dt>user</dt>
<dd>User for database connections. Not used for sqlite3.</dd>
<dt>password</dt>
<dd>Password for database connections. Not used for sqlite3.</dd>
<dt>host</dt>
<dd>Host for database connections. Not used for sqlite3.</dd>
<dt>port</dt>
<dd>Port for database connections. Not used for sqlite3.</dd>
<dt>time_zone</dt>
<dd>Specify a time zone other than that used on the system. (Note
that this will cause the Bcfg2 server to log messages in this
time zone as well).</dd>
</dl>
</div></blockquote>
</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.conf</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#file-format">File format</a></li>
<li><a class="reference internal" href="#server-options">Server options</a></li>
<li><a class="reference internal" href="#server-plugins">Server Plugins</a><ul>
<li><a class="reference internal" href="#account-plugin">Account Plugin</a></li>
<li><a class="reference internal" href="#base-plugin">Base Plugin</a></li>
<li><a class="reference internal" href="#bundler-plugin">Bundler Plugin</a></li>
<li><a class="reference internal" href="#bzr-plugin">Bzr Plugin</a></li>
<li><a class="reference internal" href="#cfg-plugin">Cfg Plugin</a></li>
<li><a class="reference internal" href="#cvs-plugin-experimental">Cvs Plugin (experimental)</a></li>
<li><a class="reference internal" href="#darcs-plugin-experimental">Darcs Plugin (experimental)</a></li>
<li><a class="reference internal" href="#dbstats-plugin">DBStats Plugin</a></li>
<li><a class="reference internal" href="#decisions-plugin">Decisions Plugin</a></li>
<li><a class="reference internal" href="#defaults-plugin">Defaults Plugin</a></li>
<li><a class="reference internal" href="#deps-plugin">Deps Plugin</a></li>
<li><a class="reference internal" href="#editor-plugin">Editor Plugin</a></li>
<li><a class="reference internal" href="#fileprobes-plugin">FileProbes Plugin</a></li>
<li><a class="reference internal" href="#fossil-plugin">Fossil Plugin</a></li>
<li><a class="reference internal" href="#git-plugin">Git Plugin</a></li>
<li><a class="reference internal" href="#grouppatterns-plugin">GroupPatterns Plugin</a></li>
<li><a class="reference internal" href="#guppy-plugin">Guppy Plugin</a></li>
<li><a class="reference internal" href="#hg-plugin-experimental">Hg Plugin (experimental)</a></li>
<li><a class="reference internal" href="#hostbase-plugin">Hostbase Plugin</a></li>
<li><a class="reference internal" href="#ldap-plugin">Ldap Plugin</a></li>
<li><a class="reference internal" href="#metadata-plugin">Metadata Plugin</a></li>
<li><a class="reference internal" href="#nagiosgen-plugin">NagiosGen Plugin</a></li>
<li><a class="reference internal" href="#ohai-plugin-experimental">Ohai Plugin (experimental)</a></li>
<li><a class="reference internal" href="#packages-plugin">Packages Plugin</a></li>
<li><a class="reference internal" href="#pkgmgr-plugin">Pkgmgr Plugin</a></li>
<li><a class="reference internal" href="#posixcompat-plugin">POSIXCompat Plugin</a></li>
<li><a class="reference internal" href="#probes-plugin">Probes Plugin</a></li>
<li><a class="reference internal" href="#properties-plugin">Properties Plugin</a></li>
<li><a class="reference internal" href="#puppetenc-plugin">PuppetENC Plugin</a></li>
<li><a class="reference internal" href="#reporting-plugin">Reporting Plugin</a></li>
<li><a class="reference internal" href="#rules-plugin">Rules Plugin</a></li>
<li><a class="reference internal" href="#semodules-plugin">SEModules Plugin</a></li>
<li><a class="reference internal" href="#servicecompat-plugin">ServiceCompat Plugin</a></li>
<li><a class="reference internal" href="#snapshots-plugin">Snapshots Plugin</a></li>
<li><a class="reference internal" href="#sshbase-plugin">SSHbase Plugin</a></li>
<li><a class="reference internal" href="#sslca-plugin">SSLCA Plugin</a></li>
<li><a class="reference internal" href="#statistics">Statistics</a></li>
<li><a class="reference internal" href="#svn-plugin">Svn Plugin</a></li>
<li><a class="reference internal" href="#tcheetah-plugin">TCheetah Plugin</a></li>
<li><a class="reference internal" href="#tgenshi-plugin">TGenshi Plugin</a></li>
<li><a class="reference internal" href="#trigger-plugin">Trigger Plugin</a></li>
</ul>
</li>
<li><a class="reference internal" href="#caching-options">Caching options</a></li>
<li><a class="reference internal" href="#client-options">Client options</a></li>
<li><a class="reference internal" href="#communication-options">Communication options</a></li>
<li><a class="reference internal" href="#component-options">Component options</a></li>
<li><a class="reference internal" href="#logging-options">Logging options</a></li>
<li><a class="reference internal" href="#mdata-options">MDATA options</a></li>
<li><a class="reference internal" href="#packages-options">Packages options</a></li>
<li><a class="reference internal" href="#paranoid-options">Paranoid options</a></li>
<li><a class="reference internal" href="#snapshots-options">Snapshots options</a></li>
<li><a class="reference internal" href="#sslca-options">SSLCA options</a></li>
<li><a class="reference internal" href="#database-options">Database 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="bcfg2-server.html"
title="previous chapter">bcfg2-server</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../unsorted/index.html"
title="next chapter">Unsorted Docs</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/man/bcfg2.conf.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="../unsorted/index.html" title="Unsorted Docs"
>next</a> |</li>
<li class="right" >
<a href="bcfg2-server.html" title="bcfg2-server"
>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>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
b50d8ee6d7871fcc13c0677a9364ed59
>
files
>
403
