Sun Microsystems Logo
Products and Services
Support and Training

A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
User Commandsdeploy(1)


 deploy - deploys the specified component


 deploy --user admin_user [ --password admin_password ] [ --host localhost ] [ --port 4848 ] [ --secure|-s ] [ --passwordfile filename ] [ --terse=false ] [ --echo=false ] [ --interactive ] [ --virtualservers virtual_servers ] [ --contextroot context_root ] [ --force=true ] [ --precompilejsp=false ] [ --verify=false ] [ --name component_name ] [ --upload=true ] [ --retrieve local_dirpath ] [ --dbvendorname dbvendorname ] [ --createtables=true|false | --dropandcreatetables=true|false ] [ --uniquetablenames=true|false ] [ --deploymentplan deployment_plan ] [ --enabled=true ] filepath



Deploys an EJB, web, connector or application. If the component is already deployed or already exists, it is forcefully re-deployed if the --force option is set to true.

The --createtables and --dropandcreatetables options are booleans and therefore can take the values of true or false. These options are only used during deployment of CMP beans that have not been mapped to a database (i.e., no sun-cmp-mappings.xml descriptor is provided in the module's META-INF directory). They are ignored otherwise.

The --createtables option and --dropandcreatetables option are mutually exclusive; only one should be used. If drop and/or create tables fails, the deployment does not fail; a warning message is provided in the log file.

This command is supported in remote mode only.


authorized domain application server administrative username.
password to administer the domain application server.
machine name where the domain application server is running.
port number of the domain application server listening for administration requests.
if true, uses SSL/TLS to communicate with the domain application server.
file containing the domain application server password.
indicates that any output data must be very concise, typically avoiding human-friendly sentences and favoring well-formatted data for consumption by a script.
setting to true will echo the command line statement on the standard output.
prompts you for the required options that are not already specified.
comma separated list of virtual server name.
valid only if the archive is a web module. It is ignored for other archive types; defaults to filename without extension.
makes sure the component is forcefully (re)deployed even if the specified component has already been deployed or already exists.
by default is set to false which does not allow the JSP to pre-compile during deployment. Instead JSPs are compiled during runtime.
if set to true, the syntax and semantics of the deployment descriptor is verified.
name of the deployable component.
when set to true, uploads the deployable file to the administration server. If the filepath of the deployable file is mounted to the server machine, or if the administration server is running locally, set the upload option to false.
retrieves the client stub JAR file from the server machine to the local directory.
name of database vendor being used. Default is the corresponding entry in the cmp-resource() element of the sun-ejb-jar.xml file. If not specified the default is SQL92. Thereby the DDL files to create and drop tables will be generated in SQL92 format.
creates tables at deploy of an application with unmapped CMP beans. Default is the corresponding entry in the cmp-resource element of the sun-ejb-jar.xml file. If not specified, defaults to the entries specified in the deployment descriptors.
drops tables at redeploy of an already deployed application with unmapped CMP beans. If not specified, the tables will be dropped if the drop-tables-at-undeploy entry in the cmp-resource element of the sun-ejb-jar.xml file is set to true. The new tables are created if the create-tables-at-deploy entry in the cmp-resource element of the sun-ejb-jar.xml file is set to true. On redeploy the tables created by the previous deploy are dropped before creating the new tables.
guarantees unique table names for all the beans and results in a hashcode added to the table names. This is useful if you have an application with case-sensitive bean names.
takes the deployment plan, which is a JAR containing Sun-specific descriptors, and deploys it. This should be passed along when deploying a pure EAR file. A pure EAR file is an EAR without Sun-specific descriptors.
if set to true (default), allows user to access the application. If set to false, user will not be able to access the application.


path to the deployable file on the local machine if the --upload option is set to true; otherwise the absolute path to the file on the server machine.


 Example 1. Deploying a J2EE application

Deploy (install) the J2EE application packaged in the Cart.ear file.

asadmin> deploy --user admin --password admin123 --host murph
--port 4848 Cart.ear
Command deploy executed successfully
Example 2. Deploying a Web application with the default context root

Deploy the Web application in the hello.war file at the hello context root.

asadmin> deploy --user admin hello.war
Command deploy executed successfully
Example 3. Deploying an enterprise bean (EJB component)

Deploy and enterprise bean with container-managed persistence (CMP) and create the database tables used by the bean.

asadmin> deploy --user admin --createtables=true EmployeeEJB.jar
Command deploy executed successfully
Example 4. Deploying a connector module (resource adapter)

Deploy a connector module packaged in a RAR file.

asadmin> deploy --user admin jdbcra.rar
Command deploy executed successfully


command executed successfully
error in executing the command



undeploy(1), list-components(1)

J2EE 1.4 SDKGo To TopLast Changed March 2004