Quick References Guide


Previous: (dir), Up: (dir)

CFEngine-Reference

COMPLETE TABLE OF CONTENTS

Summary of contents


Previous: Top, Up: Top

1 Command reference


Next: , Previous: Command reference, Up: Command reference

1.1 cfagent command options

Note that GNU long options are available with the syntax --longoption. The long names are given in brackets.

-a
(--sysadm) Print only the name of the system administrator then quit.
-A
(--auto) Can be used to signify an automatic run of cfengine, as opposed to a manual run. The distinction is not predetermined. Use of this option currently causes cfengine to ignore locks. This option is reserved for future development.
-b
(--force-net-copy) Normally cfengine detects attempts to copy from a server via the network that will loop back to the localhost. It then avoids using the network to make the copy. This option forces cfengine to copy using the network. Yes, someone thinks this is useful!
-c
(--no-check-files) Do not check file systems for ownership / permissions etc.
-C
(--no-check-mounts) Check mount points for consistency. If this option is specified then directories which lie in the “mount point” area are checked to see whether there is anything mounted on them. Normally this is off since not all machines use mounted file systems in the same way. e.g. HPUX does not generally operate with partitions, but nevertheless one might wish to mimick a partition-like environment there, but it would be irritating to be informed that nothing was mounted on the mount point.
-d
(--debug) Enable debugging output. Normally you will want to send this to a file using the shell script command or a pipe. -d1 shows only parsing output. -d2 shows only runtime action output. -d0 shows both levels. Debugging ouput is intended mainly for the author's convenience and is not a supported feature. The details of this output may change at any time.
-D
(--define) Define a compound class symbol of the form alpha.beta.gamma.
-e
(--no-edits) Suppress file editing.
-E
(--enforce-links) Globally force links to be created where plain files or links already exist. Since this option is a big hammer, you have to use it in interactive mode and answer a yes/no query before cfengine will run like this.
-f
(--file) Parse filename after this switch. By default cfengine looks for a file called cfengine.conf in the current directory.
-g
(--check-contradictions) Never implemented.
-h
(--help) Help information. Display version banner and options summary.
-H
(--no-hard-classes). Prevents cfengine from generating any built-in class name information. Can be used for emulation purposes.
-i
(--no-ifconfig) Do not attempt to configure the local area network interface.
-I
(--inform) Switches on the inform output level, whereby cfengine reports everything it changes..
-j
(--just) Executed only named action types.
          $ cfagent --avoid resolve,copy
          $ cfagent --just tidy --just shellcommands

-k
(--no-copy) Do not copy/image any files.
-K
(--no-lock) Ignore locks when running.
-l
(--traverse-links) Normally cfengine does not follow symbolic links when recursively parsing directories. This option will force it to do so.
-L
(--delete-stale-links) Delete links which do not point to existing files (except in user home directories, which are not touched).
-m
(--no-mount) Do not attempt to mount file systems or edit the filesystem table.
-M
(--no-modules) Ignore modules in actionsequence.
-n
(--recon,--dry-run,--just-print) No action. Only print what has to be done without actually doing it.
-N
(--negate,--undefine) Cancel a set of classes, or undefine (set value to false) a compound class of the form alpha.beta.gamma.
-o
(--avoid) Do not execute named action types.
          $ cfagent --avoid resolve,copy
          $ cfagent --just tidy --just shellcommands

-p
(--parse-only) Parse file and then stop. Used for checking the syntax of a program. You do not have to be superuser to use this option.
-P
(--no-processes) Do not execute the processes action.
-q
(--no-splay) Switch off host splaying (sleeping).
-Q
(--query) Query the values of the comma separated list of variable names.
-s
(--no-commands) Do not execute scripts or shell commands.
-S
(--silent) Silence run time warnings.
-t
(--no-tidy) Do not tidy file systems.
-u
(--use-env) Causes cfengine to generate an environment variable ‘CFALLCLASSES’ which can be read by child processes (scripts). This variable contains a summary of all the currently defined classes at any given time. This option causes some System V systems to generate a Bus Error or segmentation fault. The same information is available from the cfengine built-in variable $(allclasses) and can be passed as a parameter to scripts.

When this variable grows too large for embedding one can also access a complete list of current classes in /var/cfengine/state/allclasses.

-U
(--underscore-classes). When this option is set, cfengine adds an underscore to the beginning of the hard system classes (like _sun4, _linux etc. The longer compound classes are not underscored, since these are already complex and would unlikely result in collisions.) This can be used to avoid naming conflicts if you are so unjudicious as to name a host by the name of a hard class. Other classes are not affected.
-v
(--verbose) Verbose mode. Prints detailed information about actions and state.
-V
(--version) Print only the version string and then quit.
-w
(--no-warn,--quiet,--quiet) Do not print warning messages.
-W
(--csdb) Print the name of the current checksum database.
-x
(--no-preconf) Do not execute the cf.preconf net configuration file.
-X
(--no-links) Do not execute the links section of a program.
-z
(--zone-info) Print variable data
-Z
(--method) Execute a method as a sub-process.


Next: , Previous: Cfagent command options, Up: Command reference

1.2 cfservd command options

Note that GNU long options are available with the syntax --longoption. The long names are given in brackets.

-d
(debug) Set debugging ouput. e.g. -d2
-f
(file) Set name of input file instead to default cfservd.conf.
-F
(no-fork) Do not run in background (daemon mode).
-h
(help) Print help info.
-L
(ld-library-path) Set the internal LD_LIBRARY_PATH variable.
-p
(parse-only) Only parse configuration, do not run.
-v
(verbose) Run in verbose mode. Should be combined with ‘-F’ for debugging.


Next: , Previous: Cfservd command options, Up: Command reference

1.3 cfexecd command options

Note that GNU long options are available with the syntax --longoption. The long names are given in brackets.

-1
(once) Run once only, now. Do not run in background (daemon mode).
-d
(debug) Set debugging ouput. e.g. -d2
-f
(file) Set name of input file instead to default cfservd.conf.
-F
(no-fork) Do not run in background (daemon mode).
-g
(foreground) Do not run in background (daemon mode).
-h
(help) Print help info.
-L
(ld-library-path) Set the internal LD_LIBRARY_PATH variable.
-p
(parse-only) Only parse configuration, do not run.
-v
(verbose) Run in verbose mode. Should be combined with ‘-F’ for debugging.


Next: , Previous: Cfexecd command options, Up: Command reference

1.4 cfenvd command options

Note that GNU long options are available with the syntax --longoption. The long names are given in brackets.

-d
(debug) Set debugging ouput. e.g. -d2
-F
(no-fork) Do not run in background (daemon mode).
-h
(help) Print help info.
-H
(help) Keep histogram data.
-T
(help) Interface with tcpdump if present on the system.
-v
(verbose) Run in verbose mode. Should be combined with ‘-F’ for debugging.


Next: , Previous: Cfenvd command options, Up: Command reference

1.5 cfrun command options

Note that GNU long options are available with the syntax --longoption. The long names are given in brackets.

-d
Set debugging ouput. e.g. -d2
-h
Print help info.
-S
Run silently.
-T
Trust all keys offered by remote servers automatically, i.e. suppress manual prompting.
-v
Run in verbose mode.
--
Separator for forwarding remaining options to remote systems. After the first ‘--’ come options to send to cfagent on the remote system; after the second ‘--’ you may list classes that you want to be defined on the remote system in order to activate parts of the configuration in the manner of role-based access control.
          e.g.  cfrun -- -- linux          Run on all linux machines
                cfrun -- -p                Ping and parse on all hosts
                cfrun host1 host2 -- -p    Ping and parse on named hosts
                cfrun -v -- -p             Ping all, local verbose
                cfrun -v -- -k -- solaris  Local verbose, all solaris, but no copy


Next: , Previous: Cfrun command options, Up: Command reference

1.6 cfenvgraph

Cfenvgraph is the tool that converts data stored by cfenvd into text files that can be used to produce graphs. Use another tool like gnuplot or xmgrace to generate scientific graphs. Use cfbrain to perform monitoring based on cfenvd data.

-e
(--no-error-bars) Plot X,Y only, do not add error bars
-E
(--erasehistory) A comma separated list of metrics to be erased. The past week's data is not erased.
-h
(--help) Print help message.
-f
(--file) Specify a database other than the default.
-n
(--no-scaling) Do not perform automatic scaling of graphs.
-N
(--now) Plot an expanded view of the past four hours, not a weekly view.
-o
(--outputdir) Set the output directory name.
-r
(--resolution) Plot the data with maximum 5-minute resolution.
-s
(--separate) Plot one graph per metric, instead of all graphs on one trace.
-t
(--titles) Add title data to graph files.
-T
(--timestamps) Add a timestamp to the output directory name in order to keep a history.
-v
(--verbose) Verbose output.


Next: , Previous: cfenvgraph, Up: Command reference

1.7 cfshow

Cfshow is the tool that shows data recorded in cfengine's private workspace.

-a
(--active) Display any action locks that are currently active.
-A
(--audit) Dump the system auditing history.
-c
(--checksum) Dump the database of cryptographic checksums.
-C
(--classes) Dump the class history of this host.
-d
(--debug) Show debugging output.
-f
(--filename) Change the default database names.
-h
(--help) Show help message.
-H
(--html) Generate output in html.
-l
(--locks) Show the historical database of all action locks.
-p
(--performance) Show data about performance of instrumented actions.
-r
(--regex) Show configuration rules in classes that match the regular expression argument.
-s
(--last-seen) Show the last-seen times of all observed peers.
-X
(--xml) Generate output in XML.
-P
(--purge) Purge data older than one week.
-V
(--version) Output version string.
-v
(--verbose) Verbose output.


Previous: cfshow, Up: Command reference

1.8 cfkey

Has no options.

Table of Contents