WebSphere Virtual Enterprise (formerly Operations Optimization), Version 6.1
             Operating Systems: AIX, HP-UX, Linux, Solaris, Windows


Application edition management administrative tasks

To increase application monitoring and management, you can use the Jacl or Jython scripting languages. You can also use the AdminApp object to manage applications with specific editions.

Avoid trouble: Augment your profile for WebSphere® Virtual Enterprise before using the commands.gotcha
Use the following commands to activate, deactivate, perform a rollout on, validate, list, and verify an application edition. You can also clone an existing dynamic cluster to use a different node group, and you can cancel the validation mode on an application edition:
You can perform the following operations using the AdminApp object in wsadmin to manage applications with editions: For a complete list of operations that you can perform using the AdminApp object, see Commands for the AdminApp object.

activateEdition

The activateEdition command activates an edition.

Target object

None.

Parameters

-appName
Specifies the name of the application. (String)
-edition
Specifies the name of the application edition. (String)

Return value

The command returns:
  • true: success
  • false: failure

Batch mode example usage

Interactive mode example usage

deactivateEdition

The deactivateEdition command deactivates an edition.

Target object

None.

Parameters

-appName
Specifies the name of the application. (String)
-edition
Specifies the name of the application edition. (String)

Return value

The command returns:
  • true: success
  • false: failure

Batch mode example usage

Interactive mode example usage

rolloutEdition

The rolloutEdition command rolls out an edition and specifies the group size.

Target object

None.

Parameters

-appName
Specifies the name of the application. (String)
-edition
Specifies the value of the custom property. (String)
-params
Specifies configuration values for the rollout. (String)

rollout strategy

  • group: Activates the specified application in place of the current edition of the same application across the cluster on which the application cluster deploys, N servers at a time, as specified by the groupSize keyword. The default group size is 1. During rollout, both editions of the application can serve requests. Always set the group number to be at least one less than the cluster size so that at least one cluster member serves the old edition while the rollout of the new edition starts.
  • atomic: Activates the specified application in place of the current edition of the same application across the cluster on which the application cluster deploys, one half of the cluster at a time, such that only one edition of the application serves requests at any given time.

reset strategy

Specifies how to start an application edition instance during the rollout operation.
  • hard: Stops or restarts the application server.
  • soft: Stops or restarts the application instance, while leaving the application server running.

group size for group rollout

Specifies the number of servers to update when rolloutStrategy is grouped.
  • integer

drainage interval

Specifies the number of seconds to wait before stopping an application edition instance during the rollout such that sessions can complete. The default is 30 seconds.
  • integer
[Version 6.1.0.1 and later] Specify the following properties for Session Initiation Protocol (SIP) application rollout:
quiesce strategy
Specifies if cluster members and servers quiesce after all active dialogs and sessions are complete, or if the cluster members and servers quiesce after a specified interval.

DEFAULT: Cluster members and servers quiesce when active dialogs and sessions complete.

INTERVAL: Cluster members and servers quiesce after a specified interval. You must also specify the quiesceInterval as an integer value in number of seconds.

Return value

The command returns:
  • true: success
  • false: failure

Batch mode example usage

Interactive mode example usage

validateEdition

The validateEdition command validates an edition.

Target object

None.

Parameters

-appName
Specifies the name of the application. (String)
-edition
Specifies the name of the application edition. (String)
-params
Specifies the parameters for setting the size of the cluster that is being cloned during validation. By default, the size of the original cluster is used if the parameters are not specified.
  • Dynamic cluster:
    dynClusterMaxSize
    Specifies the maximum size of the dynamic cluster.
    dynClusterMinSize
    Specifies the minimum size of the dynamic cluster.
  • Static cluster:
    staticClusterSize
    Specifies the size of the static cluster. The value of staticClusterSize cannot exceed the size of the static cluster that is kbeing cloned.

Return value

The command returns:
  • true: success
  • false: failure

Batch mode example usage

Interactive mode example usage

listEditions [Version 6.1.0.1 and later]

The listEditions command provides a list of all the installed editions of the application.

Target object

None.

Parameters

-appName
Specifies the name of the application. (String)

Return value

The command returns a string array of all the installed editions of the application.

Batch mode example usage

Interactive mode example usage

isEditionExists [Version 6.1.0.1 and later]

The isEditionExists command verifies that the specified edition exists for the particular application.

Target object

None.

Parameters

-appName
Specifies the name of the application. (String)
-edition
Specifies the name of the application edition. (String)

Return value

The command returns:
  • true: success
  • false: failure

Batch mode example usage

Interactive mode example usage

cloneDynamicCluster [Version 6.1.0.1 and later]

The cloneDynamicCluster command clones a dynamic cluster to use a different node group.

Target object

None.

Parameters

-clusterName
Specifies the name of the original dynamic cluster. (String)
-newClusterName
Specifies the name of the cloned dynamic cluster. (String)
-nodeGroupName
Specifies the name of the node group in which the cloned dynamic cluster is located. Be default, the name is set to the current node group if this parameter is not specified. (String)
-opMode
Specifies the operational mode of the cloned dynamic cluster. By default, the mode of the original dynamic cluster is used if this parameter is not specified. Set the value to automatic, manual, or supervised. (String)

For more information about operational modes, see Dynamic clusters .

Batch mode example usage

Interactive mode example usage

cancelValidation [Version 6.1.0.4 and later]

The cancelValidation command cancels the validation mode on an application edition.

Target object

None.

Parameters

-appName
Specifies the name of the application. (String)
-edition
Specifies the name of the application edition. (String)

Return value

The command returns:
  • true: The cancellation of the validation succeeded.
  • false: The cancelation of the validation failed.

Batch mode example usage

Interactive mode example usage

Install an application with an edition

Use the AdminApp install command to install an application with an edition. You must pass the -edition parameter to specify the edition identifier.

You can use the following example in wsadmin to install the application BeenThere with edition 1.0.
  • Using Jacl:
    $AdminApp install /tmp/BeenThere1.0.ear {-appname BeenThere -edition 1.0 -nopreCompileJSPs -distributeApp -nouseMetaDataFromBinary -nodeployejb -createMBeansForResources -noreloadEnabled -nodeployws -validateinstall warn -noprocessEmbeddedConfig -filepermission .*\.dll=755#.*\.so=755#.*\.a=755#.*\.sl=755 -noallowDispatchRemoteInclude -noallowServiceRemoteInclude -MapModulesToServers {{"BeenThere WAR" BeenThere.war,WEB-INF/web.xml WebSphere:cell=TestCell,cluster=TestClusterB} {"BeenThere EJB" BeenThere.jar,META-INF/ejb-jar.xml WebSphere:cell=TestCell,cluster=TestClusterB}}}  
  • Using Jython:
    AdminApp.install("/tmp/BeenThere1.0.ear", '[-appname BeenThere -edition 1.0 -nopreCompileJSPs -distributeApp -nouseMetaDataFromBinary -nodeployejb -createMBeansForResources -noreloadEnabled -nodeployws -validateinstall off -processEmbeddedConfig -filepermission .*\.dll=755#.*\.so=755#.*\.a=755#.*\.sl=755 -buildVersion Unknown -noallowDispatchRemoteInclude -noallowServiceRemoteInclude -MapModulesToServers [["BeenThere WAR" BeenThere.war,WEB-INF/web.xml WebSphere:cell=TestCell,cluster=TestClusterB] ["BeenThere EJB" BeenThere.jar,META-INF/ejb-jar.xml WebSphere:cell=TestCell,cluster=TestClusterB]]]') 

Update an application with an edition

Use the AdminApp update command to update an application with an edition. Pass the full application name, which is the name of the application and the edition, to specify the edition.

You can use the following example in wsadmin to update edition 1.0 of the application BeenThere with the BeenThereE1-update.ear file.
  • Using Jacl:
    $AdminApp update BeenThere-edition1.0 app {-operation update -contents /tmp/BeenThereE1-update.ear -nopreCompileJSPs -distributeApp -nouseMetaDataFromBinary -nodeployejb -createMBeansForResources -noreloadEnabled -nodeployws -validateinstall warn -noprocessEmbeddedConfig -filepermission .*\.dll=755#.*\.so=755#.*\.a=755#.*\.sl=755 -noallowDispatchRemoteInclude -noallowServiceRemoteInclude}  
  • Using Jython:
    AdminApp.update('BeenThere-edition1.0', 'app', '[-operation update -contents /tmp/BeenThereE1-update.ear -nopreCompileJSPs -distributeApp -nouseMetaDataFromBinary -nodeployejb -createMBeansForResources -noreloadEnabled -nodeployws -validateinstall warn -noprocessEmbeddedConfig -filepermission .*\.dll=755#.*\.so=755#.*\.a=755#.*\.sl=755 -noallowDispatchRemoteInclude -noallowServiceRemoteInclude]') 

Edit an application with an edition

Use the AdminApp edit command to edit an application with an edition. Pass the full application name, which is the name of the application and the edition, to specify the edition.

You can use the following example in wsadmin to edit edition 1.0 of the application BeenThere by changing the context root of the Web module to /beenthere.
  • Using Jacl:
    $AdminApp edit BeenThere-edition1.0 {-CtxRootForWebMod {{"BeenThere WAR" BeenThere.war,WEB-INF/web.xml /beenthere}}} 
  • Using Jython:
    AdminApp.edit('BeenThere-edition1.0', '[-CtxRootForWebMod [["BeenThere WAR" BeenThere.war,WEB-INF/web.xml /beenthere]]]')

Uninstall an application with an edition

Use the AdminApp uninstall command to uninstall an application with an edition. Pass the full application name, which is the name of the application and the edition, to specify the edition.

You can use the following example in wsadmin to uninstall edition 1.0 of the application BeenThere.
  • Using Jacl:
    $AdminApp uninstall BeenThere-edition1.0 
  • Using Jython:
    AdminApp.uninstall('BeenThere-edition1.0')



Related concepts
Application edition manager
Related tasks
Deploying and managing application editions without loss of service
Performing a rollout on an edition
[Version 6.1.0.4 and later] Canceling an application validation
Installing an edition
Creating and augmenting profiles
Reference topic    

Terms of Use | Feedback

Last updated: Oct 30, 2009 6:15:26 PM EDT
http://publib.boulder.ibm.com/infocenter/wxdinfo/v6r1/index.jsp?topic=/com.ibm.websphere.ops.doc/info/reference/radtaskapped.html