4. Equinox Console Extension

Virgo provides an extension to the Equinox console that allows you to examine artifacts currently installed to a particular Web Server instance, manage the lifecycle of the installed artifacts, install new artifacts, and shutdown the server. You can install, examine, and manage the lifecycle of the following artifacts:

You can run the Equinox console via telnet to the configured port (2401 by default):

prompt$ telnet localhost 2401
Trying ::1...
Connected to localhost.
Escape character is '^]'.

osgi> 

4.1 Using the Equinox Console Extension

You invoke the Equinox Console Extension using the vsh command. For example:

osgi> vsh help


    bundle   - Management and examination of bundle artifacts
    config   - Management and examination of configuration artifacts
    exit     - Exit the kernel shell environment
    help     - Get help on commands
    install  - Install (deploy) an artifact to the server
    package  - Management and examination of exported packages
    par      - Management and examination of PAR artifacts
    plan     - Management and examination of plan artifacts
    service  - Examination of services
    shutdown - Shutdown Virgo Kernel


osgi> 

Equinox Console Extension Commands

The following table lists the Equinox Console Extension commands; each command in turn has a variety of options that you can specify, depending on what you want to do, such as start a bundle or refresh a plan. The reference documentation about each command provides the full list of available options.

Table 4.1. Equinox Console Extension Commands

Command Description
bundleUsed to manage and display information about bundle artifacts.
configUsed to manage and display information about configuration artifacts.
packageUsed to manage and display information about exported packages.
parUsed to manage and display information about PAR artifacts.
planUsed to manage and display information about plan artifacts.
serviceDisplays information about services in the OSGi registry.
installUsed to install an artifact to Web Server.
shutdownShuts down the Web Server instance to which the Equinox Console Extension is connected.
helpDisplay help about the list of available commands, as well as more detailed help about individual commands.
exitReturn to the Equinox console with no effect.