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

NAME

 undeploy - removes a component from the domain application server

SYNOPSIS

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

DESCRIPTION

undeploy removes the specified component in the domain application server.

The --droptables option is only used to undeploy CMP beans for which the tables had been created by the deployment. If not specified, the entries in the deployment descriptors are used.

This command is supported in remote mode only.

OPTIONS

-u --user

The authorized domain application server administrative username.

-w --password

The --password option is deprecated. Use --passwordfile instead.

--passwordfile

This option replaces the -- password option. Using the --password option on the command line or through the environment is deprecated. The --passwordfile option specifies the name of a file containing the password entries in a specified format. The entry for the password must have the AS_ADMIN_ prefix followed by the password name in capital letters. For example, to specify the domain application 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, AS_ADMIN_SAVEDMASTERPASSWORD, AS_ADMIN_MQPASSWORD, AS_ADMIN_ALIASPASSWORD, and so on.

-H --host

The machine name where the domain application server is running. The default value is localhost.

-p --port

The port number of the domain application server listening for administration requests. The default port number for Platform Edition is 4848. The default port number for Enterprise Edition is 4849.

-s --secure

If set to true, uses SSL/TLS to communicate with the domain application server.

-t --terse

Indicates that any output data must be very concise, typically avoiding human-friendly sentences 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 --help

Displays the help text for the command.

--droptables

If set to true, tables created by application using CMP beans during deployment are dropped. Default is the corresponding entry in the cmp-resource element of the sun-ejb-jar.xml file. If not specified, it defaults to the entries specified in the deployment descriptors.

--cascade

If set to true, it deletes all the connection pools and connector resources associated with the resource adapter being undeployed. If set to false, the undeploy fails if any pools and resources are still associated 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

Specifies the target from which you are undeploying. Valid values are:

• server, which undeploys the component from the default server instance server and is the default value

• domain, which undeploys the component from the domain.

• cluster_name, which undeploys the component from every server instance in the cluster.

• instance_name, which undeploys the component from a particular sever instance.

OPERANDS

component_name

name of the deployed component.

EXAMPLES

Example 1. Simple undeployment

Undeploy (uninstall) an application named Cart

asadmin> undeploy --user admin Cart

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 --droptables=true myejb

Example 3. Undeploy a connector (resource adapter)

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

asadmin> undeploy --user admin --cascade=true jdbcra

EXIT STATUS

0

command executed successfully

1

error in executing the command

SEE ALSO

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