.\"Copyright 2022 Northern.tech AS .\" .\"This file is part of CFEngine 3 - written and maintained by Northern.tech AS. .\" .\"This program is free software; you can redistribute it and/or modify it .\"under the terms of the GNU General Public License as published by the .\"Free Software Foundation; version 3. .\" .\"This program is distributed in the hope that it will be useful, .\"but WITHOUT ANY WARRANTY; without even the implied warranty of .\"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\"GNU General Public License for more details. .\" .\"You should have received a copy of the GNU General Public License .\"along with this program; if not, write to the Free Software .\"Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA .\" .\"To the extent this program is licensed as part of the Enterprise .\"versions of CFEngine, the applicable Commercial Open Source License .\"(COSL) may apply to this file if you as a licensee so wish it. See .\"included file COSL.txt. .TH CF-RUNAGENT 8 "CFEngine" "System Administration" .SH NAME cf-runagent \- activate cf-agent on a remote host .SH SYNOPSIS .B cf-runagent .RI [ OPTION ]... .RI [ FILE ] .SH DESCRIPTION cf-runagent connects to a list of running instances of cf-serverd. It allows foregoing the usual cf-execd schedule to activate cf-agent. Additionally, a user may send classes to be defined on the remote host. Two kinds of classes may be sent: classes to decide on which hosts cf-agent will be started, and classes that the user requests cf-agent should define on execution. The latter type is regulated by cf-serverd's role based access control. .SH OPTIONS .IP "--help, -h" Print the help message .IP "--background, -b value" Parallelize connections (50 by default) .IP "--debug, -d" Enable debugging output .IP "--verbose, -v" Output verbose information about the behaviour of cf-runagent .IP "--log-level, -g value" Specify how detailed logs should be. Possible values: 'error', 'warning', 'notice', 'info', 'verbose', 'debug' .IP "--dry-run, -n" All talk and no action mode - make no changes, only inform of promises not kept .IP "--version, -V" Output the version of the software .IP "--file, -f value" Specify an alternative input file than the default. This option is overridden by FILE if supplied as argument. .IP "--define-class, -D value" Define a list of comma separated classes to be sent to a remote agent .IP "--select-class, -s value" Define a list of comma separated classes to be used to select remote agents by constraint .IP "--inform, -I" Print basic information about changes made to the system, i.e. promises repaired .IP "--remote-options, -o value" (deprecated) .IP "--diagnostic, -x" (deprecated) .IP "--hail, -H value" Hail the following comma-separated lists of hosts, overriding default list .IP "--interactive, -i" Enable interactive mode for key trust .IP "--timeout, -t value" Connection timeout, seconds .IP "--color, -C value" Enable colorized output. Possible values: 'always', 'auto', 'never'. If option is used, the default value is 'auto' .IP "--timestamp, -l" Log timestamps on each line of log output .IP "--ignore-preferred-augments, -" Ignore def_preferred.json file in favor of def.json .IP "--log-modules, - value" Enable even more detailed debug logging for specific areas of the implementation. Use together with '-d'. Use --log-modules=help for a list of available modules .IP "--remote-bundles, - value" Bundles to execute on the remote agent .SH CFENGINE CFEngine provides automated configuration management of large-scale computer systems. A system administrator describes the desired state of a system using CFEngine policy code. The program \fBcf-agent\fR reads policy code and attempts to bring the current system state to the desired state described. Policy code is downloaded by \fBcf-agent\fR from a \fBcf-serverd\fR daemon. The daemon \fBcf-execd\fR is responsible for running \fBcf-agent\fR periodically. .br Documentation for CFEngine is available at https://docs.cfengine.com/. .SH PROMISE THEORY CFEngine is built on principles from promise theory, proposed by Mark Burgess in 2004. Promise theory is a model of voluntary cooperation between individual, autonomous actors or agents who publish their intentions to one another in the form of promises. A promise is a declaration of intent whose purpose is to increase the recipient's certainty about a claim of past, present or future behaviour. For a promise to increase certainty, the recipient needs to trust the promiser, but trust can also be built on the verification that previous promises have been kept, thus trust plays a symbiotic relationship with promises. .br For an introduction to promise theory, please see http://arxiv.org/abs/0810.3294/ .SH AVAILABILITY cf-runagent is part of CFEngine. .br Binary packages may be downloaded from https://cfengine.com/download/. .br The source code is available at https://github.com/cfengine/ .SH BUGS Please see the public bug-tracker at https://tracker.mender.io/projects/CFE/. .br GitHub pull-requests may be submitted to https://github.com/cfengine/core/. .SH "SEE ALSO" .BR cf-promises (8), .BR cf-agent (8), .BR cf-serverd (8), .BR cf-execd (8), .BR cf-monitord (8), .BR cf-runagent (8), .BR cf-key (8) .SH AUTHOR Mark Burgess and Northern.tech AS