Use the AdminApp object to install, modify, and administer applications.
The AdminApp object interacts with the WebSphere Application Server management and configuration services to make application inquiries and changes. This interaction includes installing and uninstalling applications, listing modules, exporting, and so on.
You can start the scripting client when no server is running, if you want to use only local operations. To run in local mode, use the -conntype NONE option to start the scripting client. You receive a message that you are running in the local mode. Running the AdminApp object in local mode when a server is currently running is not recommended. This is because any configuration changes made in local mode will not be reflected in the running server configuration and vice versa. If you save a conflicting configuration, you could corrupt the configuration.
In a deployment manager environment, configuration updates are available only if a scripting client is connected to a deployment manager.
When connected to a node agent or a managed application server, you will not be able to update the configuration because the configuration for these server processes are copies of the master configuration which resides in the deployment manager. The copies are created on a node machine when a configuration synchronization occurs between the deployment manager and the node agent. Make configuration changes to the server processes by connecting a scripting client to a deployment manager. For this reason, to change a configuration, do not run a scripting client in local mode on a node machine. It is not a supported configuration. The following commands are available for the AdminApp object:
Use the deleteUserAndGroupEntries command to delete users or groups for all roles, and to delete user IDs and passwords for all of the RunAs roles that are defined in the application.
Target object None.
Required parameters
Optional parameters None.
Examples
$AdminApp deleteUserAndGroupEntries myapp
print AdminApp.deleteUserAndGroupEntries('myapp')
print AdminTask.deleteUserAndGroupEntries(['myapp'])
Use the edit command to edit an application or module in batch mode. The edit command changes the application specified by the application name argument using the options specified by the options argument. No options are required for the edit command.
Target object None.
Required parameters
Optional parameters None.
Examples
$AdminApp edit "JavaMail Sample" {-MapWebModToVH {{"JavaMail Sample WebApp" mtcomps.war,WEB-INF/web.xml newVH}}}
print AdminApp.edit("JavaMail Sample", '[-MapWebModToVH [["JavaMail 32 Sample WebApp"
mtcomps.war,WEB-INF/web.xml newVH]]]')
option = [["JavaMail 32 Sample WebApp", "mtcomps.war,WEB-INF/web.xml", "newVH"]]
mapVHOption = ["-MapWebModToVH", option]
print AdminApp.edit("JavaMail Sample", mapVHOption)
Use the editInteractive command to edit an application or module in interactive mode. The editInteractive command changes the application deployment. Specify these changes in the options parameter. No options are required for the editInteractive command.
Target object None.
Required parameters
Optional parameters None.
Examples
$AdminApp editInteractive ivtApp
print AdminApp.editInteractive('ivtApp')
Use the export command to export the application name parameter to a file that you specify by the file name.
Target object None.
Required parameters
Optional parameters None.
Examples
$AdminApp export "My App" /usr/me/myapp.ear
print AdminApp.export("My App", '/usr/me/myapp.ear')
Use the exportDDL command to extract the data definition language (DDL) from the application name parameter to the directory name parameter that a directory specifies. The options parameter is optional.
Target object None.
Required parameters
Optional parameters
Examples
$AdminApp exportDDL "My App" /usr/me/DDL {-ddlprefix myApp}
print AdminApp.exportDDL("My App", '/usr/me/DDL', '[-ddlprefix myApp]')
Use the help command to display general help information about the AdminApp object.
Target object None.
Required parameters None.
Optional parameters
Sample output The following output is returned if you do not specify an argument:
WASX7095I: The AdminApp object allows application objects to be manipulated including installing, uninstalling, editing, and listing. Most of the commands supported by AdminApp operate in two modes: the default mode is one in which AdminApp communicates with the WebSphere Application Server to accomplish its tasks. A local mode is also possible, in which no server communication takes place. The local mode of operation is invoked by including the "-conntype NONE" flag in the option string supplied to the command. The following commands are supported by AdminApp; more detailed information about each of these commands is available by using the "help" command of AdminApp and supplying the name of the command as an argument. edit Edit the properties of an application editInteractive Edit the properties of an application interactively export Export application to a file exportDDL Extract DDL from application to a directory help Show help information install Installs an application, given a file name and an option string. installInteractive Installs an application in interactive mode, given a file name and an option string. list List all installed applications listModules List the modules in a specified application options Shows the options available, either for a given file, or in general. taskInfo Shows detailed information pertaining to a given installation task for a given file uninstall Uninstalls an application, given an application name and an option stringThe following output is returned if you specify uninstall as the operation name argument:
WASX7102I: Method: uninstall Arguments: application name, options Description: Uninstalls application named by "application name" using the options supplied by String 2. Method: uninstall Arguments: application name Description: Uninstalls the application specified by "application name" using default options.
Examples Using Jacl:
$AdminApp help
$AdminApp help uninstall
Using Jython:
print AdminApp.help()
print AdminApp.help('uninstall')
Use the install command to install an application in non-interactive mode, given a fully qualified file name and a string of installation options. The options parameter is optional.
Target object None.
Required parameters
Optional parameters
Examples
$AdminApp install c:/apps/myapp.ear
print AdminApp.install('c:/apps/myapp.ear')
Many options are available for this command. You can obtain a list of valid options for an Enterprise Archive (EAR) file with the following command:
Using Jacl:
$AdminApp options myApp.earUsing Jython:
print AdminApp.options('myApp.ear')
You
can also obtain help for each object with the following command:
Using Jacl:
$AdminApp help MapModulesToServersUsing Jython:
print AdminApp.help('MapModulesToServers')
Use the installInteractive command to install an application in interactive mode, given a fully qualified file name and a string of installation options. The options parameter is optional.
Target object None.
Required parameters
Optional parameters
Examples
$AdminApp installInteractive c:/websphere/appserver/installableApps/jmsample.ear
print AdminApp.installInteractive('c:/websphere/appserver/installableApps/jmsample.ear')
Use the isAppReady command to determine if the specified application has been distributed and is ready to be run. Returns a value of true if the application is ready, or a value of false if the application is not ready. This command is not supported when the wsadmin tool is not connected to a server.
Target object None.
Required parameters
Optional parameters
Sample output The following sample output is returned if you specify the application name parameter:
ADMA5071I: Distribution status check started for application DefaultApplication.WebSphere:cell=Node03Cell, node=myNode,distribution=true ADMA5011I: The cleanup of the temp directory for application DefaultApplication is complete. ADMA5072I: Distribution status check completed for application DefaultApplication.trueThe following sample output is returned if you specify the application name and ignoreUnknownState parameters:
ADMA5071I: Distribution status check started for application TEST.WebSphere:cell=myCell,node=myNode,distribution=unknown ADMA5011I: The cleanup of the temp directory for application TEST is complete. ADMA5072I: Distribution status check completed for application TEST.false
Examples The following examples only specify the application name parameter:
$AdminApp isAppReady DefaultApplication
print AdminApp.isAppReady('DefaultApplication')
The following examples specify the application name and ignoreUnknownState parameters:
Use the list command to list the applications that are installed in the configuration.
Target object None.
Required parameters None.
Optional parameters
Sample output
adminconsole DefaultApplication ivtApp
Examples
The following examples specify a value for the target parameter:
$AdminApp list WebSphere:cell=myCell,node=myNode,server=myServer
print AdminApp.list("WebSphere:cell=myCell,node=myNode,server=myServer")
Use the listModules command to list the modules in an application.
Target object None.
Required parameters
Optional parameters
Sample output The following example is the concatenation of appname, #, module URI, +, and DD URI. You can pass this string to the edit and editInteractive AdminApp commands.
ivtApp#ivtEJB.jar+META-INF/ejb-jar.xml ivtApp#ivt_app.war+WEB-INF/web.xml
Examples
Use the options command to display a list of options for installing an Enterprise Archive (EAR) file.
Target object None.
Required parameters None.
Optional parameters
Sample output
WASX7112I: The following options are valid for "ivtApp" MapRolesToUsers BindJndiForEJBNonMessageBinding MapEJBRefToEJB MapWebModToVH MapModulesToServers distributeApp nodistributeApp useMetaDataFromBinary nouseMetaDataFromBinary createMBeansForResources nocreateMBeansForResources reloadEnabled noreloadEnabled verbose installed.ear.destination reloadInterval
Examples The following example options command returns the valid options for an EAR file:
$AdminApp options c:/websphere/appserver/installableApps/ivtApp.ear
print AdminApp.options('c:/websphere/appserver/installableApps/ivtApp.ear')
The following example options command returns the valid options for an application:
The following example options command returns the valid options for an application module:
$AdminApp options ivtApp#ivtEJB.jar+META-INF/ejb-jar.xml
print AdminApp.options('ivtApp#ivtEJB.jar+META-INF/ejb-jar.xml')
The following example options command returns the valid options for the operation that is requested with the input file:
$AdminApp options c:/websphere/appserver/installableApps/ivtApp.ear updateapp
print AdminApp.options('c:/websphere/appserver/installableApps/ivtApp.ear', 'updateapp')
Use the publishWSDL command to publish Web Services Description Language (WSDL) files for the application that is specified in the application name parameter to the file that is specified in the file name parameter.
Target object None.
Required parameters
Optional parameters
Sample output
The publishWSDL command does not return output.
Examples The following example publishWSDL command specifies the application name and the file name:
$AdminApp publishWSDL JAXRPCHandlerServer c:/temp/a.zip
print AdminApp.publishWSDL('JAXRPCHandlerServer', 'c:/temp/a.zip')
The following example publishWSDL command specifies the application name, file name, and SOAP address prefixes parameter values:
$AdminApp publishWSDL JAXRPCHandlersServer c:/temp/a.zip {{JAXRPCHandlersServerApp.war {{http http://localhost:9080}}}}
print AdminApp.publishWSDL('JAXRPCHandlersServer', 'c:/temp/a.zip', '[[JAXRPCHandlersServerApp.war [[http http://localhost:9080]]]]')
Use the searchJNDIReferences command to list applications that refer to the Java Naming and Directory Interface (JNDI) name on a specific node.
Target object None.
Required parameters
Optional parameters
Sample output
WASX7410W: This operation may take a while depending on the number of applications installed in your system. MyApp MapResRefToEJB :ejb-jar-ic.jar : [eis/J2CCF1]
Examples The following example assumes that an installed application named MyApp has a JNDI name of eis/J2CCF1:
$AdminApp searchJNDIReferences $node {-JNDIName eis/J2CCF1 -verbose}
print AdminApp.searchJNDIReferences(node, '[-JNDIName eis/J2CCF1 -verbose]')
Use the taskinfo command to provide information about a particular task option for an application file. Many task names have changed between V5.x and V6.x for a similar or the exact same operation. You might need to update existing scripts if you are migrating from V5.x to V6.x.
Target object None.
Required parameters
Optional parameters None.
Sample output
MapWebModToVH: Selecting virtual hosts for Web modules Specify the virtual host where you want to install the Web modules that are contained in your application. Web modules can be installed on the same virtual host or dispersed among several hosts. Each element of the MapWebModToVH task consists of the following three fields: "webModule," "uri," "virtualHost." Of these fields, the following fields might be assigned new values: "virtualHost"and the following are required: "virtualHost" The current contents of the task after running default bindings are: webModule: JavaMail Sample WebApp uri: mtcomps.war,WEB-INF/web.xml virtualHost: default_host
Examples
$AdminApp taskInfo c:/websphere/appserver/installableApps/jmsample.ear MapWebModToVH
print AdminApp.taskInfo('c:/websphere/appserver/installableApps/jmsample.ear', 'MapWebModToVH')
Use the uninstall command uninstall an existing application.
Target object None.
Required parameters
Optional parameters None.
Sample output
ADMA5017I: Uninstallation of myapp started. ADMA5104I: Server index entry for myCellManager was updated successfully. ADMA5102I: Deletion of config data for myapp from config repository completed successfully. ADMA5011I: Cleanup of temp dir for app myapp done. ADMA5106I: Application myapp uninstalled successfully.
Examples
Use the updateAccessIDs command to update the access ID information for users and groups that are assigned to various roles that are defined in the application. The system reads the access IDs from the user registry and saves the IDs in the application bindings. This operation improves runtime performance of the application. Use this command after installing an application or after editing security role-specific information for an installed application. This method cannot be invoked when the -conntype option for the wsadmin tool is set to NONE. You must be connected to a server to invoke this command.
Target object None.
Required parameters
Optional parameters
Sample output
ADMA5017I: Uninstallation of myapp started. ADMA5104I: Server index entry for myCellManager was updated successfully. ADMA5102I: Deletion of config data for myapp from config repository completed successfully. ADMA5011I: Cleanup of temp dir for app myapp done. ADMA5106I: Application myapp uninstalled successfully.
Examples
$AdminApp updateAccessIDs myapp true
print AdminApp.updateAccessIDs('myapp', 'true')
Use the view command to view the task that is specified by the task name parameter for the application or module that is specified by the application name parameter. Use -tasknames as the option to get a list of valid task names for the application. Otherwise, specify one or more task names as the option.
Target object None.
Required parameters
Optional parameters
Sample output The command returns the following information if you specify the taskoptions value for the task name parameter:
MapModulesToServers MapWebModToVH MapRolesToUsersThe command returns the following information if you specify the mapModulesToServers task for the task name parameter:
MapModulesToServers: Selecting Application Servers Specify the application server where you want to install the modules that are contained in your application. Modules can be installed on the same server or dispersed among several servers: Module: adminconsole URI: adminconsole.war,WEB-INF/web.xml Server: WebSphere:cell=juniartiNetwork, node=juniartiManager,server=dmgr
Examples The following view command example lists each available task name:
$AdminApp view adminconsole {-tasknames}
print AdminApp.view('adminconsole', ['-tasknames'])
The following view command example returns information for the mapModulesToServer task:
$AdminApp view adminconsole {-MapModulesToServers}
print AdminApp.view('adminconsole', ['-MapModulesToServers'])
Use the update command to update an application in non-interactive mode. This command supports the addition, removal, and update of application subcomponents or the entire application. Provide the application name, content type, and update options.
Target object None.
Required parameters
Optional parameters
Sample output
Update of singleFile has started. ADMA5009I: Application archive extracted at C:\DOCUME~1\lavena\LOCALS~1\Temp\app_fb5a1960f0\ext Added files from partial ear: [] performFileOperation: source=C:\DOCUME~1\lavena\LOCALS~1\Temp\app_fb5a1960f0\ext, dest=C:\DOCUME~1\lavena\LOCALS~1\Temp\app_fb5a1960f0\mrg, uri= META-INF/web.xml, op= add Copying file from C:\DOCUME~1\lavena\LOCALS~1\Temp\app_fb5a1960f0\ext/META-INF/web.xml to C:\DOCUME~1\lavena\LOCALS~1\Temp\app_fb5a1960f0\mrg\META-INF\web.xml Collapse list is: [] FileMergeTask completed successfully ADMA5005I: Application singleFile configured in WebSphere repository delFiles: [] delM: null addM: null Pattern for remove loose and mod: Loose add pattern: META-INF/[^/]*|WEB-INF/[^/]*|.*wsdl root file to be copied: META-INF/web.xml to C:\asv\b0403.04\WebSphere\AppServer\wstemp\Scriptfb5a191b4e\workspace\cells\BAMBIE\applications\ singleFile.ear\deployments\singleFile/META-INF/web.xml ADMA5005I: Application singleFile configured in WebSphere repository xmlDoc: [#document: null] root element: [app-delta: null] ****** delta file name: C:\asv\b0403.04\WebSphere\AppServer\wstemp\Scriptfb5a191b4e\workspace\cells\BAMBIE\applications\ singleFile.ear/deltas/delta-1079548405564 ADMA5005I: Application singleFile configured in WebSphere repository ADMA6011I: Deleting directory tree C:\DOCUME~1\lavena\LOCALS~1\Temp\app_fb5a1960f0 ADMA5011I: Cleanup of temp dir for app singleFile done. Update of singleFile has ended.
Examples
Use the updateInteractive command to add, remove, and update application subcomponents or an entire application. When you update an application module or an entire application using interactive mode, the steps that you use to configure binding information are similar to those that apply to the installInteractive command. If you update a file or a partial application, the steps that you use to configure the binding information are not available. In this case, the steps are the same as the ones you use with the update command.
Target object None.
Required parameters
Optional parameters
Sample output
Getting tasks for: myApp WASX7266I: A was.policy file exists for this application; would you like to display it? [No] Task[4]: Binding enterprise beans to JNDI names Each non message driven enterprise bean in your application or module must be bound to a JNDI name. EJB Module: Increment Enterprise Java Bean EJB: Increment URI: Increment.jar,META-INF/ejb-jar.xml JNDI Name: [Inc]: Task[10]: Specifying the default data source for EJB 2.x modules Specify the default data source for the EJB 2.x Module containing 2.x CMP beans. WASX7349I: Possible value for resource authorization is container or per connection factory EJB Module: Increment Enterprise Java Bean URI: Increment.jar,META-INF/ejb-jar.xml JNDI Name: [DefaultDatasource]: Resource Authorization: [Per connection factory]: Task[12]: Specifying data sources for individual 2.x CMP beans Specify an optional data source for each 2.x CMP bean. Mapping a specific data source to a CMP bean overrides the default data source for the module containing the enterprise bean. WASX7349I: Possible value for resource authorization is container or per connection factory EJB Module: Increment Enterprise Java Bean EJB: Increment URI: Increment.jar,META-INF/ejb-jar.xml JNDI Name: [DefaultDatasource]: Resource Authorization: [Per connection factory]:container Setting "Resource Authorization" to "cmpBinding.container" Task[14]: Selecting Application Servers Specify the application server where you want to install modules that are contained in your application. Modules can be installed on the same server or dispersed among several servers. Module: Increment Enterprise Java Bean URI: Increment.jar,META-INF/ejb-jar.xml Server: [WebSphere:cell=myCell,node=myNode,server=server1]: Task[16]: Selecting method protections for unprotected methods for 2.x EJB Specify whether you want to assign security role to the unprotected method, add the method to the exclude list, or mark the method as unchecked. EJB Module: Increment Enterprise Java Bean URI: Increment.jar,META-INF/ejb-jar.xml Protection Type: [methodProtection.uncheck]: Task[18]: Selecting backend ID Specify the selection for the BackendID EJB Module: Increment Enterprise Java Bean URI: Increment.jar,META-INF/ejb-jar.xml BackendId list: CLOUDSCAPE_V50_1 CurrentBackendId: [CLOUDSCAPE_V50_1]: Task[21]: Specifying application options Specify the various options available to prepare and install your application. Pre-compile JSP: [No]: Deploy EJBs: [No]: Deploy WebServices: [No]: Task[22]: Specifying EJB deploy options Specify the options to deploy EJB. ....EJB Deploy option is not enabled. Task[24]: Copy WSDL files Copy WSDL files ....This task does not require any user input Task[25]: Specify options to deploy Web services Specify options to deploy Web services ....Web Services deploy option is not enabled. Update of myApp has started. ADMA5009I: Application archive extracted at C:\DOCUME~1\lavena\LOCALS~1\Temp\app_fb5a48e969\ext/Increment.jar FileMergeTask completed successfully ADMA5005I: Application myApp configured in WebSphere repository delFiles: [] delM: null addM: [Increment.jar, ] Pattern for remove loose and mod: Loose add pattern: META-INF/[^/]*|WEB-INF/[^/]*|.*wsdl root file to be copied: META-INF/application.xml to C:\asv\b0403.04\WebSphere\AppServer\wstemp\Scriptfb5a487089\workspace\cells\BAMBIE\ applications\testSM.ear\deployments\testSM/META-INF/application.xml del files for full module add/update: [] ADMA6017I: Saved document C:\asv\b0403.04\WebSphere\AppServer\wstemp\Scriptfb5a487089\workspace\cells\BAMBIE\ applications\testSM.ear\deployments\testSM/Increment.jar\META-INF/ejb-jar.xml ADMA6016I: Add to workspace Increment.jar/META-INF/ejb-jar.xml ADMA6017I: Saved document C:\asv\b0403.04\WebSphere\AppServer\wstemp\Scriptfb5a487089\workspace\cells\BAMBIE\ applications\testSM.ear\deployments\testSM/Increment.jar\META-INF/MANIFEST.MF ADMA6016I: Add to workspace Increment.jar/META-INF/MANIFEST.MF ADMA6017I: Saved document C:\asv\b0403.04\WebSphere\AppServer\wstemp\Scriptfb5a487089\workspace\cells\BAMBIE\ applications\testSM.ear\deployments\testSM/Increment.jar\META-INF/ibm-ejb-jar-bnd.xmi ADMA6016I: Add to workspace Increment.jar/META-INF/ibm-ejb-jar-bnd.xmi ADMA6017I: Saved document C:\asv\b0403.04\WebSphere\AppServer\wstemp\Scriptfb5a487089\workspace\cells\BAMBIE\ applications\testSM.ear\deployments\testSM/Increment.jar\META-INF/Table.ddl ADMA6016I: Add to workspace Increment.jar/META-INF/Table.ddl ADMA6017I: Saved document C:\asv\b0403.04\WebSphere\AppServer\wstemp\Scriptfb5a487089\workspace\cells\BAMBIE\ applications\testSM.ear\deployments\testSM/Increment.jar\META-INF/ibm-ejb-jar-ext.xmi ADMA6016I: Add to workspace Increment.jar/META-INF/ibm-ejb-jar-ext.xmi add files for full module add/update: [Increment.jar/META-INF/ejb-jar.xml, Increment.jar/META-INF/MANIFEST.MF, Increment.jar/META-INF/ibm-ejb-jar-bnd.xmi, Increment.jar/META-INF/Table.ddl, Increment.jar/META-INF/ibm-ejb-jar-ext.xmi] ADMA5005I: Application myApp configured in WebSphere repository xmlDoc: [#document: null] root element: [app-delta: null] ****** delta file name: C:\asv\b0403.04\WebSphere\AppServer\wstemp\Scriptfb5a487089\workspace\cells\BAMBIE\ applications\testSM.ear/deltas/delta-1079551520393 ADMA5005I: Application myApp configured in WebSphere repository ADMA6011I: Deleting directory tree C:\DOCUME~1\lavena\LOCALS~1\Temp\app_fb5a48e969 ADMA5011I: Cleanup of temp dir for app myApp done. Update of myApp has ended.
Examples