Skip to main content

Persistent Desktops Administration

With a default Frame account, sessions are “stateless.” This means that all changes made to an instance are wiped from the instance after the session is closed. The instance is then returned to a pool where it waits to be served to the next user. The Frame platform also offers an alternative option called “Persistent Desktops.”

Persistent Desktops are stateful, desktop-only instances which are individually assigned to users. Users are given administrative control over their own desktop – they can install and manage their own unique application sets and settings in their own persistent environment. Account administrators can still monitor usage and basic session activity through the account Dashboard.

Persistent Desktop accounts can be created and configured:

  • On one of the supported infrastructures
  • For Windows domain-joined instances, if required

Applicability

Persistent Desktops were designed for organizations who prefer to give their users more control over their own environments. Frame Account administrators still configure the Sandbox image to be used as a base for all instances in the pool, but end users manage their own instance once assigned. If required, Persistent Desktops can be domain joined, in order for enterprises to manage these persistent desktops through a Windows domain.

Requirements

  • Users must be able to authenticate to the platform using either:

  • If the persistent desktop Frame account is configured to join the persistent desktop VMs to a Windows domain, the users can be required to authenticate to their Windows domain before accessing their assigned Windows desktop.

Setup

The Persistent Desktops feature is enabled upon account creation. It cannot be enabled on accounts that have already been created, since provisioning and infrastructure management of a Persistent Desktop account is handled differently than on a non-persistent Frame account.

Persistent Desktop Lifecycle

The state of a persistent desktop instance can be defined in the following ways:

  1. Currently assigned to a user ("Assigned Persistent Desktop")
  2. Currently unassigned, but was previously assigned to a user ("Unassigned Persistent Desktop")
  3. Waiting to be assigned to a new user ("Shadow Persistent Desktop")

When a user starts a Frame session and has not been assigned a persistent desktop, Frame associates the user's identity (as defined by the combination of identity provider they used to authenticate to Frame and their email address) to a Shadow Persistent Desktop. This persistent desktop is now the user's Assigned Persistent Desktop. If there are no Shadow Persistent Desktops available, the user will receive an error. Once a Shadow Persistent Desktop has been assigned, then Frame will provision another Shadow Persistent Desktop using the last published Sandbox, provided that the sum total of Assigned, Unassigned, and Shadow Persistent Desktops is less than or equal to the Max possible number of users set in Capacity.

Each time the user authenticates to their identity provider and the identity provider passes to Frame the user's email address, Frame will broker the user into their Assigned Persistent Desktop instance.

Administrators can also unassign a user from their Assigned Persistent Desktops as well as reassign a previously logged in user to the Assigned Persistent Desktop.

Finally, if the administrator can terminate a persistent desktop whether the desktop is Assigned or Unassigned.

Capacity Administration

Account capacity settings work a little differently than a non-persistent Frame account as there is only one pool of persistent desktops.

Persistent Desktop Capacity

  • Max possible number of users: Enter the max number of expected users (instances) for the account in this field. This value governs the sum total number of Assigned, Unassigned, and Shadow Persistent Desktops that can exist at anytime in the Frame account.

  • Limit number of backups saved: Enabling this toggle allows administrators to define the maximum number of scheduled and/or manual backups for each persistent desktop in the Frame account.

  • Number of automatic backups saved: Specifies the maximum number of scheduled backups retained for each persistent desktop.

  • Number of manual backups saved: Specifies the maximum number of manual backups retained for each persistent desktop.

  • Keep running instances for new users: Enabling this toggle keeps a Shadow Persistent Desktop instance running at all times to be immediately available for a new user (assuming that the total number of Assigned, Unassigned, and Shadow Persistent Desktops is less than the specified Max possible number of users).

    note

    Once a Shadow Persistent Desktop instance is assigned to a user, Frame will provision a new Shadow Persistent Desktop subject to the Max possible number of users value. By default, the number of Shadow Persistent Desktop is set to 1. This value can be increased on request by contacting Support.

    When using AWS, GCP, or Azure, enabling this toggle will result in infrastructure costs for the time that the Shaddow Persistent Desktops are running, even though it is not being actively used. Keeping this toggle off eliminates those infrastructure costs, but a new user will need to wait for the instance to power on before the instance can be assigned to them for their first Frame session. This can take upwards of 10-15 minutes, depending on the infrastructure.

  • Keep instances running: Specifies when and for how long will the persistent desktop VMs stay powered on.

    • Basic: The persistent desktop is powered on when the user requests access to their persistent desktop. The persistent desktop will remain on, even if the user closes their session for the next full hour increment, as measured from when the instance was first powered on. For example, if the persistent desktop was powered on at 9:05 AM and the user used their persistent desktop until 12:30 PM, then the active, but not used persistent desktop would be powered off at 1:05 PM. The time period can be lowered to 15 minutes by contacting Support.
    • Always: The persistent desktop powers on and will remain powered on unless the persistent desktops are rebooted or powered off by the end user or administrator.
    • Wake up instances: Instances can be powered on at a specific time of the day. Those persistent desktop VMs that are not in use will remain powered on for the next full hour increment, as measured from when the instance was first powered on, and then powered off. The time period can be lowered to 15 minutes by contacting Support.

Persistent Desktop Wake Up Instances

Sandbox Image Management

Managing your Sandbox image on a Persistent Desktop account is essentially the same as a non-persistent, regular Frame account. The difference lies in how your changes are propagated to the workload instances. Since an instance is assigned to each user as they log in for the first time, any Sandbox updates that are published after the assignment will only be made to the Shadow Persistent Desktop. Assigned and Unassigned Persistent Desktops will not be affected by the publish of the Sandbox.

In the event that the same changes to the Sandbox must be applied to Assigned or Unassigned Persistent Desktop instances, an account administrator must apply them to those instances or terminate the Assigned or Unassigned Persistent Desktop, as discussed in Terminate a Persistent Desktop.

danger

Terminating an instance will permanently delete all data on that instance. Any data that a user needs from their instance, such as work files or software licenses, should be retrieved from their persistent desktop before the account administrator terminates their instance.

Updates

The Updates page of your Account Dashboard will display any needed OS or Frame-related updates for your VMs. More details can be found in the Updates section of our documentation.

Persistent Desktop Volumes

Administrators can manage the persistent desktop backups for individual users by navigating to the Volumes page in the account Dashboard. The first tab is the Volumes tab which provides a list of named user volumes, the volume size and status, and the available free space for each volume. There are also additional operations, described below, accessible under the kebab menu in the upper right corner of the page.

Persistent Desktop Volumes

If you are looking for a specific volume, you can use the search bar at the top of the page to search by volume name.

Autogrow Settings

If you anticipate that your users will need to regularly increase their Persistent Desktop disk size, you can set parameters for Frame to automatically scale up as needed. To do this, navigate to the Volumes page, click on the kebab menu and select Autogrow settings. A new dialog box will appear:

Persistent Desktop Autogrow Settings

Here, you can specify the threshold at which the disk size will automatically increase for established users. By default, the disk volume will automatically be increased by 10 GB when there is less than 5 GB of free space remaining. You can adjust these values as you see fit for your users.

You can enforce a maximum disk volume size by enabling the Limit maximum volume size slider and setting the Maximum volume size. Enable autogrow settings must be enabled first. If you do not enable Limit maximum volume size, there is no limitation on how large the individual user's persistent desktop volume can autogrow.

Be sure to click Confirm once you have adjusted the settings as desired.

Backup All Volumes

You can backup all persistent desktop volumes (versus individual persistent desktop volumes) by clicking on the kebab menu and select Backup all persistent desktop volumes. You will be asked to confirm that you wish to proceed.

Clone

You can clone the persistent desktops from one Frame account to another Frame account using the Clone persistent volumes feature. This feature is only for persistent desktop Frame accounts on Nutanix AHV clusters.

  1. Before you initiate the clone operation, you can specify whether the clone operation will replace persistent desktops in the destination Frame account if the same owners have assigned persistent desktop in the source Frame Account:

    • Disable Replace Assigned Volumes (default) will direct the clone operation to skip the cloning of any persistent desktops from the source Frame account whose owners have assigned persistent desktops in the destination Frame account.
    • Enable Replace Assigned Volumes to copy all persistent desktop volumes from the source to destination Frame account. If there are owners with assigned persistent desktops in both the source and destination Frame accounts, the owners' assigned persistent desktop volume from the source Frame account will replace the persistent desktop volume in the destination Frame account.
  2. Then click on Clone button to proceed or Cancel button to cancel the clone operation request.

note

The clone operation will not delete the persistent desktop volumes in the source Frame account.

Prerequisites

  1. Nutanix Remote Site must be configured between the two AHV Clusters.
  2. The destination Frame account must exist in Frame Console.

Process

The persistent desktop VMs in the source Frame account will be powered off before the clone operation commences. If there are any users in session, the clone operation will block until all users have finished their sessions and Frame can power off their persistent desktop VMs.

Once the clone operation completes, Frame Platform will power on the persistent desktop VMs based on Capacity Administration Keep instances running setting.

Backups

The Backups tab provides the account administrator with a detailed view of available backups for the volume specified under the Volume drop-down menu at the top of the window. Details include the name, time/date of creation, type of backup, and the number of backups for the volume (shown in the lower right corner of the window).

Persistent Desktop Backups

Manual Backup and Restore

To create a backup, simply click the blue Create backup link in the upper right corner of the window. A new window will appear prompting you to select the volume you wish to backup from the drop-down menu. Be sure to provide a name for this backup as well. From there, click Create in the bottom right corner of the window.

Persistent Desktop Backups

caution

In order to create a persistent desktop volume backup, you must ensure the instance is in a stopped state.

The status of your backup will appear in your Notification Center:

Backup Status Notification Center

Once completed, the new backup will appear in your list. You can restore a backup at any time by clicking on the kebab menu to the right of the desired backup and clicking Restore.

caution

Restoring from a previous backup will replace the volume with the backup image you select. Any changes made since the selected backup was created will be erased.

Schedule Backups

To schedule daily backups of all persistent desktops, simply click the kebab menu in the upper right corner of the backups section and click on Settings. A new window will appear with a toggle to enable daily scheduled backups. Enable the toggle and schedule the time you would like your daily backups to start. Click Confirm to proceed.

Schedule Persistent Desktop Backups

note

In order for a persistent desktop to be included in the next scheduled backup event, the persistent desktop must:

  1. Be in Stopped or Running status. If the persistent desktop is Running, Frame will power off the persistent desktop before the disk is backed up. If a user is In Session, the persistent desktop will not be included in the scheduled backup event.
  2. Have been powered on for the disk to have changed since the last scheduled backup event.

If you change the backup schedule, the revised backup schedule takes effect on the next day.

Delete a Backup

You can delete a backup by clicking on the kebab menu mentioned above and selecting Delete.

User-managed Backups

Administrators can decide whether or not they would like their users to manage their own system backups. User-managed backups can be enabled by navigating to the Settings page in the Dashboard and enabling the Are persistent desktops backups allowed toggle listed under General settings.

User-managed Backups

Once enabled, end users can manage their backups from their profile page. More information about this feature can be found in the Navigating your Frame Account Guide.

Change Instance Type

Some administrators may wish to change their Persistent Desktop user's instance type to accommodate the user's needs. For instance, the end user may need a higher-performing instance type after taking on a project which requires video editing and graphic design. Since Persistent Desktop accounts are structured differently than a standard Frame account, this process is also slightly different (but still simple!).

  1. Start by navigating to the Status page within the desired Account Dashboard. Under the Servers tab, find the Persistent Desktop you wish to change. You can hover over the machine name on this list to see more details (including the user name assigned to the Persistent Desktop VM).

Status > Servers

  1. Next, click the kebab menu to the right of the Persistent Desktop and select Change instance type.

Change Instance Type

  1. Select the desired instance from the drop-down menu. Click Save.

Save Instance Type

  1. You will receive status updates for the operation through the Notification Center.

Save Instance Type

The instance type update will be reflected in the listed details under the Servers tab.

note

For public cloud infrastructure, changing the instance type requires the new VM to power on after the existing persistent desktop disk is attached to the new VM and the old VM is terminated.

Reassign Persistent Desktops

Administrators can reassign an Assigned Persistent Desktop to a different user (or let an existing user be reassigned to their Persistent Desktop via a different Identity Provider) by going to the Status page within the Account Dashboard. Before proceeding to the instructions, please carefully read the considerations below:

Considerations

  • The desired user must have already logged in to the Frame Account using the identity provider and email address specified by the administrator. If the user is not visible in the drop-down menu, then they have not logged in to Frame using that specific Identity Provider. Ensure the user first logs in to the Frame Account before reassigning the Assigned Persistent Desktop to the user.

  • Any existing applications, configurations, files, application data, local user profiles, etc. will still remain on the VM when you reassign a Persistent Desktop. If desired, administrators can reassign the VM to themselves first if they need to perform any maintenance before reassigning to a new user.

  • The VM cannot be in use by a Persistent Desktop user.

  • If a user already has a Persistent Desktop assigned to them within the same Frame account, they cannot be assigned to another Persistent Desktop. Administrators attempting to do so will see an error message that reads “Bad Request: Invalid request. Selected user already has assigned instance with same account.”

Procedure

  1. Navigate to the Status page on the Account Dashboard and select the Servers tab. You can hover over the machine name on this list to see more details (including the user name assigned to the Persistent Desktop VM).

    Servers Tab

  2. Click on the kebab menu to the right of the Persistent Desktop to be reassigned and click Reassign.

    Reassign Persistent Desktop

  3. When you select Reassign, the following window will appear:

    Reassign Dialog

  4. Use the drop-down menus to select the Identity Provider the user will be accessing the platform with and the new user's email address.

  5. Click Save when you're ready. Once the desktop has been reassigned, you can hover over the machine name of the Persistent Desktop VM to verify the change has been made.

Unassign Persistent Desktops

Administrators can unassign a user from their Assigned Persistent Desktop at anytime. Once the user is unassigned from their persistent desktop, the persistent desktop is an Unassigned Persistent Desktop.

Considerations

  • The administrator cannot unassign an Assigned Persistent Desktop if the persistent desktop in use by a Persistent Desktop user.

  • If the user starts a session after they were unassigned from their Assigned Persistent Desktop, Frame will:

    1. Assign the user a Shadow Persistent Desktop, if one exists, and this persistent desktop will now be an Assigned Persistent Desktop.
    2. Broker the user to an existing persistent desktop that the administrator assigned to the user using the Reassign Persistent Desktops featur (prior to the user starting a session in Frame Console).

If the administrator does not want the user to get a new persistent desktop, then they must remove the user's authorization to access the Frame persistent desktop account.

Procedure

  1. Navigate to the Status page on the Account Dashboard and select the Servers tab. You can hover over the machine name on this list to see more details (including the user name assigned to the Persistent Desktop VM).
  2. Click on the kebab menu to the right of the Persistent Desktop to be reassigned and click Unassign.
  3. Click on Unassign to confirm that the user will no longer be assigned with the persistent desktop or Cancel if you do not want to unassign the user from their Assigned Persistent Desktop. Once the desktop has been unassigned, you can hover over the machine name of the Persistent Desktop VM to verify the user is no longer assigned to the Persistent Desktop VM.

Terminate a Persistent Desktop

If an assigned persistent desktop is no longer needed, you can terminate the persistent desktop with the following procedure:

  1. Start by navigating to the Status page within the desired Account Dashboard. Under the Servers tab, find the Persistent Desktop you wish to terminate.

  2. Click on the kebab menu to the right of the Persistent Desktop to be terminated and click Terminate.

  3. Select the checkbox to Delete all backups associated with the selected Volume if you wish to delete all of the backups associated with this persistent desktop.

  4. Select:

    • Terminate: If you wish to wait for the Frame session to close before terminating the persistent desktop VM, disk volume, and backups (if requested).
    • Force Terminate: Terminate the persistent desktop VM, disk volume, and backups (if requested) immediately without waiting for the Frame session to close.

Depending on the values for the Persistent Desktop Capacity setting Max possible number of users, the current number of assigned persistent desktops, the current number of unassigned persistent desktops, and the current number of Shadow Persistent Desktops, Frame may create a new Shadow Persistent Desktop instance to replace the terminated Persistent Desktop.

The next time the user logs into Frame and requests a desktop, Frame will:

  1. Assign the user a Shadow Persistent Desktop, if one exists, and this persistent desktop will now be an Assigned Persistent Desktop.
  2. Broker the user to an existing persistent desktop that the administrator assigned to the user using the Reassign Persistent Desktops feature (prior to the user starting a session in Frame Console).

If the administrator does not want the user to get a new persistent desktop, then they must remove the user's authorization to access the Frame persistent desktop account.

If you wish to reduce the number of shadow persistent desktops after the termination of one or more assigned/unassigned persistent desktops, reduce the Persistent Desktop Capacity setting Max possible number of users by the number of unwanted shadow persistent desktops. Once Frame control plane will terminate the desired number of shadow persistent desktops, you can revert the Max possible number of users value to the original value.