4.1. Console and Commands

Overview

ServiceMix Kernel provides a powerful console and a set of commands that can be used to perform various tasks. Commands can be located in the root shell or in a sub-shell. A sub-shell is a group of related commands, like commands related to the OSGi framework or the log system.

The following shells are available out-of-the-box, but the console can be easily extended:

• root
• admin
• features
• log
• obr
• osgi
• remote
• utils

Root shell

help or ?

The help method is one of the most usefull method to get you started. Without any parameters, the command will display the list of available commands.
You can also access the help from a subshell by launching help osgi for example, or osgi help.
You can access the help from a command by launching help clear or for a sub-shell command: osgi help list or help osgi list.

An alias ? has been defined for convenience.

exit

If ran inside a sub-shell, the sub-shell will be terminated and the console will be back to its previous shell. If ran from the root shell, ServiceMix Runtime will be stopped. If ran from a remote console, the remote shell will be terminated, but the ServiceMix Runtime remote instance will not be terminated.

Admin shell

Features shell

Log shell

The log shell contains a few commands to display the log entries, retrieve or change the log levels:

servicemix> log help

Available commands in log:
  d                     Alias to: display
  display               Display log entries
  get                   Show Log Level
  set                   Change the log level

See the documentation on the logging system for more informations.

OBR shell

OBR (OSGi Bundle Repository) is a proposed specification that defines an xml format for repositories of OSGi bundles and an associated service to access it. ServiceMix Runtime proposes a number of commands that can be used to deal with such repositories.

servicemix> obr help

Available commands in obr:
  addUrl                Add a list of repository URLs to the repository service
  deploy                Deploy
  info                  Display the meta-data for the specified bundles.
  list                  List
  listUrl               Display the repository URLs currently associated with the repository service.
  removeUrl             Remove a list of repository URLs from the repository service
  source                Source
  start                 Start

OSGi shell

The OSGi sub-shell provides commands for managing the OSGi framework: listing OSGi bundles, services, managing bundle lifecycles.
Look at the online help (launch osgi help command) for more informations.

servicemix> osgi help

Available commands in osgi:
  bundle-level          Get or set the start level of a given bundle
  headers               Display headers
  install               Install bundle
  list                  List bundles
  list-services         List services
  ls                    Alias to: list-services
  refresh               Refresh bundle
  resolve               Resolve bundle
  shutdown              Shutdown
  start                 Start bundle
  start-level           Get or set the start level
  stop                  Stop bundle
  uninstall             Uninstall bundle

Remote shell

Utils shell

This subshell contains a set of utility commands:

servicemix> osgi help

Available commands in utils:
  cat                   Concatenate and print files and/or URLs
  exec                  Execute system processes
  grep                  Print lines matching a pattern
  java                  Execute a Java standard application
  sleep                 Sleep for a bit then wake up

Examples:

utils cat mvn:org.apache.servicemix/servicemix/3.2.1/pom

or

log d | utils grep error

#top