| <html><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Using Virgo Shell Commands</title><meta content="DocBook XSL Stylesheets V1.76.0" name="generator"><link rel="home" href="index.html" title="Virgo User Guide"><link rel="up" href="ch08.html" title="Chapter 8. Equinox Console"><link rel="prev" href="ch08.html" title="Chapter 8. Equinox Console"><link rel="next" href="ch08s03.html" title="Virgo Shell Command Reference"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><td align="left" width="20%"><a accesskey="p" href="ch08.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ch08s03.html">Next</a></td></tr></table><hr></div><div class="section" title="Using Virgo Shell Commands"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="admin-shell-using-vsh"></a>Using Virgo Shell Commands</h2></div></div></div><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3> |
| This section is not applicable to Virgo Nano. |
| </div><p>Virgo provides shell commands |
| that allow you to examine artifacts |
| currently installed in a particular Virgo Kernel instance, manage the lifecycle of the installed artifacts, install new artifacts, and shut down |
| the Virgo Kernel. You can install, examine, and manage the lifecycle of the following artifacts: |
| </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Bundles</p></li><li class="listitem"><p>Configuration Artifacts</p></li><li class="listitem"><p>PARs</p></li><li class="listitem"><p>Plans</p></li></ul></div><p> |
| </p><p> |
| and can examine: |
| </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Exported packages</p></li><li class="listitem"><p>Services in the OSGi service registry</p></li></ul></div><p> |
| </p><p> |
| Virgo also provides shell commands to list all bundles that contain, export, or load a particular class. |
| </p><p> |
| These commands are provided <span class="emphasis"><em>for the user region shells only</em></span> and are grouped together in |
| the <code class="literal">vsh</code> <span class="emphasis"><em>scope</em></span>. |
| </p><p>You invoke commands using the <code class="literal">vsh:</code> scope. For example:</p><pre class="programlisting"> |
| osgi> vsh:plan list |
| |
| Name Version State |
| org.eclipse.virgo.apps.admin.plan 2.1.0 ACTIVE |
| org.eclipse.virgo.kernel.userregion.springdm 2.1.0 ACTIVE |
| org.eclipse.virgo.web 2.1.0 ACTIVE |
| |
| osgi> </pre><div class="section" title="Virgo Shell Commands"><div class="titlepage"><div><div><h3 class="title"><a name="admin-shell-vsh-using-command-list"></a>Virgo Shell Commands</h3></div></div></div><p>The following table lists the Virgo shell 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. </p><div class="table"><a name="admin-shell-vsh-commands-table"></a><p class="title"><b>Table 8.1. Virgo Shell Commands</b></p><div class="table-contents"><table summary="Virgo Shell Commands" border="1"><colgroup><col><col></colgroup><thead><tr><th>Command </th><th>Description</th></tr></thead><tbody><tr><td><a class="link" href="ch08s03.html#admin-shell-vsh-bundle-command" title="bundle Command">bundle</a></td><td>Manages and displays information about bundle artifacts.</td></tr><tr><td><a class="link" href="ch08s03.html#admin-shell-cl-clhas" title="clhas command">clhas</a></td><td>Lists all bundles that <span class="bold"><strong>contain</strong></span> a class or resource.</td></tr><tr><td><a class="link" href="ch08s03.html#admin-shell-cl-clexport" title="clexport command">clexport</a></td><td>Lists all bundles that <span class="bold"><strong>export</strong></span> a class or package.</td></tr><tr><td><a class="link" href="ch08s03.html#admin-shell-cl-clload" title="clload command">clload</a></td><td>Lists all bundles that can <span class="bold"><strong>load</strong></span> a class.</td></tr><tr><td><a class="link" href="ch08s03.html#admin-shell-vsh-config-command" title="config Command">config</a></td><td>Manages and displays information about configuration artifacts.</td></tr><tr><td><a class="link" href="ch08s03.html#admin-shell-vsh-package-command" title="packages Command">packages</a></td><td>Displays information about exported packages.</td></tr><tr><td><a class="link" href="ch08s03.html#admin-shell-vsh-par-command" title="par Command">par</a></td><td>Manages and displays information about PAR artifacts.</td></tr><tr><td><a class="link" href="ch08s03.html#admin-shell-vsh-plan-command" title="plan Command">plan</a></td><td>Manages and displays information about plan artifacts.</td></tr><tr><td><a class="link" href="ch08s03.html#admin-shell-vsh-service-command" title="service Command">service</a></td><td>Displays information about services in the OSGi service registry.</td></tr><tr><td><a class="link" href="ch08s03.html#admin-shell-vsh-install-command" title="install Command">install</a></td><td>Installs an artifact to Virgo Kernel. </td></tr><tr><td><a class="link" href="ch08s03.html#admin-shell-vsh-shutdown-command" title="shutdown Command">shutdown</a></td><td>Shuts down the Virgo Kernel instance to which the Equinox Console is connected.</td></tr></tbody></table></div></div><br class="table-break"></div></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="ch08.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="ch08.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="ch08s03.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%"> </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> </td></tr></table></div></body></html> |
