sun.com | docs.sun.com |  | How To Buy | My Sun | Worldwide Sites |

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 Commands | deploy(1)

- NAME
- SYNOPSIS
- DESCRIPTION
- OPTIONS
- OPERANDS
- EXAMPLES
- EXIT STATUS
- SEE ALSO

## NAME

> deploy - deploys the specified component

## SYNOPSIS

> ``deploy` --user admin_user[ --password admin_password ][ --host localhost ] [ --port 4848 ][ --secure|-s ][ --passwordfile filename ] [ --virtualservers virtual_servers ][ --type application|ejb|web|connector ] [ --contextroot context_root ][ --force=true ][ --precompilejsp=false ] [ --verify=false ][ --name component_name ][ --upload=true ] [ --availabilityenabled ][ --retrieve local_dirpath ] [ --instance instance_name ] filepath`

## DESCRIPTION

> Use the `deploy` command to deploy an EJB, web, client, connector or application. If there is no component with the name you specify, the system returns that the component does not exist. If the component is already deployed or already exists, it is forcefully re-deployed if the --force option is set to true.

## OPTIONS

> --user

>   administrative user associated for the instance.

> --password

>   administrative password corresponding to the administrative user.

> --host

>   host name of the machine hosting the administrative instance.

> --port

>   administrative port number associated with the administrative host.

> --passwordfile

>   file containing passwords appropriate for the command (for example, administrative instance).

> --secure

>   if true, uses SSL/TLS to communicate with the administrative instance.

> --virtualservers

>   comma separated list of virtual server IDs.

> --type

>   identifies the type of component to be deployed; defaults to the type of the extension of file.

> --contextroot

>   valid only if the archive is a web module. It is ignored for other archive types; defaults to filename without extension.

> --force

>   makes sure the component is forcefully (re)deployed even if the specified component has already been deployed or already exists.

> --precompilejsp

>   by default is set to false which does not allow the JSP to pre-compile during deployment. Instead JSPs are compiled during runtime.

> --verify

>   the syntax and semantics of the deployment descriptor is verified if set to true.

> --name

>   name of the deployable component.

> --upload

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

> --availabilityenabled

>   valid only for deployment of application, ejb-module and web-module. Valid values are null, true and false. If this option is not specified, it will be considered null and not false. When set to true, availability is enabled for that application or module. For applications, both HTTPSessions and stateful session beans (SFSB) are enabled for availability. The parent web and ejb container values take precedence. The ejb-module or web-module is enabled for availability. The parent ejb or web container value takes precedence.

>   This option is available only in the Enterprise Edition of Sun Java System Application Server.

> --retrieve

>   retrieves the client stub JAR file from the server machine to the local directory.

> --instance

>   name of the instance.

## OPERANDS

> filepath

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

## EXAMPLES

> Example 1. Using `deploy` for WAR module

> > >     asadmin> deploy --user admin --passwordfile passwords.txt --host localhost
> > >     --port 4848 --virtualservers server1 --type web --contextroot simple --force=false
> > >     --precompilejsp=false --verify=false --name simple --upload=true --instance server1
> > >     /export/samples/simple.war
> > >     Deployed the WAR module:simple

> > Where: the `simple` WAR module is deployed to the absolute filepath specified.

> Example 2. Using `deploy` for an application

> > >     asadmin> deploy --user admin --password adminadmin --host localhost
> > >     --port 4848 --virtualservers server1 --type application --force=false
> > >     --verify=false --name fortune --upload=true --instance server1
> > >     /export/samples/fortune.ear
> > >     Deployed the application:fortune

> > Where: the `fortune` application is deployed to the absolute filepath specified.

## EXIT STATUS

> 0

>   command executed successfully

> 1

>   error in executing the command

## SEE ALSO

> `deploydir`(1), `undeploy`(1), `enable`(1), `disable`(1), `list-components`(1)

Sun Java System Application Server | Go To Top | Last Changed 16 Feb 2004

Company Info | Contact | Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.