Frame Agent Setup Tool

The Frame Agent Setup Tool (FAST) is a utility which updates the Frame Guest Agent as well as drivers and tools used by Frame to keep an image up-to-date, regardless of infrastructure or instance types being used. FAST can be used to update Frame non-essential components and to complete a Master Image creation. FAST will silently and automatically check for updates with every startup.

Warning

Before any action (installation or removal), ensure that there is a valid backup of the VM on which the Frame Agent Setup Tool is operating.

Supported Applications/Drivers

Name

Description

Frame Audio Driver

Enables Frame to properly interface with the audio card on the workload VM for use in a Frame session.

Frame Video Driver

Enables Frame to properly interface with the video card on the workload VM for use in a Frame session.

Liquidware ProfileDisk

Enables support for Frame Enterprise Profiles in a Frame session (non-persistent only).

Frame Pen Driver

Enables support for digital pen tablets in a Frame session (requires supported endpoint device).

Frame Printer Driver

Enables support for Frame Printer in a Frame session.

Frame Scanner Driver

Enables support for WIA scanners in a Frame session (requires supported endpoint device).

Frame SmartCard Driver

Enables support for CAC/SmartCards in a Frame session (requires supported endpoint device).

Frame USB Driver

Enables support for Generic USB in a Frame session (requires supported endpoint device).

Frame AD Helper

Tool for troubleshooting issues with joining a Frame workload VM to an Active Directory domain.

Frame Proxy Helper

Tool for configuring Frame Agent to function properly with proxy servers.

Frame Sysprep Helper

Tool for troubleshooting and automatically resolving issues related to Windows Sysprep.

Frame Agent Setup Tool Installation

Warning

The Frame Agent Setup Tool is not able to resolve problems with broken MSI installations on the machine. Frame Agent Setup Tool is not a package repair tool. If you run into this issue, try resolving it manually or by using 3rd party software.

  1. Navigate to the account Sandbox where you would like to install the Frame Agent Setup Tool.

  2. Open FAST in the C:\ProgramData\Nutanix\Frame\Tools Folder, or Download the tool from the Nutanix Portal.

  3. Run the executable to launch the Frame Agent Setup Tool.

Usage

When you start the application, it will try to determine the infrastructure (AHV, GPC, Azure, or AWS) and attempt to obtain the Frame platform type (government or commercial) for that infrastructure. In cases where the machine still cannot determine the Frame platform type, a popup dialog box will appear:

../../_images/fastgov.png

Once the FAST utility has determined its environment, it will continue.

The FAST utility has two different views: Bundle View and Updater View. When you run the FAST utility, it will try to find Frame Agent and Streaming component. If it locates Frame Agent, it will start in Updater View. If Frame Agent cannot be found but streaming components are installed on the instance (e.g. clean Windows image), it will start in Bundle View.

Note

Frame recommends removing the FAST utility from the Sandbox when you have finished using it, before moving on to the publishing process.

Bundle View

  1. A dialog prompt will open, accept the terms and conditions. Click the “Next” button to continue.

../../_images/fuub1.png
  1. Select the desired packages for installation by checking the associated boxes. Click the “Install” button to continue.

../../_images/fuub2.png

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

../../_images/fuub3.png

Updater View

  1. Select the desired packages for installation by checking the associated boxes.

  2. Click the toggle located at the bottom of the window to acknowledge the machine has been backed up.

  3. Click the gear icon at the top left of the application to download and install your selected programs.

../../_images/fuu1.png
  1. Accept the prompt by clicking “OK.”

../../_images/fuu3.png

Up to Date

A package found on the machine is already up-to-date with the latest version.

Update Required

An installed package requires an update. Failure to update could result in system instability or compatibility conflicts.

Update Available

An installed package has an optional update. While not required, this update could improve performance or add new features.

Not Installed

An optional package is not installed.

Note

You may want to automate Frame Agent Setup Tool to update all components of their Frame Virtual Machines programmatically. In that case, you can use a command prompt, Frame Agent Setup Tool, and appropriate arguments to achieve this:

FrameUpdater getpackages
../../_images/fuucom.png

This argument will list all obsolete or non-installed packages. Additional run options are listed in the table below:

Name

Description

frameagentsetuptool.exe /?

Display help

frameagentsetuptool.exe getpackages

Display a list of all missing/obsolete packages

frameagentsetuptool.exe getpackages json

Display a list of all missing/obsolete packages in json format

frameagentsetuptool.exe install

Install all missing/obsolete packages

frameagentsetuptool.exe install only <Package1> <Package2> …

Install only provided packages

frameagentsetuptool.exe install except <Package1> <Package2> …

Install all missing/obsolete packages except provided packages

frameagentsetuptool.exe install bundle

Install all system and Frame components

frameagentsetuptool.exe install only <Package1> <Package2> bundle

Install only provided applications and all Frame system components

frameagentsetuptool.exe install except <Package1> <Package2> bundle

Install all available application except listed ones after installation of Frame system components

Note

For VMs still not connected to Frame platform (BYO Master Image preparation), registrationmetadata argument must provided:
frameagentsetuptool.exe getpackages registrationmetadata=YOUR-ADDRESS.com
frameagentsetuptool.exe install bundle registrationmetadata=YOUR-ADDRESS.com

Troubleshooting

The Frame Agent Setup Tool generates a log file for troubleshooting which is located in:

C:\ProgramData\Nutanix\Frame\Logs