Operating Systems: AIX, HP-UX, Linux, Solaris, Windows

---

 

Application edition management administrative tasks

You can use the Jacl or Jython scripting languages to manage application editions. The administrative tasks for the application edition manager include the following commands:

• activateEdition

• deactivateEdition

• rolloutEdition

• validateEdition

• listEditions

• isEditionExists

• cloneDynamicCluster

• cancelValidation

 

activateEdition

The activateEdition command activates an edition.

Target object

None.

Required parameters

-appName

Name of the application. (String, required)

-edition

Name of the application edition. (String, required)

Optional parameters

None.

Return value The command returns:

• true: success

• false: failure

Batch mode example usage

• Use Jacl:

  $AdminTask activateEdition {-appName BeenThere -edition 1.0}  
  

• Use Jython string:

  AdminTask.activateEdition ('[-appName BeenThere -edition 1.0]')  
  

• Use Jython list:

  AdminTask.activateEdition (['-appName', 'BeenThere', '-edition', '1.0'])
  

Interactive mode example usage

• Use Jacl:

  $AdminTask activateEdition {-interactive}  
  

• Use Jython string:

  AdminTask.activateEdition ('[-interactive]')
  

• Use Jython list:

  AdminTask.activateEdition (['-interactive'])
  

 

deactivateEdition

The deactivateEdition command deactivates an edition.

Target object

None.

Required parameters

-appName

Name of the application. (String, required)

-edition

Name of the application edition. (String, required)

Optional parameters

None.

Return value The command returns:

• true: success

• false: failure

Batch mode example usage

• Use Jacl:

  $AdminTask deactivateEdition {-appName BeenThere -edition 1.0}  
  

  Using Jython string:

  AdminTask.deactivateEdition ('[-appName BeenThere -edition 1.0]')
  

• Use Jython list:

  AdminTask.deactivateEdition (['-appName', 'BeenThere', '-edition', '1.0'])
  

Interactive mode example usage

• Use Jacl:

  $AdminTask deactivateEdition {-interactive}  
  

  Using Jython string:

  AdminTask.deactivateEdition ('[-interactive]')
  

• Use Jython list:

  AdminTask.deactivateEdition (['-interactive'])
  

 

rolloutEdition

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

Target object

None.

Required parameters

-appName

Name of the application. (String, required)

Optional parameters

-edition

Specifies the value of the custom property. (String, optional)

-params

Specifies configuration values for the rollout. (String, optional)

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 Number of servers to update when rolloutStrategy is grouped.

• integer

drainage interval 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

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

• Use Jacl:

  $AdminTask rolloutEdition {-appName BeenThere -edition 1.0 -params {rolloutStrategy[grouped|atomic]}{resetStrategy[soft|hard]}{groupSize[int]}{drainageInterval[int]}}  
  

  $AdminTask rolloutEdition {-appName BeenThere -edition 1.0 -params {quiesceStrategy[DEFAULT|INTERVAL]}{quiesceInterval[int]}}  
  

  Using Jython string:

  AdminTask.rolloutEdition ('[-appName BeenThere -edition 1.0 -params {rolloutStrategy[grouped|atomic]}{resetStrategy[soft|hard]}{groupSize[int]}{drainageInterval[int]}]')  
  

  AdminTask.rolloutEdition ('[-appName BeenThere -edition 1.0 -params {quiesceStrategy[DEFAULT|INTERVAL]}{quiesceInterval[int]}]')  
  

• Use Jython list:

  AdminTask.rolloutEdition (['-appName', 'BeenThere', '-edition', '1.0', '-params', '{rolloutStrategy[grouped|atomic]}{resetStrategy[soft|hard]}{groupSize[int]}{drainageInterval[int]}']) 
  

  AdminTask.rolloutEdition (['-appName', 'BeenThere', '-edition', '1.0', '-params', '{quiesceStrategy[DEFAULT|INTERVAL]}{quiesceInterval[int]}']) 
  

Interactive mode example usage

• Use Jacl:

  $AdminTask rolloutEdition {-interactive}  
  

  Using Jython string:

  AdminTask.rolloutEdition ('[-interactive]')
  

• Use Jython list:

  AdminTask.rolloutEdition (['-interactive'])
  

 

validateEdition

The validateEdition command validates an edition.

Target object

None.

Required parameters

-appName

Name of the application. (String, required)

-edition

Name of the application edition. (String, required)

Optional parameters

-params

Specifies the parameters for the dynamic cluster maximum, minimum, and static size.

Return value The command returns:

• true: success

• false: failure

Batch mode example usage

• Use Jacl:

  $AdminTask validateEdition {-appName BeenThere -edition 1.0 -params {dynClusterMaxSize[int]}{dynClusterMinSize[int]}{staticClusterSize[int]}}   
  

  Using Jython string:

  AdminTask.validateEdition ('[-appName BeenThere -edition 1.0 -params {dynClusterMaxSize[int]}{dynClusterMinSize[int]}{staticClusterSize[int]}]')
  

• Use Jython list:

  AdminTask.validateEdition (['-appName', 'BeenThere', '-edition', '1.0', '-params', '{dynClusterMaxSize[int]}{dynClusterMinSize[int]}{staticClusterSize[int]}']) 
  

Interactive mode example usage

• Use Jacl:

  $AdminTask validateEdition {-interactive}  
  

  Using Jython string:

  AdminTask.validateEdition ('[-interactive]')
  

• Use Jython list:

  AdminTask.validateEdition (['-interactive'])
  

 

listEditions

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

Target object

None.

Required parameters

-appName

Name of the application. (String, required)

Optional parameters

None.

Return value

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

Batch mode example usage

• Use Jacl:

  $AdminTask listEditions {-appName HelloWorld}   
  

  Using Jython string:

  AdminTask.listEditions ('[-appName HelloWorld]')
  

• Use Jython list:

  AdminTask.listEditions (['-appName', 'HelloWorld']) 
  

Interactive mode example usage

• Use Jacl:

  $AdminTask listEditions {-interactive}  
  

  Using Jython string:

  AdminTask.listEditions ('[-interactive]')
  

• Use Jython list:

  AdminTask.listEditions (['-interactive'])
  

 

isEditionExists

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

Target object

None.

Required parameters

-appName

Name of the application. (String, required)

-edition

Name of the application edition. (String, required)

Optional parameters

None.

Return value The command returns:

• true: success

• false: failure

Batch mode example usage

• Use Jacl:

  $AdminTask isEditionExists {-appName HelloWorld -edition 2.0}   
  

  Using Jython string:

  AdminTask.isEditionExists ('[-appName HelloWorld -edition 2.0]')
  

• Use Jython list:

  AdminTask.isEditionExists (['-appName', 'HelloWorld', '-edition', '2.0']) 
  

Interactive mode example usage

• Use Jacl:

  $AdminTask isEditionExists {-interactive}  
  

  Using Jython string:

  AdminTask.isEditionExists ('[-interactive]')
  

• Use Jython list:

  AdminTask.isEditionExists (['-interactive'])
  

 

cloneDynamicCluster

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

Target object

None.

Required parameters

-clusterName

Name of the original dynamic cluster. (String, required)

-newClusterName

Name of the cloned dynamic cluster. (String, required)

Optional parameters

-nodeGroupName

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, optional)

-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. (String, optional)

Batch mode example usage

• Use Jacl:

  $AdminTask cloneDynamicCluster {-clusterName SourceCluster -newClusterName newCluster -nodeGroupName CloneNodeGroup -opMode supervised}   
  

  Using Jython string:

  AdminTask.cloneDynamicCluster ('[-clusterName SourceCluster -newClusterName newCluster -nodeGroupName CloneNodeGroup -opMode supervised]')
  

• Use Jython list:

  AdminTask.cloneDynamicCluster (['-clusterName', 'SourceCluster', '-newClusterName', 'newCluster', '-nodeGroupName', 'CloneNodeGroup', '-opMode', 'supervised']) 
  

Interactive mode example usage

• Use Jacl:

  $AdminTask cloneDynamicCluster {-interactive}  
  

  Using Jython string:

  AdminTask.cloneDynamicCluster ('[-interactive]')
  

• Use Jython list:

  AdminTask.cloneDynamicCluster (['-interactive'])
  

 

cancelValidation

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

Target object

None.

Required parameters

-appName

Name of the application. (String, required)

-edition

Name of the application edition. (String, required)

Optional parameters

None.

Return value The command returns:

• true: The cancellation of the validation succeeded.

• false: The cancelation of the validation failed.

Batch mode example usage

• Use Jacl:

  $AdminTask cancelValidation {-appName BeenThere -edition 1.0}  
  

  Using Jython string:

  AdminTask. cancelValidation ('[-appName BeenThere -edition 1.0]') 
  

• Use Jython list:

  AdminTask. cancelValidation (['-appName', 'BeenThere', '-edition', '1.0']) 
  

Interactive mode example usage

• Use Jacl:

  $AdminTask cancelValidation {-interactive}  
  

  Using Jython string:

  AdminTask.cancelValidation ('[-interactive]')
  

• Use Jython list:

  AdminTask.cancelValidation (['-interactive'])
  

---

 

Related concepts

Application edition manager
Rollout an edition

 

Related tasks

Deploying and managing application editions without loss of service
Canceling an application validation