...

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

Wiki Markup{{*<geronimo_home>/bin/geronimo \ [*{*}{_}options{_}{*}*\]*}}

The available options are:

...

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

-wiki-markup *\-override \ [*{*}{_}configId{_}{*}*\]* Overrides the configurations in *]
Overrides the configurations in <geronimo_home>/var/config.xml* 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.

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

...

The shutdown command stops the Apache Geronimo server. This command has the following syntax:unmigrated-wiki-markup

{{*<geronimo_home>/bin/shutdown \ [*{*}{_}options{_}{*}*\]*}}

The available options are:

unmigrated-wiki-markup*\--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 port *1099* is used.

]
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 port 1099 is used.

--host [host_name]
Specifies the host name of the server you are trying to stop. By default localhost is used. This parameter is only available in Geronimo 2.1.3 and greater. Wiki Markup*\--host \[*{*}{_}host_name{_}{*}*\]* Specifies the host name of the server you are trying to stop. By default *localhost* is used. _This parameter is only available in Geronimo 2.1.3 and greater._

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

...

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

• unmigrated-wiki-markup*\--uri* <identifier> Where <identifier> is a Universal Resource Identifier 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.

...

• Common commands
  • #Deploy
  • #Login
  • #Redeploy
  • #Start
  • #Stop
  • #Undeploy
• Other commands
  • #Distribute
  • #Encrypt
  • #InstallInstall-library
  • #ListList-modules
  • #ListList-targets
  • #UnlockKeystore
• Geronimo Plugins
  • #InstallInstall-plugin
  • #SearchSearch-plugins

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

...

<geronimo_home>/bin/deploy <general_options> redeploy <--targets target> <module> <deployment_plan>

...

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

you can use --targets option only for clustering redeployment. For clustering redeployment you can find the target with list-targets command. Copy the one with the name as MasterConfigurationStore and use it as a target variable.

Back to top

Start

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

...

Encrypt

Use the encrypt command to encrypt a generate an encrypted string. The encrypt command This command takes use of org.apache.geronimo.util.EncryptionManager and has the following syntax:

<geronimo_home>/bin/deploy <general_options> encrypt <string>

Where <string> specifies the string to get encrypted.

Examples:

deploy -h localhost -p 1099 encrypt passw0rd

That command will encrypt the passw0rd string when the server is running.

deploy -o encrypt passw0rd

That command will encrypt the passw0rd string when the server is not running.

Back to top

Install-library

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

{{*<geronimo_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_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_home>/bin/deploy -u system -p manager install-library --groupId mygroup mylib-1.0.jar

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

Back to top

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:

{{*<geronimo_home>/bin/deploy <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

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_home>/bin/deploy <general_options> list-targets

...

<general_options> are common options that apply to all commands, <string> specifies a string to get encrypted.

Currently password strings are plain text in deployment plans, such as datasource or JMS deployment plans within an EAR. It might pose a security problem to store password strings as plain text even though the deployment plans are only used during the deployment process, and not at runtime. Starting from Geronimo 2.1.5, users can encrypt passwords using the encrypt command and paste the encrypted strings into deployment plans as password.

Examples:

Use this syntax to encrypt string passw0rd on an active server so that the encryption settings of that server will be used

deploy --user myadmin --password mypassword encrypt passw0rd

Online encryption result:

......
String to encrypt: passw0rd
Online encryption result:
{Simple}rO0ABXNyABlqYXZheC5jcnlwdG8uU2VhbGVkT2JqZWN0PjY9psO3VHACAARbAA1lbmNv
ZGVkUGFyYW1zdAACW0JbABBlbmNyeXB0ZWRDb250ZW50cQB+AAFMAAlwYXJhbXNBbGd0ABJMamF2YS9s
YW5nL1N0cmluZztMAAdzZWFsQWxncQB+AAJ4cHB1cgACW0Ks8xf4BghU4AIAAHhwAAAAEG2NoqXONCcU
GqfK0reVCpVwdAADQUVT

Use this syntax to encrypt string passw0rd offline

deploy --offline encrypt passw0rd

Offline encryption result:

......
String to encrypt: passw0rd
Offline encryption result:
{Simple}rO0ABXNyABlqYXZheC5jcnlwdG8uU2VhbGVkT2JqZWN0PjY9psO3VHACAARbAA1lbmNv
ZGVkUGFyYW1zdAACW0JbABBlbmNyeXB0ZWRDb250ZW50cQB+AAFMAAlwYXJhbXNBbGd0ABJMamF2YS9s
YW5nL1N0cmluZztMAAdzZWFsQWxncQB+AAJ4cHB1cgACW0Ks8xf4BghU4AIAAHhwAAAAEG2NoqXONCcU
GqfK0reVCpVwdAADQUVT

Note: Online encryption needs a running server to connect to and will use the encryption settings of that server, such as an encryption key, to do the encryption. As a result, the encrypted password usually can only be used for that particular server. Offline encryption uses the default encryption settings, and the encrypted password can be used by all servers. Offline encryption is thus less secure than online encryption.

Back to top

Install-library

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

<geronimo_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_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_home>/bin/deploy -u system -p manager install-library --groupId mygroup mylib-1.0.jar

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

Back to top

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:

<geronimo_home>/bin/deploy <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

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_home>/bin/deploy <general_options> list-targets

In the case of Geronimo, each configuration store is a separate target. Geronimo does not yet support clusters as targets.

Back to top

UnlockKeystore

Use the unlockKeystore command to unlock a keystore and private keys. The unlockKeystore command has the following syntax:

<geronimo_home>/bin/deploy <general_options> unlockKeystore <keyStoreName> <keyAlias1> <keyAlias2>

Where <keyStoreName> specifies a locked keystore to get unlocked, <keyAlias1> and <keyAlias2> are optionally used to specify one or more locked private keys in the keystore to get unlocked.

Note that before you can use the unlockKeystore command, you need to ensure that the following lines are added to <geronimo_home>/var/config/config-substitutions.properties:

<keyStoreName>=<keyStoreEncryptedPassword>
<keyAlias1>=<keyAlias1EncryptedPassword>
<keyAlias2>=<keyAlias1EncryptedPassword>
...

Where

• <keyStoreName> is the name of the keystore.
• <keyStoreEncryptedPassword> is the encrypted password for the keystore, which can be generated by using the encrypt command. When you copy and paste the generated encrypted password to <geronimo_home>/var/config/config-substitutions.properties, there should be no space in the encrypted password string.
• <keyAlias1>, <keyAlias2> are the names of the private keys in the keystore.
• <keyAlias1EncryptedPassword>, <keyAlias2EncryptedPassword> are the encrypted passwords for the private keys, which can also be generated by using the encrypt command.

Alternatively, you can create a key file to contain the passwords of the keystore and its private keys. Use org.apache.geronimo.keyStoreTrustStorePasswordFile property to specify the key file. See Configuring SSL client authentication for more detailed instructions.

Examples:

Use this syntax to unlock the keystore whose name is mykeystore

deploy --user myadmin --password mypassword unlockKeystore mykeystore

Use this syntax to unlock the keystore whose name is mykeystore and the private key whose alias is key1

deploy --user myadmin --password mypassword unlockKeystore mykeystore key1

Back to top

Install-plugin

...

The client command launches the client application container. This command has the following syntax:unmigrated-wiki-markup

{{*<geronimo_home>/bin/client 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.

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

Wiki Markup{{{*}java \ -Djava.endorsed.dirs=lib/endorsed \ -jar bin/client.jar config-name \ [app arg\] \ [app arg\] ...*}}

jaxws-tools

The jaxws-tools command can be used to generate portable artifacts used in JAX-WS web services. For example, portable artifacts such as Service Endpoint Interface (SEI) class, Service class, JAXB generated value types, etc.

This command has the following syntax::

Wiki Markup{{*<geronimo_home>/bin/jaxws-tools toolName \ [toolOptions\] ...*}}

Where toolName can be either:

...

The jaxws-tools command can also be started by using the java -jar command:unmigrated-wiki-markup

{{{*}java \ -Djava.endorsed.dirs=lib/endorsed \ -jar bin/jaxws-tools.jar toolName \ [toolOptions\] ...*}}

wsgen

The jaxws-tools uses the wsgen tool provided by Sun to generate the portable artifacts from Java class. The wsgen tools has the following syntax:

Wiki Markup{{*<geronimo_home>/bin/jaxws-tools wsgen \ [options\] <SEI>*}}

• -classpath <path>
  Specifies where to find input class files.

...

The jaxws-tools uses the wsimport tool provided by Sun to generate the portable artifacts from WSDL. The wsimport has the following syntax:

Wiki Markup{{*<geronimo_home>/bin/jaxws-tools wsimport \ [options\] <WSDL_URI>*}}

• -d <directory>
  Specifies where to place generated output files.

...