uberAgent

Configure uberAgent® via Citrix Policies

Starting with uberAgent 7.4.0, uberAgent can be configured through Citrix Studio or Citrix Web Studio when it is installed as part of the Citrix Virtual Apps and Desktops installation.

Information:

This configuration option is only available if uberAgent is installed using the Citrix Virtual Apps and Desktops™ installer. Customers who installed uberAgent using the uberAgent standalone installer must first uninstall uberAgent and then reinstall it using the Citrix Virtual Apps and Desktops installer to utilize these policies.

Enable uberAgent Data Collection

Description

The policy Enable uberAgent Data Collection determines whether uberAgent is generally enabled or disabled. When enabled, uberAgent can enhance Director and collect metrics for monitoring and analysis in a third-party backend. Please note that the policy Enhance Director with uberAgent Data is additionally required to activate the Director integration. To collect the following metrics, customers need to provide a configuration bundle and a license file (e.g., via the policies uberAgent Configuration Archive Path and uberAgent License Archive Path):

  • User experience
  • Application performance
  • System health
  • Network activity
  • Security analytics

Please note that if this setting is set to disabled, uberAgent is unable to enhance Director metrics nor to collect data based on a customer-provided configuration.

Default Setting: Enabled

Enhance Director with uberAgent Data

Description

This policy enables the integration of Director with uberAgent. It allows Director to process data provided by uberAgent to enhance monitoring capabilities, including monitoring of local application usage. Please see more details here.

Default Setting: Enabled

uberAgent Configuration Archive Path

Description

This policy specifies the path to a directory containing an uberAgent configuration archive (uberAgent.uAConfig). This archive allows advanced customization of uberAgent.

The configuration archive can be stored:

  • Locally on the endpoint
  • On an SMB share, from which uberAgent automatically retrieves it

Important: Specify only the directory path without the filename. Example: Use \\fileserver\configshare instead of \\fileserver\configshare\uberAgent.uAConfig.

Default Setting: empty (not applied)

Note: This policy is not required if uberAgent is only used to enhance Director.

For a detailed explanation of how to set up and manage the configuration archive, refer to the Central Config File Management documentation.

uberAgent License Archive Path

Description

This policy specifies the path to a directory containing at least one uberAgent license file (uberAgent.lic). License files ensure that uberAgent operates in its licensed mode, unlocking the full feature set.

The license files can be stored:

  • Locally on the endpoint
  • On an SMB share, from which uberAgent automatically retrieves them

Important: Specify only the directory path without the filename. Example: Use \\licserver\licenseshare instead of \\licserver\licenseshare\uberAgent.lic.

Default Setting: empty (not applied)

Note: This policy is not required if uberAgent is only used to enhance Director.

For detailed instructions on managing license files, refer to the Central License File Management documentation.

Configure uberAgent® via Citrix Policies