WebSphere Virtual Enterprise (formerly Operations Optimization), Version 6.1
             Operating Systems: AIX, HP-UX, Linux, Solaris, Windows


Middleware application administrative tasks

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

addMiddlewareAppWebModule

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

Target object

None.

Required parameters

-app
Specifies the name of the middleware application. (String, required)
-moduleName
Specifies the name of a module. (String, required)
-virtualHost
Specifies the name of the virtual host, which enables a single host machine to resemble multiple host machines. (String, required)
-contextRoot
Specifies the path prefix that is associated with the application. Use this parameter to compose the URL that is needed to access the application files. (String, required)

Optional parameters

-edition
Specifies the name of the edition. This parameter is required if the specified application has more than one edition. (String, optional)
-cluster
Specifies the name of the cluster. This parameter adds a dynamic cluster as a deployment target. (String, optional)
-node
Specifies the name of the node. (String, optional)
-server
Specifies the 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 usage

Interactive mode example usage

addMiddlewareTarget

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

Target object

None.

Required parameters

-app
Specifies the name of the middleware application. (String, required)

Optional parameters

-edition
Specifies the name of the edition. This parameter is required if the specified application has more than one edition. (String, optional)
-module
Specifies the name of the module. Use this parameter to narrow the scope of a command to a single module. (String, optional)
-cluster
Specifies the name of the cluster. Use this parameter to add a dynamic cluster as a deployment target. (String, optional)
-node
Specifies the name of the node. (String, optional)
-server
Specifies the 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 usage

Interactive mode example usage

deployWASCEApp [Version 6.1.0.1 and later]

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

Target object

None.

Required parameters

-app
Specifies the name of the middleware application. (String, required)
-node
Specifies the name of the node. (String, required)
-server
Specifies the name of the server. (String, required)

Optional parameters

-edition
Specifies the name of the edition. (String, optional)

Return value

Batch mode example usage

Interactive mode example usage

exportMiddlewareApp

The exportMiddlewareApp command exports a middleware application to a directory.

Target object

None.

Required parameters

-app
Specifies the name of the middleware application. (String, required)
-dir
Specifies the directory in which the application is located. (String, required)

Optional parameters

-edition
Specifies the name of the edition. This parameter is required if the specified application has more than one edition. (String, optional)

Return value

Batch mode example usage

Interactive mode example usage

exportMiddlewareAppScript

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

Target object

None.

Required parameters

-app
Specifies the name of the middleware application. (String, required)
-dir
Specifies the name of the directory in which the middleware application script is located. (String, required)

Optional parameters

-edition
Specifies the name of the edition. (String, optional)
-type
Specifies the 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 usage

Interactive mode example usage

listMiddlewareAppEditions

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

Target object

None.

Required parameters

-app
Specifies the name of the middleware application. (String, required)

Optional parameters

None.

Return value

The command returns a list of edition names.

Batch mode example usage

Interactive mode example usage

listMiddlewareApps

The listMiddlewareApps command list all of the middleware applications.

Target object

None.

Required parameters

-app
Specifies the name of the middleware application. (String, required)

Optional parameters

None.

Return value

The command returns a list of the middleware applications.

Batch mode example usage

Interactive mode example usage

listMiddlewareAppWebModules

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

Target object

None.

Required parameters

-app
Specifies the name of the middleware application. (String, required)
-edition
Specifies the name of the edition. (String, required)

Optional parameters

None.

Return value

Batch mode example usage

Interactive mode example usage

listMiddlewareTargets

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

Target object

None.

Required parameters

-app
Specifies the name of the middleware application. (String, required)

Optional parameters

-edition
Specifies the name of the edition. (String, optional)
-module
Specifies the name of the module. (String, optional)

Return value

The command returns a list of deployment target objects.

Batch mode example usage

Interactive mode example usage

modifyMiddlewareAppWebModule [Version 6.1.0.1 and later]

The modifyMiddlewareAppWebModule command modifies the virtual hosts of an application.

Target object

None.

Required parameters

-app
Specifies the name of the application. (String, required)

Optional parameters

-edition
Specifies the name of the edition. (String, optional)
-renameEdition
Specifies the new name of the edition. (String, optional)
-description
Specifies how the edition is modified. (String, optional)

Return value

Batch mode example usage

Interactive mode example usage

modifyPHPApp

The modifyPHPApp command updates a PHP application.

Target object

None.

Required parameters

-app
Specifies the name of the PHP application. (String, required)

Optional parameters

-edition
Specifies the edition of the PHP application. (String, optional)
-renameEdition
Specifies the new name of the edition. (String, optional)
-description
Specifies the description of the modified edition. (String, optional)
-archive
Specifies the path to the application archive file. (String, optional)
-setupScript
Specifies the path to the setup script file. (String, optional)
-cleanupScript
Specifies the path to the cleanup script file. (String, optional)
-contextRoot
Specifies the path prefix that is associated with the application. (String, optional)
-virtualHost
Specifies the name of the virtual host. (String, optional)

Return value

Batch mode example usage

Interactive mode example usage

modifyUnmanagedWebApp

The modifyUnmanagedWebApp command updates an unmanaged Web application.

Target object

None.

Required parameters

-app
Specifies the name of the application. (String, required)

Optional parameters

-edition
Specifies the name of the edition. (String, optional)
-renameEdition
Specifies the new name of the edition. (String, optional)
-description
Specifies the description of the modified edition. (String, optional)

Return value

Batch mode example usage

Interactive mode example usage

modifyWasCEApp [Version 6.1.0.1 and later]

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

Target object

None.

Required parameters

-app
Specifies the name of the application. (String, required)

Optional parameters

-edition
Specifies the name of the edition. (String, optional)
-renameEdition
Specifies the new name of the edition. (String, optional)
-description
Specifies the description of the edition. (String, optional)

Return value

Batch mode example usage

Interactive mode example usage

removeMiddlewareAppWebModule

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

Target object

None.

Required parameters

-app
Specifies the name of the middleware application. (String, required)

Optional parameters

-edition
Specifies the name of the edition. (String, optional)
-moduleName
Specifies the name of the Web module. (String, optional)
-cluster
Specifies the name of the cluster. (String, optional)
-node
Specifies the name of the node. (String, optional)
-server
Specifies the name of the server. (String, optional)

Return value

Batch mode example usage

Interactive mode example usage

removeMiddlewareTarget

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

Target object

None.

Required parameters

-app
Specifies the name of the middleware application. (String, required)

Optional parameters

-edition
Specifies the name of the edition. (String, optional)
-module
Specifies the name of the Web module. (String, optional)
-cluster
Specifies the name of the cluster. (String, optional)
-node
Specifies the name of the node. (String, optional)
-server
Specifies the name of the server. (String, optional)

Return value

Batch mode example usage

Interactive mode example usage

showMiddlewareApp

The showMiddlewareApp command displays the attributes of the middleware application.

Target object

None.

Required parameters

-app
Specifies the name of the application. (String, required)

Optional parameters

-edition
Specifies the name of the edition. (String, optional)

Return value

Batch mode example usage

Interactive mode example usage

installWasCEApp [Version 6.1.0.1 and later]

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

Target object

None.

Required parameters

-app
Specifies the name of the application. (String, required)
-archive
Specifies the location of the archive file. (String, required)

Optional parameters

-edition
Specifies the name of the edition. (String, optional)
-description
Specifies the description of the edition.
-plan
Specifies the location of the external deployment plan.
-webModules: [[moduleName1 contextRoot1 virtualHost1][moduleName2 contextRoot2 virtualHost2]...]
Specifies the Web modules. Each moduleName value must match the name that is contained in the deployment descriptor file.
-clusterTargets
Specifies the cluster targets. Apply this parameter to the entire application.
-serverTargets
Specifies the server targets. Apply this parameter to the entire application.

Return value

Batch mode example usage

Interactive mode example usage

startWasCEApp [Version 6.1.0.1 and later]

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

Target object

None.

Required parameters

-app
Specifies the name of the application. (String, required)

Optional parameters

-edition
Specifies the name of the edition. (String, optional)

Return value

Batch mode example usage

Interactive mode example usage

stopWasCEApp [Version 6.1.0.1 and later]

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

Target object

None.

Required parameters

-app
Specifies the name of the application. (String, required)

Optional parameters

-edition
Specifies the name of the edition. (String, optional)

Return value

Batch mode example usage

Interactive mode example usage

undeployWasCEApp [Version 6.1.0.1 and later]

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

Target object

None.

Required parameters

-app
Specifies the name of the application. (String, required)
-node
Specifies the name of the node. (String, required)
-server
Specifies the name of the server. (String, required)

Optional parameters

-edition
Specifies the name of the edition. (String, optional)

Return value

Batch mode example usage

Interactive mode example usage

uninstallMiddlewareApp

The uninstallMiddlewareApp command uninstalls the middleware application.

Target object

None.

Required parameters

-app
Specifies the name of the application. (String, required)

Optional parameters

-edition
Specifies the name of the edition. (String, optional)

Return value

Batch mode example usage

Interactive mode example usage

registerApp

The registerApp command registers a middleware application that is already installed on an unmanaged server.

Target object

None.

Required parameters

-app
Specifies the name of the middleware application. (String, required)

Optional parameters

-edition
Specifies the name of the edition. (String, optional)
-description
Specifies a description of the edition. (String, optional)
-webModules: [[moduleName1 contextRoot1 virtualHost1][moduleName2 contextRoot2 virutalHost2]...]
Specifies the Web modules. Each moduleName value must match the name that is contained in the deployment descriptor file. (String, optional)
-clusterTargets
Specifies the cluster targets. Apply this parameter to the entire application. (String, optional)
-serverTargets
Specifies the server targets. Apply this parameter to the entire application. (String, optional)

Return value

Batch mode example usage

Interactive mode example usage

unregisterApp

The unregisterApp command removes an unmanaged middleware application.

Target object

None.

Required parameters

-app
Specifies the name of the middleware application. (String, required)

Optional parameters

-edition
Specifies the name of the edition. (String, optional)

Return value

Batch mode example usage

Interactive mode example usage

Reference topic    

Terms of Use | Feedback

Last updated: Oct 30, 2009 6:15:26 PM EDT
http://publib.boulder.ibm.com/infocenter/wxdinfo/v6r1/index.jsp?topic=/com.ibm.websphere.ops.doc/info/reference/radtaskmiddleapps.html