HomeDocumentation > Apache Geronimo v1.0 - User's Guide > Administration > Tools and commands


Apache Geronimo provides several tools for administering the server. These tools are available via command line and some via a Web based console. The Web based Geronimo console is explained in detail in the following section Geronimo Administration Console. The currently available command line tools are located in the <geronimo_home>/bin directory and are enumerated in the following list:

Although the tools name is self-explanatory, it may not be the same case with the tool's parameters. The following sections explain more in detail these tools and commands usage.

startup

This command is certainly used to start the Apache Geronimo server. You can start the Apache Geronimo server in two different ways by running the following commands:

<geronimo_home>/bin/java -jar server.jar

or simply

<geronimo_home>/bin/startup

The startup command invokes the server.jar.

In both cases this command accepts the same parameters. The available parameters are:

--quiet
Suppress the normal startup progress bar. This is typically used when redirecting console output to a file, or starting the server from an IDE or other tool.

--long
Write startup progress to the console in a format that is suitable for redirecting console output to a file, or starting the server from an IDE or other tool (does not use linefeeds to update the progress information that is used by default if you do not specify --quiet or --long).

-v --verbose
Sets the console log level to INFO, resulting in more console output than is normally present.

-vv --veryverbose
Sets the console log level to DEBUG, resulting in even more console output.

-override [configId]
Overrides the configurations in <geronimo_home>/var/config.list such that only the configurations listed on the command line will be started. Note that many J2EE
features depend on certain configs being started, so you should be very careful what you omit. Any arguments after -override are assumed to be configuration names.

When you run this command from a Microsoft Windows command line that window will get locked with the startup results screen. On a Linux based operating system you can run this command in background getting back the control for this window terminal.

If you run the startup command without any parameters you will see a screen similar to this one.

Booting Geronimo Kernel (in Java 1.4.2_09)...
Started configuration  1/23   1s geronimo/rmi-naming/1.0/car
Started configuration  2/23   3s geronimo/j2ee-server/1.0/car
Started configuration  3/23   2s geronimo/j2ee-security/1.0/car
Started configuration  4/23   9s geronimo/activemq-broker/1.0/car
Started configuration  5/23   1s geronimo/activemq/1.0/car
Started configuration  6/23   0s geronimo/system-database/1.0/car
Started configuration  7/23   4s geronimo/directory/1.0/car
Started configuration  8/23   0s geronimo/ldap-realm/1.0/car
Started configuration  9/23   2s geronimo/jetty/1.0/car
Started configuration 10/23   0s geronimo/geronimo-gbean-deployer/1.0/car
Started configuration 11/23   2s geronimo/j2ee-deployer/1.0/car
Started configuration 12/23   0s geronimo/jetty-deployer/1.0/car
Started configuration 13/23   1s geronimo/welcome-jetty/1.0/car
Started configuration 14/23   1s geronimo/ldap-demo-jetty/1.0/car
Started configuration 15/23   1s geronimo/servlets-examples-jetty/1.0/car
Started configuration 16/23   2s geronimo/jsp-examples-jetty/1.0/car
Started configuration 17/23   3s geronimo/webconsole-jetty/1.0/car
Started configuration 18/23   1s geronimo/uddi-jetty/1.0/car
Started configuration 19/23   1s geronimo/jmxdebug-jetty/1.0/car
Started configuration 20/23  11s geronimo/daytrader-derby-jetty/1.0/car
Started configuration 21/23   0s geronimo/remote-deploy-jetty/1.0/car
Started configuration 22/23   1s geronimo/hot-deployer/1.0/car
Started configuration 23/23   0s geronimo/j2ee-system/1.0/car
Startup completed in 51 seconds
  Listening on Ports:
    1099 0.0.0.0   RMI Naming
    1527 0.0.0.0   Derby Connector
    4201 0.0.0.0   ActiveIO Connector EJB
    4242 0.0.0.0   Remote Login Listener
    8019 127.0.0.1 Jetty Connector AJP13
    8080 0.0.0.0   Jetty Connector HTTP
    8443 0.0.0.0   Jetty Connector HTTPS
   61616 0.0.0.0   ActiveMQ Message Broker Connector

  Started Application Modules:
    WAR: geronimo/welcome-jetty/1.0/car
    WAR: geronimo/servlets-examples-jetty/1.0/car
    EAR: geronimo/daytrader-derby-jetty/1.0/car
    EAR: geronimo/webconsole-jetty/1.0/car
    WAR: geronimo/jmxdebug-jetty/1.0/car
    RAR: geronimo/activemq/1.0/car
    WAR: geronimo/ldap-demo-jetty/1.0/car
    WAR: geronimo/jsp-examples-jetty/1.0/car
    WAR: geronimo/remote-deploy-jetty/1.0/car
    RAR: geronimo/system-database/1.0/car
    EAR: geronimo/uddi-jetty/1.0/car

  Web Applications:
    http://hcunico:8080/
    http://hcunico:8080/console
    http://hcunico:8080/console-standard
    http://hcunico:8080/daytrader
    http://hcunico:8080/debug-tool
    http://hcunico:8080/jsp-examples
    http://hcunico:8080/juddi
    http://hcunico:8080/ldap-demo
    http://hcunico:8080/remote-deploy
    http://hcunico:8080/servlets-examples

Geronimo Application Server started

Back to Top

shutdown

If the startup command starts the Apache Geronimo server, shutdown will definitively stop it. This command has the following syntax:

<geronimo_home>/bin/shutdown [options]

The available options are:

--user [user_name]
Specifies the user name with the authority to stop the server. By default you would normally use system as the user name.

--password [password]
Specifies the password for the user name you just entered. By default you would normally use manager as the password.

--port [port_number]
Specifies the RMI naming port to connect to the server (for example JMX connection port). By default you would normally use port 1099.

If you do not specify any parameters, this command will prompt you for a user name and password and will assume port 1099 by default and will not prompt for any port.

Back to Top

geronimo

The geronimo command lets you perform the previous two actions, that is start and stop the server in different modes depending on the parameters you specify. This command has the following syntax:

<geronimo_home>/bin/geronimo [options]

The available options are:

debug
This option will start the server in JDB debugger.

jpda start
This option will start the server in JPDA debugger.

run
This option will start the server in the current window.

start
This option will start the server in a separate window just like the startup command.

stop
This option will stop the server.

Both start and stop options for this command will have the same set of parameters as the startup and shutdown commands.

Back to Top

deploy

The deployer tool is used for installing, uninstalling, starting and stopping applications and modules and for installing and uninstalling configurations (for example some configuration specific deployment plans, security realms, etc.). Due to the number of options in this case, the deployment tool is covered in detail in the Deployment section - Deployer tool.

This is a powerful tool with many parameters and options but it is not hard to use at all.

As with the startup command, the deployment tool can also be invoked in two different ways:

java -jar deployer.jar [general_options] <command> [command_options]

or simply

deploy [general_options] <command> [command_options]

Please refer to Deployer tool for a fully detailed description of this tool options and usage.

Back to Top

client.jar

The client.jar launches the client application container. This command has the following syntax:

java -jar client.jar config-name [app arg] [app arg] ...

The first argument identifies the Geronimo configuration that contains the application client you want to run. The rest of the arguments will be passed as arguments to the client application when it is started.

Back to Top