applyPatch
The "applyPatch
" command applies a patch to a TIBCO Host instance or to all TIBCO Host instances in CONFIG_HOME
.
Some patches are successive in nature, and may require other patches to be applied before the new patch can be applied. The "describeAvailablePatches
" command shows which patches require other patches to be applied first.
Applying a patch consists of two operations, and they are executed depending on the scope of the patch.
- The first operation upgrades the TIBCO Host itself.
- The second operation upgrades the software running in all the nodes of TIBCO Host. If a patch does not affect the TIBCO Host, the TIBCO Host is not modified. Similarly, if a patch does not affect Node software, nodes are not modified. If any errors are encountered during application of a patch, all changes are rolled back and the TIBCO Host instance is not modified.
Running
state at the time of applying the patch. All Nodes managed by the instance must be stopped first before applying the patch.
Argument | Description |
---|---|
-ID | The identifier of the patch to be applied. Identifiers are of the form <name>:<version>.
You can get a list of available Patch IDs using the " |
-handleStop | Stops TIBCO Host instances before applying the patch. |
-handleStart | Starts TIBCO Host instances with "clearCache " after applying the patch. Starts TIBCO Host instance as a service if it is installed as Windows Service.
|
-nonInteractive |
Automatically applies the last-released patch from
|
-clearCache | Clear the cache of all participating nodes without starting the TIBCO Host instance on which the nodes are running.
Note: If you intend to start host instances manually, ensure that ALL Hosts are started with "clearCache". Alternatively, use " -clearCache " while running this command. TIBCO host instances start with "clearCache " on their next startup.
With this, the TIBCO Host instances started from outside of ActiveMatrix (for example, using TIBCO Hawk®) after applying the patch can automatically be started with " Note: This command does not handle "clearCache" start of Hosts running as NT Service by default. This can be handled by " -clearCache ". If you have Hosts running as NT service, you must specify "-clearCache " along with "-handleStart " to start the hosts with "clearCache ".
|
-delayInSeconds |
Allows adding a delay of a specified amount of time after applying the patch and between each TIBCO host instance startup if TIBCO Host startup is handled. If the delay is not provided, it uses the default delay of 10 seconds. |
-dryRun |
Allows you to see what changes would be made by applying a patch, without making the actual changes. The command runs without making changes and you can look in the log to see what changes would have been made. |
Examples
-
>applyPatch -configHomeLocation /path/to/confighome/location -instanceName myTibcoHostInstance -ID amx.platform.patch:3.3.0.HF14 -handleStop -handleStart
It stops the TIBCOHost Instance
myTibcoHostInstance
in theCONFIG_HOME path/to/confighome/location
, applies the patchamx.platform.patch:3.3.0.HF14
and starts the Instance with "clearCache
".Note: By default, this starts TIBCO hosts running as Windows Service without the "clearCache
" option. -
>applyPatch -configHomeLocation /path/to/confighome/location -nonInteractive
It applies the latest available patch in
TIBCO_HOME
to all TIBCO Host Instances in theCONFIG_HOME
path/to/confighome/location
. -
>applyPatch -configHomeLocation /path/to/confighome/location -instanceName myTibcoHostInstance -ID amx.platform.patch:3.3.0.HF14 -clearCache
It applies the patch
amx.platform.patch:3.3.0.HF14
to TIBCO Host InstancemyTibcoHostInstance
in theCONFIG_HOME path/to/confighome/location
and clears the cache of all Nodes on the InstancemyTibcoHostInstance
. -
>applyPatch -configHomeLocation /path/to/confighome/location -clearCache
It applies the latest available patch in
TIBCO_HOME
to all TIBCO Host instances in theCONFIG_HOME
path/to/confighome/location
and clears the cache of all nodes on all TIBCO Host instances. -
>applyPatch -configHomeLocation /path/to/confighome/location -handleStop -handleStart -clearCache
It stops all TIBCO Host instances in the
CONFIG_HOME path/to/confighome/location
, applies the latest available patch to all of them, clears the cache of all nodes on all of the TIBCO Host instances and starts the instances. This starts all instances with "clearCache
" whether they are running as processes or as Windows service. -
>applyPatch -configHomeLocation /path/to/confighome/location -handleStop -handleStart -delayInSeconds 30
It stops all TIBCO Host instances in the
CONFIG_HOME path/to/confighome/location
, applies the latest available patch to all of them and starts the instances with "clearCache
". This adds a delay of 30 seconds after applying the patch and between each TIBCO Host instance startup.