Page History

...

Anchortoptop

The deployer application is a Java application that manages J2EE artifacts and GBean components in the Geronimo server. If Geronimo is running, it will connect to the server and perform its action through the server's deployment service. If it cannot find a running server, it will throw an error stating it could not connect to the server or the server is unavailable.

...

This section lists all the available general options for the Geronimo deployer tool.

...

• *--uri* <identifier>
  Where <identifier> is a Universal Resource Identifier (URI) that specifies how the deployer is to contact the server. If this flag is not specified, the deployer will attempt to contact the server using the standard port on localhost. The identifier must have the following form:
  deployer:geronimo:jmx:rmi:///jndi/rmi:\[//host\[:port\]]/JMXConnector
  where <host> is replaced with the host name or TCP/IP address of the system where the server is running and <port> is replaced with the port number where the server is listening. If unspecified, localhost and the default port will be used.

• --host <host>
  Where <host> is the host name of the server you are trying to deploy that application or resource. This option allows you to deploy resources and applications to a remote server. This parameter is optional and defaults to localhost.

...

java -jar deployer.jar help <commands>

Back to top

Deploy Anchordeploydeploy

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>

Back to top

Login Anchor loginlogin

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.

...

So, next time you run a different command that originally required user name and password, you can run the command directly, for example:

deploy list-modules

...

...

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 .geronimo-deployer file in your home directory so that nobody else can read or write it.

...

Back to top

Redeploy Anchorredeployredeploy

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.

Back to top

Start Anchor startstart

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.

Back to top

Stop Anchor stopstop

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.

Back to top

Undeploy Anchorundeployundeploy

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>

Back to top

Distribute Anchordistributedistribute

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

Back to top

List-modules Anchorlist-modules 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:

Wiki Markup*{{java -jar deployer.jar <general_options> list-modules \ [\-\-all|\-\-started|\-\-stopped\]}}*

• --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.

Back to top

List-targets Anchor list-targetslist-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:

...

Back to top

Install-plugin Anchorinstall-plugininstall-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>

Back to top

Search-plugins Anchorsearch-plugins 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:

...