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 What’s New section. 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.

Upgrading to uberAgent 7.5.1

Upgrading to uberAgent 7.5.1 follows the standard installation instructions. However, there are important changes regarding the licensing as uberAgent no longer processes its legacy license files.

Since uberAgent 7.4.2, the agent automatically detects when it is installed on a Citrix Virtual Delivery Agent (VDA). In this case, uberAgent is automatically licensed when the VDA itself has a valid license. This means that no additional license file is needed on VDA-deployments.

Starting with uberAgent 7.5.1, uberAgent uses the Citrix License Activation Service on all deployment types to verify its license. This means that the agent processes an activation file issued from your Citrix Cloud account.

Please review the licensing guide carefully, to learn how to get and use the activation file and adopt changes to your uberAgent deployment process. Additionally, you may review the What’s New section about this change.

To secure a successful license validation, ensure that uberAgent (running in SYSTEM context) is able to connect to the LAS backends. Therefore, verify that these firewall exclusions are in-place. If you’re using a proxy in your infrastructure, please configure uberAgent to use a proxy.

Note: If uberAgent cannot reach the LAS backend, license validation may fail, preventing the uberAgent service from starting.

Splunk Apps

Upgrade Procedure

  1. Delete the following Splunk app directories:

    $SPLUNK_HOME\etc\apps\uberAgent
    $SPLUNK_HOME\etc\apps\uberAgent_ESA
    $SPLUNK_HOME\etc\apps\uberAgent_indexer
    <!--NeedCopy-->
    
  2. Install the new versions of the Splunk apps as described here.

  3. Restart Splunk.

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.

Upgrading uberAgent®