4. Equinox Console Extension
Prev |  | Next

## 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:

- Bundles
- Configuration Artifacts
- Exported packages
- PARs
- Plans
- Services installed in the OSGi registry

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

Prev |  | Next
3.2 The VWS User Region | Home | 4.2 Equinox Console Extension Command Reference