# Frame Agent Setup Tool (FAST)

The Frame Agent Setup Tool (FAST) is used to install Frame Agent, Frame drivers, and Frame tools on your template image. FAST is also used to keep the Frame components on your template image(s), Sandboxes, Utility server(s), and persistent desktops up-to-date, regardless of infrastructure or instance types being used.

When using FAST to prepare a template image for use in Frame, RDP will continue to function (unlike the Frame Guest Agent Installer). Once the template image is used by Frame to provision workload VMs in a Frame account, administrators will need to enable the [RDP Debug Mode](https://docs.difr.com/books/platform-administrators-guide/page/rdp-debug-mode) feature to access Frame-managed workloads via RDP.

<p class="callout info"> Before using FAST to install, update, or remove Frame components, ensure that there is a valid backup of the VM. 2. FAST is not a package repair tool. If you encounter issues with broken MSI installations, you will need to repair MSI installations manually or use 3rd party software tools.</p>

### Requirements

In order for FAST to download the required Frame components for installation or update, the VM running FAST must be able to reach the following Internet FQDNs via tcp/443 (HTTPS), as discussed in [Networking Requirements](https://docs.difr.com/link/51#bkmrk-requirements):

1. download.visualstudio.microsoft.com
2. downloads.console.nutanix.com

### Installation

<p class="callout info"> FAST is included in Frame-provided Windows OS images in public cloud. If you are using a Frame-provided image, the FAST executable will be in the `C:\\ProgramData\\Nutanix\\Frame\\Tools` folder.</p>

1. Download the Frame Agent Setup Tool from the [Downloads page](https://files.difr.com/) into your template image or existing Sandbox, Utility Server, and/or persistent desktops.
2. Run the executable to launch the Frame Agent Setup Tool.

### Usage

The FAST utility has two different views: Bundle View and Updater View. When you run FAST, it will search for the Frame Guest Agent and Server components. If Frame Guest Agent cannot be found (e.g. clean Windows OS image), FAST will start in [Bundle View](#bundle-view). If Frame Guest Agent is already installed, FAST will start in [Updater View](#updater-view).

Bundle View

When FAST is started and determines the Frame Guest Agent is not present on the VM (such as when you are preparing a template image to be used in Frame):

1. A dialog prompt will open. Accept the terms and conditions and click the “Next” button to continue.

<figure class="admin-ui" id="bkmrk-">[![image.png](https://docs.difr.com/uploads/images/gallery/2025-12/scaled-1680-/PFTimage.png)](https://docs.difr.com/uploads/images/gallery/2025-12/PFTimage.png)

</figure>2\. Click on \*\*Select All\*\* for all of the packages to be installed or install specific packages by checking the associated boxes. Frame Guest Agent and Frame Server will be installed automatically. Click the \*\*Install\*\* button to continue.

<figure class="admin-ui" id="bkmrk--1">[![image.png](https://docs.difr.com/uploads/images/gallery/2025-12/scaled-1680-/yuzimage.png)](https://docs.difr.com/uploads/images/gallery/2025-12/yuzimage.png)

</figure>Each package will be downloaded and then installed, one by one. See the example below:

<figure class="admin-ui" id="bkmrk--2">[![image.png](https://docs.difr.com/uploads/images/gallery/2025-12/scaled-1680-/dWNimage.png)](https://docs.difr.com/uploads/images/gallery/2025-12/dWNimage.png)

</figure>1\. When all components are installed, you may either \*\*Exit\*\* the Frame Agent Setup Tool to perform additional tasks in the VM or \*\*Reboot\*\* the VM. The VM must be rebooted for the Frame components to take effect.

<figure class="admin-ui" id="bkmrk--3">[![image.png](https://docs.difr.com/uploads/images/gallery/2025-12/scaled-1680-/laMimage.png)](https://docs.difr.com/uploads/images/gallery/2025-12/laMimage.png)

</figure>#### Updater View

When FAST is started and determines the Frame Guest Agent is present on the VM (Sandbox, Utility server, and/or Persistent Desktops), FAST will display the Updater view.

Enable or disable the **Show Early Access Components** if you wish to see or not see the components that have an Early Access version.

**Single Component Installation**

To install/update an individual component, click either on the appropriate action on the right side (Download or Download and Install). You can double click the component row to view the component version number (current and latest), release notes, and link to documentation. Click on **Download and Install** to begin the download and installation process or **Cancel** to return to the component list.

<figure class="admin-ui" id="bkmrk--4">[![image.png](https://docs.difr.com/uploads/images/gallery/2025-12/scaled-1680-/8YJimage.png)](https://docs.difr.com/uploads/images/gallery/2025-12/8YJimage.png)

</figure>**Multi-Component Installation**

1. Select the desired component(s) for update or installation by checking the associated checkboxes.

<figure class="admin-ui" id="bkmrk--5">[![image.png](https://docs.difr.com/uploads/images/gallery/2025-12/scaled-1680-/nGTimage.png)](https://docs.difr.com/uploads/images/gallery/2025-12/nGTimage.png)

</figure>2\. Click the toggle located at the bottom of the window to acknowledge the machine has been backed up. 3. Click the "Download" or "Download and Install" icon at the upper left corner of the FAST application window. FAST will not update the Frame Agent and Frame Server components, if they are up to date. 4. Accept the prompt by clicking \*\*OK\*\*. FAST will download and install the selected components.

<figure class="admin-ui" id="bkmrk--6">[![image.png](https://docs.difr.com/uploads/images/gallery/2025-12/scaled-1680-/hcVimage.png)](https://docs.difr.com/uploads/images/gallery/2025-12/hcVimage.png)

</figure>5\. When all components are updated, you can close the Frame Agent Setup Tool.

### Package Statuses

In the Updater View, FAST will display the status of each package. Definitions for each of the package status are described in the following table.

<table id="bkmrk-status-description-u"><thead><tr><th>Status</th><th>Description</th></tr></thead><tbody><tr><td>Up to Date</td><td>A package found on the machine is already up-to-date with the latest version.</td></tr><tr><td>Update Required</td><td>An installed package requires an update. Failure to update could result in system instability or compatibility conflicts.</td></tr><tr><td>Update Available</td><td>An installed package has an optional update. While not required, this update could improve performance or add new features.</td></tr><tr><td>Not Installed</td><td>An optional package is not installed.</td></tr></tbody></table>

### Command-Line Usage

You may want to automate Frame Agent Setup Tool to update all components of your Frame virtual machines programmatically. In that case, Frame Agent Setup Tool can be executed with various arguments to orchestrate installation and updates. For example, if you execute on the Windows command line:

```
 FrameAgentSetupTool.exe getpackages
```

FAST will list all missing or obsolete packages.

### Arguments

<table id="bkmrk-name-description-%2F%3F-"><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>`/?`</td><td>Display help</td></tr><tr><td>`getpackages`</td><td>Display a list of all missing/obsolete packages</td></tr><tr><td>`getpackages json`</td><td>Display a list of all missing/obsolete packages in json format</td></tr><tr><td>`install`</td><td>Install all missing/obsolete packages</td></tr><tr><td>`install only ...`</td><td>Install only provided packages</td></tr><tr><td>`install except ...`</td><td>Install all missing/obsolete packages except provided packages</td></tr><tr><td>`install frameimage`</td><td>Install all system and Frame components</td></tr><tr><td>`install only frameimage`</td><td>Install only provided applications and all Frame system components</td></tr><tr><td>`install except frameimage`</td><td>Install all available application except listed ones after installation of Frame system components</td></tr></tbody></table>

### Supported Applications &amp; Drivers

In addition to the Frame Guest Agent and Frame Server, FAST installs and updates the following drivers and tools.

<table id="bkmrk-name-description-fra"><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>Frame Audio Driver</td><td>Enables Frame to properly interface with the audio card on the workload VM for use in a Frame session.</td></tr><tr><td>Frame Video Driver</td><td>Enables Frame to properly interface with the video card on the workload VM for use in a Frame session.</td></tr><tr><td>Liquidware ProfileDisk</td><td>Enables support for Frame Enterprise Profiles in a Frame session (non-persistent only).</td></tr><tr><td>Frame Pen Driver</td><td>Enables support for digital pen tablets in a Frame session (requires supported endpoint device).</td></tr><tr><td>Frame Printer Driver</td><td>Enables support for Frame Printer in a Frame session.</td></tr><tr><td>Frame Scanner Driver</td><td>Enables support for WIA scanners in a Frame session (requires supported endpoint device).</td></tr><tr><td>Frame SmartCard Driver</td><td>Enables support for CAC/SmartCards in a Frame session (requires supported endpoint device).</td></tr><tr><td>Frame USB Driver</td><td>Enables support for Generic USB in a Frame session (requires supported endpoint device).</td></tr><tr><td>Frame AD Helper</td><td>Tool for troubleshooting issues with joining a Frame workload VM to an Active Directory domain.</td></tr><tr><td>Frame Proxy Helper</td><td>Tool for configuring Frame Agent to function properly with proxy servers.</td></tr><tr><td>Frame Sysprep Helper</td><td>Tool for troubleshooting and automatically resolving issues related to Windows Sysprep.</td></tr></tbody></table>

### FGA Proxy Helper Tool

The FGA must be able to communicate with the Frame control plane in order for Frame Platform to be able to orchestrate and broker users into these workload VMs. If your workload VMs must connect to an outbound proxy server to reach the Internet, you will need to configure (or update) the FGA Proxy Settings once the Frame Guest Agent is installed (or if your outbound proxy server information changes). The proxy settings apply **only** to the Frame Guest Agent. You will need to configure the Windows proxy server settings for Windows OS and your applications separately.

The Proxy Helper tool `FrameProxyHelper.exe` is located in the Frame Tools directory `C:\ProgramData\Nutanix\Frame\Tools`.

<figure class="admin-ui" id="bkmrk-fga-proxy-helper-too-1">[![image.png](https://docs.difr.com/uploads/images/gallery/2025-12/scaled-1680-/oUUimage.png)](https://docs.difr.com/uploads/images/gallery/2025-12/oUUimage.png)

  
<figcaption>  
</figcaption></figure>**Server:** The IP address of the outbound proxy server.  
**Port:** The desired port on the outbound proxy server.

If your proxy server requires basic authentication, select "Use following credentials for authentication" and enter the "Username" and "Password." You can then test the settings by clicking "Start test" and save them by clicking "Save Settings".

## Manual installation and repair of the Frame Agent and its components

This guide outlines the process for installing and repairing the Frame Agent and its associated system components. It is beneficial for repairing or reinstalling the Agent on Persistent Desktops, as well as upgrading Frame components on the Sandbox.

#### Prerequisites:<span class="heading-anchor-wrapper" role="presentation"><button aria-hidden="true" class="css-vhh4ux" data-testid="anchor-button" type="button"><span aria-label="Copy" class="_1e0c1o8l _vchhusvi _1o9zidpf _vwz4kb7n _y4ti1igz _bozg1mb9 _12va1onz _jcxd1r8n" role="img"><svg class="_1reo15vq _18m915vq _syaz1r31 _lcxvglyw _s7n4yfq0 _vc881r31 _1bsbpxbi _4t3ipxbi" fill="none" role="presentation" viewbox="0 0 16 16"><path clip-rule="evenodd" d="M8.22 2.22a3.932 3.932 0 1 1 5.56 5.56l-2.25 2.25-1.06-1.06 2.25-2.25a2.432 2.432 0 0 0-3.44-3.44L7.03 5.53 5.97 4.47zm3.06 3.56-5.5 5.5-1.06-1.06 5.5-5.5zM2.22 8.22l2.25-2.25 1.06 1.06-2.25 2.25a2.432 2.432 0 0 0 3.44 3.44l2.25-2.25 1.06 1.06-2.25 2.25a3.932 3.932 0 1 1-5.56-5.56" fill="currentcolor" fill-rule="evenodd"></path></svg></span></button></span>

Dizzion strongly advises administrators to back up before proceeding.

#### Solution:<span class="heading-anchor-wrapper" role="presentation"><button aria-hidden="true" class="css-vhh4ux" data-testid="anchor-button" type="button"><span aria-label="Copy" class="_1e0c1o8l _vchhusvi _1o9zidpf _vwz4kb7n _y4ti1igz _bozg1mb9 _12va1onz _jcxd1r8n" role="img"><svg class="_1reo15vq _18m915vq _syaz1r31 _lcxvglyw _s7n4yfq0 _vc881r31 _1bsbpxbi _4t3ipxbi" fill="none" role="presentation" viewbox="0 0 16 16"><path clip-rule="evenodd" d="M8.22 2.22a3.932 3.932 0 1 1 5.56 5.56l-2.25 2.25-1.06-1.06 2.25-2.25a2.432 2.432 0 0 0-3.44-3.44L7.03 5.53 5.97 4.47zm3.06 3.56-5.5 5.5-1.06-1.06 5.5-5.5zM2.22 8.22l2.25-2.25 1.06 1.06-2.25 2.25a2.432 2.432 0 0 0 3.44 3.44l2.25-2.25 1.06 1.06-2.25 2.25a3.932 3.932 0 1 1-5.56-5.56" fill="currentcolor" fill-rule="evenodd"></path></svg></span></button></span>

1. Please make sure you create a backup before starting the installation or repair process.
2. Start a session or connect via Remote Desktop Protocol (RDP) if the Frame session is unavailable.
3. Open Terminal as an administrator.
4. Navigate to the Frame Tools directory by running:  
      
    ```
    cd C:\ProgramData\Nutanix\Frame\Tools
    ```
5. Execute the installation script:  
      
    ```
    .\FrameAgentSetupTool.exe install frameimage
    ```

<div class="rich-media-item mediaSingleView-content-wrap image-center css-wmwdcs" data-layout="center" data-media-vc-wrapper="true" data-node-type="mediaSingle" data-renderer-start-pos="868" data-ssr-placeholder="Eb7Gh:EfLS5:z8NN7:qz-Pe:Y6119-0" data-vc="media-single" data-width="760" data-width-type="pixel" id="bkmrk--7"></div>[![image.png](https://docs.difr.com/uploads/images/gallery/2026-01/scaled-1680-/lCyimage.png)](https://docs.difr.com/uploads/images/gallery/2026-01/lCyimage.png)

This process installs all required system dependencies, including Frame drivers and updated components.

6. Reboot and Validate  
    After installation, reboot the system and verify the installation.

<p class="callout info"> Handy to know; You can re-install and re-register all FAST components by holding the left Shift Key, and then running FAST</p>

## Troubleshooting

#### Logs

The Frame Agent Setup Tool generates a log file for troubleshooting which is located in: C:\\ProgramData\\Nutanix\\Frame\\Logs

Take a look at these and if you need further assistance, open a [support ticket](https://support.dizzion.com/hc/en-us).