.nh
.TH bluechictl 1
.SH NAME
bluechictl \- Simple command line tool to interact with the public D-Bus API of bluechi

.SH SYNOPSIS
\fBbluechictl\fP [\fIoptions\fP] \fIcommand\fP

.SH DESCRIPTION
A simple command line tool that uses the public D-Bus API provided by Eclipse BlueChi™ to manage services on all connected \fBbluechi-agents\fR and retrieve information from them.

.PP
\fBbluechictl [OPTIONS]\fP

.SH OPTIONS
.SS \fB--help\fP, \fB-h\fP
Print usage statement and exit.

.SS \fB--version\fP,  \fB-v\fP
Print current bluechictl version

.SH Commands
.SS \fBbluechictl\fP [\fIstart|stop|freeze|thaw|restart|reload\fP] [\fIagent\fP] [\fIunit\fP]
Performs one of the listed lifecycle operations on the given systemd unit for the \fBbluechi-agent\fR\&.

.SS \fBbluechictl\fP [\fIkill\fP] [\fIagent\fP] [\fIunit\fP]
Kills the processes of (i.e. sends a signal to) the specified unit on the chosen node.

.PP
\fBOptions:\fP

.PP
\fB--kill-whom\fP
    Enum defining which processes of the unit are killed.
    Needs to be one of [all, main, control]. Default: all

.PP
\fB--signal\fP
    The signal sent to kill the processes of the unit.
    Default: 15 (SIGTERM)

.SS \fBbluechictl\fP [\fIenable\fP] [\fIagent\fP] [\fIunit1\fP,\fI\&...\fP]
Enable the list of systemd unit files for the \fBbluechi-agent\fR\&.

.PP
\fBOptions:\fP

.PP
\fB--force\fP, \fB-f\fP
    Override existing symlinks

.PP
\fB--runtime\fP
    Enable unit files temporarily until next reboot

.PP
\fB--no-reload\fP
    Don't reload daemon after enabling unit files

.SS \fBbluechictl\fP [\fIdisable\fP] [\fIagent\fP] [\fIunit1\fP,\fI\&...\fP]
Disable the list of systemd unit files for the \fBbluechi-agent\fR\&.

.PP
\fBOptions:\fP

.PP
\fB--no-reload\fP
    Don't reload daemon after disabling unit files

.SS \fBbluechictl\fP \fIlist-unit-files\fP [\fIagent\fP]
Fetches information about all systemd unit files on the bluechi-agents. If [bluechi-agent] is not specified, all agents are queried.

.PP
\fBOptions:\fP

.PP
\fB--filter\fP
    Use glob filter for the unit file path

.SS \fBbluechictl\fP \fIis-enabled\fP [\fIagent\fP] [\fIunit\fP]
Fetches the current enablement status of the specific unit file on the specific \fBbluechi-agent\fR\&.

.SS \fBbluechictl\fP \fIlist-units\fP [\fIagent\fP]
Fetches information about all systemd units on the bluechi-agents. If [bluechi-agent] is not specified, all agents are queried.

.PP
\fBOptions:\fP

.PP
\fB--filter\fP
    Use glob filter for the unit names

.SS \fBbluechictl\fP \fImonitor\fP [\fIagent\fP] [\fIunit1\fP,\fIunit2\fP,\fI\&...\fP]
Creates a monitor on the given agent to observe changes in the specified units. Wildcards \fB*\fP to match all agents and/or units are also supported.

.PP
\fBExample:\fP

.PP
bluechictl monitor

.PP
bluechictl monitor node1

.PP
bluechictl monitor \\* dbus.service,apache2.service

.SS \fBbluechictl\fP \fIdaemon-reload\fP [\fIagent\fP]
Performs \fBdaemon-reload\fR for the \fBbluechi-agent\fR\&.

.SS \fBbluechictl\fP \fIstatus\fP [\fIagent\fP]
Fetches the status of all the agents or a specific agent: state (online/offline) and when was it last seen

.PP
\fBOptions:\fP

.PP
\fB--watch\fP, \fB-w\fP
    Continuously display agent(s) status, updating when state change update received

.PP
\fBExample:\fP

.PP
bluechictl status

.PP
bluechictl status rpi

.PP
bluechictl status -w

.SS \fBbluechictl\fP \fIstatus\fP [\fIagent\fP] [\fIunit1\fP,\fI\&...\fP]
Fetches the status of the systemd units for the \fBbluechi-agent\fR\&.

.SS \fBbluechictl\fP \fIreset-failed\fP [\fIagent\fP] [\fIunit1\fP,\fI\&...\fP]
Performs a \fBreset-failed\fR on the chosen \fBbluechi-agent\fR for the selected units.

.SS \fBbluechictl\fP \fIget-default\fP [\fIagent\fP]
Fetches the default target on the chosen \fBbluechi-agent\fR\&.

.SS \fBbluechictl\fP \fIset-default\fP [\fIagent\fP] [TARGET]
Changes the default target to \fBTARGET\fR file on the chosen \fBbluechi-agent\fR\&.