uberAgent

uberAgent® Config & Support Tool - 1.1.x

The uberAgent Config & Support Tool simplifies the configuration process for uberAgent, allowing you to set up a proof-of-concept installation with minimal effort.

System Requirements

  • Windows 10 version 1607 or later
  • Windows Server 2016 or later
  • macOS Ventura or newer

Download and Installation

  1. Install uberAgent before proceeding.
  2. Download the uberAgent Config & Support Tool from the Citrix Observability website.
  3. Once the download has finished, launch the tool.

Main Dialog Options

uberAgent-Config-and-support-tool-main

The tool provides three options:

  • Quick Configuration: Streamlined configuration process for basic uberAgent setup - perfect for proof-of-concept installations.
  • Advanced Configuration: Extended configuration options with maximum flexibility.
  • Create Support Bundle: Collects log files and settings for troubleshooting.

Quick Configuration

The Quick Configuration option provides a streamlined approach to configuring uberAgent with predefined templates and simplified settings. This option maintains the same functionality as described in the Quickstart 1.0.x documentation, including:

  • Configuration source selection (Web/GitHub or Local)
  • Data volume optimization options
  • Receiver type configuration (Splunk, Elasticsearch, OMS Log Analytics, Kafka, Azure Event Hubs)
  • License file selection
  • Apply configuration or create config archive options

For detailed instructions on using Quick Configuration, refer to the Quickstart 1.0.x documentation.

Advanced Configuration

The Advanced Configuration option provides enhanced flexibility for managing uberAgent configurations with extended configuration source options.

Note

If uberAgent is not installed, the configuration cannot be applied locally.

Supported Configuration Sources

The Advanced Configuration supports three configuration sources:

Web/GitHub

AdvancedConfiguration Web/GitHub

Downloads configuration templates from specified URLs, typically from the uberAgent config GitHub repository.

Local Config Archive

AdvancedConfiguration Local Archive

Uses a configuration archive from the local disk. This is particularly helpful for configuring machines without internet access or for editing existing configuration archives and repackaging them.

Local Config Directory

AdvancedConfiguration Local Directory

Works with a local configuration directory structure. This is particularly helpful for creating configuration archives for Central Config File Management.

Note

When using the uberAgent configuration directory (C:\ProgramData\vast limits\uberAgent\Configuration) as source, only creating a config archive is available.

Advanced Configuration Workflow

The workflow is identical for all Advanced Configuration options:

  1. Select Source: Choose your configuration source (Web/GitHub, Local Config Archive, or Local Config Directory)
  2. Load Configuration: If available, click the Load button to load the configuration files
  3. Edit Configuration: The working directory with config files automatically opens in File Explorer. Make your changes using any text editor of your choice (e.g., Notepad, Notepad++, VSCode)
  4. Select Destination: Choose whether to apply the configuration locally or create a config archive
  5. Apply Changes: Click the Apply button to execute the selected process

Creating a Support Bundle

To generate an uberAgent support bundle, select the “Create Support Bundle” button from the main dialog. Upon completion, you’ll receive a notification, and the bundle will be saved to your desktop.

uberAgent® Config & Support Tool - 1.1.x