
Administration Commands                               undeploy(1)

NAME
     undeploy - removes a deployed component

SYNOPSIS
     undeploy
     [--terse={true|false}][ --echo={true|false} ]
     [ --interactive={true|false} ] [ --host  host]
     [--port port] [--secure| -s ] [ --user  admin_user]
     [--passwordfile filename] [--help]
     [ --droptables =true|false]
     [--cascade=false] [ --target  target]
     component_name

DESCRIPTION
     The undeploy command removes  the  specified  deployed  com-
     ponent.

     This command is supported in remote mode only.

OPTIONS
     -t --terse                  Indicates that any  output  data
                                 must  be very concise, typically
                                 avoiding   human-friendly   sen-
                                 tences    and   favoring   well-
                                 formatted data  for  consumption
                                 by a script. Default is false.

     -e --echo                   Setting to true  will  echo  the
                                 command  line  statement  on the
                                 standard  output.   Default   is
                                 false.

     -I --interactive            If set to true  (default),  only
                                 the  required  password  options
                                 are prompted.

     -H --host                   The  machine  name   where   the
                                 domain  administration server is
                                 running. The  default  value  is
                                 localhost.

     -p --port                   The HTTP/S port for  administra-
                                 tion.  This is the port to which
                                 you should point your browser in
                                 order  to manage the domain. For
                                 example, http://localhost:4848.

Java EE 5           Last change: 30 Jan 2007                    1

Administration Commands                               undeploy(1)

                                 The default port number is 4848.

     -s --secure                 If set to true, uses SSL/TLS  to
                                 communicate   with   the  domain
                                 administration server.

     -u --user                   The authorized  domain  adminis-
                                 tration   server  administrative
                                 username.

                                 If you have authenticated  to  a
                                 domain  using  the asadmin login
                                 command,  then  you   need   not
                                 specify  the  --user  option  on
                                 subsequent  operations  to  this
                                 particular domain.

     --passwordfile              The --passwordfile option speci-
                                 fies  the  name,  including  the
                                 full path, of a file  containing
                                 the   password   entries   in  a
                                 specific format. The  entry  for
                                 the   password   must  have  the
                                 AS_ADMIN_ prefix followed by the
                                 password   name   in   uppercase
                                 letters.

                                 For  example,  to  specify   the
                                 domain   administration   server
                                 password, use an entry with  the
                                 following                format:
                                 AS_ADMIN_PASSWORD=password,
                                 where  password  is  the  actual
                                 administrator  password.   Other
                                 passwords  that can be specified
                                 include AS_ADMIN_MAPPEDPASSWORD,
                                 AS_ADMIN_USERPASSWORD,       and
                                 AS_ADMIN_ALIASPASSWORD.

                                 All remote commands must specify
                                 the  admin password to authenti-
                                 cate to the  domain  administra-
                                 tion  server,  either through --
                                 passwordfile or  asadmin  login,
                                 or  interactively on the command
                                 prompt. The asadmin  login  com-
                                 mand can be used only to specify
                                 the admin  password.  For  other
                                 passwords,    that    must    be

Java EE 5           Last change: 30 Jan 2007                    2

Administration Commands                               undeploy(1)

                                 specified for  remote  commands,
                                 use  the --passwordfile or enter
                                 them at the command prompt.

                                 If you have authenticated  to  a
                                 domain  using  the asadmin login
                                 command,  then  you   need   not
                                 specify   the   admin   password
                                 through    the    --passwordfile
                                 option  on subsequent operations
                                 to this particular domain.  How-
                                 ever, this is applicable only to
                                 AS_ADMIN_PASSWORD  option.   You
                                 will  still  need to provide the
                                 other  passwords,  for  example,
                                 AS_ADMIN_USERPASSWORD,   as  and
                                 when required by individual com-
                                 mands, such as update-file-user.

                                 For security reasons,  passwords
                                 specified   as   an  environment
                                 variable will  not  be  read  by
                                 asadmin.

                                 The    default     value     for
                                 AS_ADMIN_MASTERPASSWORD       is
                                 changeit.

     --help                      Displays the help text  for  the
                                 command.

     --droptables                If set to true,  tables  created
                                 by  application  using CMP beans
                                 during deployment  are  dropped.
                                 The default is the corresponding
                                 entry in the  cmp-resource  ele-
                                 ment   of   the  sun-ejb-jar.xml
                                 file.   If  not  specified,   it
                                 defaults  to  the entries speci-
                                 fied in the deployment  descrip-
                                 tors.

     --cascade                   If set to true, it  deletes  all
                                 the connection pools and connec-
                                 tor  resources  associated  with
                                 the resource adapter being unde-
                                 ployed. If  set  to  false,  the
                                 undeploy  fails if any pools and
                                 resources are  still  associated

Java EE 5           Last change: 30 Jan 2007                    3

Administration Commands                               undeploy(1)

                                 with the resource adapter. Then,
                                 either those pools and resources
                                 have  to  be deleted explicitly,
                                 or the option has to be  set  to
                                 true.  If  the  option is set to
                                 false, and if there are no pools
                                 and  resources  still associated
                                 with the resource  adapter,  the
                                 resource  adapter is undeployed.
                                 This  option  is  applicable  to
                                 connectors  (resource  adapters)
                                 and applications.

     --target                    This option  is  valid  only  in
                                 domains  that  are configured to
                                 support   clusters,   such    as
                                 domains  that  are  created with
                                 the  cluster  profile   or   the
                                 enterprise profile.Specifies the
                                 target from which you are  unde-
                                 ploying.  Valid values are:

                                     o    server-  Specifies  the
                                          default server instance
                                          as the target.   server
                                          is   the  name  of  the
                                          default server instance
                                          and   is   the  default
                                          value.

                                     o    domain_name-  Specifies
                                          a certain domain as the
                                          target.

                                     o    cluster_name- Specifies
                                          a  certain  cluster  as
                                          the target.

                                     o    instance_name-   Speci-
                                          fies  a  certain server
                                          instance as the target.

OPERANDS
     component_name              Name of the deployed component.

EXAMPLES
     Example 1 Simple undeployment

Java EE 5           Last change: 30 Jan 2007                    4

Administration Commands                               undeploy(1)

     Undeploy (uninstall) an enterprise application Cart.ear.

       asadmin> undeploy --user admin --passwordfile password.txt Cart
       Command undeploy executed successfully.

     Example 2 Undeploying an  enterprise  bean  with  container-
     managed persistence (CMP)

     Undeploy a CMP bean named myejb and drop  the  corresponding
     database  tables.  In  a  production  environment,  database
     tables contain valuable information, so use the --droptables
     option with care.

       asadmin> undeploy --user admin --passwordfile password.txt --droptables=true myejb
       Command undeploy executed successfully.

     Example 3 Undeploy a connector (resource adapter)

     Undeploy the connector module named  jdbcra  and  perform  a
     cascading delete to remove the associated resources and con-
     nection pools.

       asadmin> undeploy --user admin --passwordfile password.txt --cascade=true jdbcra
       Command undeploy executed successfully.

EXIT STATUS
     0                           command executed successfully

     1                           error in executing the command

SEE ALSO
     deploy(1), deploydir(1), list-components(1)

Java EE 5           Last change: 30 Jan 2007                    5

