Upgrading Universal Agent
Overview
Upgrading Universal Agent refers to the increase of a currently installed pre-7.7.x Version, Release, or Modification level (see Versioning) of Universal Agent (7.7.x, 7.7.x, 7.7.x, 7.1.x, 7.0.x, 6.9.x, 6.8.x, 6.7.x, 6.6.x, 6.5.x, 6.4.x, 6.3.x, 6.2.x, 5.2.0, 5.1.0, 4.x, 3.x, 2.x) to Universal Agent 7.7.x.
Universal Agent refers to all Universal components that have been packaged under the following names:
- Universal Agent 7.7.x
- Universal Agent 7.5.x
- Universal Agent 7.4.x
- Universal Agent 7.3.x
- Universal Agent 7.2.x
- Universal Agent 7.1.x
- Universal Agent 7.0.x
- Universal Agent 6.9.x
- Universal Agent 6.8.x
- Universal Agent 6.7.x
- Universal Agent 6.6.x
- Universal Agent 6.5.x
- Universal Agent 6.4.x
- Universal Agent 6.3.x
- Universal Agent 6.2.x
- Opswise Universal Agent 5.2.0
- Workload Automation 5.1.0 (Indesca, Infitran, UAG)
- Indesca / Infitran 4.x
- Universal Products 3.x
- Universal Command 2.x
You do not have to remove a pre-7.7.x Agent to upgrade to Agent 7.7.x.
(Applying maintenance to an Agent refers to the increase of its currently installed Maintenance level to a later Maintenance level; for example, applying maintenance to Agent 7.7.0.0 to increase its maintenance level to Agent 7.7.0.1.)
Note
You cannot upgrade an Opswise Automation Center Agent (releases 1.7, 1.6, and 1.5) to Universal Agent 7.7.x.
IMPORTANT
Before upgrading Universal Connector, you must first install the appropriate SAP NW RFC Libraries for the platform on which the connector agent is installed (see Installing Universal Agent - Universal Connector for SAP Prerequisite).
Licensing
All upgrades to Universal Agent 7.7.x from versions 4.x, 5.1.0, 5.2.0, 6.2.x, 6.3.x, 6.4.x, 6.5.x, 6.6.x, 6.7.x, 6.8.x, 6.9.x, 7.0.x, and 7.1.x do not require new licenses for its licensed components, except for the UEC, UEM, and SOA licensed components of version 4.1.0. That SOA component will require a new license. Licenses are no longer required for UEC and UEM components.
All upgrades to Universal Agent 7.7.x from versions 3.2.0 and earlier do require new licenses for its licensed components.
Upgrade Procedures
The upgrade procedure actually is an un-install / re-install of the Agent. All configuration files (*.conf) are updated, not replaced. Local modifications to the configuration files are preserved.
Upgrading Universal Agent for z/OS
Step 1 | From the Stonebranch Customer Portal, download the Agent product distribution file for z/OS (for instructions, see Product Distribution File Download). |
---|---|
Step 2 | Stop all started tasks (STC) on the Agent that you are updating (for instructions on how to stop an Agent on a specific platform, see Starting and Stopping Agent Components). |
Step 3 | Install the Agent. For version-specific details, see z/OS Installation - SMP/E Installation. |
Step 4 | Start the Agent. The start/stop procedure may differ depending on your platform (see Starting and Stopping Agent Components and select your platform). |
Step 5 | Verify that the Agent is installed and running. If the Agent is configured to communicate with a Controller, verify that the Controller shows the Agent as being online (see Verifying Universal Agent Installation). |
Upgrading Universal Agent for Windows
Step 1 | From the Stonebranch Customer Portal, download the Agent product distribution file that is appropriate for your platform (for instructions, see Product Distribution File Download). |
---|---|
Step 2 | Install the Agent. For details, see Windows Installation. |
Step 3 | Verify that the Agent is installed and running. If the Agent is configured to communicate with a Controller, verify that the Controller shows the Agent as being online (see Verifying Universal Agent Installation). |
Note
A user mode installation of Universal Agent for Windows does not support an upgrade (that is, configuration files are not preserved.)
Configuration File Archives
During a Windows system mode install upgrade, the installation logic creates .archive directories (if they do not already exist) under the C:\ProgramData\Universal\conf
and the C:\ProgramData\Universal\comp
directories. Copies of existing configuration and component definition files, respectively, are stored in these directories. These archived files are then used to merge existing configuration and component definition values into the newly installed files. This allows the install to provide new configured default values while retaining existing settings.
If you take your own configuration or component definition file backups prior to upgrading a Universal Agent install, be sure to save them outside of the .\conf\.archive
and .\comp\.archive
directories. Otherwise, the configuration merge logic may fail to behave as expected.
Upgrading Universal Agent for SOA for Windows
Step 1 | From the Stonebranch Customer Portal, download the Universal Agent for SOA for Windows product distribution file (for instructions, see Product Distribution File Download). |
---|---|
Step 2 | Perform the recommended back-up of Universal Agent for SOA files (see Universal Agent for SOA for Windows - Pre-Installation / Upgrade Backups). |
Step 3 | Install Universal Agent for SOA. For details, see Universal Agent for SOA for Windows Installation. |
Upgrading Universal Enterprise Controller (UEC) for Windows
Step 1 | From the Stonebranch Customer Portal, download the Universal Enterprise Controller (UEC) for Windows product distribution file (for instructions, see Product Distribution File Download). |
---|---|
Step 2 | Install UEC. For details, see Universal Enterprise Controller for Windows Installation. |
Upgrading UEC Client Applications for Windows
Step 1 | From the Stonebranch Customer Portal, download the UEC Client Applications for Windows product distribution file (for instructions, see Product Distribution File Download). |
---|---|
Step 2 | Log out of active UEC Client Applications instances on the machine where you are upgrading UEC Client Applications. |
Step 3 | Install UEC Client Applications. For details, see UEC Client Applications Installation. |
Note
If you are upgrading a per-user installation of UEC Client Applications from any release prior to 5.2.0.1, you must uninstall the older version before installing the new version. There is an error in the older releases that prevents the upgrade from retaining a per-user installation environment.
Upgrades from 5.2.0.1 to any newer release should behave as expected.
Upgrading Universal Agent for UNIX
Step 1 | From the Stonebranch Customer Portal, download the Agent product distribution file that is appropriate for your platform (for instructions, see Product Distribution File Download). |
---|---|
Step 2 | Install the Agent. For details, see Universal Agent for UNIX Installation. |
Step 3 | If you are installing the Agent on AIX or Linux, you must review and perform PAM customization: If you are upgrading the Agent on an Intel-based Solaris system, you must follow the update procedure described below (See Upgrading Universal Agent for Intel-Based Solaris Systems). |
Step 4 | Verify that the Agent is installed and running. If the Agent is configured to communicate with a Controller, verify that the Controller shows the Agent as being online (see Verifying Universal Agent Installation). |
Note
A user mode installation of Universal Agent for UNIX does not support an upgrade (that is, configuration files are not preserved.)
Configuration File Archives
During a UNIX system mode install upgrade, the installation logic creates .archive directories (if they do not already exist) under the /etc/universal
and /etc/universal/comp
directories. Copies of existing configuration and component definition files, respectively, are stored in these directories. These archived files are then used to merge existing configuration and component definition values into the newly installed files. This allows the install to provide new configured default values while retaining existing settings.
If you take your own configuration or component definition file backups prior to upgrading a Universal Agent install, be sure to save them outside of the /etc/universal and /etc/universal/comp
directories. Otherwise, the configuration merge logic may fail to behave as expected.
Upgrading Universal Agent on Intel-Based Solaris Systems
Overview
In versions 7.5.x.x and earlier, all Universal Agent components (on Intel-based Solaris systems) were built on a 32-bit, little-endian Solaris Intel machine. With the release of 7.7.x.x, we have transitioned to a more robust 64-bit, little-endian Solaris Intel machine.
Implications of the Change
This transition, while offering numerous benefits, also means that the persistent data stored on disk by the components from previous releases is no longer compatible with the new release. Specifically, the binary format used for persistent data in earlier versions does not align with the new 64-bit architecture.
The following components are affected:
- OMS Server: creates message data files (in binary format) and persists them to disk to ensure message reliability. These files are not designed to be portable. See OMS Server Message Database.
- UAG: creates a job file (in binary format) for each task and persists it to disk until the task is completed.
Pre-Upgrade Steps
Before starting the pre-upgrade steps, ensure the Solaris Intel machine being upgraded is not executing any tasks. Verify that there are no tasks in either Queued or Running status, as any such tasks will be lost and cannot be recovered.
- Restart the Universal Broker by running
/opt/universal/ubroker/ubrokerd restart
- Once the broker restarts, both OMS and UAG will process the persistent data written to disk. Do not move on to the next step until you see message
UNV6312I
in/var/opt/universal/log/unv.log
andOPSAGT029I
in/var/opt/universal/uag/logs/agent.log
- Suspend any Agents running on the Solaris Intel machine being upgraded.
- Suspend the OMS server running on the Solaris Intel machine being upgraded. This may not be necessary if the OMS server is on a different system.
- Stop the Universal Broker by running
/opt/universal/ubroker/ubrokerd stop
- Delete any
.data
files in/var/opt/universal/spool/oms
- Delete any
_job
files in/var/opt/universal/uag/cache
Performing the Upgrade
After completing the above pre-upgrade steps, you may proceed with the standard upgrade process detailed in the previous section. Upon successful upgrade, make sure to Resume the suspended Agent(s) and OMS server.
Upgrading Universal Agent for SOA for UNIX
Step 1 | From the Stonebranch Customer Portal, download the Universal Agent for SOA for UNIX product distribution file that is appropriate for your platform (for instructions, see Product Distribution File Download). |
---|---|
Step 2 | Perform the recommended back-up of Universal Agent for SOA files (see Universal Agent for SOA for UNIX - Pre-Installation / Upgrade Backups). |
Step 3 | Install the Universal Agent for SOA. For details, see Universal Agent for SOA for UNIX Installation. |
Upgrading Universal Agent for IBM i
Currently, IBM i runs Workload Automation 5.1.1. For information on upgrading to that version, see IBM i Installation - Upgrade Installation to New Release.