blob: f9781c7b954d3d15b0a68411a5cf1ffb8f433c17 [file] [log] [blame]
<html><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Chapter&nbsp;8.&nbsp;Equinox Console</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="index.html" title="Virgo User Guide"><link rel="prev" href="ch07s08.html" title="Using Equinox Launcher"><link rel="next" href="ch08s02.html" title="Using Virgo Shell Commands"></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="ch07s08.html">Prev</a>&nbsp;</td><th align="center" width="60%">&nbsp;</th><td align="right" width="20%">&nbsp;<a accesskey="n" href="ch08s02.html">Next</a></td></tr></table><hr></div><div class="chapter" title="Chapter&nbsp;8.&nbsp;Equinox Console"><div class="titlepage"><div><div><h2 class="title"><a name="admin-shell"></a>Chapter&nbsp;8.&nbsp;Equinox Console</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch08.html#admin-shell-enable">Enabling the Equinox Console</a></span></dt><dt><span class="section"><a href="ch08s02.html">Using Virgo Shell Commands</a></span></dt><dd><dl><dt><span class="section"><a href="ch08s02.html#admin-shell-vsh-using-command-list">Virgo Shell Commands</a></span></dt></dl></dd><dt><span class="section"><a href="ch08s03.html">Virgo Shell Command Reference</a></span></dt><dd><dl><dt><span class="section"><a href="ch08s03.html#admin-shell-vsh-bundle-command">bundle Command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-vsh-config-command">config Command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-vsh-package-command">packages Command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-vsh-par-command">par Command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-vsh-plan-command">plan Command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-vsh-service-command">service Command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-vsh-install-command">install Command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-vsh-shutdown-command">shutdown Command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-cl-clhas">clhas command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-cl-clexport">clexport command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-cl-clload">clload command</a></span></dt></dl></dd><dt><span class="section"><a href="ch08s04.html">Using the p2 for extending your Virgo installation</a></span></dt><dd><dl><dt><span class="section"><a href="ch08s04.html#N10F94">Extending with the p2 director</a></span></dt><dt><span class="section"><a href="ch08s04.html#N10FA4">Extending via the p2 shell commands</a></span></dt></dl></dd></dl></div><div class="section" title="Enabling the Equinox Console"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="admin-shell-enable"></a>Enabling the Equinox Console</h2></div></div></div><p>
Shells are provided for both user region and kernel, although they are disabled by default and need enabling before
they can be used.
</p><p>
The user region shell ports may be reconfigured by editing the file
<code class="literal">osgi.console.properties</code> in the <code class="literal">repository/ext</code> directory, and
then restarting Virgo. The telnet properties in the file are prefixed with <span class="emphasis"><em>telnet.</em></span>, and the ssh properties are prefixed with <span class="emphasis"><em>ssh.</em></span>.
The kernel shell ports may be reconfigured by editing the file <code class="literal">osgi.console.properties</code> in the <code class="literal">configuration</code> directory, and then restarting Virgo.
</p><p>
To enable any of these shell ports, change the <code class="literal">enabled</code> setting from <code class="literal">false</code> to <code class="literal">true</code>
</p><pre class="programlisting">enabled=true</pre><p>
in the corresponding properties files.
</p><p>
If you wish to change a port, any free port can be used, but the usual defaults are, for telnet, 2501 for the user region and 2401 for the kernel, and
for ssh, 2502 for the user region and 2402 for the kernel.
</p><p>
Access is via ssh or telnet.
The simplest way to access the shell is via telnet to port 2501 or 2401 for user region or kernel, respectively.
</p><pre class="programlisting">prompt$ telnet localhost 2501
Trying ::1...
Connected to localhost.
Escape character is '^]'.
osgi&gt; </pre><p>
</p><p>
Alternatively, you can ssh to port 2502 or 2402 for user region or kernel, respectively.
The users and passwords for ssh are configured in <code class="literal">configuration/org.eclipse.virgo.kernel.users.properties</code> as described
in <a class="link" href="ch13s06.html#configuring-authentication" title="Configuring Authentication">Configuring Authentication</a>. The default user and password are <code class="literal">admin</code>
and <code class="literal">springsource</code>.
</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3>
Currently the Virgo Nano Equinox Console is enabled by default. Telnet is accesible on <span class="emphasis"><em>2401</em></span> and SSH on <span class="emphasis"><em>2402</em></span>. In future these will be configurable.
</div><p>
</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3>
If you use the <code class="literal">shutdown</code> shell command to stop Virgo Tomcat Server, the shutdown messages appear in the shell terminal instead of in the terminal in which Virgo runs. This is due to the
mechanisms which the shell implementation uses to redirect standard output.
</div><p>
</p></div></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="ch07s08.html">Prev</a>&nbsp;</td><td align="center" width="20%">&nbsp;</td><td align="right" width="40%">&nbsp;<a accesskey="n" href="ch08s02.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">&nbsp;</td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%">&nbsp;</td></tr></table></div></body></html>