Weave Console
- Aaron van Herk
- Shaun Forbes
- Graeme Taylor
The Weave console (or osgi console) is a command prompt available for interacting with the Weave server.
The console is available directly, if Weave is started using startup.cmd (on Windows) or startup.sh (on Linux), or it is available via telnet if Weave is started as a background service (i.e. a Windows service or a Linux daemon). If you have the Admin UI installed it is also available via the Console shortcut.
OSGi console when Weave is manually started on Windows (startup.cmd)
OSGi console via Telnet when running as a service on Windows (telnet localhost 9001)
OSGi console when manually started on Linux (startup.sh)
Console accessed via the Admin UI
Providing telnet access presents security implications as no username or password is required to connect so telnet may not be enabled by default. If it is not enabled then it will need to be manually enabled in order to provide access.
Summary of useful console commands
Useful console commands
Command | Description |
|---|---|
start | Starts a bundle given an ID or symbolic name |
stop | Stops a bundle given an ID or symbolic name |
install | Adds a bundle given a URL for the current instance |
uninstall | Removes a bundle given a URL for the current instance |
update | Updates a bundle given a URL for the current instance |
active | Lists all active bundles in the current instance |
headers | List the headers for a bundle given an ID or symbolic name |
ss | Lists a short status of all the bundles registered in the current instance |
services <filter> | Lists services given the proper filter |
diag | Runs diagnostics on a bundle given an ID or symbolic name |
dump | Generates a Weave support dump |
ustorage | Work with information persisted for users |
storage | Work with information persisted for the system |
There are many other OSGi commands available. To get a list of all the commands, just type 'help' at the OSGi prompt ( e.g. osgi> help ) in the Weave console.
Note that starting and stopping bundles (the start and stop commands above) can also be done via the Admin UI using the Bundles shortcut.
Enabling telnet access
If Weave was installed as a service in Windows without telnet access and you want to enable it then you need to edit the service\conf\wrapper.conf file.
Telnet access is enabled by setting the osgi.console property to the port number that you want to provide telnet access on.
The wrapper.conf file may already contain a line, that is commented out with a #, that can be edited to provide telnet access, e.g.
# set the console port for telneting into Weave.
# wrapper.java.additional.20=-Dosgi.console=<port>
Removing the # at the start of the second line and replacing <port> with the port number will enable telnet access on that port.
Alternatively the line may already be enabled, in which case you should already be able to telnet to Weave on the port number listed by <port>
wrapper.java.additional.20=-Dosgi.console=9001
The default value for the telnet port is 9001, but can be changed during installation.
If the wrapper.conf file does not contain the osgi.console line at all then it should be added, paying special attention to the number just before the equals sign, to make sure it is one more than the highest value used in any other additional settings. e.g. 20 in the above examples.
After this line has been added or changed in wrapper.conf you will need to restart Weave to enable the telnet access.
Once that is done you should be able to telnet directly into Weave and access the osgi console. e.g.
C:> telnet localhost 9001
osgi>
When you have finished accessing the osgi console use the disconnect command to close the connection.
osgi> disconnect
Disconnect from console? (y/n; default=y) y
Connection to host lost.
C:>
Do not use close when connected to the osgi console via telnet as this command will shutdown Weave!
You may not have telnet installed on the server or client PC. The following link contains information on how to Install Telnet Client
UTF-8 and Internationalization
By default Windows may not correctly display UTF-8 characters in the OSGi console.
To fix this you need to change the default font for the Command Prompt to a true type font (for example Consolas or Lucinda Console) and then execute chcp 65001
This should be done before running startup.cmd, from the same command prompt window where you just entered the chcp command.
Alternatively you could edit the startup.cmd file to include the chcp 65001 command and set the command prompt as the default (this has been done in recent releases of Weave).