-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added new bluechi-is-online package and man page
Signed-off-by: Michael Engel <mengel@redhat.com>
- Loading branch information
Showing
4 changed files
with
123 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
% bluechi-is-online 1 | ||
|
||
## NAME | ||
|
||
bluechi-is-online - Command line tool to check and monitor the connection state of BlueChi's core components. | ||
|
||
## SYNOPSIS | ||
|
||
**bluechi-is-online** [*system|node|agent*] [*options*] | ||
|
||
## DESCRIPTION | ||
|
||
Command line tool to check and monitor the connection state of BlueChi's core components. It uses the public D-Bus API provided by `bluechi-controller` and/or `bluechi-agent`. | ||
|
||
**bluechi-is-online [OPTIONS]** | ||
|
||
## OPTIONS | ||
|
||
#### **--help**, **-h** | ||
|
||
Print usage statement and exit. | ||
|
||
#### **--version**, **-v** | ||
|
||
Print current bluechictl version | ||
|
||
## Commands | ||
|
||
### **bluechi-is-online** [*system*] [*options*] | ||
|
||
Checks the connection state of `bluechi-controller` and all expected `bluechi-agent`s. Runs on primary node. | ||
Uses the D-Bus property `Status` of the `org.eclipse.bluechi.Controller` interface. | ||
If the `Status` is `up`, exit code is 0. Otherwise 1. | ||
|
||
**Options:** | ||
|
||
**--wait** | ||
Initial time to wait till the expected system status is `up`. In milliseconds. | ||
|
||
**--monitor** | ||
If set, `bluechi-is-online` continuously monitors the system state after the initial `up` check succeeded. | ||
|
||
### **bluechi-is-online** [*node*] [*node_name*] [*options*] | ||
|
||
Checks the connection state of a specific node. Runs on primary node. | ||
Uses the D-Bus property `Status` of the `org.eclipse.bluechi.Node` interface. | ||
If the `Status` is `online`, exit code is 0. Otherwise 1. | ||
|
||
**Options:** | ||
|
||
**--wait** | ||
Initial time to wait till the expected node status is `online`. In milliseconds. | ||
|
||
**--monitor** | ||
If set, `bluechi-is-online` continuously monitors the system state after the initial `online` check succeeded. | ||
|
||
### **bluechi-is-online** [*agent*] [*options*] | ||
|
||
Checks the connection state of the `bluechi-agent` with the controller. Runs on any managed node. | ||
Uses the D-Bus property `Status` of the `org.eclipse.bluechi.Agent` interface. | ||
If the `Status` is `online`, exit code is 0. Otherwise 1. | ||
|
||
**Options:** | ||
|
||
**--wait** | ||
Initial time to wait till the expected node status is `online`. In milliseconds. | ||
|
||
**--monitor** | ||
If set, `bluechi-is-online` continuously monitors the system state after the initial `online` check succeeded. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,6 +15,7 @@ man1 = [ | |
'bluechi-agent', | ||
'bluechictl', | ||
'bluechi-proxy', | ||
'bluechi-is-online', | ||
] | ||
|
||
man5 = [ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,4 +24,4 @@ executable( | |
) | ||
|
||
# build test binaries | ||
# subdir('test') | ||
# subdir('test') |