...
The available commands for the Geronimo deployer tool are listed below:
- Common commands
- Other commands
- Geronimo Plugins
Additionally, you can type help for further details on a given command, the syntax is as follows:
java -jar deployer.jar help <commands>
Deploy
...
Use the deploy command to add and start a new module. The deploy command has the following syntax:
...
java -jar deployer.jar <general_options> --offline deploy --inPlace <app_home>
Login
...
...
Use the login command to save the username and password for the current connection to the file .geronimo-deployer
in the current user's home directory. Future connections to the same server will try to use this saved authentication information instead of prompting where possible.
...
Warning |
---|
Even when the login information is not saved in clear text, it is not secure either. If you want to save the authentication securely, you should change the |
Redeploy
...
Use the redeploy command to stop, replace and restart a module that has been deployed before. The redeploy command has the following syntax:
...
Typically, both a module and a plan are specified. If the module contains a plan or if a default plan can be used, the plan can be omitted. However, if a plan is specified in this case, it overrides the other plans. If the plan references a server component already deployed in the server's environment, the module is omitted.
Start
...
...
Use the start command to start a previously deployed module. The start command has the following syntax:
...
Where <moduleIDs> is a list of one or more modules (configID) separated by blank space. The module identification (or ConfigID) is defined at deployment time in the respective deployment plan for each module previously deployed.
Stop
...
Use the stop command to stop a running module. The stop command has the following syntax:
...
Where <moduleIDs> is a list of one or more modules (configID) separated by blank space. The module identification (or ConfigID) is defined at deployment time in the respective deployment plan for each module previously deployed.
Undeploy
...
...
Use the undeploy command to stop and remove a module (running or not) and its deployment information from the server. The undeploy command has the following syntax:
...
java -jar deployer.jar <general_options> --offline undeploy <moduleID>
Distribute
...
Use the distribute command to add a new module to the server. This command does not start the module nor mark it to be started in the future. The distribute command has the following syntax:
...
- J2EE Enterprise Application Archive (EAR) file
- J2EE Web Application Archive (WAR) file
- J2EE Enterprise JavaBean Archive (JAR) file
- J2EE Java Resource Archive (RAR) file
List
...
-modules
...
Use the list-modules command to list all available modules on the server, note that for running this command the server must be running. The list-modules command has the following syntax:
...
- --all : is used by default when no other option is specified. It will list all the available modules.
- --started : this option will list only the modules that are running.
- --stopped : this option will list only the modules that are not running.
List
...
-targets
...
Use the list-targets command to lists the targets known to the server you have connected to. The list-targets command has the following syntax:
...
In the case of Geronimo, each configuration store is a separate target. Geronimo does not yet support clusters as targets.
Install
...
-plugin
Use the install-plugin command to install a Geronimo plugin previously exported from a Geronimo server or downloaded from a repository. A Geronimo plugin can be an application, a configuration such data sources and drivers or a combination. The install-plugin command has the following syntax:
java -jar deployer.jar install-plugin <plugin_file>
Search
...
-plugins
Use the search-plugins command to list all the Geronimo plugins available in a Maven repository. The search-plugins command has the following syntax:
...