Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fixed a typo & added small editorial changes #919

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fixed a typo & added small editorial changes #919

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/docs/getting_started/examples_bluechictl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!-- markdownlint-disable-file MD010 MD013 MD014 MD024 MD046 -->
# Examples on how to use BlueChi

For the examples in this section the a [multi-node setup](./multi_node.md) is assumed to be running and uses [bluechictl](../man/bluechictl.md) to interact with BlueChi. In order to leverage the full potential of BlueChi, e.g. by writing custom applications, please refer to the section describing how to [use BlueChi's D-Bus API](../api/examples.md).
For the examples in this section, assume a [multi-node setup](./multi_node.md) that uses [bluechictl](../man/bluechictl.md) to interact with BlueChi is running. To leverage the full potential of BlueChi, e.g. by writing custom applications, please refer to the section describing how to [use BlueChi's D-Bus API](../api/examples.md).

## Getting information of units

The `bluechictl list-units` command can be used to get a list of all units and their states on either all or the specified node. It also provides a filter option for the unit name:
The `bluechictl list-units` command can be used to get a list of all units and their states on either all nodes or the specified node. It also provides a filter option for the unit name:

```bash
$ bluechictl list-units --filter=bluechi*
Expand Down