6.2 Using the Equinox Console Extension (vsh)

Virgo provides an extension to the Equinox console, for the user region only, in the form of the vsh command 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 shut down the server. You can install, examine, and manage the lifecycle of the following artifacts:

and can examine:

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  - 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 (vsh) Subcommands

The following table lists the Equinox Console Extension subcommands; each subcommand 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 subcommand provides the full list of available options.

Table 6.1. Equinox Console Extension Subcommands

Subcommand Description
bundleManages and displays information about bundle artifacts.
configManages and displays information about configuration artifacts.
packageDisplays information about exported packages.
parManages and displays information about PAR artifacts.
planManages and displays information about plan artifacts.
serviceDisplays information about services in the OSGi service registry.
installInstalls an artifact to Web Server.
shutdownShuts down the Web Server instance to which the Equinox Console is connected.
helpDisplays help about the list of available subcommands, as well as more detailed help about individual subcommands.
exitReturns to the Equinox console with no effect.