1bluechi-agent(1) General Commands Manual bluechi-agent(1)
2
3
4
6 bluechi-agent - Agent managing services on the local machine
7
8
10 bluechi-agent [options]
11
12
14 BlueChi is a systemd service controller intended for multi-node envi‐
15 ronment with a predefined number of nodes and with a focus on highly
16 regulated environment such as those requiring functional safety (for
17 example in cars).
18
19
20 A bluechi-agent establishes a peer-to-peer connection to bluechi and
21 exposes its API to manage systemd units on it.
22
23
24 bluechi-agent [OPTIONS]
25
26
28 --help, -h
29 Print usage statement and exit.
30
31
32 --host, -H
33 The host used by bluechi-agent to connect to bluechi. Must be a valid
34 IPv4 or IPv6. This option will overwrite the host defined in the con‐
35 figuration file.
36
37
38 --port, -p
39 The port on which bluechi is listening for connection request and the
40 bluechi-agent is connecting to. This option will overwrite the port de‐
41 fined in the configuration file. (default: 842)
42
43
44 --address, -a
45 DBus address used by bluechi-agent to connect to bluechi. See man
46 sd_bus_set_address for its format. Overrides any setting of Manager‐
47 Host or ManagerPort defined in the configuration file as well as the
48 respective CLI options.
49
50
51 --name, -n
52 The unique name of this bluechi-agent used for registering at bluechi.
53 This option will overwrite the port defined in the configuration file.
54
55
56 --interval, -i
57 The interval between two heartbeat signals sent to bluechi in millisec‐
58 onds. If an agent is not connected, it will retry to connect on each
59 heartbeat. Setting this options to values smaller or equal to 0 dis‐
60 ables it. This option will overwrite the heartbeat interval defined in
61 the configuration file.
62
63
64 --config, -c
65 Path to the configuration file, see bluechi-agent.conf(5). (default:
66 /etc/bluechi/agent.conf)
67
68
69 --version, -v
70 Print current bluechi-agent version
71
72
73 --user
74 Connect to the user systemd instance instead of the system one.
75
76
78 bluechi-agent understands the following environment variables that can
79 be used to override the settings from the configuration file (see
80 bluechi-agent.conf(5)).
81
82
83 BC_LOG_LEVEL
84 The level used for logging. Supported values are:
85
86
87 • DEBUG
88
89 • INFO
90
91 • WARN
92
93 • ERROR
94
95
96
97 BC_LOG_TARGET
98 The target where logs are written to. Supported values are:
99
100
101 • stderr
102
103 • stderr-full
104
105 • journald
106
107
108
109 BC_LOG_IS_QUIET
110 If this flag is set to true, no logs are written by bluechi.
111
112
114 TBD
115
116
118 bluechi-agent.conf(5) ⟨https://github.com/contain‐
119 ers/bluechi/blob/main/doc/man/bluechi-agent.conf.5.md⟩
120
121
122
123 bluechi-agent(1)