LibraryLink ToToggle FramesPrintFeedback

Chapter 1. Using the Fuse ESB Command Console

The Fuse ESB command console is the central tool for both managing the Fuse ESB environment and interacting with the Fuse ESB kernel. When you start Fuse ESB the console starts automatically.

Based on Apache Felix Gogo, the console provides commands that you can use to perform basic management of your Fuse ESB environment, including managing services, installing new applications or libraries, and managing their state.

The console uses prefixes to group commands relating to the same functionality. For example commands related to the OSGi framework are prefixed osgi:, and logging-related commands are prefixed log:.

See the Fuse product documentation for information about working with Fuse ESB, the Fuse ESB runtime, and the Fuse ESB kernel.

The following sections explain how to access the console commands:

Managing artifacts describes the console subshells provided for managing artifacts deployed in the Fuse ESB runtime.

To start Fuse ESB to access the Fuse ESB kernel console, open a console at the installation directory and enter:

Windows

bin\servicemix.bat

*NIX

bin/servicemix.sh

Fuse ESB starts and the console is ready.


Press Tab to view the commands.


The help for each command includes the definition, the syntax, and the arguments and options (if any). To display the help for a command, type the full command name with the --help option. For example, type admin:start --help to display the help for that command..


Commands are grouped under prefixes according to functionality, similar to the subshells available in the GShell console that shipped with previous versions of Fuse ESB.

To list the commands available in a group, type CommandPrefix: then press Tab. For example, type osgi: and press Tab to list the OSGi commands

Table 1.1 summarizes the command groups available in the console. Click on a command group name for more information.


When running shell or osgi commands, you can omit the prefix. For example, typing list produces the same output as osgi:list.

One of the most important uses of the command console is managing the artifacts deployed in the Fuse ESB runtime. The following command groups are used to manage deployed artifacts: