181 lines
9.5 KiB
HTML
181 lines
9.5 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<META http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<LINK rel="stylesheet" type="text/css" href="../../../rzahg/ic.css">
|
||
|
|
|
||
|
|
<title>The AdminApp object for scripted administration</title>
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<BODY>
|
||
|
|
<!-- Java sync-link -->
|
||
|
|
<SCRIPT LANGUAGE="Javascript" SRC="../../../rzahg/synch.js" TYPE="text/javascript"></SCRIPT>
|
||
|
|
|
||
|
|
<h5><a name="wsaobjadmapp"></a>The AdminApp object for scripted administration</h5>
|
||
|
|
|
||
|
|
<p>The AdminApp object interacts with the WebSphere Application Server management and configuration services to administer applications. For example, you can use the AdminApp object to install and uninstall applications, list the modules for an application, and export an application.</p>
|
||
|
|
|
||
|
|
<p>You can invoke most of the AdminApp functions in local mode, which means that the client does not communicate with the server to accomplish the function. To run in local mode, use the -conntype NONE option when you start the scripting client. If a server is running, it is not recommended that you run the AdminApp tool in local mode.</p>
|
||
|
|
|
||
|
|
<p>For additional information about the AdminApp object, see these topics:</p>
|
||
|
|
<ul>
|
||
|
|
<li><a href="help/rxml_taskoptions.html">Installation options for the AdminApp object</a> <img src="help.gif" width="18" height="15" align="absbottom" alt="Go to Help documentation"></li>
|
||
|
|
<li><a href="help/rxml_taskinfo.html">Example: Obtaining information about task options for the AdminApp install command</a> <img src="help.gif" width="18" height="15" align="absbottom" alt="Go to Help documentation"></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>The following public methods are available for the AdminApp object:</p>
|
||
|
|
|
||
|
|
<p><strong>deleteUserAndGroupEntries</strong><br>
|
||
|
|
Deletes users or groups for all roles, and deletes userids and passwords for all of the RunAs roles defined in the application.</p>
|
||
|
|
<p>Parameters: appname</p>
|
||
|
|
<p>Example usage:</p>
|
||
|
|
<pre>$AdminApp deleteUserAndGroupEntries myapp</pre>
|
||
|
|
|
||
|
|
<p><strong>edit</strong><br>
|
||
|
|
Edits an application or module in interactive mode.</p>
|
||
|
|
<p>Parameters: appname, options</p>
|
||
|
|
<p>Example usage:</p>
|
||
|
|
<pre>$AdminApp edit "JavaMail Sample" {-MapWebModToVH {{"JavaMail
|
||
|
|
Sample WebApp" mtcomps.war,WEB-INF/web.xml newVH}}}</pre>
|
||
|
|
<p>Note: The edit command changes the application deployment. Specify these changes in the options parameter. No options are required for the edit command.</p>
|
||
|
|
|
||
|
|
<p><strong>editInteractive</strong><br>
|
||
|
|
Edits an application or module in interactive mode.</p>
|
||
|
|
<p>Parameters: appname, options</p>
|
||
|
|
<p>Example usage:</p>
|
||
|
|
<pre>$AdminApp editInteractive ivtApp</pre>
|
||
|
|
<p><strong>Note:</strong> The editInteractive command changes the application deployment. Specify these changes in the options parameter. No options are required for the editInteractive command.</p>
|
||
|
|
|
||
|
|
<p><strong>export</strong><br>
|
||
|
|
Exports the application appname parameter to a file you specify by file name.</p>
|
||
|
|
<p>Parameters: appname, filename</p>
|
||
|
|
<p>Example usage:</p>
|
||
|
|
<pre>$AdminApp export "My App" /usr/me/myapp.ear</pre>
|
||
|
|
|
||
|
|
<p><strong>exportDDL</strong><br>
|
||
|
|
Extracts the description definition language (DDL) from the application appname parameter to the directoryname parameter that a directory specifies.</p>
|
||
|
|
<p>Note: This command is not supported when running from a system with only standalone scripting client install.</p>
|
||
|
|
<p>Parameters: appname, directoryname, options</p>
|
||
|
|
<p>Example usage:</p>
|
||
|
|
<pre>$AdminApp exportDDL "My App" /usr/me/DDL</pre>
|
||
|
|
|
||
|
|
<p><strong>help</strong><br>
|
||
|
|
Displays help for the AdminApp object and AdminApp commands.</p>
|
||
|
|
<p>Output:</p>
|
||
|
|
<pre>wsadmin>$AdminApp help
|
||
|
|
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</pre>
|
||
|
|
|
||
|
|
<p><strong>install</strong><br>
|
||
|
|
Installs an application in non-interactive mode, given a fully qualified file name and a string of installation options.</p>
|
||
|
|
<p>Note: This command is not supported when running from a system with only standalone scripting client install.</p>
|
||
|
|
<p>Parameters: earfile, options</p>
|
||
|
|
<p>Example usage:</p>
|
||
|
|
<pre>$AdminApp install /home/mydir/apps/myapp.ear</pre>
|
||
|
|
<p>There are many options available for this command. You can obtain a list of valid options for an EAR file with the following command:</p>
|
||
|
|
<pre>$AdminApp options <earfilename></pre>
|
||
|
|
<p>You can also obtain help for each object with the following command:</p>
|
||
|
|
<pre>$AdminApp help <optionname></pre>
|
||
|
|
|
||
|
|
<p><strong>installInteractive</strong><br>
|
||
|
|
Installs an application in interactive mode, given a fully qualified file name and a string of installation options.</p>
|
||
|
|
<p>Note: This command is not supported when running from a system with only standalone scripting client install.</p>
|
||
|
|
<p>Parameters: earfile, options</p>
|
||
|
|
<p>Example usage:</p>
|
||
|
|
<pre>$AdminApp installInteractive /QIBM/UserData/WebASE/ASE5/myInstance/installableApps/jmsample.ear</pre>
|
||
|
|
|
||
|
|
<p><strong>list</strong><br>
|
||
|
|
Lists the applications installed in the configuration.</p>
|
||
|
|
<p>Parameters: none</p>
|
||
|
|
<p>Example usage:</p>
|
||
|
|
<pre>$AdminApp list</pre>
|
||
|
|
<p>Example output:</p>
|
||
|
|
<pre>wsadmin>$AdminApp list
|
||
|
|
adminconsole
|
||
|
|
DefaultApplication
|
||
|
|
ivtApp</pre>
|
||
|
|
|
||
|
|
<p><strong>listModules</strong><br>
|
||
|
|
Lists the modules in an application.</p>
|
||
|
|
<p>Parameters: appname, options</p>
|
||
|
|
<p>Example usage:</p>
|
||
|
|
<pre>$AdminApp listModules ivtApp</pre>
|
||
|
|
<p>Example output:</p>
|
||
|
|
<pre>wsadmin>$AdminApp listModules ivtApp
|
||
|
|
ivtApp#ivtEJB.jar+META-INF/ejb-jar.xml
|
||
|
|
ivtApp#ivt_app.war+WEB-INF/web.xml</pre>
|
||
|
|
<p>This 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.</p>
|
||
|
|
|
||
|
|
<p><strong>options</strong><br>
|
||
|
|
Displays a list of options for installing an EAR file.</p>
|
||
|
|
<p>Parameters: earfile</p>
|
||
|
|
<p>Example usage:</p>
|
||
|
|
<pre>$AdminApp options /QIBM/UserData/WebASE/ASE5/myInstance/installableApps/jmsample.ear</pre>
|
||
|
|
|
||
|
|
<p><strong>publishWSDL</strong><br>
|
||
|
|
Publishes WSDL files for the application specified in the appname parameter to the file specified in the filename parameter using the soap address prefixes specified in the soapAddressPrefixes parameter.</p>
|
||
|
|
<p>Parameters: appname, filename, soapAddressPrefixes</p>
|
||
|
|
<p>Example usage:</p>
|
||
|
|
<pre>$AdminApp publishWSDL JAXRPCHandlersServer /temp/a.zip
|
||
|
|
{{JAXRPCHandlersServerApp.war {{http http://localhost:9080}}}}</pre>
|
||
|
|
|
||
|
|
<p><strong>taskInfo</strong><br>
|
||
|
|
Provides information about a particular task option for an application file.</p>
|
||
|
|
<p>Parameters: earfile, task name</p>
|
||
|
|
<p>Example usage:</p>
|
||
|
|
<pre>$AdminApp taskInfo /QIBM/UserData/WebASE/ASE5/myInstance/installableApps/jmsample.ear
|
||
|
|
MapWebModToVH</pre>
|
||
|
|
<p>Example output:</p>
|
||
|
|
<pre>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: null</pre>
|
||
|
|
|
||
|
|
<p><strong>updateAccessIDs</strong><br>
|
||
|
|
Updates the access id information for users and groups assigned to various roles defined in the application. The access ids are read from the user registry and saved in the application bindings. It is recommended that you call this method after you install an application or after you edit security role information for an installed application. The scripting client must be connected to the application server when you invoke this command.</p>
|
||
|
|
<p>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.</p>
|
||
|
|
<p>Parameters: appname, bAll</p>
|
||
|
|
<p>Example usage:</p>
|
||
|
|
<pre>$AdminApp updateAccessIDs myapp true</pre>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|