Frame Guest Agent (FGA)

Overview

Frame Guest Agent (FGA) is a collection of Frame-specific services that manage VM configuration and functionality. FGA provides the following services:

• Communication between the VM and Frame backplane.

• VM configuration, orchestration, and session management.

• Session customization and scripting (stateful/stateless sessions, scripting, etc.)

• Verification, migration, and upgrade orchestration.

• Collection of server diagnostics and a variety of logs.

• Frame Remoting Protocol (FRP) which is responsible for the capture, encoding, and streaming of virtual applications/desktops to end user devices.

Network

The required ports/protocols for Frame Guest Agent 8 (using FRP7 or FRP8) are documented in the Networking Requirements based on your Frame account's deployment model.

OS Firewall

If your configuration relies on an OS-level firewall (e.g., Windows Firewall with Advanced Security or a third-party firewall) on a Sandbox, Utility Server, and/or persistent desktops, you will need to update firewall configurations on those workload VMs. For non-persistent Frame accounts, update the Windows Firewall on the Sandbox VM and publish, or use a GPO.

For example, using Windows Firewall with Advanced Security, Frame administrators would enable an inbound rule UDP ports 4503-4509 (either via GPO or directly within the workload VMs) for FRP8.

1. Go to Windows Firewall with Advanced Security
2. Select “Inbound Rules”
3. Right click > “New Rule…”
4. Port > UDP > Specific local ports: 4503-4509 > Allow the connection > Check all, Domain, Private, Public > Enter a name > Finish

  Refer to the [Networking Requirements](/platform/networking/requirements) for the complete list of inbound and                  outbound protocols/ports your OS firewall must allow for your workload VMs, specific to your deployment model, to work      with your end users and Frame Platform using FRP7 and/or FRP8.

Windows Updates

For non-persistent Frame accounts, Frame requires Windows updates to be applied in the Sandbox. Frame admins can then publish those updates to their test or production pools. During the provisioning of test or production workload VMs (triggered by a publish or the increase in the max Default Capacity), the Frame Guest Agent will disable Windows Update Services in the newly-provisioned non-persistent workload VMs.

Frame does not disable Windows Update Services in Sandbox, Utility server, or persistent desktop VMs.

Windows OS Performance Counters

Frame administrators can monitor the behavior of Frame Agent in Windows OS workload VMs through a set of performance counters, as described in the following table. Admins can use Windows Reliability and Performance Monitor (perfmon) or third-party monitoring tools to capture and report on these counters.

Troubleshooting

Frame Guest Agent logs can be found in the C:\ProgramData\Nutanix\Frame directory within the session.

After filing a support ticket, you may be asked by Frame support personnel to provide these logs, if available.