guide:Cfengine/components

cf-agent - cfengine's change agent
 
SYNOPSIS:
 
   program [options]
 
DESCRIPTION:
 
The main cfengine agent is the instigator of change
in the system. In that sense it is the most important
part of the cfengine suite.
 
Command line options:
 
--bootstrap   , -B       - Bootstrap/repair a cfengine configuration from failsafe file in the current directory
--bundlesequence, -b value - Set or override bundlesequence from command line
--debug       , -d value - Set debugging level 0,1,2
--define      , -D value - Define a list of comma separated classes to be defined at the start of execution
--diagnostic  , -x       - Activate internal diagnostics (developers only)
--dry-run     , -n       - All talk and no action mode - make no changes, only inform of promises not kept
--file        , -f value - Specify an alternative input file than the default
--help        , -h       - Print the help message
--inform      , -I       - Print basic information about changes made to the system, i.e. promises repaired
--negate      , -N value - Define a list of comma separated classes to be undefined at the start of execution
--no-lock     , -K       - Ignore locking constraints during execution (ifelapsed/expireafter) if "too soon" to run
--policy-server, -s value - Define the server name or IP address of the a policy server (for use with bootstrap)
--verbose     , -v       - Output verbose information about the behaviour of the agent
--version     , -V       - Output the version of the software

cf-execd - cfengine's execution agent
 
SYNOPSIS:
 
   program [options]
 
DESCRIPTION:
 
The executor daemon is a scheduler and wrapper for
execution of cf-agent. It collects the output of the
agent and can email it to a specified address. It can
splay the start time of executions across the network
and work as a class-based clock for scheduling.
Command line options:
 
--help        , -h       - Print the help message
--debug       , -d value - Set debugging level 0,1,2,3
--verbose     , -v       - Output verbose information about the behaviour of the agent
--dry-run     , -n       - All talk and no action mode - make no changes, only inform of promises not kept
--version     , -V       - Output the version of the software
--file        , -f value - Specify an alternative input file than the default
--define      , -D value - Define a list of comma separated classes to be defined at the start of execution
--negate      , -N value - Define a list of comma separated classes to be undefined at the start of execution
--no-lock     , -K       - Ignore locking constraints during execution (ifelapsed/expireafter) if "too soon" to run
--inform      , -I       - Print basic information about changes made to the system, i.e. promises repaired
--diagnostic  , -x       - Activate internal diagnostics (developers only)
--no-fork     , -F       - Run as a foreground processes (do not fork)
--no-winsrv   , -W       - Do not run as a service on windows - use this when running from a command shell (Cfengine Nova only)
--ld-library-path, -L value - Set the internal value of LD_LIBRARY_PATH for child processes

cf-know - cfengine's knowledge agent
 
SYNOPSIS:
 
   program [options]
 
DESCRIPTION:
 
The knowledge management agent is capable of building
an analysing a semantic knowledge network. It can
configure a relational database to contain an ISO
standard topic map and permit regular-expression based
searching of the map. Analysis of the semantic network
can be performed providing graphical output of the data,
and cfknow can assemble and converge the reference manual
for the current version of the cfengine software.
Command line options:
 
--help        , -h       - Print the help message
--debug       , -d value - Set debugging level 0,1,2,3
--verbose     , -v       - Output verbose information about the behaviour of the agent
--version     , -V       - Output the version of the software
--file        , -f value - Specify an alternative input file than the default
--graphs      , -g       - Generate graphs from topic map data
--html        , -H       - Output queries in HTML
--manual      , -m       - Generate reference manual from internal data
--regex       , -r value - Specify a regular expression for searching the topic map
--sql         , -s       - Store topic map in defined SQL database
--syntax      , -S value - Print a syntax summary of the optional keyword or this cfengine version
--topic       , -t value - Specify a literal string topic to look up in the topic map

cf-monitord - cfengine's monitoring agent
 
SYNOPSIS:
 
   program [options]
 
DESCRIPTION:
 
The monitoring agent is a machine-learning, sampling
daemon which learns the normal state of the current
host and classifies new observations in terms of the
patterns formed by previous ones. The data are made
available to and read by cf-agent for classification
of responses to anomalous states.
Command line options:
 
--help        , -h       - Print the help message
--debug       , -d value - Set debugging level 0,1,2,3
--verbose     , -v       - Output verbose information about the behaviour of the agent
--dry-run     , -n       - All talk and no action mode - make no changes, only inform of promises not kept
--version     , -V       - Output the version of the software
--no-lock     , -K       - Ignore system lock
--file        , -f value - Specify an alternative input file than the default
--inform      , -I       - Print basic information about changes made to the system, i.e. promises repaired
--diagnostic  , -x       - Activate internal diagnostics (developers only)
--no-fork     , -F       - Run process in foreground, not as a daemon
--histograms  , -H       - Store informatino about histograms / distributions
--tcpdump     , -T       - Interface with tcpdump if available to collect data about network

cf-promises - cfengine's promise analyzer
 
SYNOPSIS:
 
   program [options]
 
DESCRIPTION:
 
The promise agent is a validator and analysis tool for
confguration files belonging to any of the components
of cfengine. Configurations that make changes must be
approved by this validator before being executed.
Command line options:
 
--help        , -h       - Print the help message
--debug       , -d value - Set debugging level 0,1,2,3
--verbose     , -v       - Output verbose information about the behaviour of the agent
--dry-run     , -n       - All talk and no action mode - make no changes, only inform of promises not kept
--version     , -V       - Output the version of the software
--file        , -f value - Specify an alternative input file than the default
--define      , -D value - Define a list of comma separated classes to be defined at the start of execution
--negate      , -N value - Define a list of comma separated classes to be undefined at the start of execution
--inform      , -I       - Print basic information about changes made to the system, i.e. promises repaired
--diagnostic  , -x       - Activate internal diagnostics (developers only)
--analysis    , -a       - Perform additional analysis of configuration
--reports     , -r       - Generate reports about configuration

cf-runagent - Run agent
 
SYNOPSIS:
 
   program [options]
 
DESCRIPTION:
 
The run agent connects to a list of running instances of
the cf-serverd service. The agent allows a user to
forego the usual scheduling interval for the agent and
activate cf-agent on a remote host. Additionally, a user
can send additional classes to be defined on the remote
host. Two kinds of classes may be sent: classes to decide
on which hosts the agent will be started, and classes that
the user requests the agent should define on execution.
The latter type is regulated by cf-serverd's role based
access control.
Command line options:
 
--help        , -h       - Print the help message
--debug       , -d value - Set debugging level 0,1,2,3
--verbose     , -v       - Output verbose information about the behaviour of the agent
--dry-run     , -n       - All talk and no action mode - make no changes, only inform of promises not kept
--version     , -V       - Output the version of the software
--file        , -f value - Specify an alternative input file than the default
--define-class, -D value - Define a list of comma separated classes to be sent to a remote agent
--select-class, -s value - Define a list of comma separated classes to be used to select remote agents by constraint
--inform      , -I       - Print basic information about changes made to the system, i.e. promises repaired
--remote-options, -o value - Pass options to a remote server process
--diagnostic  , -x       - Activate internal diagnostics (developers only)
--hail        , -H value - Hail the following comma-separated lists of hosts, overriding default list
--interactive , -i       - Enable interactive mode for key trust

cf-serverd - cfengine's server agent
 
SYNOPSIS:
 
   program [options]
 
DESCRIPTION:
 
The server daemon provides two services: it acts as a
file server for remote file copying and it allows an
authorized cf-runagent to start start a cf-agent process
and set certain additional classes with role-based access
control.
 
Command line options:
 
--help        , -h       - Print the help message
--debug       , -d value - Set debugging level 0,1,2,3
--verbose     , -v       - Output verbose information about the behaviour of the agent
--dry-run     , -n       - All talk and no action mode - make no changes, only inform of promises not kept
--version     , -V       - Output the version of the software
--file        , -f value - Specify an alternative input file than the default
--define      , -D value - Define a list of comma separated classes to be defined at the start of execution
--negate      , -N value - Define a list of comma separated classes to be undefined at the start of execution
--no-lock     , -K       - Ignore locking constraints during execution (ifelapsed/expireafter) if "too soon" to run
--inform      , -I       - Print basic information about changes made to the system, i.e. promises repaired
--diagnostic  , -x       - Activate internal diagnostics (developers only)
--no-fork     , -F       - Run as a foreground processes (do not fork)
--ld-library-path, -L value - Set the internal value of LD_LIBRARY_PATH for child processes

cf-report - cfengine's reporting agent
 
SYNOPSIS:
 
   program [options]
 
DESCRIPTION:
 
The reporting agent is a merger between the older
cfengine programs cfshow and cfenvgraph. It outputs
data stored in cfengine's embedded databases in human
readable form.
Command line options:
 
--help        , -h       - Print the help message
--debug       , -d value - Set debugging level 0,1,2,3
--verbose     , -v       - Output verbose information about the behaviour of the agent
--inform      , -I       - Output information about actions performed by the agent
--version     , -V       - Output the version of the software
--no-lock     , -K       - Ignore ifelapsed locks
--file        , -f value - Specify an alternative input file than the default
--html        , -H       - Print output in HTML
--xml         , -X       - Print output in XML
--version     , -V       - Print version string for software
--purge       , -P       - Purge data about peers not seen beyond the threshold horizon for assumed-dead
--erasehistory, -E value - Erase historical data from the cf-monitord monitoring database
--outputdir   , -o value - Set output directory for printing graph data
--titles      , -t       - Add title data to generated graph files
--timestamps  , -T       - Add a time stamp to directory name for graph file data
--resolution  , -R       - Print graph data in high resolution
--syntax      , -S       - Print a syntax summary for this cfengine version
--no-error-bars, -e       - Do not add error bars to the printed graphs
--no-scaling  , -n       - Do not automatically scale the axes
--verbose     , -v       - Generate verbose output

cf-key - cfengine's key generator
 
SYNOPSIS:
 
   program [options]
 
DESCRIPTION:
 
The cfengine's generator makes key pairs for remote authentication.
 
Command line options:
 
--help        , -h       - Print the help message
--debug       , -d value - Set debugging level 0,1,2,3
--verbose     , -v       - Output verbose information about the behaviour of the agent
--version     , -V       - Output the version of the software
--output-file , -f value - Specify an alternative output file than the default (localhost)