bluechi-controller.conf - Man Page

Configuration file to bootstrap bluechi-controller


The basic file definition used to bootstrap bluechi-controller.


The bluechi-controller configuration file is using the systemd configuration file format ⟨⟩. Contrary to this, there is no need for the \ symbol at the end of a line to continue a value on the next line. A value continued on multiple lines will just be concatenated by bluechi. The maximum line length supported is 500 characters. If the value exceeds this limitation, use multiple, indented lines.

bluechi-controller section

All fields to bootstrap the bluechi controller are contained in the bluechi-controller section. The following keys are understood by bluechi-controller.

ControllerPort (uint16_t)

The port the bluechi-controller listens on to establish connections with the bluechi-agent. By default port 842 is used.

AllowedNodeNames (string)

A comma separated list of unique bluechi-agent names. It's mandatory to set the option, only nodes with names mentioned in the list can connect to bluechi-controller'. These names are defined in the agent's configuration file underNodeName option (seebluechi-agent.conf(5)`).

LogLevel (string)

The level used for logging. Supported values are:

  • INFO
  • WARN

By default INFO level is used for logging.

LogTarget (string)

The target where logs are written to. Supported values are:

  • stderr
  • stderr-full
  • journald

By default journald is used as the target.

LogIsQuiet (string)

If this flag is set to true, no logs are written by bluechi. By default the flag is set to false.

IPReceiveErrors (string)

If this flag is set to true, it enables extended, reliable error message passing for the peer connection with all agents. This results in BlueChi receiving errors such as host unreachable ICMP packets instantly and possibly dropping the connection. This is useful to detect disconnects faster, but should be used with care as this might cause unnecessary disconnects in less robut networks. Default: true.

TCPKeepAliveTime (long)

The number of seconds the individual TCP connection with an agent needs to be idle before keepalive packets are sent. When TCPKeepAliveTime is set to 0, the system default will be used. Default: 1s.

TCPKeepAliveInterval (long)

The number of seconds between each keepalive packet. When TCPKeepAliveInterval is set to 0, the system default will be used. Default: 1s.

TCPKeepAliveCount (long)

The number of keepalive packets without ACK from an agent till the individual connection is dropped. When TCPKeepAliveCount is set to 0, the system default will be used. Default: 6.


A basic example of a configuration file for bluechi:


Using a value that is continued on multiple lines:



Distributions provide the /usr/share/bluechi/config/controller.conf file which defines bluechi configuration defaults. Administrators can copy this file to /etc/bluechi/controller.conf and specify their own configuration.

Administrators can also use a "drop-in" directory /etc/bluechi/controller.conf.d to drop their configuration changes.

See Also


Referenced By