As of version 12 of the Automation EngineDiese Komponente steuert ein Automation Engine-System. Besteht aus verschiedenen Serverprozessen. it is possible to upgrade all CAU-supported agents to a new version with a centralized and easy to use automatic procedure.
In this document you find the background information, requirements and steps you have to follow.
Our consultants are experts in upgrading AE systems. Contact Automic, our experts will be pleased to assist you whenever it is necessary.
In order to print the whole contents of the collapsed pages below, use the button Expand all/Collapse all in the menu bar above.
Centralized Agent Upgrade - Video
The Centralized Agent UpgradeDas Cenralized Agent Upgrade erlaubt das zentrale Upgrade von allen installierten und durch das CAU unterstützten Agenten auf neue Versionen mithilfe des Automic Web Interface (AWI). is very secure and easy to do, watch our video here:
https://youtu.be/HCI5RgIGFBQ
Concept
The Centralized Agent"Programm, das die Ausführung von Verarbeitungen auf Zielsystemen wie z.B. Rechner oder Geschäftslösungen ermöglicht. Auch ein eigener Objekttyp in der Automation Engine. [Früher ""Executor"" genannt.] Siehe auch ""Host""." Upgrade (CAU) as of AWA v12 is another automatic upgrade solution:
Procedure Summary
You have to import the new version binaries into the system client 0000. (The binaries are attached to and delivered with Storage objects).
The CAU itself can be carried out from any client of your system, by any user with the necessary authorizations.
Please refer to the list of CAU enabled agents below to check, if a particular agent or agent can be upgraded by using the CAU.
In order for the CAU to work properly you also have to first manually upgrade your ServiceManager to v12 .
As of v12 the following agents can be upgraded by using the CAU:
Agent type | Agent |
---|---|
OS Agents |
Windows UNIX:
|
Dos and Donts
Make sure that all binaries attached to Storage objects and thus imported into the system are from trusted sources.
Users that have the privilege to conduct a CAU are potentially able to import malicious files as well.
Use the ServiceManager to start agents for the CAU. That way you make sure that the agents after upgrading will restart automatically.
Using a different method to start agents is possible, but you will have to ensure the restart another way as well, because the agents will not restart automatically.
The Storage objects mentioned above will be delivered via Automic Plugin Manager packages.
Automic strongly recommends you use separate binaries for agents, not shared ones. Otherwise errors may occur.
Do not change the names of these objects. The specific name pattern is used to identify the resources' types and versions.
If the names of these objects do not match the pattern, the agent version is not displayed in the update list.
Do not change the resource content.
It is released by Automic and shouldn't be altered.
Take care of the following:
The Automation Engine installationnull has to be installed and / or upgraded (ZDU) in the usual way.
Make sure that you upgrade your ServiceManager to v12 manually first.
The CAU is possible as of v12, which applies to the ServiceManager as well.
You have to install an (initial) agent manually in the following cases:
An agent has already been installed that supports CAU functionality (see table above).
Any administrator / user who shall be able to execute an upgrade, CAU or ZDU, needs the privilege Execute system upgrades.
In order to be able to import the resource packages mentioned above you need to install the Automic Plugin Manager. It is itself a plugin and would be part of your Automic Web Interface installation.
Details you find in: Installing and Configuring the Plugin Manager
Install the packages (packs) you downloaded using the Packs page in your AWIAutomic-Produkt: Übersichtliche und einfach zu bedienende Weboberfläche, mit welcher der Zugriff auf verschiedene Funktionalitäten der Automation Engine möglich ist. installation. For details refer to: Packs Page
Summary of Steps to Take
As a system administrator working in client 0000 you have to follow these steps:
Detailed Upgrade Steps
I. and II. Download and Import Plugin Manager Packages for CAU
The necessary agent resources for the CAU are kept in storage objects (AE object type = STORE).
Therefore you have to make these objects available in the AE before performing CAU actions.
The delivery of these objects is realized via Automic Plugin Manager packages.
These packages are available for each released agent version on the Automic Marketplace.
In case a reversion of the CAU is a possibility, make sure to also import packages for the version you are upgrading from.
To import PM packages for CAU follow these steps:
Important Notes:
Removing an Plugin Manager package via Plugin Manager plugin will not remove already available agent target versions for CAU.
The versions of all imported packages are accumulated in the AE.
Do not change the names and / or content of Plugin Manager packages or related Storage objects.
If the agent is busy at the time the Automation Engine tries to trigger the upgrade, the agent blocks the upgrade until it is idle again (for example JobVerarbeitung auf einem Zielsystem. Auch ein eigener Objekttyp in der Automation Engine. objects, script functions or file transfers).
III. and IV. Select Agents to be Upgraded and Specify Version
Please follow these steps:
You can also filter for particular agents, using the button Filter in the toolbar at the right hand side of the Agents page.
Column | Description |
---|---|
Number of Agents | Number of all agents available for the platform in the second column. |
Platform | The respective platform of the agents you selected in the Agents page. |
Target Version |
The target versions available for that agent type, ordered in descending order, so the latest version is shown at the top. If there is more than one version available for that platform, a drop down arrow at the end of the row indicates that you can select the appropriate version there. |
V. and VI. Check Reports and Upgrade History
Immediately after the upgrade has been started, you can look up any detailed information and reports in the Upgrade History page.
Column | Description |
---|---|
Name | Name of the CAU run, can be configured in the Custom Upgrade Text field when you select the target version. |
StatusZustand einer Aufgabe (z.B. aktiv, blockiert, in Generierung, usw.). | Status of the run - or the child, which would be an agent or agents individual deployment, depending on the selection you made when choosing the agents to be upgraded. |
RundID | RunID"Kurzform für ""laufende Nummer"". Hierbei handelt es sich genauer um eine Zahl, welche die Durchführung einer Aufgabe eindeutig kennzeichnet. Die RunID kann zwischen 7 und 10 Stellen aufweisen. Sie wird von der Komponente Automation Engine vergeben." of the CAU run or the individual agent deployment. |
ParentEin Objekt kann auf verschiedenste Arten aktiviert werden. Der Verursacher der Aktivierung wird als übergeordnete Aufgabe (Parent) bezeichnet. (siehe auch Child, Children) | (only filled, if child is displayed) Shows the CAU run which is parent of an individual agent's deployment. |
User | User name of the user executing the CAU. |
Agent | (only filled, if child is displayed) Agent name of the individual agent being upgraded. |
Target Version | New version to be upgraded to. |
Start Time/End Time | Start and end time of the run or the individual agent upgrade. |
Runtime | The upgrade's duration. |
You can configure the necessary AE system modules to execute objects on the CAU's completion automatically.
You have to be logged in into system client 0000 to be able to configure the necessary variables and keys.
Execute on Upgrade - Configuration
In order to configure the automatic execution of objects after the CAU has been completed, the system variables UC_HOSTCHAR_DEFAULT - Host Characteristics and - for a particular agent - the UC_EX_HOSTCHAR - Assigning Agents to Host Characteristics variable have to be edited or created.
You first have to create the object or objects to be executed after the upgrade has been finished.
Afterward you set the values in the respective UC_HOSTCHAR_DEFAULT key, following these steps:
In order to read or print the report contents of CAU runs, you can use script functions and available script variables. Find examples here:
Using Scripts and Script Variables
Available Script Variables
There are script variables available that you can use in scripts in the Process page of an object you referenced to read the respective values, namely:
Use with EXECUTE_ON_DEPLOYMENT_RUN, so the variables listed will return the values as described here:
Use with EXECUTE_ON_DEPLOYMENT_AGENT, which will return the following values:
Script Examples:
This script reads all variables from the read buffer and uses / prints them (single agent deployment):
:READ&UC_EX_CAU_NAME#,,
:READ&UC_EX_CAU_RUNID#,,
:READ&UC_EX_HOST#,,
:READ&UC_EX_DEPLOYMENT_RUNID#,,
:READ&UC_EX_DEPLOYMENT_STATUS#,,
:P"CAU RUN INFORMATION:"
:P"CAU custom text=",&UC_EX_CAU_NAME#
:P"CAU runID=",&UC_EX_CAU_RUNID#
:P"AGENT DEPLOYMENT INFORMATION:"
:P"Agent=",&UC_EX_HOST#
:P"Agent deployment runID=",&UC_EX_DEPLOYMENT_RUNID#
:P"Agent deployment status=",&UC_EX_DEPLOYMENT_STATUS#
Use PREP_PROCESS and this example script for a CAU report (an entire CAU run):
For a whole CAU run use "CAU" as parameter report type in PREP_PROCESS_REPORT.
:SET &HND#=PREP_PROCESS_REPORT(,&UC_EX_DEPLOYMENT_RUNID,"CAU")
:PROCESS&HND#
:SET&RET#=GET_PROCESS_LINE(&HND#)
:PRINT&RET#
:ENDPROCESS
Use PREP_PROCESS and this example script for a "REP" report (single agent deployment):
For processing the detailed report of a single agent upgrade use "REP" as parameter report type in PREP_PROCESS_REPORT.
:SET&HND#=PREP_PROCESS_REPORT(,&UC_EX_DEPLOYMENT_RUNID#,"REP")
:PROCESS&HND#
: SET&LINE#=GET_PROCESS_LINE(&HND#)
: PRINT&LINE#
:ENDPROCESS
Because of this cleanup function which will be triggered on the agent's re-connect, it is necessary that you provide the binaries as CAU packages of previous versions in case you want to revert the CAU. Take care to import them should they not be present in the system yet.
It is possible to skip the upgrade of agents that you initially registered for an upgrade, if they are in the status Waiting for host.
Two possibilities exist to skip the upgrade:
Upgrade Skip in AWI:
How to Revert to a Previous Version
You may want to revert the agent's upgrade in case your preferences or system occurrences make it seem appropriate.
This function is technically an upgrade to another agent version.
Therefore you just have to follow the steps described above for the CAU itself.
What you have to do
System Behavior during a Centralized Agent Upgrade (CAU)