-
-
-
Installing the Windows Endpoint Agent
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Installing the Windows Endpoint Agent
Introduction
The uberAgent Windows Endpoint Agent can be installed in two primary ways:
- Standalone Installation: This installation is independent of Citrix Virtual Apps and Desktops and offers multiple methods for deployment, including manual installation, installation through software deployment tools, and deployment through Splunk Deployment Server.
- Installation via Citrix Virtual Apps and Desktops: Since uberAgent 7.4 and Citrix Virtual Apps and Desktops (CVAD) 2503, uberAgent can be installed as part of the CVAD installation, allowing centralized management through Citrix Studio or Citrix Web Studio.
Note
Starting with uberAgent 7.2.1, the service does not start automatically after installation. Update your deployment procedures to include a manual service start if required.
Security Considerations
uberAgent configuration files are stored and cached in the %ProgramData% directory. Securing this directory with appropriate Access Control Lists (ACLs) is essential to prevent privilege escalation or misuse. Starting with version 7.0.2, the installer automatically applies secure permissions by default.
Recommended Permissions
- Administrators: Full Control
- SYSTEM: Full Control
- Users: No Access
Users must not have read access to the configuration directory as it may contain sensitive information like backend credentials.
Custom Scripts
Custom scripts that need to be executed in the user context can be securely managed in two ways:
- Assign read permissions to individual scripts without exposing the entire configuration directory.
- Place the scripts in a separate folder with appropriate permissions, containing only scripts that need execution from the user context.
Automatic Security Configuration
The following MSI parameters control automatic security settings:
-
PROGRAMDATA_CONFIGDIR_RESETPERMISSIONS(default:1): Ensures secure permissions are applied. -
PROGRAMDATA_CONFIGDIR_DELETEFILES(default:1): Deletes existing configuration files during installation.
For Citrix Virtual Apps and Desktops installations:
-
Initial Installation: Both parameters are set to
1to apply secure permissions and remove existing configurations. -
Updates: The
PROGRAMDATA_CONFIGDIR_DELETEFILESparameter is disabled (0) to preserve existing configurations.
Note
When deploying configuration files, ensure that secure ACLs are applied to the directory and remain intact throughout the process. Neglecting this step could compromise security and allow unintended access to the configuration files.
Standalone Installation
Download Installer
Download the latest uberAgent standalone release from Citrix Observability - uberAgent Product Software and unzip the content. The installer can be found in the uberAgent_endpoint\bin directory:
-
32-bit Systems:
uberAgent-32.msi -
64-bit Systems:
uberAgent-64.msi
MSI Parameters
INSTALLDIR
- Required: no
-
Default:
%ProgramFiles%\Citrix\uberAgent - Description: installation directory
- Valid values: any local file system path
PROGRAMDATA_CONFIGDIR_RESETPERMISSIONS
- Required: no
-
Default:
1 -
Description: Set secure permissions on uberAgent’s ProgramData directory (
%ProgramData%\vast limits\uberAgent). -
Valid values:
-
0: disabled -
1: enabled
-
PROGRAMDATA_CONFIGDIR_DELETEFILES
- Required: no
-
Default:
1 -
Description: Delete existing config files in uberAgent’s ProgramData directory (
%ProgramData%\vast limits\uberAgent). Disable this setting only if you’re removing potentially malicious existing config files as part of your own deployment package logic. -
Valid values:
-
0: disabled -
1: enabled
-
Manual Installation
- Install the appropriate MSI file from the directory
uberAgent_endpoint\bindepending on the bitness of your machine:uberAgent-32.msioruberAgent-64.msi. - If you have a license file for uberAgent, copy it to the installation directory (default:
%ProgramFiles%\Citrix\uberAgent). uberAgent does not start without a license file. Please see the uberAgent licensing guide for more details. - Configure uberAgent as needed; see the Configuration Options section for details.
- Start the uberAgent service.
Installation Through a Software Deployment Tool
- Install the appropriate MSI file from the directory
uberAgent_endpoint\bindepending on the bitness of your machine:uberAgent-32.msioruberAgent-64.msi.
- Configure the MSI parameters as needed.
- Distribute the license file and configuration templates as part of your deployment package. uberAgent does not start without a license file. Please see the uberAgent licensing guide for more details.
- Optional: The uberAgent service does not start automatically after installation, so a service start step may be included.
Installation Through Splunk Deployment Server
Note:
Deployment Server can only be used with Splunk Enterprise and requires Splunk Universal Forwarder on the endpoint as a deployment client.
uberAgent
Copy the directory uberAgent_endpoint from the unzipped uberAgent download package to $SPLUNK_HOME\etc\deployment-apps on your deployment server.
Note: $SPLUNK_HOME refers to the base directory of the Splunk installation, typically C:\Program Files\Splunk.
Configuration
To deploy a customized configuration file, copy it into the directory $SPLUNK_HOME\etc\deployment-apps\uberAgent_endpoint\bin. This overwrites the default configuration file from the installation package.
License File
If you have a license file for uberAgent, copy it into the directory $SPLUNK_HOME\etc\deployment-apps\uberAgent_endpoint\bin.
Serverclass
Create a file called serverclass.conf in $SPLUNK_HOME\etc\system\local on your deployment server. Serverclass.conf defines what to deploy where. For a quick start, paste the following content into serverclass.conf to deploy uberAgent to all Windows machines. You may want to fine-tune this to suit your needs.
# [global]
# We cannot match by machine type here. We'll do that on the app level below.
whitelist.0 = *
# Define a serverclass
[serverClass:windows]
# Deploy only to Windows machines
machineTypesFilter = windows-*
# Define which apps to deploy to the serverclass
[serverClass:windows:app:uberAgent_endpoint]
stateOnClient = enabled
restartSplunkd = true
<!--NeedCopy-->
To make Splunk read the new file serverclass.conf, run the following command:
$SPLUNK_HOME\splunk.exe reload deploy-server
<!--NeedCopy-->
Installation via Citrix Virtual Apps and Desktops
Since uberAgent 7.4 and Citrix Virtual Apps and Desktops 2503, uberAgent can be installed and updated as part of the Citrix VDA installation.
Note
To install and update uberAgent using the Citrix Virtual Apps and Desktops (CVAD) installation, you must first uninstall all existing uberAgent installations and then reinstall them using the CVAD installation.
Installation Steps
- Start the Citrix Virtual Apps and Desktops installation.
- In the Optional Software step, ensure that Citrix uberAgent is selected.
- Configure uberAgent as needed; see the Configuration Options section for details.
- Enable uberAgent Data Collection in Citrix Studio or Web Studio.
- Start the uberAgent service.
Note:
By default, the uberAgent Data Collection policy is disabled. uberAgent will run in idle mode until the policy is enabled.
uberAgent Director Integration
When uberAgent is installed as part of the Citrix Virtual Apps and Desktops installation, you only need to enable the uberAgent Data Collection policy. Everything else works seamlessly.
For more information, please refer to the Director documentation.
Citrix Site Monitoring
uberAgent supports Citrix Site Monitoring in both standalone mode and Citrix Virtual Apps and Desktops installations.
If some or all of your endpoints are running the Citrix Virtual Apps and Desktops (CVAD) VDA, you should install uberAgent on the Citrix delivery controller(s), too. Please see this page for details.
Imaging & Citrix PVS
If you intend to copy the agent installation via an imaging method or Citrix PVS, we recommend you remove instance-specific information. To do that, follow these steps right before capturing the image:
- Stop the service
uberAgent(but leave the start type atautomatic). - Open an administrative command prompt.
- Run the command:
reg delete "HKLM\SOFTWARE\vast limits\uberAgent" /f /reg:64. - Optionally: delete existing log files.
- Optionally: delete existing Persistent Output Queue files/folders.
- Prepare the machine for cloning as necessary, but do not reboot.
If you have Splunk Universal Forwarder installed, please follow the steps listed here, too.
Endpoint to Backend Communication via Splunk Universal Forwarder
Note: This is optional and not required for the recommended architecture.
If you decide to implement the alternative endpoint to backend communication path via Splunk Universal Forwarder, you need to install Universal Forwarder on each endpoint.
Share
Share
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.