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. 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
- 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
- Name of the edition. This parameter is 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 usage
- Use Jacl:
$AdminTask addMiddlewareAppWebModule {-app myJ2EEApplication -moduleName myModule -contextRoot /MyJ2EEApp -virtualHost default_host -node AppServerNode1 -server tomcatServer1}- Use Jython string:
AdminTask.addMiddlewareAppWebModule ('[-app myJ2EEApplication -moduleName myModule -contextRoot /MyJ2EEApp -virtualHost default_host -node AppServerNode1 -server tomcatServer1]')- Use Jython list:
AdminTask.addMiddlewareAppWebModule (['-app', 'myJ2EEApplication', '-moduleName', 'myModule', '-contextRoot', '/MyJ2EEApp', '-virtualHost', 'default_host', '-node', 'AppServerNode1', '-server', 'tomcatServer1'])Interactive mode example usage
- Use Jacl:
$AdminTask addMiddlewareAppWebModule {-interactive}- Use Jython string:
AdminTask.addMiddlewareAppWebModule ('[-interactive]')- Use 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. This parameter is 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 usage
- Use Jacl:
$AdminTask addMiddlewareTarget {-app myJ2EEApplication -node AppServerNode1 -server tomcatServer1}- Use Jython string:
AdminTask.addMiddlewareTarget ('[-app myJ2EEApplication -node AppServerNode1 -server tomcatServer1]')- Use Jython list:
AdminTask.addMiddlewareTarget (['-app', 'myJ2EEApplication', '-node', 'AppServerNode1', '-server', 'tomcatServer1'])Interactive mode example usage
- Use Jacl:
$AdminTask addMiddlewareTarget {-interactive}- Use Jython string:
AdminTask.addMiddlewareTarget ('[-interactive]')- Use 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 usage
- Use Jacl:
$AdminTask deployWasCEApp {-app newSample -edition 2 -node nodeName -server WasCEServerRep}- Use Jython string:
AdminTask.deployWasCEApp ('[-app newSample -edition 2 -node nodeName -server WasCEServerRep]')- Use Jython list:
AdminTask.deployWasCEApp (['-app', 'newSample', '-edition', '2', '-node', 'nodeName', '-server', 'WasCEServerRep'])Interactive mode example usage
- Use Jacl:
$AdminTask deployWasCEApp {-interactive}- Use Jython string:
AdminTask.deployWasCEApp ('[-interactive]')- Use 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. This parameter is required if the specified application has more than one edition. (String, optional)
Return value
Batch mode example usage
- Use Jacl:
$AdminTask exportMiddlewareApp {-app sample -dir /home/user1}- Use Jython string:
AdminTask.exportMiddlewareApp ('[-app sample -dir /home/user1]')- Use Jython list:
AdminTask.exportMiddlewareApp (['-app', 'sample', '-dir', '/home/user1'])Interactive mode example usage
- Use Jacl:
$AdminTask exportMiddlewareApp {-interactive}- Use Jython string:
AdminTask.exportMiddlewareApp ('[-interactive]')- Use 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
- 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
- Use Jacl:
$AdminTask exportMiddlewareAppScript {-app sample -dir /home/user1}- Use Jython string:
AdminTask.exportMiddlewareAppScript ('[-app sample -dir /home/user1]')- Use Jython list:
AdminTask.exportMiddlewareAppScript (['-app', 'sample', '-dir', '/home/user1'])Interactive mode example usage
- Use Jacl:
$AdminTask exportMiddlewareAppScript {-interactive}- Use Jython string:
AdminTask.exportMiddlewareAppScript ('[-interactive]')- Use 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 usage
- Use Jacl:
$AdminTask listMiddlewareAppEditions {-app sample}- Use Jython string:
AdminTask.listMiddlewareAppEditions ('[-app sample]')- Use Jython list:
AdminTask.listMiddlewareAppEditions (['-app', 'sample'])Interactive mode example usage
- Use Jacl:
$AdminTask listMiddlewareAppEditions {-interactive}- Use Jython string:
AdminTask.listMiddlewareAppEditions ('[-interactive]')- Use Jython list:
AdminTask.listMiddlewareAppEditions (['-interactive'])
listMiddlewareApps
The listMiddlewareApps command list all of the middleware applications.
Target object
None.
Required parameters
- -app
- 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
- Use Jacl:
$AdminTask listMiddlewareApps {-app sample}- Use Jython string:
AdminTask.listMiddlewareApps ('[-app sample]')- Use Jython list:
AdminTask.listMiddlewareApps (['-app', 'sample'])Interactive mode example usage
- Use Jacl:
$AdminTask listMiddlewareApps {-interactive}- Use Jython string:
AdminTask.listMiddlewareApps ('[-interactive]')- Use 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 usage
- Use Jacl:
$AdminTask listMiddlewareAppWebModules {-app sample -edition 1}- Use Jython string:
AdminTask.listMiddlewareAppWebModules ('[-app sample -edition 1]')- Use Jython list:
AdminTask.listMiddlewareAppWebModules (['-app', 'sample', '-edition', '1'])Interactive mode example usage
- Use Jacl:
$AdminTask listMiddlewareAppWebModules {-interactive}Using Jython string:AdminTask.listMiddlewareAppWebModules ('[-interactive]')- Use 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 usage
- Use Jacl:
$AdminTask listMiddlewareTargets {-app sample}- Use Jython string:
AdminTask.listMiddlewareTargets ('[-app sample]')- Use Jython list:
AdminTask.listMiddlewareTargets (['-app', 'sample'])Interactive mode example usage
- Use Jacl:
$AdminTask listMiddlewareTargets {-interactive}- Use Jython string:
AdminTask.listMiddlewareTargets ('[-interactive]')- Use 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
- Specifies how the edition is modified. (String, optional)
Return value
Batch mode example usage
- Use Jacl:
$AdminTask modifyMiddlewareAppWebModule {-app sample -edition 1 -renameEdition 2 -description Update Edition}- Use Jython string:
AdminTask.modifyMiddlewareAppWebModule ('[-app sample -edition 1 -renameEdition 2 -description Update Edition]')- Use Jython list:
AdminTask.modifyMiddlewareAppWebModule (['-app', 'sample', '-edition', '1', '-renameEdition', '2', '-description', 'Update Edition'])Interactive mode example usage
- Use Jacl:
$AdminTask modifyMiddlewareAppWebModule {-interactive}- Use Jython string:
AdminTask.modifyMiddlewareAppWebModule ('[-interactive]')- Use 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
- Specifies the edition of the PHP application. (String, optional)
- -renameEdition
- New name of the edition. (String, optional)
- -description
- 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
- Name of the virtual host. (String, optional)
Return value
Batch mode example usage
- Use Jacl:
$AdminTask modifyPHPApp {-app myPHPApplication -edition 1 -renameEdition 1.0.0}- Use Jython string:
AdminTask.modifyPHPApp ('[-app myPHPApplication -edition 1 -renameEdition 1.0.0]')- Use Jython list:
AdminTask.modifyPHPApp (['-app', 'myPHPApplication', '-edition', '1', '-renameEdition', '1.0.0'])Interactive mode example usage
- Use Jacl:
$AdminTask modifyPHPApp {-interactive}- Use Jython string:
AdminTask.modifyPHPApp ('[-interactive]')- Use 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 usage
- Use Jacl:
$AdminTask modifyUnmanagedWebApp {-app sample -edition 1 -renameEdition 2 -description Update Edition}- Use Jython string:
AdminTask.modifyUnmanagedWebApp ('[-app sample -edition 1 -renameEdition 2 -description Update Edition]')- Use Jython list:
AdminTask.modifyUnmanagedWebApp (['-app', 'sample', '-edition', '1', -renameEdition', '2', '-description', 'Update Edition'])Interactive mode example usage
- Use Jacl:
$AdminTask modifyUnmanagedWebApp {-interactive}- Use Jython string:
AdminTask.modifyUnmanagedWebApp ('[-interactive]')- Use 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 usage
- Using Jacl:
$AdminTask installWasCEAapp {-app sample -edition 1 -renameEdition 2 -description Update Edition}- Using Jython string:
AdminTask.modifyWasCEApp ('[-app sample-edition 1 -renameEdition 2 -description Update Edition]')- Use Jython list:
AdminTask.modifyWasCEApp (['-app', 'sample','-edition', '1', 'renameEdition', '2', '-description', 'Update Edition'])Interactive mode example usage
- Use Jacl:
$AdminTask modifyWasCEApp {-interactive}- Use Jython string:
AdminTask.modifyWasCEApp ('[-interactive]')- Use 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 usage
- Use Jacl:
$AdminTask removeMiddlewareAppWebModule {-app sample -edition 1 -moduleName myModule}- Use Jython string:
AdminTask.removeMiddlewareAppWebModule ('[-app sample -edition 1 -moduleName myModule]')- Use Jython list:
AdminTask.removeMiddlewareAppWebModule (['-app', 'sample', '-edition', '1', '-moduleName', 'myModule'])Interactive mode example usage
- Use Jacl:
$AdminTask removeMiddlewareAppWebModule {-interactive}- Use Jython string:
AdminTask.removeMiddlewareAppWebModule ('[-interactive]')- Use 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 usage
- Use Jacl:
$AdminTask removeMiddlewareTarget {-app sample -cluster cluster1}- Use Jython string:
AdminTask.removeMiddlewareTarget ('[-app sample -cluster cluster1]')- Use Jython list:
AdminTask.removeMiddlewareTarget (['-app', 'sample', '-cluster', 'cluster1'])Interactive mode example usage
- Using Jacl:
$AdminTask removeMiddlewareTarget {-interactive}- Use Jython string:
AdminTask.removeMiddlewareTarget ('[-interactive]')- Use 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 usage
- Use Jacl:
$AdminTask showMiddlewareApp {-app sample}- Use Jython string:
AdminTask.showMiddlewareApp ('[-app sample]')- Use Jython list:
AdminTask.showMiddlewareApp (['-app', 'sample'])Interactive mode example usage
- Use Jacl:
$AdminTask showMiddlewareApp {-interactive}- Use Jython string:
AdminTask.showMiddlewareApp ('[-interactive]')- Use 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
- Specifies the location of the archive file. (String, required)
Optional parameters
- -edition
- Name of the edition. (String, optional)
- -description
- 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
- Use Jacl:
$AdminTask installWasCEApp {-app sample -archive /tmp/sample.war -edition 1 -description Sample Application}- Use Jython string:
AdminTask.installWasCEApp ('[-app sample -archive /tmp/sample.war -edition 1 -description Sample Application]')- Use Jython list:
AdminTask.installWasCEApp (['-app', 'sample', '-archive', '/tmp/sample.war', '-edition', '1', '-description', 'Sample Application'])Interactive mode example usage
- Use Jacl:
$AdminTask installWasCEApp {-interactive}- Use Jython string:
AdminTask.installWasCEApp ('[-interactive]')- Use 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 usage
- Use Jacl:
$AdminTask startWasCEApp {-app sample -edition 1}- Use Jython string:
AdminTask.startWasCEApp ('[-app sample -edition 1]')- Use Jython list:
AdminTask.startWasCEApp (['-app', 'sample', '-edition', '1'])Interactive mode example usage
- Use Jacl:
$AdminTask startWasCEApp {-interactive}- Use Jython string:
AdminTask.startWasCEApp ('[-interactive]')- Use 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 usage
- Use Jacl:
$AdminTask stopWasCEApp {-app sample -edition 1}- Use Jython string:
AdminTask.stopWasCEApp ('[-app sample -edition 1]')- Use Jython list:
AdminTask.stopWasCEApp (['-app', 'sample', '-edition', '1'])Interactive mode example usage
- Use Jacl:
$AdminTask stopWasCEApp {-interactive}- Use Jython string:
AdminTask.stopWasCEApp ('[-interactive]')- Use 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 usage
- Use Jacl:
$AdminTask undeployWasCEApp {-app sample -edition 2 -node nodeName -server WasCEServerRep}- Use Jython string:
AdminTask.undeployWasCEApp ('[-app newSample -edition 2 -node nodeName -server WasCEServerRep]')- Use Jython list:
AdminTask.undeployWasCEApp (['-app', 'newSample', '-edition', '2', '-node', 'nodeName', '-server', 'WasCEServerRep'])Interactive mode example usage
- Use Jacl:
$AdminTask undeployWasCEApp {-interactive}- Use Jython string:
AdminTask.undeployWasCEApp ('[-interactive]')- Use 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 usage
- Use Jacl:
$AdminTask uninstallMiddlewareApp {-app sample -edition 1}- Use Jython string:
AdminTask.uninstallMiddlewareApp ('[-app sample -edition 1]')- Use Jython list:
AdminTask.uninstallMiddlewareApp (['-app', 'sample', '-edition', '1'])Interactive mode example usage
- Use Jacl:
$AdminTask uninstallMiddlewareApp {-interactive}- Use Jython string:
AdminTask.uninstallMiddlewareApp ('[-interactive]')- Use 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 usage
- Use Jacl:
$AdminTask unregisterApp {-app sample -edition 1}- Use Jython string:
AdminTask.unregisterApp ('[-app sample -edition 1]')- Use Jython list:
AdminTask.unregisterApp (['-app', 'sample', '-edition', '1'])Interactive mode example usage
- Use Jacl:
$AdminTask unregisterApp {-interactive}- Use Jython string:
AdminTask.unregisterApp ('[-interactive]')- Use Jython list:
AdminTask.unregisterApp (['-interactive'])