.nh
.TH bluechi-is-online 1
.SH NAME
bluechi-is-online \- Command line tool to check and monitor the connection state of BlueChi's core components.

.SH SYNOPSIS
\fBbluechi-is-online\fP [\fIsystem|node|agent\fP] [\fIoptions\fP]

.SH DESCRIPTION
Eclipse BlueChi™ is a systemd service controller intended for multi-node environment with a predefined number of nodes and with a focus on highly regulated environment such as those requiring functional safety (for example in cars).

.PP
\fBbluechi-is-online\fR is a command line tool to check and monitor the connection state of BlueChi's core components. It uses the public D-Bus API provided by \fBbluechi-controller\fR and/or \fBbluechi-agent\fR\&.

.PP
\fBbluechi-is-online [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 \fBbluechi-is-online\fP \fIsystem\fP [\fIoptions\fP]
Checks the connection state of \fBbluechi-controller\fR and all expected \fBbluechi-agent\fRs. Runs on primary node.
Uses the D-Bus property \fBStatus\fR of the \fBorg.eclipse.bluechi.Controller\fR interface.
If the \fBStatus\fR is \fBup\fR, exit code is 0. Otherwise 1.

.PP
\fBOptions:\fP

.PP
\fB--wait\fP
Initial time in milliseconds to wait until the expected system status is \fBup\fR\&.

.PP
\fB--monitor\fP
If set, \fBbluechi-is-online\fR continuously monitors the system state after the initial \fBup\fR check succeeded.

.SS \fBbluechi-is-online\fP \fInode\fP [\fInode_name\fP] [\fIoptions\fP]
Checks the connection state of a specific node. Runs on primary node.
Uses the D-Bus property \fBStatus\fR of the \fBorg.eclipse.bluechi.Node\fR interface.
If the \fBStatus\fR is \fBonline\fR, exit code is 0. Otherwise 1.

.PP
\fBOptions:\fP

.PP
\fB--wait\fP
Initial time in milliseconds to wait until the expected node status is \fBonline\fR\&.

.PP
\fB--monitor\fP
If set, \fBbluechi-is-online\fR continuously monitors the node state after the initial \fBonline\fR check succeeded.

.SS \fBbluechi-is-online\fP \fIagent\fP [\fIoptions\fP]
Checks the connection state of the \fBbluechi-agent\fR with the controller. Runs on any managed node.
Uses the D-Bus property \fBStatus\fR of the \fBorg.eclipse.bluechi.Agent\fR interface.
If the \fBStatus\fR is \fBonline\fR, exit code is 0. Otherwise 1.

.PP
\fBOptions:\fP

.PP
\fB--wait\fP
Initial time in milliseconds to wait until the expected agent status is \fBonline\fR\&.

.PP
\fB--monitor\fP
If set, \fBbluechi-is-online\fR continuously monitors the agent state after the initial \fBonline\fR check succeeded.

.PP
\fB--switch-timeout\fP
Time to wait until the agent is expected to connect again on a call to the \fBSwitchController\fR API method. In milliseconds.

.SH Exit Codes
If the respective BlueChi component is online at the time of exiting, 0 is returned. Otherwise, 1 is returned.