Updating installed applications using the wsadmin scripting tool

Use the wsadmin tool and scripting to update installed applications on an application server.

About this task

Both the update command and the updateinteractive command support a set of options. You can also obtain a list of supported options for an Enterprise Archive (EAR) file using the options command, for example:

Using Jacl:

$AdminApp options

Using Jython:

print AdminApp.options()

You can set or update a configuration value using options in batch mode. To identify which configuration object is to be set or updated, the values of read only fields are used to find the corresponding configuration object. All the values of read only fields have to match with an existing configuration object, otherwise the command fails.

Attention: If an application is running, changing an application setting causes the application to restart. On stand-alone servers, the application restarts after you save the change. On multiple-server products, the application restarts after you save the change and files synchronize on the node where the application is installed. To control when synchronization occurs on multiple-server products, deselect Synchronize changes with nodes on the Console preferences page.

Perform the following steps to update an application:

Procedure

Start the wsadmin scripting tool.

Update the installed application using one of the following options.

The following command updates a single file in a deployed application:

Using Jacl:

$AdminApp update app1 file {-operation update -contents c:/apps/app1/my.xml 
 -contenturi app1.jar/my.xml}

$AdminApp update app1 file {-operation update -contents /apps/app1/my.xml 
 -contenturi app1.jar/my.xml}

$AdminApp update app1 file {-operation update -contents 
 /home/myProfile/apps/app1/my.xml -contenturi app1.jar/my.xml}

Using Jython string:

AdminApp.update('app1', 'file', '[-operation update -contents c:/apps/app1/my.xml  
 -contenturi app1.jar/my.xml]')

AdminApp.update('app1', 'file', '[-operation update -contents /apps/app1/my.xml  
 -contenturi app1.jar/my.xml]')

AdminApp.update('app1', 'file', '[-operation update -contents /home/myProfile/ 
 apps/app1/my.xml -contenturi app1.jar/my.xml]')

Using Jython list:

AdminApp.update('app1', 'file', ['-operation', 'update', '-contents', 
 'c:/apps/app1/my.xml', '-contenturi', 'app1.jar/my.xml'])

AdminApp.update('app1', 'file', ['-operation', 'update', '-contents', 
 '/apps/app1/my.xml',  '-contenturi', 'app1.jar/my.xml'])

AdminApp.update('app1', 'file', ['-operation', 'update', '-contents', 
 '/home/myProfile/apps/app1/my.xml', '-contenturi', 'app1.jar/my.xml'])

Table 1. update file command elements. Run the update command to change an installed application file.
Element	Definition
$	is a Jacl operator for substituting a variable name with its value
AdminApp	is an object that supports application objects management
update	is an AdminApp command
app1	is the name of the application to update
file	is the content type value
operation	is an option of the update command
update	is the value of the operation option
contents	is an option of the update command
`/apps/app1/my.xml`	is the value of the contents option
contenturi	is an option of the update command
`app1.jar/my.xml`	is the value of the contenturi option

The following command adds a module to the deployed application, if the module does not exist. Otherwise, the existing module is updated.

Using Jacl:

$AdminApp update app1 modulefile {-operation addupdate -contents 
 c:/apps/app1/app1.jar -contenturi app1.jar -nodeployejb}

$AdminApp update app1 modulefile {-operation addupdate -contents 
 c:/apps/app1/app1.jar -contenturi app1.jar -nodeployejb}

$AdminApp update app1 modulefile {-operation addupdate -contents  
 /home/myProfile/apps/app1/app1.jar -contenturi app1.jar -nodeployejb}

Using Jython string:

AdminApp.update('app1', 'modulefile', '[-operation addupdate -contents
c:/apps/app1/app1.jar -contenturi app1.jar -nodeployejb]')

AdminApp.update('app1', 'modulefile', '[-operation addupdate -contents 
 /apps/app1/Increment.jar -contenturi Increment.jar -nodeployejb
 -BindJndiForEJBNonMessageBinding [["Increment EJB module" Increment Increment.jar,META-INF/ejb-jar.xml Inc]]]')

AdminApp.update('app1', 'modulefile', '[-operation addupdate -contents
/home/myProfile/apps/app1/Iapp1.jar -contenturi app1.jar -nodeployejb]')

Using Jython list:

AdminApp.update('app1', 'modulefile', ['-operation', 'addupdate', '-contents',
'c:/apps/app1/app1.jar', '-contenturi', 'app1.jar', '-nodeployejb'])

bindJndiForEJBValue = [["Increment EJB module", "Increment", "Increment.jar,META-INF/ejb-jar.xml", 
"Inc"]]  AdminApp.update('app1', 'modulefile', ['-operation', 'addupdate', '-contents', 
 '/apps/app1/Increment.jar', '-contenturi','Increment.jar' '-nodeployejb', `-BindJndiForEJBNonMessageBinding', 
 bindJndiForEJBValue])

AdminApp.update('app1', 'modulefile', ['-operation', 'addupdate', '-contents',
'/home/myProfile/apps/app1/Iapp1.jar', '-contenturi', 'app1.jar', '-nodeployejb'])

Table 2. update modulefile command elements. Run the update command to change an installed module file.
Element	Definition
$	is a Jacl operator for substituting a variable name with its value
AdminApp	is an object that supports application objects management
update	is an AdminApp command
app1	is the name of the application to update
modulefile	is the content type value
operation	is an option of the update command
addupdate	is the value of the operation option
contents	is an option of the update command
/apps/app1/app1.jar	is the value of the contents option
contenturi	is an option of the update command
app1.jar	is the value of the contenturi option
nodeployejb	is an option of the update command

The following command uses a partial application to update a deployed application:

Using Jacl:

$AdminApp update app1 partialapp {-contents c:/apps/app1/app1Partial.zip}

$AdminApp update app1 partialapp {-contents /apps/app1/app1Partial.zip}

$AdminApp update app1 partialapp {-contents /home/myProfile/apps/app1/app1Partial.zip}

Using Jython string:

AdminApp.update('app1', 'partialapp', '[-contents 
 c:/apps/app1/app1Partial.zip]')

AdminApp.update('app1', 'partialapp', '[-contents /apps/app1/app1Partial.zip]')

AdminApp.update('app1', 'partialapp', '[-contents
 /home/myProfile/apps/app1/app1Partial.zip]')

Using Jython list:

AdminApp.update('app1', 'partialapp', ['-contents', 
 'c:/apps/app1/app1Partial.zip'])

AdminApp.update('app1', 'partialapp', ['-contents', 
 '/apps/app1/app1Partial.zip'])

AdminApp.update('app1', 'partialapp', ['-contents', 
 '/home/myProfile/apps/app1/app1Partial.zip'])

Table 3. update partialapp command elements. Run the update command to change part of an installed application.
Element	Definition
$	is a Jacl operator for substituting a variable name with its value
AdminApp	is an object that supports application objects management
update	is an AdminApp command
app1	is the name of the application to update
partialapp	is the content type value
contents	is an option of the update command
`/apps/app1/app1Partial.zip`	is the value of the contents option

Update the entire deployed application.

To use the existing listener port instead of using or creating a new activation specification, determine whether the EJB JAR version is earlier than 2.1. The system automatically creates and uses an activation specification when you specify the -usedefaultbindings option to deploy an application. If an activation specification exists, the system ignores the listener port, and instead uses the activation specification. To deploy an application with an EJB JAR version greater than or equal to 2.1 using the defined listener ports instead of a new activation specification, set the com.ibm.websphere.management.application.dfltbndng.mdb.preferexisting system property to true in the wsadmin.properties file in the properties directory of the profile of interest.

Using Jacl:

$AdminApp update app1 app {-operation update -contents c:/apps/app1/newApp1.ear 
 -usedefaultbindings -nodeployejb}

$AdminApp update app1 app {-operation update -contents /apps/app1/newApp1.ear 
 -usedefaultbindings -nodeployejb -BindJndiForEJBNonMessageBinding {{"Increment EJB module" Increment 
 Increment.jar,META-INF/ejb-jar.xml Inc}}}

$AdminApp update app1 app {-operation update -contents 
 /home/myProfile/apps/app1/newApp1.ear -usedefaultbindings -nodeployejb}

Using Jython string:

AdminApp.update('app1', 'app', '[-operation update -contents 
 c:/apps/app1/newApp1.ear  -usedefaultbindings -nodeployejb]')

AdminApp.update('app1', 'app', '[-operation update -contents 
 /apps/app1/newApp1.ear -usedefaultbindings -nodeployejb
 -BindJndiForEJBNonMessageBinding [["Increment EJB module" Increment 
 Increment.jar,META-INF/ejb-jar.xml Inc]]]')

AdminApp.update('app1', 'app', '[-operation update -contents 
 /home/myProfile/apps/app1/newApp1.ear -usedefaultbindings -nodeployejb]')

Using Jython list:

AdminApp.update('app1', 'app', ['-operation', 'update', '-contents',
'c:/apps/app1/newApp1.ear', '-usedefaultbindings', '-nodeployejb'])

AdminApp.update('app1', 'app', ['-operation', 'update', '-contents', 
 'c:/apps/app1/newApp1.ear', '-usedefaultbindings', '-nodeployejb'])

AdminApp.update('app1', 'app', ['-operation', 'update', '-contents',
'/home/myProfile/apps/app1/newApp1.ear', '-usedefaultbindings', '-nodeployejb'])

Any application analysis report generated for the application will be deleted and is not recoverable even if a configuration save is not performed.

Table 4. update app command elements. Run the update command to change an installed application.
Element	Definition
$	is a Jacl operator for substituting a variable name with its value
AdminApp	is an object that supports application objects management
update	is an AdminApp command
app1	is the name of the application to update
app	is the content type value
operation	is an option of the update command
update	is the value of the operation option
contents	is an option of the update command
`/apps/app1/newApp1.ear`	is the value of the contents option
usedefaultbindings	is an option of the update command
nodeployejb	is an option of the update command

Save the configuration changes.
Use the following command example to save your configuration changes:
```
AdminConfig.save()
```
In a network deployment environment only, synchronize the node.
Use the syncActiveNode or syncNode scripts in the AdminNodeManagement script library to propagate the configuration changes to node or nodes.
- Use the syncActiveNodes script to propagate the changes to each node in the cell, as the following example demonstrates:
```
AdminNodeManagement.syncActiveNodes()
```
- Use the syncNode script to propagate the changes to a specific node, as the following example demonstrates:
```
AdminNodeManagement.syncNode("myNode")
```

What to do next

The steps in this task return a success message if the system successfully updates the application. However, the steps might complete successfully before the system extracts each binary file. In a network deployment environment, for example, binary files are extracted after node synchronization is complete. You cannot start the application until the system extracts all binary files. Use the isAppReady and getDeployStatus commands for the AdminApp object to verify that the system extracted the binary files before starting the application.

The isAppReady command returns a value of true if the system is ready to start the application, or a value of false if the system is not ready to start the application. If the system is not ready to start the application, the system might be expanding application binaries. A script that updates an application and then starts it typically would loop around a call to isAppReady until it returns a value of true before attempting to start the application, as shown in the following example:

Using Jython:

import time
result = AdminApp.isAppReady('app1')
while (result == "false"):
   ### Wait 5 seconds before checking again
   time.sleep(5)
   result = AdminApp.isAppReady('app1')
print("Starting application...")

Using Jacl:

set result [$AdminApp isAppReady app1]
while {$result == "false"} {
   ### Wait 5 seconds before checking again
   after 5000
   set result [$AdminApp isAppReady app1]
}
puts "Starting application..."

Use the getDeployStatus command to display additional information about the binary file expansion status, as the following example displays:

AdminApp.getDeployStatus('app1')

Running the getDeployStatus command on app1 results in status information resembling the following:

ADMA5071I: Distribution status check started for application app1.
WebSphere:cell=myCell01,node=myNode01,distribution=unknown,expansion=unknown
ADMA5011I: The cleanup of the temp directory for application app1 is complete.
ADMA5072I: Distribution status check completed for application app1.
WebSphere:cell=myCell01,node=myNode01,distribution=unknown,expansion=unknown