6. Equinox Console Extension (vsh)
Prev |  | Next

## 6. Equinox Console Extension (`vsh`)

Virgo provides an extension to the Equinox console 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:

- Bundles

- Configuration Artifacts

- PARs

- Plans

and can examine:

- Exported packages

- Services in the OSGi service registry

The Equinox console is not enabled by default. To enable it place the setting

    osgi.console=2401

in the `org.eclipse.virgo.kernel.userregion.properties` file in the `config` directory. Any free port can be used, but 2401 is the usual default.

You can run the Equinox console via telnet to the configured port, for example:

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

    osgi>

## 6.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  - 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
--- | ---
bundle | Manages and displays information about bundle artifacts.
config | Manages and displays information about configuration artifacts.
package | Displays information about exported packages.
par | Manages and displays information about PAR artifacts.
plan | Manages and displays information about plan artifacts.
service | Displays information about services in the OSGi service registry.
install | Installs an artifact to Web Server.
shutdown | Shuts down the Web Server instance to which the Equinox Console is connected.
help | Displays help about the list of available subcommands, as well as more detailed help about individual subcommands.
exit | Returns to the Equinox console with no effect.

Prev |  | Next
5.2 The User Region | Home | 6.2 Equinox Console Extension Subcommand Reference