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 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 will receive a message that you are running in the local mode. If a server is currently running, it is not recommended to run the AdminApp tool in local mode.
The following public commands are available for the AdminApp object:
Parameters: | appname |
Return Type: | none |
Example usage:
Using Jacl:
$AdminApp deleteUserAndGroupEntries myapp
Parameters using Jacl: | appname -- java.lang.String options -- java.lang.String |
Return Type: | java.lang.String |
Example usage:
Using Jacl:
$AdminApp edit "JavaMail Sample" {-MapWebModToVH {{"JavaMail Sample WebApp" mtcomps.war,WEB-INF/web.xml newVH}}}
Note: The edit command changes the application deployment. Specify these changes in the options parameter. No options are required for the edit command.
Parameters using Jacl:: | appname -- java.lang.String; options -- java.lang.String |
Return Type: | java.lang.String |
Example usage:
Using Jacl:
$AdminApp editInteractive ivtApp
Note: The editInteractive command changes the application deployment. Specify these changes in the options parameter. No options are required for the editInteractive command.
Parameters: | appname, filename |
Return Type: | none |
Example usage:
Using Jacl:
$AdminApp export "My App" /usr/me/myapp.ear
Parameters: | appname, directoryname, options |
Return Type: | none |
Example usage:
Using Jacl:
$AdminApp exportDDL "My App" /usr/me/DDL {-ddlprefix myApp}
Parameters: | none |
Return Type: | none |
Example usage:
Using Jacl:
$AdminApp help
Example output:
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 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 install task for a given file uninstall Uninstalls an application, given an application name and an option string
Parameters: | operation name |
Return Type: | none |
Example usage:
Using Jacl:
$AdminApp help uninstall
Example output:
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.
Parameters using Jacl: | earfile -- java.lang.String; options -- java.lang.String |
Return Type: | none |
Example usage:
Using Jacl:
$AdminApp install c:/apps/myapp.earThere are many options available for this command. You can obtain a list of valid options for an EAR file with the following command:
Using Jacl:
$AdminApp options myApp.earYou can also obtain help for each object with the following command:
Using Jacl:
$AdminApp help MapModulesToServers
Parameters using Jacl: | earfile -- java.lang.String; options - java.lang.String |
Return Type: | none |
Example usage:
Using Jacl:
$AdminApp installInteractive c:/websphere/appserver/installableApps/jmsample.ear
Parameters: | application name |
Returns: | true or false |
Example usage:
Using Jacl:
$AdminApp isAppReady DefaultApplication
Example output:
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. true
Parameters: | application name, ignoreUnknownState |
Returns: | true or false |
Example usage:
Using Jacl:
$AdminApp isAppReady TEST true
Example output:
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
Parameters: | none |
Return Type: | java.lang.String |
Example usage:
Using Jacl:
$AdminApp list
Example output:
adminconsole DefaultApplication ivtApp
Parameters: | appname -- java.lang.String | options -- java.lang.String |
Return Type: | java.lang.String |
The options parameter is optional. The valid option is -server. This option lists the application servers on which the modules are installed.
Example usage:
Using Jacl:
$AdminApp listModules ivtApp
Example output:
ivtApp#ivtEJB.jar+META-INF/ejb-jar.xml ivtApp#ivt_app.war+WEB-INF/web.xmlThis example is formed by the concatenation of appname, #, module URI, +, and DD URI. You can pass this string to the edit and editInteractive AdminApp commands.
Parameters: | earfile |
Return Type: | Information about the valid installation options for an EAR file. |
Example usage:
Using Jacl:
$AdminApp options c:/websphere/appserver/installableApps/jmsample.ear
Parameters: | appname, filename |
Return Type: | none |
Example usage:
Using Jacl:
$AdminApp publishWSDL JAXRPCHandlerServer c:/temp/a.zip
Parameters: | appname, filename, soapAddressPrefixes |
Return Type: | none |
Example usage:
Using Jacl:
$AdminApp publishWSDL JAXRPCHandlersServer c:/temp/a.zip {{JAXRPCHandlersServerApp.war {{http http://localhost:9080}}}}
Parameters: | earfile, task name |
Return Type: | none |
Example usage:
Using Jacl:
$AdminApp taskInfo c:/websphere/appserver/installableApps/jmsample.ear MapWebModToVH
Example output:
MapWebModToVH: Selecting virtual hosts for Web modules Specify the virtual host where you want to install the Web modules 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 3 fields: "webModule," "uri," "virtualHost." Of these fields, the following may 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
Parameters: | appname -- java.lang.String |
Return Type: | none |
Example usage:
Using Jacl:
$AdminApp uninstall myApp
Example 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.
The bALL Boolean parameter retrieves and saves all access IDs for users and groups in the application bindings. Specify false if you want to retrieve access IDs for users or groups that do not have an access ID in the application bindings.
Parameters: | appname, bALL |
Return Type: | none |
Example usage:
Using Jacl:
$AdminApp updateAccessIDs myapp true
Parameters: | name |
Return Type: | java.lang.String |
Example usage:
Using Jacl:
$AdminApp view adminconsole
Example output:
MapRolesToUsers: Mapping Users to Roles
You must map each role defined in the application or module to a user or group from the user registry of the domain:
Role: administrator Everyone?: No All Authenticated?: No Mapped Users: Mapped Groups: Role: operator Everyone?: No All Authenticated?: No Mapped Users: Mapped Groups: Role: configurator Everyone?: No All Authenticated?: No Mapped Users: Mapped Groups: Role: monitor Everyone?: No All Authenticated?: No Mapped Users: Mapped Groups:
MapWebModToVH: Selecting Virtual Hosts for Web Modules
Specify the virtual host where you want to install the Web modules contained in your application. You can install Web modules on the same virtual host or dispersed among several hosts:
Web Module: adminconsole URI: adminconsole.war,WEB-INF/web.xml Virtual Host: admin_host
MapModulesToServers: Selecting Application Servers
Specify the application server where you want to install modules contained in your application. You can install modules 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
Specify the various options available to prepare and install your application:
Directory to Install Application: $(APP_INSTALL_ROOT)/juniartiNetwork Distribute Application: Yes Use Binary Configuration: No Application Name: adminconsole Create MBeans for Resources: Yes Enable Class Reloading: No Reload Interval in Seconds: 0