Application installation and uninstallation scripts

The scripting library provides multiple script procedures to automate the application configurations. See the usage information for scripts that install applications. We can run each script individually or combine procedures to create custom automation scripts for your environment.

Each application management script procedure is located in the app_server_root/scriptLibraries/application/V70 directory. Use the following script procedures to install and uninstall applications:

• installAppWithDefaultBindingOption

• installAppWithNodeAndServerOptions

• installAppWithClusterOption

• installAppModulesToSameServerWithMapModulesToServersOption

• installAppModulesToDiffServersWithMapModulesToServersOption

• installAppModulesToSameServerWithPatternMatching

• installAppModulesToDiffServersWithPatternMatching

• installAppModulesToMultiServersWithPatternMatching

• installAppWithTargetOption

• installAppWithDeployEjbOptions

• installAppWithVariousTasksAndNonTasksOptions

• installWarFile

• uninstallApplication

The file path specified for the earFile argument can use forward (/) or backward (\) slashes. For example, both c:\ears\MyApp.ear and c:/ears/MyApp.ear are supported values for earFile.

installAppWithDefaultBindingOption

This script installs an application using the -usedefaultbindings option.

To run the script, specify the application name, EAR file, data source JNDI name, data source user name, data source password, connection factory, Enterprise JavaBeans prefix, and virtual host name arguments, as defined in the following table:

Argument	Description
appName	Name of the application to install.
earFile	Specifies the EAR file to deploy.
nodeName	Name of the target node.
serverName	Name of the target server.
dsJndiName	Specifies the JNDI name of the data source to use.
dsUserName	User name for the data source.
dsPassword	Password for the data source.
connFactory	Name of the connection factory to use.
EJBprefix	Specifies the EJB prefix to use.
virtualHostName	Virtual host for the application to install.

Syntax

AdminApplication.installAppWithDefaultBindingOption(appName, earFile, nodeName, serverName, dsJndiName, dsUserName, dsPassword, connFactory, EJBprefix, virtualHostName)

Example usage

AdminApplication.installAppWithDefaultBindingOption("myApp", "c:/ears/DefaultApplication.ear", "myNode", "myServer", "myJndi", "user1", "password", "myCf", "myEjb", "myVH")

AdminApplication.installAppWithDefaultBindingOption("myApp", "/ears/DefaultApplication.ear", "myNode", "myServer", "myJndi", "user1", "password", "myCf", "myEjb", "myVH")

installAppWithNodeAndServerOptions

This script installs an application using the -node and -server options.

To run the script, specify the application name, EAR file, node name, and server name arguments, as defined in the following table:

Argument	Description
appName	Name of the application to install.
earFile	Specifies the EAR file to deploy.
nodeName	Name of the node of interest.
serverName	Name of the application server of interest.

Syntax

AdminApplication.installAppWithNodeAndServerOptions(appName, earFile, nodeName, serverName)

Example usage

AdminApplication.installAppWithNodeAndServerOptions("myApp", "c:/ears/DefaultApplication.ear", "myNode", "myServer")

AdminApplication.installAppWithNodeAndServerOptions("myApp", "/ears/DefaultApplication.ear", "myNode", "myServer")

installAppWithClusterOption

This script installs an application using the -cluster option.

To run the script, specify the application name, EAR file, and cluster name arguments, as defined in the following table:

Argument	Description
appName	Name of the application to install.
earFile	Specifies the EAR file to deploy.
clusterName	Name of the cluster of interest.

Syntax

AdminApplication.installAppWithClusterOption(appName, earFile, clusterName)

Example usage

AdminApplication.installAppWithClusterOption("myApp", "c:/ears/DefaultApplication.ear", "myCluster")

AdminApplication.installAppWithClusterOption("myApp", "/ears/DefaultApplication.ear", "myCluster")

installAppModulesToSameServerWithMapModulesToServersOption

This script deploys application modules to the same server using the -MapModulesToServers option.

To run the script, specify the application name, EAR file, node name, and server name arguments, as defined in the following table:

Argument	Description
appName	Name of the application to install.
earFile	Specifies the EAR file to deploy.
nodeName	Name of the node of interest.
serverName	Name of the application server of interest.

Syntax

AdminApplication.installAppModulesToSameServerWithMapModulesToServersOption(appName, earFile, nodeName, serverName)

Example usage

AdminApplication.installAppModulesToSameServerWithMapModulesToServersOption("myApp", "c:/ears/DefaultApplication.ear", "myNode", "myServer")

AdminApplication.installAppModulesToSameServerWithMapModulesToServersOption("myApp", "/ears/DefaultApplication.ear", "myNode", "myServer")

installAppModulesToDiffServersWithMapModulesToServersOption

This script deploys application modules to different servers using the -MapModulesToServers option. Use this script to install application modules to one or two servers. To install to additional servers, create a custom script based on the syntax in the AdminApplication.py file, or run the script multiple times.

To run the script, specify the application name, EAR file, node name, and both server name arguments, as defined in the following table:

Argument	Description
appName	Name of the application to install.
earFile	Specifies the EAR file to deploy.
nodeName	Name of the node of interest.
serverName1	Name of the application server to which the application is deployed.
serverName2	Name of an additional application server to which the application is deployed.

Syntax

AdminApplication.installAppModulesToDiffServersWithMapModulesToServersOption(appName, earFile, nodeName, serverName1, serverName2)

Example usage

AdminApplication.installAppModulesToDiffServersWithMapModulesToServersOption("myApp", "c:/ears/DefaultApplication.ear", "myCell", "myNode", "myServer1", "myServer2")

AdminApplication.installAppModulesToDiffServersWithMapModulesToServersOption("myApp", "/ears/DefaultApplication.ear", "myCell", "myNode", "myServer1", "myServer2")

installAppModulesToSameServerWithPatternMatching

This script deploys application modules with the -MapModulesToServers pattern matching option.

To run the script, specify the application name, EAR file, node name, and server name arguments, as defined in the following table:

Argument	Description
appName	Name of the application to install.
earFile	Specifies the EAR file to deploy.
nodeName	Name of the node of interest.
serverName	Name of the application server of interest.

Syntax

AdminApplication.installAppModulesToSameServerWithPatternMatching(appName, earFile, nodeName, serverName)

Example usage

AdminApplication.installAppModulesToSameServerUingPatternMatching("myApp", "c:\ears\DefaultApplication.ear", "myNode", "myServer")

AdminApplication.installAppModulesToSameServerUingPatternMatching("myApp", "/ears/DefaultApplication.ear", "myNode", "myServer")

installAppModulesToDiffServersWithPatternMatching

This script deploys application modules to different servers using the -MapModulesToServers pattern matching option. Use this script to install application modules to one or two servers. To install to additional servers, create a custom script based on the syntax in the AdminApplication.py file, or run the script multiple times.

To run the script, specify the application name, EAR file, node name, and both server name arguments, as defined in the following table:

Argument	Description
appName	Name of the application to install.
earFile	Specifies the EAR file to deploy.
nodeName	Name of the node of interest.
serverName1	Name of the application server to which the application is deployed.
serverName2	Name of an additional application server to which the application is deployed.

Syntax

AdminApplication.installAppModulesToDiffServersWithPatternMatching(appName, earFile, nodeName, serverName1, serverName2)

Example usage

AdminApplication.installAppModulesToDiffServersWithPatternMatching("myApp", "c:\ears\DefaultApplication.ear", "myNode", "myServer1", "myServer2")

AdminApplication.installAppModulesToDiffServersWithPatternMatching("myApp", "/ears/DefaultApplication.ear", "myNode", "myServer1", "myServer2")

installAppModulesToMultiServersWithPatternMatching

This script deploys application modules to multiple servers using the -MapModulesToServers pattern matching option. Use this script to install application modules to one or two servers. To install to additional servers, create a custom script based on the syntax in the AdminApplication.py file, or run the script multiple times.

To run the script, specify the application name, EAR file, node name, and each server name arguments, as defined in the following table:

Argument	Description
appName	Name of the application to install.
earFile	Specifies the EAR file to deploy.
nodeName	Name of the node of interest.
serverName1	Name of the application server to which the application is deployed.
serverName2	Name of an additional application server to which the application is deployed.

Syntax

AdminApplication.installAppModulesToMultiServersWithPatternMatching(appName, earFile, nodeName, serverName1, serverName2)

Example usage

AdminApplication.installAppModulesToMultiServersWithPatternMatching("myApp", "c:\ears\DefaultApplication.ear", "myCell", "myNode", "myServer1", "myServer2")

AdminApplication.installAppModulesToMultiServersWithPatternMatching("myApp", "/ears/DefaultApplication.ear", "myCell", "myNode", "myServer1", "myServer2")

installAppWithTargetOption

This script deploys an application to multiple servers using the -target option. Use this script to install application modules to one or two servers. To install to additional servers, create a custom script based on the syntax in the AdminApplication.py file, or run the script multiple times.

To run the script, specify the application name, EAR file, node name, and each server name arguments, as defined in the following table:

Argument	Description
appName	Name of the application to install.
earFile	Specifies the EAR file to deploy.
nodeName	Name of the node of interest.
serverName1	Name of the application server to which the application is deployed.
serverName2	Name of an additional application server to which the application is deployed.

Syntax

AdminApplication.installAppWithTargetOption(appName, earFile, nodeName, serverName1, serverName2)

Example usage

AdminApplication.installAppWithTargetOption("myApp", "c:\ears\DefaultApplication.ear", "myNode", "myServer1", "myServer2")

AdminApplication.installAppWithTargetOption("myApp", "/ears/DefaultApplication.ear", "myNode", "myServer1", "myServer2")

installAppWithDeployEjbOptions

This script deploys an application with the -deployejb option.

To run the script, specify the application name and EAR file arguments, as defined in the following table:

Argument	Description
appName	Name of the application to install.
earFile	Specifies the EAR file to deploy.
nodeName	Name of the target node.
serverName	Name of the target server.

Syntax

AdminApplication.installAppWithDeployEjbOptions(appName, earFile, nodeName, serverName)

Example usage

AdminApplication.installAppWithDeployEjbOptions("myApp", "c:\ears\DefultApplication.ear", "myNode", "myServer")

AdminApplication.installAppWithDeployEjbOptions("myApp", "/ears/DefultApplication.ear", "myNode", "myServer")

installAppWithVariousTasksAndNonTasksOptions

This script deploys an application with various tasks and non-tasks options.

To run the script, specify the application name and EAR file arguments, as defined in the following table:

Argument	Description
appName	Name of the application to install.
earFile	Specifies the EAR file to deploy.

Syntax

AdminApplication.installAppWithVariousTasksAndNonTasksOptions(appName, earFile)

Example usage

AdminApplication.installAppWithVariousTasksAndNonTasksOptions("myApp", "c:\ears\DefaultApplication.ear")

AdminApplication.installAppWithVariousTasksAndNonTasksOptions("myApp", "/ears/DefaultApplication.ear")

installWarFile

This script installs a WAR file. A web module is created by assembling servlets, JSP files, and static content such as Hypertext Markup Language (HTML) pages into a single deployable unit. Web modules are stored in WAR files, which are standard Java archive files.

To run the script, specify the application name, WAR file, node name, server name, and context root arguments, as defined in the following table:

Argument	Description
appName	Name of the application to install.
warFile	Specifies the WAR file to deploy.
nodeName	Name of the node of interest.
serverName	Name of the application server of interest.
contextRoot	Context root of the web application. The context root is combined with the defined servlet mapping (from the WAR file) to compose the full URL that users type to access the servlet. For example, if the context root is /gettingstarted and the servlet mapping is MySession, then the URL is http://host:port/gettingstarted/MySession.

Syntax

AdminApplication.installWarFile(appName, warFile, nodeName, serverName, contextRoot)

Example usage

AdminApplication.installWarFile("myApp", "c:\binaries\DefaultWebApplication.war", "myNode", "myServer", "/")

AdminApplication.installWarFile("myApp", "/binaries/DefaultWebApplication.war", "myNode", "myServer", "/")

uninstallApplication

This script uninstalls an application.

To run the script, specify the application name argument, as defined in the following table:

Argument	Description
appName	Name of the application to uninstall.

Syntax

AdminApplication.uninstallApplication(appName)

Example usage

AdminApplication.uninstallApplication("myApp")

Related tasks

Use the script library to automate the application serving environment

Automating application configurations

Application administration scripts

Application query scripts

Application update scripts

Application export scripts

Application deployment configuration scripts