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

• addMiddlewareTarget

• deployWasCEApp

• exportMiddlewareApp

• exportMiddlewareAppScript

• listMiddlewareAppEditions

• listMiddlewareApps

• listMiddlewareAppWebModules

• listMiddlewareTargets

• modifyMiddlewareAppWebModule

• modifyPHPApp

• modifyUnmanagedWebApp

• modifyWasCEApp

• removeMiddlewareAppWebModule

• removeMiddlewareTarget

• showMiddlewareApp

• installWasCEApp

• startWasCEApp

• stopWasCEApp

• undeployWasCEApp

• uninstallMiddlewareApp

• unregisterApp

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

• Jacl:
  $AdminTask addMiddlewareAppWebModule {-app myJavaEEApplication -moduleName myModule -contextRoot /MyJ2EEApp -virtualHost default_host -node AppServerNode1 -server tomcatServer1}

• Jython string...
  AdminTask.addMiddlewareAppWebModule ('[-app myJavaEEApplication -moduleName myModule -contextRoot /MyJ2EEApp -virtualHost default_host -node AppServerNode1 -server tomcatServer1]')

• Jython list:
  AdminTask.addMiddlewareAppWebModule (['-app', 'myJavaEEApplication', '-moduleName', 'myModule', '-contextRoot', '/MyJ2EEApp', '-virtualHost', 'default_host', '-node', 'AppServerNode1', '-server', 'tomcatServer1'])

Interactive mode

• Jacl:
  $AdminTask addMiddlewareAppWebModule {-interactive}

• Jython string...
  AdminTask.addMiddlewareAppWebModule ('[-interactive]')

• Jython list:
  AdminTask.addMiddlewareAppWebModule (['-interactive'])

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

• Jacl:
  $AdminTask addMiddlewareTarget {-app myJavaEEApplication -node AppServerNode1 -server tomcatServer1}

• Jython string...
  AdminTask.addMiddlewareTarget ('[-app myJavaEEApplication -node AppServerNode1 -server tomcatServer1]')

• Jython list:
  AdminTask.addMiddlewareTarget (['-app', 'myJavaEEApplication', '-node', 'AppServerNode1', '-server', 'tomcatServer1'])

Interactive mode

• Jacl:
  $AdminTask addMiddlewareTarget {-interactive}

• Jython string...
  AdminTask.addMiddlewareTarget ('[-interactive]')

• Jython list:
  AdminTask.addMiddlewareTarget (['-interactive'])

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

• Jacl:
  $AdminTask deployWasCEApp {-app newSample -edition 2 -node nodeName -server WasCEServerRep}

• Jython string...
  AdminTask.deployWasCEApp ('[-app newSample -edition 2 -node nodeName -server WasCEServerRep]')

• Jython list:
  AdminTask.deployWasCEApp (['-app', 'newSample', '-edition', '2', '-node', 'nodeName', '-server', 'WasCEServerRep'])

Interactive mode

• Jacl:
  $AdminTask deployWasCEApp {-interactive}

• Jython string...
  AdminTask.deployWasCEApp ('[-interactive]')

• Jython list:
  AdminTask.deployWasCEApp (['-interactive'])

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

• Jacl:
  $AdminTask exportMiddlewareApp {-app sample -dir /home/user1}

• Jython string...
  AdminTask.exportMiddlewareApp ('[-app sample -dir /home/user1]')

• Jython list:
  AdminTask.exportMiddlewareApp (['-app', 'sample', '-dir', '/home/user1'])

Interactive mode

• Jacl:
  $AdminTask exportMiddlewareApp {-interactive}

• Jython string...
  AdminTask.exportMiddlewareApp ('[-interactive]')

• Jython list:
  AdminTask.exportMiddlewareApp (['-interactive'])

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

• Jacl:
  $AdminTask exportMiddlewareAppScript {-app sample -dir /home/user1}

• Jython string...
  AdminTask.exportMiddlewareAppScript ('[-app sample -dir /home/user1]')

• Jython list:
  AdminTask.exportMiddlewareAppScript (['-app', 'sample', '-dir', '/home/user1'])

Interactive mode

• Jacl:
  $AdminTask exportMiddlewareAppScript {-interactive}

• Jython string...
  AdminTask.exportMiddlewareAppScript ('[-interactive]')

• Jython list:
  AdminTask.exportMiddlewareAppScript (['-interactive'])

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

• Jacl:
  $AdminTask listMiddlewareAppEditions {-app sample}

• Jython string...
  AdminTask.listMiddlewareAppEditions ('[-app sample]')

• Jython list:
  AdminTask.listMiddlewareAppEditions (['-app', 'sample'])

Interactive mode

• Jacl:
  $AdminTask listMiddlewareAppEditions {-interactive}

• Jython string...
  AdminTask.listMiddlewareAppEditions ('[-interactive]')

• Jython list:
  AdminTask.listMiddlewareAppEditions (['-interactive'])

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

• Jacl:
  $AdminTask listMiddlewareApps

• Jython string...
  AdminTask.listMiddlewareApps()

• Jython list:
  AdminTask.listMiddlewareApps()

Interactive mode

• Jacl:
  $AdminTask listMiddlewareApps {-interactive}

• Jython string...
  AdminTask.listMiddlewareApps ('[-interactive]')

• Jython list:
  AdminTask.listMiddlewareApps (['-interactive'])

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

• Jacl:
  $AdminTask listMiddlewareAppWebModules {-app sample -edition 1}

• Jython string...
  AdminTask.listMiddlewareAppWebModules ('[-app sample -edition 1]')

• Jython list:
  AdminTask.listMiddlewareAppWebModules (['-app', 'sample', '-edition', '1'])

Interactive mode

• Jacl:
  $AdminTask listMiddlewareAppWebModules {-interactive}

  Using Jython string:

  AdminTask.listMiddlewareAppWebModules ('[-interactive]')

• Jython list:
  AdminTask.listMiddlewareAppWebModules (['-interactive'])

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

• Jacl:
  $AdminTask listMiddlewareTargets {-app sample}

• Jython string...
  AdminTask.listMiddlewareTargets ('[-app sample]')

• Jython list:
  AdminTask.listMiddlewareTargets (['-app', 'sample'])

Interactive mode

• Jacl:
  $AdminTask listMiddlewareTargets {-interactive}

• Jython string...
  AdminTask.listMiddlewareTargets ('[-interactive]')

• Jython list:
  AdminTask.listMiddlewareTargets (['-interactive'])

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

• Jacl:
  $AdminTask modifyMiddlewareAppWebModule {-app sample -edition 1 -renameEdition 2 -description Update Edition}

• Jython string...
  AdminTask.modifyMiddlewareAppWebModule ('[-app sample -edition 1 -renameEdition 2 -description Update Edition]')

• Jython list:
  AdminTask.modifyMiddlewareAppWebModule (['-app', 'sample', '-edition', '1', '-renameEdition', '2', '-description', 'Update Edition'])

Interactive mode

• Jacl:
  $AdminTask modifyMiddlewareAppWebModule {-interactive}

• Jython string...
  AdminTask.modifyMiddlewareAppWebModule ('[-interactive]')

• Jython list:
  AdminTask.modifyMiddlewareAppWebModule (['-interactive'])

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

• Jacl:
  $AdminTask modifyPHPApp {-app myPHPApplication -edition 1 -renameEdition 1.0.0}

• Jython string...
  AdminTask.modifyPHPApp ('[-app myPHPApplication -edition 1 -renameEdition 1.0.0]')

• Jython list:
  AdminTask.modifyPHPApp (['-app', 'myPHPApplication', '-edition', '1', '-renameEdition', '1.0.0'])

Interactive mode

• Jacl:
  $AdminTask modifyPHPApp {-interactive}

• Jython string...
  AdminTask.modifyPHPApp ('[-interactive]')

• Jython list:
  AdminTask.modifyPHPApp (['-interactive'])

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

• Jacl:
  $AdminTask modifyUnmanagedWebApp {-app sample -edition 1 -renameEdition 2 -description Update Edition}

• Jython string...
  AdminTask.modifyUnmanagedWebApp ('[-app sample -edition 1 -renameEdition 2 -description Update Edition]')

• Jython list:
  AdminTask.modifyUnmanagedWebApp (['-app', 'sample', '-edition', '1', -renameEdition', '2', '-description', 'Update Edition'])

Interactive mode

• Jacl:
  $AdminTask modifyUnmanagedWebApp {-interactive}

• Jython string...
  AdminTask.modifyUnmanagedWebApp ('[-interactive]')

• Jython list:
  AdminTask.modifyUnmanagedWebApp (['-interactive'])

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

• Jacl:
  $AdminTask installWasCEAapp {-app sample -edition 1 -renameEdition 2 -description Update Edition}

• Jython string...
  AdminTask.modifyWasCEApp ('[-app sample-edition 1 -renameEdition 2 -description Update Edition]')

• Jython list:
  AdminTask.modifyWasCEApp (['-app', 'sample','-edition', '1', 'renameEdition', '2', '-description', 'Update Edition'])

Interactive mode

• Jacl:
  $AdminTask modifyWasCEApp {-interactive}

• Jython string...
  AdminTask.modifyWasCEApp ('[-interactive]')

• Jython list:
  AdminTask.modifyWasCEApp (['-interactive'])

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

• Jacl:
  $AdminTask removeMiddlewareAppWebModule {-app sample -edition 1 -moduleName myModule}

• Jython string...
  AdminTask.removeMiddlewareAppWebModule ('[-app sample -edition 1 -moduleName myModule]')

• Jython list:
  AdminTask.removeMiddlewareAppWebModule (['-app', 'sample', '-edition', '1', '-moduleName', 'myModule'])

Interactive mode

• Jacl:
  $AdminTask removeMiddlewareAppWebModule {-interactive}

• Jython string...
  AdminTask.removeMiddlewareAppWebModule ('[-interactive]')

• Jython list:
  AdminTask.removeMiddlewareAppWebModule (['-interactive'])

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

• Jacl:
  $AdminTask removeMiddlewareTarget {-app sample -cluster cluster1}

• Jython string...
  AdminTask.removeMiddlewareTarget ('[-app sample -cluster cluster1]')

• Jython list:
  AdminTask.removeMiddlewareTarget (['-app', 'sample', '-cluster', 'cluster1'])

Interactive mode

• Jacl:
  $AdminTask removeMiddlewareTarget {-interactive}

• Jython string...
  AdminTask.removeMiddlewareTarget ('[-interactive]')

• Jython list:
  AdminTask.removeMiddlewareTarget (['-interactive'])

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

• Jacl:
  $AdminTask showMiddlewareApp {-app sample}

• Jython string...
  AdminTask.showMiddlewareApp ('[-app sample]')

• Jython list:
  AdminTask.showMiddlewareApp (['-app', 'sample'])

Interactive mode

• Jacl:
  $AdminTask showMiddlewareApp {-interactive}

• Jython string...
  AdminTask.showMiddlewareApp ('[-interactive]')

• Jython list:
  AdminTask.showMiddlewareApp (['-interactive'])

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

• Jacl:
  $AdminTask installWasCEApp {-app sample -archive /tmp/sample.ear -edition 1 -serverTargets {{myserver01 WASCE_2.0.0.2_myserver01_DS_1}} -webModules {{samplemicrowebapp.war /B default_host}}}

• Jython string...
  AdminTask.installWasCEApp ('[-app sample -archive /tmp/sample.ear -edition 1 -serverTargets [[myserver01 WASCE_2.0.0.2_myserver01_DS_1]] -webModules [[samplemicrowebapp.war /B default_host}}]')

• Jython list:
  AdminTask.installWasCEApp (['-app', 'sample', '-archive', '/tmp/sample.ear', '-edition', '1', '-serverTargets', '[[myserver01 WASCE_2.0.0.2_myserver01_DS_1]]', '-webModules', '[[samplemicrowebapp.war /B default_host]]'])

Interactive mode

• Jacl:
  $AdminTask installWasCEApp {-interactive}

• Jython string...
  AdminTask.installWasCEApp ('[-interactive]')

• Jython list:
  AdminTask.installWasCEApp (['-interactive'])

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

• Jacl:
  $AdminTask startWasCEApp {-app sample -edition 1}

• Jython string...
  AdminTask.startWasCEApp ('[-app sample -edition 1]')

• Jython list:
  AdminTask.startWasCEApp (['-app', 'sample', '-edition', '1'])

Interactive mode

• Jacl:
  $AdminTask startWasCEApp {-interactive}

• Jython string...
  AdminTask.startWasCEApp ('[-interactive]')

• Jython list:
  AdminTask.startWasCEApp (['-interactive'])

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

• Jacl:
  $AdminTask stopWasCEApp {-app sample -edition 1}

• Jython string...
  AdminTask.stopWasCEApp ('[-app sample -edition 1]')

• Jython list:
  AdminTask.stopWasCEApp (['-app', 'sample', '-edition', '1'])

Interactive mode

• Jacl:
  $AdminTask stopWasCEApp {-interactive}

• Jython string...
  AdminTask.stopWasCEApp ('[-interactive]')

• Jython list:
  AdminTask.stopWasCEApp (['-interactive'])

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

• Jacl:
  $AdminTask undeployWasCEApp {-app sample -edition 2 -node nodeName -server WasCEServerRep}

• Jython string...
  AdminTask.undeployWasCEApp ('[-app newSample -edition 2 -node nodeName -server WasCEServerRep]')

• Jython list:
  AdminTask.undeployWasCEApp (['-app', 'newSample', '-edition', '2', '-node', 'nodeName', '-server', 'WasCEServerRep'])

Interactive mode

• Jacl:
  $AdminTask undeployWasCEApp {-interactive}

• Jython string...
  AdminTask.undeployWasCEApp ('[-interactive]')

• Jython list:
  AdminTask.undeployWasCEApp (['-interactive'])

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

• Jacl:
  $AdminTask uninstallMiddlewareApp {-app sample -edition 1}

• Jython string...
  AdminTask.uninstallMiddlewareApp ('[-app sample -edition 1]')

• Jython list:
  AdminTask.uninstallMiddlewareApp (['-app', 'sample', '-edition', '1'])

Interactive mode

• Jacl:
  $AdminTask uninstallMiddlewareApp {-interactive}

• Jython string...
  AdminTask.uninstallMiddlewareApp ('[-interactive]')

• Jython list:
  AdminTask.uninstallMiddlewareApp (['-interactive'])

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

• Jacl:
  $AdminTask unregisterApp {-app sample -edition 1}

• Jython string...
  AdminTask.unregisterApp ('[-app sample -edition 1]')

• Jython list:
  AdminTask.unregisterApp (['-app', 'sample', '-edition', '1'])

Interactive mode

• Jacl:
  $AdminTask unregisterApp {-interactive}

• Jython string...
  AdminTask.unregisterApp ('[-interactive]')

• Jython list:
  AdminTask.unregisterApp (['-interactive'])

Reference topic