Using template versions

Template versions allow you to safely test changes on your hosts and perform rollback if necessary.

Supported providers

Template versions are supported for the following providers:

Hypervisor Providers:

  • Microsoft Hyper-V
  • Microsoft Hyper-V Failover Cluster
  • VMware ESXi
  • VMware VCenter

Cloud Providers:

  • Microsoft Azure

Virtualization services:

  • Azure Virtual Desktop

Creating a new version

To create a new version:

  1. Do one of the following:
    • To create a new version for an RD Session Host template, navigate to Farm > Site > RD Session Hosts > Templates.
    • To create a new version for a VDI host template, navigate to Farm > Site > VDI > Templates.
    • To create a new version for an AVD host template, navigate to Farm > Site > Azure Virtual Desktop > Templates.
  2. Select the template, enter the maintenance mode, make changes and exit. You will see a dialog that prompts you to create a new template version. Select the Create a new version option.
  3. Click Next.
  4. On the New template version page, specify the name and description and select the tags for the version. If the tag was previously assigned to another version, it will be removed from this version. You can select several tags.
  5. Click Next.
  6. (Optional) On the Select host pools page, select the host pools that you want to recreate on schedule and click the Configure button. You will see a dialog that allows you to schedule recreation. Configure the schedule according to your needs and click Next.
  7. Click Finish.

Working with version tags

To rename a tag:

  1. Navigate to Farm > Site > Settings and select Template versions tab.
  2. Double-click the tag that you want to rename.
  3. Change the name of the tag and press Enter.

To reassign tags of a version:

  1. Do one of the following:
    • To reassign tags for RD Session Host template, navigate to Farm > Site > RD Session Hosts > Templates.
    • To reassign tags for a VDI host template, navigate to Farm > Site > VDI > Templates.
    • To reassign tags for an AVD host template, navigate to Farm > Site > VDI > Azure Virtual Desktop > Templates.
  2. Select a template and click Tasks > Versions. The Versions dialog opens.
  3. Select a version and click Tasks > Properties.
  4. In the Version tag section, select the tags that you need. If the tag was previously assigned to another version, it will be removed from this version. You can assign several tags to a version. If another host pool uses the same version with the same tags, you will see a dialog that allows you to recreate hosts in that host pool.

Deleting a version

To delete a version:

  1. Do one of the following:
    • To delete a version of an RD Session Host template, navigate to Farm > Site > RD Session Hosts > Templates.
    • To delete a version of a VDI host template, navigate to Farm > Site > VDI > Templates.
    • To delete a version of an AVD host template, navigate to Farm > Site > VDI > Azure Virtual Desktop > Templates.
  2. Select a template and click Tasks > Versions. The Versions dialog opens.
  3. Select a version and click Tasks > Delete.

Settings audit

Settings audit allows you to see recent changes to versions.

To see settings audit:

  1. Do one of the following:
    • For RD Session Host template version settings audit, navigate to Farm > Site > RD Session Hosts > Templates.
    • For a VDI template version settings audit, navigate to Farm > Site > VDI > Templates.
    • For an AVD template version settings audit, navigate to Farm > Site > VDI > Azure Virtual Desktop > Templates.
  2. Select a template and click Tasks > Versions. The Versions dialog opens.
  3. Select a version and click Tasks > Settings audit.
Was this topic helpful?