uberAgent

Upgrading uberAgent

This document outlines the procedure for upgrading uberAgent to a newer version.

Note

Securing the Configuration Directory

Please review this document for important information on securing the agent’s %ProgramData% configuration directory.

Understand What’s New and Changed

Please read the changelog. Changes might affect uberAgent’s configuration, for example.

Depending on the nature of the changes made for a new version, it may be necessary to update custom apps that make use of the data collected by uberAgent.

Endpoint Agents

To upgrade uberAgent’s endpoint agents, run the installer for the newer version. It detects the existing installation, uninstalls it, and installs the updated version automatically. Please refer to the endpoint agent installation documentation for more details (Windows, macOS).

Note: Any custom configuration files in the installation directory are not preserved during the upgrade. As of uberAgent 7.3, configuration files must be stored outside the installation directory in %ProgramData%, as described here.

User & Host Tags

Starting with uberAgent 7.0, host and user tags are collected through dedicated timers. If you are upgrading from an earlier version, adjust your configuration to implement a timer for user and host tags as described here.

Upgrading to uberAgent 7.3.1

Upgrading to uberAgent 7.3.1 follows the standard installation instructions. However, there are important changes regarding the configuration directory for Windows. Please note the following when upgrading:

Configuration Directory Change: Starting with uberAgent 7.3, configuration files can no longer be deployed in the installation folder due to security concerns.

Beginning with version 7.3, uberAgent only searches for configuration files in the %ProgramData%\vast limits\uberAgent\Configuration\ directory. Customers who previously stored their configurations in the installation folder need to move them to %ProgramData%\vast limits\uberAgent\Configuration\. Please refer to the endpoint agent installation documentation for more details (Windows).
Template Configuration Source Change: Starting with uberAgent 7.3.1, the agent installer does not store the template configuration files on disk any more. You can download the latest template config files for your installed uberAgent version on GitHub.
License File: While configuration files must be deployed to %ProgramData%, the license file should still be placed in the installation folder.
GPO and Central Configuration File Management: uberAgent can continue to be configured using Group Policy Objects (GPO) or Central Configuration File Management. Ensure that these methods reflect the new %ProgramData% directory requirement.
Securing the Configuration Directory: Please review this document for important information on securing the agent’s %ProgramData% configuration directory.

Upgrade Steps to uberAgent 7.3.1

Install the Update: Run the uberAgent 7.3.1 installer. It automatically removes any previous installations and set the correct permissions for the configuration folder in %ProgramData%.
Dowload Configuration from GitHub: Download the latest template config files for your installed uberAgent version on GitHub.
Deploy Configuration: After installation, move your configuration files to %ProgramData%.
Deploy License: Place the license file in the installation folder, as this remains the default location in uberAgent 7.3.

Splunk Apps

Upgrade Procedure

Delete the following Splunk app directories:

 $SPLUNK_HOME\etc\apps\uberAgent
 $SPLUNK_HOME\etc\apps\uberAgent_ESA
 $SPLUNK_HOME\etc\apps\uberAgent_indexer
 <!--NeedCopy-->

Install the new versions of the Splunk apps as described here.
Restart Splunk.

Upgrade from uberAgent 6.0

With uberAgent 6.1, the experience score data was moved from the KV store to a dedicated index. If you’re upgrading from 6.0 to a newer version, delete the Splunk KV store lookup lookup_hostinfo2 and associated data by running the following Splunk searches:

| outputlookup lookup_hostinfo2

| outputlookup lookup_score_per_machine

| outputlookup lookup_score_historic_per_machine

| outputlookup lookup_score_per_session

| outputlookup lookup_score_historic_per_session

| outputlookup lookup_score_per_application

| outputlookup lookup_score_historic_per_application
<!--NeedCopy-->

Elasticsearch

New versions of uberAgent often include additional fields, which may require updating the Elasticsearch index template. To do so, overwrite the existing index template with the new version as described here. Note that index templates are applied only to new indexes; existing indexes retain their original templates.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Upgrading uberAgent

Upgrading uberAgent

Understand What’s New and Changed

Endpoint Agents

User & Host Tags

Upgrading to uberAgent 7.3.1

Upgrade Steps to uberAgent 7.3.1

Splunk Apps

Upgrade Procedure

Upgrade from uberAgent 6.0

Elasticsearch

In this article