Page History

...

This command has the following syntax:

<geronimo<GERONIMO_home>HOME>/bin/deploy <general_options> <command> <command_options>

where <general_options> specify common options that apply to all commands and control how the application behaves, <command> is a command name that specifies the action to be performed, and <command_options> are options unique to the command specified.

The deploy command can also be started by using the java -jar command:

java -Djava.endorsed.dirs=lib/endorsed -jar bin/deployer.jar <general_options> <command> <command_options>

...

• Wiki Markup

  *\--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.

• --port <port>
  Where <port> is the port of the remote server you are trying to deploy that application or resource. This parameter is optional and defaults to port 1099.

• --driver <driver_path>
  Where <driver_path> is the path to the driver JAR if you want to use this tool with a server other than Geronimo. Currently, manifest Class-Path entries in that JAR are ignored.

• --user <username>
  Where <username> is a user name authorized to be an administrator on the server. If the command requires authorization, you must use this option.

• --password <password>
  Where <password> is a the password required to authenticate the user name. If this flag is not specified, the deployer will attempt to perform the command with no password, but if that fails, it will prompt you to enter a password.

• --secure
  Use secure channel to communicate with JMX server, see #Security for details. This parameter is only available in Geronimo 2.1.2 or greater.

• --syserr <select>
  Where <select> can be either true or false. If this flag is unspecified. false is assumed. Specify true when you want errors to be logged to the syserr device.

• --verbose <select>
  Where <select> can be either true or false. If this flag is unspecified. false is assumed. Specify true when you need more messages to determine the cause of an error.

...

export JAVA_OPTS="-Djavax.net.ssl.trustStore=<geronimo_home>/var/security/keystores/geronimo-default -Djavax.net.ssl.trustStorePassword=secret"

Once that property is set, you can execute the following command (just as an example):

<geronimo<GERONIMO_home>HOME>/bin/deploy -u system -p manager --secure list-modules

...

Additionally, you can type help for further details on a given command, the syntax is as follows:

<geronimo<GERONIMO_home>HOME>/bin/deploy help <command>

...

Use the deploy command to add and start a new module. The deploy command has the following syntax:

<geronimo<GERONIMO_home>HOME>/bin/deploy <general_options> deploy <module> <deployment_plan>

...

To use this option you should type:

<geronimo<GERONIMO_home>HOME>/bin/deploy <general_options> deploy --inPlace <app<APP_home>HOME>

Where <app<APP_home> HOME> indicates the home directory where you have your application (exploded).

You can also deploy applications if Geronimo is not running by using the --offline option, the syntax for this command would be:

<geronimo<GERONIMO_home>HOME>/bin/deploy <general_options> --offline deploy <module>

Off course, you can also combine --offline and --inPlace

<geronimo<GERONIMO_home>HOME>/bin/deploy <general_options> --offline deploy --inPlace <app<APP_home>HOME>

Back to top

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.

...

The login command has the following syntax:

<geronimo<GERONIMO_home>HOME>/bin/deploy --user <user_name> --password <password> login

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

<geronimo<GERONIMO_home>HOME>/bin/deploy list-modules

...

Use the redeploy command to stop, replace and restart a module that has been deployed before. The redeploy command has the following syntax:

<geronimo<GERONIMO_home>HOME>/bin/deploy <general_options> redeploy <module> <deployment_plan>

...

Use the start command to start a previously deployed module. The start command has the following syntax:

<geronimo<GERONIMO_home>HOME>/bin/deploy <general_options> start <moduleIDs>

...

Use the stop command to stop a running module. The stop command has the following syntax:

<geronimo<GERONIMO_home>HOME>/bin/deploy <general_options> stop <moduleIDs>

...

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:

<geronimo<GERONIMO_home>HOME>/bin/deploy <general_options> undeploy <moduleIDs>

...

This command has the same ability as with deploy to uninstall applications when the server is not running, this command has the following syntax:

<geronimo<GERONIMO_home>HOME>/bin/deploy <general_options> --offline undeploy <moduleID>

...

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:

<geronimo<GERONIMO_home>HOME>/bin/deploy <general_options> distribute <module> <deployment_plan>

...

Use the install-library command to install a library into server's repository. The install-library command has the following syntax:

{{*<geronimo<GERONIMO_home>HOME>/bin/deploy <general_options> install-library \[--groupId groupName\] <libraryFile>*}}

Use the --groupId option to specify a non-default group id for the library. Otherwise, the library file will be installed with the group id named default.

Examples:

<geronimo<GERONIMO_home>HOME>/bin/deploy -u system -p manager install-library mylib-1.0.jar

That command will install the mylib-1.0.jar at <geronimo_home>/repository/default/mylib/1.0/mylib-1.0.jar

<geronimo<GERONIMO_home>HOME>/bin/deploy -u system -p manager install-library --groupId mygroup mylib-1.0.jar

...

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:

<geronimo<GERONIMO_home>HOME>/bin/deploy <general_options> list-targets

...

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:

<geronimo<GERONIMO_home>HOME>/bin/deploy install-plugin <plugin_file>

...