Intelligent Management: middleware application administrative tasks

We can use the Jacl or Jython scripting languages to create and manage middleware applications with wsadmin.sh.

The administrative tasks for middleware applications include the following commands:


addMiddlewareAppWebModule

The addMiddlewareAppWebModule command adds a Web module to a middleware application.

Target object: None.

Required parameters

-app

Name of the middleware application. (String, required)

-moduleName

Name of a module. (String, required)

-virtualHost

Name of the virtual host, which enables a single host machine to resemble multiple host machines. (String, required)

-contextRoot

Path prefix that is associated with the application. Use this parameter to compose the URL needed to access the application files. (String, required)

Optional parameters

-edition

Name of the edition. Required if the specified application has more than one edition. (String, optional)

-cluster

Name of the cluster. This parameter adds a dynamic cluster as a deployment target. (String, optional)

-node

Name of the node. (String, optional)

-server

Name of the server. Issue both the server and node parameters to add a standalone server as a deployment target. (String, optional)

Return value

Batch mode example

Interactive mode


addMiddlewareTarget

The addMiddlewareTarget command adds a deployment target to a middleware application.

Target object: None.

Required parameters

-app

Name of the middleware application. (String, required)

Optional parameters

-edition

Name of the edition. Required if the specified application has more than one edition. (String, optional)

-module

Name of the module. Use this parameter to narrow the scope of a command to a single module. (String, optional)

-cluster

Name of the cluster. Use this parameter to add a dynamic cluster as a deployment target. (String, optional)

-node

Name of the node. (String, optional)

-server

Name of the server. Issue both the server and node parameters to add a standalone server as a deployment target. (String, optional)

Return value

Batch mode example

Interactive mode


deployWASCEApp

The deployWasCEApp command adds a representation of a WebSphere Application Server Community Edition application.

Target object: None.

Required parameters

-app

Name of the middleware application. (String, required)

-node

Name of the node. (String, required)

-server

Name of the server. (String, required)

Optional parameters

-edition

Name of the edition. (String, optional)

Return value

Batch mode example

Interactive mode


exportMiddlewareApp

The exportMiddlewareApp command exports a middleware application to a directory.

Target object: None.

Required parameters

-app

Name of the middleware application. (String, required)

-dir

Directory in which the application is located. (String, required)

Optional parameters

-edition

Name of the edition. Required if the specified application has more than one edition. (String, optional)

Return value

Batch mode example

Interactive mode


exportMiddlewareAppScript

The exportMiddlewareAppScript command exports the scripts of a middleware application to a directory.

Target object: None.

Required parameters

-app

Name of the middleware application. (String, required)

-dir

Name of the directory in which the middleware application script is located. (String, required)

Optional parameters

-edition

Name of the edition. (String, optional)

-type

Type of script. The valid types are SETUP and CLEANUP. Specify the type to narrow the scope of the command to a single script. (String, optional)

Return value

Batch mode example

Interactive mode


listMiddlewareAppEditions

The listMiddlewareAppEditions command lists all the editions of a middleware application.

Target object: None.

Required parameters

-app

Name of the middleware application. (String, required)

Optional parameters

None.

Return value

The command returns a list of edition names.

Batch mode example

Interactive mode


listMiddlewareApps

The listMiddlewareApps command list all of the middleware applications.

Target object: None.

Required parameters

None.

Optional parameters

None.

Return value

The command returns a list of the middleware applications.

Batch mode example

Interactive mode


listMiddlewareAppWebModules

The listMiddlewareAppWebModules command lists the Web modules of a middleware application.

Target object: None.

Required parameters

-app

Name of the middleware application. (String, required)

-edition

Name of the edition. (String, required)

Optional parameters

None.

Return value

Batch mode example

Interactive mode


listMiddlewareTargets

The listMiddlewareTargets command lists the deployment targets for a middleware application.

Target object: None.

Required parameters

-app

Name of the middleware application. (String, required)

Optional parameters

-edition

Name of the edition. (String, optional)

-module

Name of the module. (String, optional)

Return value

The command returns a list of deployment target objects.

Batch mode example

Interactive mode


modifyMiddlewareAppWebModule

The modifyMiddlewareAppWebModule command modifies the virtual hosts of an application.

Target object: None.

Required parameters

-app

Name of the application. (String, required)

Optional parameters

-edition

Name of the edition. (String, optional)

-renameEdition

New name of the edition. (String, optional)

-description

How the edition is modified. (String, optional)

Return value

Batch mode example

Interactive mode


modifyPHPApp

The modifyPHPApp command updates a PHP application.

Target object: None.

Required parameters

-app

Name of the PHP application. (String, required)

Optional parameters

-edition

Edition of the PHP application. (String, optional)

-renameEdition

New name of the edition. (String, optional)

-description

Description of the modified edition. (String, optional)

-archive

Path to the application archive file. (String, optional)

-setupScript

Path to the setup script file. (String, optional)

-cleanupScript

Path to the cleanup script file. (String, optional)

-contextRoot

Path prefix that is associated with the application. (String, optional)

-virtualHost

Name of the virtual host. (String, optional)

Return value

Batch mode example

Interactive mode


modifyUnmanagedWebApp

The modifyUnmanagedWebApp command updates an unmanaged Web application.

Target object: None.

Required parameters

-app

Name of the application. (String, required)

Optional parameters

-edition

Name of the edition. (String, optional)

-renameEdition

New name of the edition. (String, optional)

-description

Description of the modified edition. (String, optional)

Return value

Batch mode example

Interactive mode


modifyWasCEApp

The modifyWasCEApp command updates a WebSphere Application Server Community Edition application.

Target object: None.

Required parameters

-app

Name of the application. (String, required)

Optional parameters

-edition

Name of the edition. (String, optional)

-renameEdition

New name of the edition. (String, optional)

-description

Description of the edition. (String, optional)

Return value

Batch mode example

Interactive mode


removeMiddlewareAppWebModule

The removeMiddlewareAppWebModule command removes the Web module from the middleware application.

Target object: None.

Required parameters

-app

Name of the middleware application. (String, required)

Optional parameters

-edition

Name of the edition. (String, optional)

-moduleName

Name of the Web module. (String, optional)

-cluster

Name of the cluster. (String, optional)

-node

Name of the node. (String, optional)

-server

Name of the server. (String, optional)

Return value

Batch mode example

Interactive mode


removeMiddlewareTarget

The removeMiddlewareTarget command removes the deployment targets from the middleware application.

Target object: None.

Required parameters

-app

Name of the middleware application. (String, required)

Optional parameters

-edition

Name of the edition. (String, optional)

-module

Name of the Web module. (String, optional)

-cluster

Name of the cluster. (String, optional)

-node

Name of the node. (String, optional)

-server

Name of the server. (String, optional)

Return value

Batch mode example

Interactive mode


showMiddlewareApp

The showMiddlewareApp command displays the attributes of the middleware application.

Target object: None.

Required parameters

-app

Name of the application. (String, required)

Optional parameters

-edition

Name of the edition. (String, optional)

Return value

Batch mode example

Interactive mode


installWasCEApp

The installWasCEApp command installs a WebSphere Application Server Community Edition application.

Target object: None.

Required parameters

-app

Name of the application. (String, required)

-archive

Location of the archive file. (String, required)

Optional parameters

-edition

Name of the edition. (String, optional)

-description

Description of the edition.

-plan

Location of the external deployment plan.

-webModules: [[moduleName1 contextRoot1 virtualHost1][moduleName2 contextRoot2 virtualHost2]...]

Specifies the Web modules. Each moduleName value must match the name contained in the deployment descriptor file.

-clusterTargets

Cluster targets. Apply this parameter to the entire application.

-serverTargets

Server targets. Apply this parameter to the entire application.

Return value

Batch mode example

Interactive mode


startWasCEApp

The startWasCEApp command starts a WebSphere Application Server Community Edition application.

Target object: None.

Required parameters

-app

Name of the application. (String, required)

Optional parameters

-edition

Name of the edition. (String, optional)

Return value

Batch mode example

Interactive mode


stopWasCEApp

The stopWasCEApp command stops a WebSphere Application Server Community Edition application.

Target object: None.

Required parameters

-app

Name of the application. (String, required)

Optional parameters

-edition

Name of the edition. (String, optional)

Return value

Batch mode example

Interactive mode


undeployWasCEApp

The undeployWasCEApp command removes a representation of a WebSphere Application Server Community Edition application.

Target object: None.

Required parameters

-app

Name of the application. (String, required)

-node

Name of the node. (String, required)

-server

Name of the server. (String, required)

Optional parameters

-edition

Name of the edition. (String, optional)

Return value

Batch mode example

Interactive mode


uninstallMiddlewareApp

The uninstallMiddlewareApp command uninstalls the middleware application.

Target object: None.

Required parameters

-app

Name of the application. (String, required)

Optional parameters

-edition

Name of the edition. (String, optional)

Return value

Batch mode example

Interactive mode


unregisterApp

The unregisterApp command removes an unmanaged middleware application.

Target object: None.

Required parameters

-app

Name of the middleware application. (String, required)

Optional parameters

-edition

Name of the edition. (String, optional)

Return value

Batch mode example

Interactive mode

Reference topic