control_agent

Table of contents

Variables in the default:control_agent context are automatically created from attributes defined in body agent control following the pattern default:default:control_agent.<attribute>.

default:control_agent.abortbundleclasses

Defines a list of regular expressions that match classes which if defined lead to termination of current bundle. If no list is defined, then a default of abortbundle is used.

default:control_agent.abortclasses

Defines a list of regular expressions that result in cf-agent terminating itself upon definition of a matching class.

default:control_agent.agentfacility

Controls the syslog facility used by cf-agent . Valid values are LOG_USER, LOG_DAEMON, LOG_LOCAL0 through LOG_LOCAL7.

default:control_agent.default_repository

Defines the default repository for file backups. When this variable is set, backup files will be placed in this location instead of the same directory as the edited file.

default:control_agent.files_single_copy

Specifies a list of regular expressions that when matched will prevent the agent from performing subsequent copy operations on the same file.

default:control_agent.maxconnections

Controls the maximum number of connections that cf-agent will open simultaneously.

default:control_agent.timezone

Defines the timezone setting for the agent. Note that this variable provides the value for policy authors to implement their own timezone-related policy; it does not enforce timezone settings automatically.

default:control_agent.agentaccess

Contains a list of user names that are allowed to execute cf-agent.

default:control_agent.allclassesreport

Determines whether to generate the allclasses.txt report. If set to true, the state/allclasses.txt file will be written to disk during agent execution.

default:control_agent.alwaysvalidate

A true/false flag that determines whether configurations will always be checked before executing, or only after updates. When set, cf-agent will force a revalidation of the input.

default:control_agent.bindtointerface

Describes the interface to be used for outgoing connections. On multi-homed hosts, this defines the IP address of the interface for server traffic.

default:control_agent.checksum_alert_time

Represents the persistence time for the checksum_alert class. When checksum changes trigger an alert, this value determines the longevity of that class.

default:control_agent.childlibpath

Contains the LD_LIBRARY_PATH for child processes. This string sets the internal LD_LIBRARY_PATH environment of the agent.

default:control_agent.copyfrom_restrict_keys

Restricts cf-agent to copying files from hosts that have a key explicitly defined in this list.

default:control_agent.defaultcopytype

Sets the global default policy for comparing source and image in copy transactions. Possible values include: mtime, atime, ctime, digest, hash, binary.

default:control_agent.dryrun

A boolean flag that if set, makes no changes to the system, and will only report what it needs to do.

See also: dryrun in body agent control

default:control_agent.editbinaryfilesize

Represents the limit on maximum binary file size to be edited. This is a global setting for the file-editing safety-net for binary files.

default:control_agent.editfilesize

The limit on maximum text file size to be edited. This is a global setting for the file-editing safety-net.

default:control_agent.environment

Contains environment variables to be inherited by children. This sets the runtime environment of the agent process.

default:control_agent.files_auto_define

Contains a list of regular expressions matching filenames. When a file matching one of these regular expressions is copied, classes prefixed with auto_ are defined.

default:control_agent.hashupdates

Determines whether stored hashes are updated when change is detected in source. If ’true’ the stored reference value is updated as soon as a warning message has been given.

default:control_agent.inform

Sets the default output level ‘permanently’ within the class context indicated. It is equivalent to the command line option ‘-I’.

See also: inform in body agent control

default:control_agent.max_children

Represents the maximum number of background tasks that should be allowed concurrently. For the agent it represents the number of background jobs allowed concurrently.

default:control_agent.mountfilesystems

Determines whether to mount any filesystems promised. It issues the generic command to mount file systems defined in the file system table.

default:control_agent.nonalphanumfiles

Determines whether to warn about filenames with no alphanumeric content. This test is applied in all recursive/depth searches.

default:control_agent.refresh_processes

Contains bundles to reload the process table before verifying the bundles named in this list (lazy evaluation).

default:control_agent.repchar

Represents a character used to canonize pathnames in the file repository. Default value is _.

default:control_agent.report_class_log

Enables logging of classes set by cf-agent. Each class set by cf-agent will be logged at the end of agent execution.

default:control_agent.secureinput

Checks whether input files are writable by unauthorized users. If this is set, the agent will not accept an input file that is not owned by a privileged user.

default:control_agent.sensiblecount

Represents the minimum number of files a mounted filesystem is expected to have. Default value is 2 files.

default:control_agent.sensiblesize

Represents the minimum number of bytes a mounted filesystem is expected to have. Default value is 1000 bytes.

default:control_agent.skipidentify

Determines whether to send an IP/name during server connection because address resolution is broken. Causes the agent to ignore its missing DNS credentials.

default:control_agent.suspiciousnames

Contains names to skip and warn about if found during any file search. If CFEngine sees these names during recursive (depth) file searches, it will skip them and output a warning message.

default:control_agent.verbose

Determines whether to switch on verbose standard output. It is equivalent to (and when present, overrides) the command line option ‘-v’.