Excerpt |
---|
The deploy script is used for installing, uninstalling, reinstalling, starting and stopping applications and modules |
Usage
This command has the following syntax:
No Format |
---|
Wiki Markup |
{excerpt}The *deploy* script is used for installing, uninstalling, reinstalling, starting and stopping applications and modules{excerpt} and for installing and uninstalling configurations (for example some configuration specific deployment plans, security realms, database connection pools etc.) h1. Usage This command has the following syntax: {noformat} deploy <general_options> <command> <command_options> {noformat} where _ |
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:
No Format |
---|
} java \-Djava.endorsed.dirs=lib/endorsed \-jar bin/deployer.jar <general_options> <command> <command_options> {noformat} h2. General options 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: {noformat} |
General options
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:No Format 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
...
- defined
...
- as
...
- RemoteDeployHostname=localhost
...
- in
...
- <Geronimo_home>/var/config/config-substitutions.properties.
...
- Change
...
- localhost
...
- to
...
- the
...
- server's
...
- ip
...
- address
...
- if
...
- you
...
- want
...
- remote-deployment
...
- enabled
...
- on
...
- it.
...
- --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.
Security
Starting with Geronimo 2.1.2, the deployer tool can use a secure channel (SSL/TLS) to communicate with the JMX server to perform the given actions. To enable secure communication just add the --secure option. Depending on your configuration you might also need to specify some Java security properties to configure the JVM to use the right keystores and passwords. For example, on a default Geronimo installation you might need to set the following (all in one line):
No Format |
---|
_<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. [Back to top|#top] h2. Security Starting with Geronimo 2.1.2, the deployer tool can use a secure channel (SSL/TLS) to communicate with the JMX server to perform the given actions. To enable secure communication just add the *--secure* option. Depending on your configuration you might also need to specify some Java security properties to configure the JVM to use the right keystores and passwords. For example, on a default Geronimo installation you might need to set the following (all in one line): {noformat} export JAVA_OPTS="-Djavax.net.ssl.trustStore=<geronimo_home>/var/security/keystores/geronimo-default -Djavax.net.ssl.trustStorePassword=secret" {noformat} |
Once
...
that
...
property
...
is
...
set,
...
you
...
can
...
execute
...
the
...
following
...
command
...
(just
...
as
...
an
...
example):
No Format |
---|
} <GERONIMO_HOME>/bin/deploy -u system -p manager --secure list-modules {noformat} {note}The secure JMX server might not |
Note |
---|
The secure JMX server might not be running by default. Please see Configuring secure JMX server for more information. |
Sub-commands
The available sub-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:
No Format |
---|
be running by default. Please see [Configuring secure JMX server] for more information.{note}
[Back to top|#top]
h2. Sub-commands
The available sub-commands for the Geronimo deployer tool are listed below:
* Common commands
** [#Deploy]
** [#Login]
** [#Redeploy]
** [#Start]
** [#Stop]
** [#Undeploy]
* Other commands
** [#Distribute]
** [#Install-library]
** [#List-modules]
** [#List-targets]
* Geronimo Plugins
** [#Install-plugin]
** [#Search-plugins]
Additionally, you can type *help* for further details on a given command, the syntax is as follows:
{noformat}
deploy help <command>
|
Deploy
Use the deploy command to add and start a new module. The deploy command has the following syntax:
No Format |
---|
{noformat} [Back to top|#top] h3. Deploy Use the *deploy* command to add and start a new module. The deploy command has the following syntax: {noformat} deploy <general_options> deploy <module> <deployment_plan> {noformat} |
The
...
<module>
...
specifies
...
the
...
application
...
file
...
name
...
and
...
location.
...
The
...
<deployment_plan>
...
specifies
...
the
...
file
...
name
...
and
...
location
...
of
...
the
...
XML
...
with
...
the
...
deployment
...
plan.
...
Sometimes
...
the
...
application
...
module
...
already
...
has
...
included
...
in
...
the
...
package
...
a
...
deployment
...
plan
...
or
...
the
...
application
...
is
...
so
...
simple
...
that
...
does
...
not
...
require
...
any
...
deployment
...
plan,
...
in
...
these
...
cases
...
this
...
parameter
...
can
...
be
...
omited.
...
A
...
module
...
file
...
can
...
be
...
one
...
of
...
the
...
following:
...
- J2EE
...
- Enterprise
...
- Application
...
- Archive
...
- (EAR)
...
- file
...
- J2EE
...
- Web
...
- Application
...
- Archive
...
- (WAR)
...
- file
...
- J2EE
...
- Enterprise
...
- JavaBean
...
- Archive
...
- (JAR)
...
- file
...
- J2EE
...
- Java
...
- Resource
...
- Archive
...
- (RAR)
...
- file
...
If
...
the
...
server
...
is
...
not
...
currently
...
running
...
at
...
the
...
time
...
of
...
deploying
...
the
...
application,
...
the
...
module
...
will
...
be
...
marked
...
to
...
start
...
next
...
time
...
the
...
server
...
is
...
started.
...
The
...
most
...
common
...
<general_options>
...
would
...
be
...
--user
...
and
...
--password.
...
The
...
--inPlace
...
option
...
allows
...
you
...
point
...
to
...
and
...
deploy
...
an
...
application
...
directly
...
from
...
a
...
directory
...
external
...
to
...
Geornimo
...
without
...
the
...
need
...
for
...
even
...
packaging
...
the
...
application.
...
In
...
other
...
words,
...
you
...
can
...
have
...
an
...
application
...
running
...
in
...
Geronimo
...
but
...
that
...
application
...
may
...
be
...
anywhere
...
else
...
on
...
the
...
file
...
system.
Note |
---|
Please note that the {note} Please note that the--inPlace option cannot be used when deploying an application to a remote server. |
To use this option you should type:
No Format |
---|
{note} To use this option you should type: {noformat} deploy <general_options> deploy --inPlace <APP_HOME> {noformat} |
Where
...
<APP_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:
No Format |
---|
} deploy <general_options> --offline deploy <module> {noformat} |
Off
...
course,
...
you
...
can
...
also
...
combine
...
--offline
...
and
...
--inPlace
No Format |
---|
} deploy <general_options> --offline deploy --inPlace <APP_HOME> {noformat} |
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.
This information will be saved separately per connection URL, so you can specify --url or --host and/or --port on the command line to save a login to a different server.
The login command has the following syntax:
No Format |
---|
[Back to top|#top] h3. 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. This information will be saved separately per connection URL, so you can specify \--url or \--host and/or \--port on the command line to save a login to a different server. The *login* command has the following syntax: {noformat} deploy --user <user_name> --password <password> login {noformat} |
So,
...
next
...
time
...
you
...
run
...
a
...
different
...
command
...
that
...
originally
...
required
...
user
...
name
...
and
...
password,
...
you
...
can
...
run
...
the
...
command
...
directly,
...
for
...
example:
No Format |
---|
} deploy list-modules {noformat} |
Similarly,
...
you
...
don't
...
have
...
to
...
specify
...
or
...
re-enter
...
the
...
user
...
name
...
and
...
password
...
when
...
you
...
shut
...
down
...
the
...
server
...
using
...
the
...
...
command.
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 .geronimo-deployer file in your home directory so that nobody else can read or write it. |
Redeploy
Use the redeploy command to stop, replace and restart a module that has been deployed before. The redeploy command has the following syntax:
No Format |
---|
{warning} [Back to top|#top] h3. Redeploy Use the *redeploy* command to stop, replace and restart a module that has been deployed before. The redeploy command has the following syntax: {noformat} deploy <general_options> redeploy <module> <deployment_plan> {noformat} |
Just
...
like
...
the
...
...
...
,
...
the
...
redeploy
...
command
...
accepts
...
the
...
following
...
modules
...
file
...
types:
...
- J2EE
...
- Enterprise
...
- Application
...
- Archive
...
- (EAR)
...
- file
...
- J2EE
...
- Web
...
- Application
...
- Archive
...
- (WAR)
...
- file
...
- J2EE
...
- Enterprise
...
- JavaBean
...
- Archive
...
- (JAR)
...
- file
...
- J2EE
...
- Java
...
- Resource
...
- Archive
...
- (RAR)
...
- file
...
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:
No Format |
---|
top|#top] h3. Start Use the *start* command to start a previously deployed module. The start command has the following syntax: {noformat} deploy <general_options> start <moduleIDs> {noformat} |
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:
No Format |
---|
top|#top] h3. Stop Use the *stop* command to stop a running module. The stop command has the following syntax: {noformat} deploy <general_options> stop <moduleIDs> {noformat} |
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:
No Format |
---|
previously deployed. [Back to top|#top] h3. 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: {noformat} deploy <general_options> undeploy <moduleIDs> {noformat} |
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.
...
This
...
command
...
has
...
the
...
same
...
ability
...
as
...
with
...
deploy
...
to
...
uninstall
...
applications
...
when
...
the
...
server
...
is
...
not
...
running,
...
this
...
command
...
has
...
the
...
following
...
syntax:
No Format |
---|
} deploy <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:
No Format |
---|
{noformat} [Back to top|#top] h3. 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: {noformat} deploy <general_options> distribute <module> <deployment_plan> {noformat} |
Just
...
like
...
with
...
the
...
deploy
...
command,
...
<module>
...
specifies
...
the
...
application
...
file
...
name
...
and
...
location.
...
The
...
<deployment_plan>
...
specifies
...
the
...
file
...
name
...
and
...
location
...
of
...
the
...
XML
...
with
...
the
...
deployment
...
plan.
...
Sometimes
...
the
...
application
...
module
...
already
...
has
...
included
...
in
...
the
...
package
...
a
...
deployment
...
plan
...
or
...
the
...
application
...
is
...
so
...
simple
...
that
...
does
...
not
...
require
...
any
...
deployment
...
plan,
...
in
...
these
...
cases
...
this
...
parameter
...
can
...
be
...
omitted.
...
A
...
module
...
file
...
can
...
be
...
one
...
of
...
the
...
following:
...
- J2EE
...
- Enterprise
...
- Application
...
- Archive
...
- (EAR)
...
- file
...
- J2EE
...
- Web
...
- Application
...
- Archive
...
- (WAR)
...
- file
...
- J2EE
...
- Enterprise
...
- JavaBean
...
- Archive
...
- (JAR)
...
- file
...
- J2EE
...
- Java
...
- Resource
...
- Archive
...
- (RAR)
...
- file
...
...
...
Install-library
...
Use
...
the
...
install-library
...
command
...
to
...
install
...
a
...
library
...
into
...
server's
...
repository.
...
The
...
install-library
...
command
...
has
...
the
...
following
...
syntax:
No Format |
---|
} deploy <general_options> install-library \[--groupId groupName\] <libraryFile> {noformat} |
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:
No Format |
---|
} deploy -u system -p manager install-library mylib-1.0.jar {noformat} |
That
...
command
...
will
...
install
...
the
...
mylib-1.0.jar
...
at
...
<geronimo_home>/repository/default/mylib/1.0/mylib-1.0.jar
No Format |
---|
} {noformat} deploy -u system -p manager install-library --groupId mygroup mylib-1.0.jar {noformat} |
That
...
command
...
will
...
install
...
the
...
mylib-1.0.jar
...
at
...
<geronimo_home>/repository/mygroup/mylib/1.0/mylib-1.0.jar
...
...
...
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:
No Format |
---|
} deploy <general_options> list-modules \[--all|\--started|\--stopped\] {noformat} * \ |
- --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:
No Format |
---|
} deploy <general_options> list-targets {noformat} |
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:
No Format |
---|
} deploy install-plugin <plugin_file> {noformat} [Back to top|#top] h3. |
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:
No Format |
---|
{{*<geronimo_home>/bin/deploy search-plugins <maven_repository_URL>*}} [ |
...
...
...