Use the rolloutOracleHome command if you only want to do one of the following tasks:

• Update your Administration Server to use a patched Oracle home.

• Update your entire domain (Administration Server and clustered Managed Servers) to use a patched Oracle home.

• Update clustered Managed Servers to use a patched Oracle home.

• Revert your Administration Server, clustered Managed Servers, or domain to use the previous unpatched Oracle home.

rolloutOracleHome has the following syntax:

rolloutOracleHome(target, rolloutOracleHome, backupOracleHome, [isRollback], [options=options])

This command supports the isDryRun, isAutoRevertOnFailure, and isSessionCompatible options. You can include a comma-separated list of one or more options in this command. For information about these options, see Using WLST to Initiate and Monitor Workflows.

The following example shows how to roll out a new Oracle home to the domain mydomain. The JAR file for the patched Oracle home is located at /net/wls/wls_patched.jar. The original Oracle home will be moved (renamed) to /u01/Oracle_Home_backup. The process will not automatically revert if it fails.

connect('adminname', 'adminpassword', 't3://hostname:port')
domain='/domains/mydomain'
progress=rolloutOracleHome(domain, '/net/wls/wls_patched.jar', 
'/u01/Oracle_Home_backup', options='isAutoRevertOnFailure=FALSE')

Use the rolloutJavaHome command if you only want to do one of the following tasks:

• Update your Administration Server to use a new Java version.

• Update your entire domain (Administration Server and Managed Servers) to use a new Java version.

• Update your Managed Servers to use a new Java version.

• Revert your Administration Server, Managed Servers, or domain to use the previous Java version.

rolloutJavaHome has the following syntax:

rolloutJavaHome(target, javaHome, [options=options])

This command supports the isDryRun and isAutoRevertOnFailure options. You can include one or more options in a comma-separated list in this command. For information about these options, see Using WLST to Initiate and Monitor Workflows.

The following example shows how to roll out a new Java home to clusters Cluster1, Cluster2, Cluster3. The new Java home location is /u01/jdk-17.0.12. The isAutoRevertOnFailure option is not included in this example; therefore, the workflow will automatically revert if the process fails.

connect('adminname', 'adminpassword', 't3://hostname:port')
clusters='Cluster1,Cluster2,Cluster3'
progress=rolloutJavaHome(clusters, '/u01/jdk-17.0.12')

Use the rolloutUpdate command if you only want to do one of the following tasks:

• Update your Administration Server to use both a patched Oracle home and a new Java version.

• Update your entire domain (Administration Server and clustered Managed Servers) to use both a patched Oracle home and a new Java version.

• Update your Managed Servers to use both a patched Oracle home and a new Java version.

• Revert your Administration Server, Managed Servers, or domain to the previous Oracle home and previous Java version.

rolloutUpdate has the following syntax:

rolloutUpdate(target, rolloutOracleHome, backupOracleHome, [isRollback], [javaHome], [options=options])

This command supports the isDryRun, isAutoRevertOnFailure, and isSessionCompatible options. You can include one or more options in a comma-separated list in this command. For information about these options, see Using WLST to Initiate and Monitor Workflows.

The following example shows how to roll out a new Oracle home and a new Java home to the Administration Server. The JAR file for the patched Oracle home is located at /net/wls/wls_patched.jar. The original Oracle home will be moved (renamed) to /u01/Oracle_Home_backup. The new Java home location is /u01/jdk-17.0.12. The isAutoRevertOnFailure option is not included in this example; therefore, the workflow will automatically revert if the process fails.

connect('adminname', 'adminpassword', 't3://hostname:port')
server='AdminServer'
progress=rolloutUpdate(server, '/net/wls/wls_patched.jar', 
'/u01/Oracle_Home_backup', '/u01/jdk-17.0.12')

Use the rolloutApplications command if you want to do one of the following tasks:

• Update your Managed Servers to use a new version of one or more applications.

• Revert your Managed Servers to the previous version of one or more applications.

rolloutApplications has the following syntax:

rolloutApplications(target, applicationProperties, [options=options])

This command supports the isDryRun, isAutoRevertOnFailure, and isSessionCompatible options. You can include one or more options in a comma-separated list in this command. For information about these options, see Using WLST to Initiate and Monitor Workflows.

The following example shows how to roll out the applications defined in the JSON-formatted application properties file /u01/scratch/app_update.json to all clusters Cluster1, Cluster2, Cluster3 on a UNIX system.

connect('adminname', 'adminpassword', 't3://hostname:port')
clusters='Cluster1,Cluster2,Cluster3'
progress=rolloutApplications(clusters, '/u01/scratch/app_update.json')

Use the rollingRestart command if you want to do one of the following tasks:

• Initiate a rolling restart of all servers in a domain.

• Initiate a rolling restart of all servers in a specific cluster or clusters.

rollingRestart has the following syntax:

rolloutRestart(target, [options=options])

This command can include one or more options in a comma-separated list.

The following example shows how to perform a rolling restart of all servers in Cluster1 and Cluster2.

connect('adminname', 'adminpassword', 't3://hostname:port')
clusters='Cluster1,Cluster2'
progress=rollingRestart(clusters)

Each rollout command returns a WorkFlowTaskRuntimeMBean that you can use to poll the current status of the workflow. To monitor the progress of a rollout, use a rolloutcommand in the following format:

progress=rollout_command

For example, use this command if you are rolling out a new Oracle home:

progress=rolloutOracleHome(DomainA, '/net/patched/wls1221p.jar', 
'/net/backups/wls1221', options='isAutoRevertOnFailure=FALSE')

You can then use the methods of the WorkflowTaskRuntimeMBean to return information about the workflow. See WorkflowTaskRuntimeMBean in the MBean Reference for Oracle WebLogic Server. Here are some examples:

progress.getWorkflowId()

Returns the ID of the workflow.

progress.getProgressString()
'Workflow wf0011 Running: 13/36'

Returns a human-readable message containing information about the current workflow progress. In this example, workflow wf0011is currently running and has completed 13 of the 36 workflow commands.

progress.getStatus()
STARTED

Returns the current status of the workflow, which can be STARTED, SUCCESS, RETRY, REVERTING, FAIL, REVERTED, REVERT_FAIL, CANCELED, or REVERT_CANCELED.

The following Python script segment demonstrates one way to use the progress object to monitor a workflow and output the progress of a rollout task. Sample output is shown after the script.

# Print the starting information
rolloutName = progress.getName()
startTime = progress.getStartTime()
print "Started rollout task \"" + rolloutName + "\" at " + str(startTime)
 
# Check the state every 2 minutes
domainRuntime()
cd('RolloutService/rollout-service/ActiveWorkflows')
cd(progress.getWorkflowId())
while(get('Running')==1):
  progressString = progress.getProgressString()
  print progressString
  time.sleep(120)
 
# Print the ending information
endTime = progress.getEndTime()
state = progress.getState()
print "rollout \"" + rolloutName + "\" finished with state 


Output
Started rollout task "Domain1Rollout" at 2014-07-22 07:29:06.528971
Running step 1 of 9
Running step 2 of 9
Running step 3 of 9
Running step 4 of 9
Running step 5 of 9
Running step 6 of 9
Running step 7 of 9
Running step 8 of 9
Running step 9 of 9
rollout "Domain1Rollout" finished with state "SUCCESS" at 
2014-07-22 07:47:15.538299

A workflow can stop in either the running or reverting direction for the following reasons:

• The workflow failed while running, with the isAutoRevertOnFailure option set to FALSE.

• The workflow was manually canceled.

• An unrecoverable error occurred during a revert operation.

When a workflow is stopped, you can resolve any errors manually. You can then set the workflow to continue to run or revert by using the following methods on the RolloutServiceRuntimeMBean:

This section describes several WLST commands that you may find useful.

• To get a list of completed workflows:

  wls:/domain_name/domainRuntime/RolloutService/rollout-service> completeWfs=
  cmo.getCompleteWorkflows()
  
  

• To get a list of active workflows:

  wls:/domain_name/domainRuntime/RolloutService/rollout-service> activeWfs = 
  cmo.getActiveWorkflows()
  
  

• To look up a workflow by ID and retrieve its status:

  wls:/domain_name/domainRuntime/RolloutService/rollout-service> 
   progress=cmo.getWorkflowTask('workflow_id')
  wls:/Domain1221/domainRuntime/RolloutService/rollout-service> progress.getStatus()
  
  

• To cancel a running workflow:

  wls:/domain_name/domainRuntime/RolloutService/rollout-service>
   progress=cmo.getWorkflowTask('workflow_id')
  wls:/domain_name/domainRuntime/RolloutService/rollout-service> progress.cancel()
  
  

• To delete a completed workflow:

  wls:/domain_name/domainRuntime/RolloutService/rollout-service> cmo.deleteWorkflow('workflow_id')

This section contains a sample WLST script that illustrates how to perform a rolling restart of all servers in a cluster called cluster1 with single service migration. In this script, the following arguments are defined:

• username — The WebLogic Server administrator user name.

• password — The WebLogic Server administrator password.

• adminURL — The host name and port number of the domain's Administration Server.

• target — The target or targets for the operation. See Table 4-1.

• options — The rollout option or options for the operation. See Table 4-1.

The following example shows a sample WLST script for a rollout operation.

import sys, socket
import os
import time
from java.util import Date
from java.text import SimpleDateFormat
 
argUsername = sys.argv[1]
argPassword = sys.argv[2]
argAdminURL = sys.argv[3]
argTarget = sys.argv[4]
argOptions = sys.argv[5]

try:
   connect(argUsername, argPassword, argAdminURL)
   progress = rollingRestart(argTarget, argOptions)
   lastProgressString = ""
 
   progressString=progress.getProgressString()
   # for testing progressString="12 / 12"
   steps=progressString.split('/')
 
 
   while not (steps[0].strip() == steps[1].strip()):
     if not (progressString == lastProgressString):
       print "Completed step " + steps[0].strip() + " of " + steps[1].strip()
       lastProgressString = progressString
 
     java.lang.Thread.sleep(1000)
 
     progressString=progress.getProgressString()
     steps=progressString.split('/')
     if(len(steps) == 1):
       print steps[0]
       break;
 
   if(len(steps) == 2):
     print "Completed step " + steps[0].strip() + " of " + steps[1].strip()
 
   t = Date()
   endTime=SimpleDateFormat("hh:mm:ss").format(t)
 
   print ""
   print "RolloutDirectory task finished at " + endTime
   print ""
 
   state = progress.getStatus()
   error = progress.getError()

   stateString = '%s' % state   
   if stateString != 'SUCCESS':
     #msg = 'State is %s and error is: %s' % (state,error)
     msg = "State is: " + state
     raise(msg)
   elif error is not None:
     msg = "Error not null for state: " + state
     print msg
     #raise("Error not null for state: %s and error is: %s" + (state,error))
     raise(error)  
except Exception, e:
  e.printStackTrace()
  dumpStack()
  raise("Rollout failed")
 
exit()

To run this script, save it in a Python (.py) file and then enter commands similar to this. If you are running WLST on Windows, see ZDT Patching Restrictions, for important information about using WLST on Windows.

$ORACLE_HOME/oracle_common/common/bin/wlst.sh 
/u01/scripts/rollout/RollingRestart.py username password 
t3://hostname:port cluster1 "migrationProperties=/u01/json/mig.txt"