Export (0) Print
Expand All

Deploying the UE-V 2.0 Agent

Updated: March 14, 2014

Applies To: User Experience Virtualization 2.0

The UE-V Agent in Microsoft User Experience Virtualization (UE-V) 2.0 must run on each computer that uses UE-V to synchronize application and Windows settings. A single installation file, AgentSetup.exe, installs the UE-V Agent on both 32-bit and 64-bit operating systems. The command-line parameters of the UE-V Agent are as follows.

AgentSetup.exe command-line parameters


Command-line parameter Definition Notes

/help or /h or /?

Displays the AgentSetup.exe usage dialog box.


Indicates the Universal Naming Convention (UNC) path that defines where settings are stored.

%username% or %computername% environment variables are accepted. Scripting can require escaped variables.

Default: <none> (Active Directory user home)


Indicates the Universal Naming Convention (UNC) path that defines the location that was checked for new settings location templates.

Only required for custom settings location templates


Specifies whether the default Microsoft templates should be registered during installation.

True | False

Default: True


Specifies which synchronization method should be used.

SyncProvider | None

Default: SyncProvider


Specifies the number of milliseconds that the computer waits before time-out when it retrieves user settings from the settings storage location.

Default: 2000 milliseconds

(wait up to 2 seconds)


Specifies whether UE-V synchronization is enabled or disabled.

True | False

Default: True


Specifies a settings package file size in bytes when the UE-V Agent reports that files exceed the threshold.


Default: none (no warning threshold)


Specifies the setting for participation in the Customer Experience Improvement program. If set to True, installer information is uploaded to the Microsoft Customer Experience Improvement Program site. If set to False, no information is uploaded.

True | False

Default: False


Supports deferral of the restart of the computer after the UE-V Agent is installed.


Enables a different installation folder to be set for the UE-V Agent or UE-V Generator.


Enables Setup to accept the option to be included in the Microsoft Update program.

During installation, the SettingsStoragePath command-line parameter specifies the settings storage location for the settings values. You can define a settings storage location before you deploy the UE-V Agent. If you do not define a settings storage location, then UE-V uses the Active Directory user Home Directory or custom AD property setting as the settings storage location. When you specify the SettingsStoragePath configuration during Setup and use the %username% environment variable as part of the value, it synchronizes the same user settings experience on all computers or sessions that a user logs on to. If you specify the %username%\%computername% variables as part of the SettingsStoragePath value, it preserves the settings experience for each computer.

Architecture-specific Windows Installer (.msi) files are provided for the UE-V Agent installation in addition to the combined 32-bit and 64-bit installer. The AgentSetupx86.msi or AgentSetupx64.msi installation files are smaller than the AgentSetup.exe file and might streamline the agent deployments. The command-line parameters for the AgentSetup.exe installer are supported for the Windows Installer (.msi) installation.

During UE-V Agent installation or uninstallation, you can either use the AgentSetup.exe file or the AgentSetup<arch>.msi file, but not both. The same file must be used to uninstall the UE-V Agent that was used to install the UE-V Agent.

Be sure to use the correct variable format when you install the UE-V Agent. The following table provides examples of deployment options for using the AgentSetup.exe or the Windows Installer (.msi) files.


Deployment type Deployment description Example

Command prompt

When you install the UE-V Agent at a command prompt, use the %^username% variable format. If quotation marks are required because of spaces in the settings storage path, use a batch script file for deployment.

AgentSetup.exe /quiet /norestart /log "%temp%\UE-VAgentInstaller.log" SettingsStoragePath=\\server\settingsshare\%^username%

msiexec.exe /i "<path to msi file>" /quiet /norestart /l*v "%temp%\UE-VAgentInstaller.log" SettingsStoragePath=\\server\settingsshare\%^username%

Batch script

When you install the UE-V Agent from a batch script file, use the %%username%% variable format. If you use this installation method, you must escape the variable with the %% characters. Without this character, the script expands the username variable at installation time, rather than at run time, which causes UE-V to use a single settings storage location for all users.

AgentSetup.exe /quiet /norestart /log "%temp%\UE-VAgentInstaller.log" SettingsStoragePath="\\server\settingsshare\%%username%%"

msiexec.exe /i "<path to msi file>" /quiet /norestart /l*v "%temp%\UE-VAgentInstaller.log" SettingsStoragePath="\\server\settingsshare\%%username%%"

Windows PowerShell

When you install the UE-V Agent from a Windows PowerShell prompt or a Windows PowerShell script, use the %username% variable format.

& AgentSetup.exe /quiet /norestart /log "%temp%\UE-VAgentInstaller.log" SettingsStoragePath=\\server\settingsshare\%username%

& msiexec.exe /i "<path to msi file>" /quiet /norestart /l*v "%temp%\UE-VAgentInstaller.log" SettingsStoragePath=\\server\settingsshare\%username%

Electronic software distribution, such as deployment of Configuration Manager Software Deployment

When you install the UE-V Agent by using Configuration Manager, use the ^%username^% variable format.

AgentSetup.exe /quiet /norestart /log "%temp%\UE-VAgentInstaller.log" SettingsStoragePath=\\server\settingsshare\^%username^%

msiexec.exe /i "<path to msi file>" /quiet /norestart /l*v "%temp%\UE-VAgentInstaller.log" SettingsStoragePath=\\server\settingsshare\^%username^%

The installation of the UE-V Agent requires administrator rights, and the computer requires a restart before the UE-V Agent can run.

UE-V 2.0 Agent deployment methods from a network share

You can use the following methods to deploy the UE-V Agent:

  • An electronic software distribution (ESD) solution system that can install a Windows Installer (.msi) file.

  • An installation script that references the Windows Installer (.msi) file that is stored centrally on a share.

  • An installation program that you run manually on the computer.

Use the following procedure to deploy the UE-V Agent from a network share.

To install and configure the UE-V Agent from a network share

  1. Stage the UE-V Agent installation file AgentSetup.exe on a network share to which users have Read permission.

  2. Deploy a script to user computers that installs the UE-V Agent. The script should specify the settings storage location.

Update the UE-V Agent

Updates for the UE-V Agent software are provided through Microsoft Update. During a UE-V Agent upgrade, the default group of settings location templates for common Microsoft applications and Windows settings can be updated. UE-V Agent updates can be deployed by using Enterprise Software Distribution (ESD) infrastructure systems.

See Also

Other Resources

Deploying UE-V 2.0

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2014 Microsoft