Prepare the OS Image (vSphere)

This topic explains how to prepare an OS Image for the Unidesk environment, using the OS Machine Tools available for download on the Unidesk Download page.

Notes:

• The OS Image should not be in a domain.
• The OS Image should get its IP address from DHCP.
• Using Third-party optimization scripts can have adverse effects in Unidesk, as they can change services and features that Unidesk uses, for example, Universal Plug and Play and the 8.3 file names setting. Use the optimization tools in the Unidesk Installer download to optimize your image.
• Ensure that the VM for your OS Layer is MBR partitioned, rather than GPT partitioned. Otherwise, you will not be able to install the Unidesk OS Machine Tools.
• The Paravirtual SCSI controller is not supported. You must use the default controller (SCSI BusLogic) for the OS to be functional. Unidesk supports the LSI Logic SAS controller type. If you subsequently change the SCSI controller type to anything else, such as VMware Paravirtual SCSI controller, the OS Layer import will fail.

Which operating system are you using?

Choose the operating system you are using for the OS Image:

• Windows Server 2012 R2 (Session Host)
• Windows Server 2008 R2
• Windows 10
• Windows 7

Prepare a Windows Server 2012 R2 image (Session Host)

STEP 1: Set up a Windows Server 2012 R2 OS Image on a virtual machine

In the vSphere client:

1. Create a VM for the OS image.

2. Configure the virtual machine hardware settings, for example, the NIC and video memory.

   Important: You can have just one network device for the virtual machine, and it must be the VMXNET 3 network adapter, as the default E1000 adapter (or even a ghost NIC leftover from an E1000 adapter) can cause customization timeout errors on the VM when attempting to boot the image in environments such as Citrix PVS, Citrix MCS, or VMware Horizon View.

3. Configure a virtual hard disk that is large enough for a Windows operating system installation, and make sure it is accessible by the Unidesk Management Appliance.
4. Install Windows Server 2012 R2.
5. Disable Windows System Restore and Windows Automatic Updates. The Unidesk system handles restore points for you, and Unidesk layer versions allow you to control when updates occur.
6. Install VMware Tools on your OS image.

STEP 2: Copy the Unidesk OS Machine Tools onto the OS Image

1. Download the Unidesk_OS_Machine_Tools ZIP file onto the OS Image.
2. Extract the Unidesk_OS_Machine_Tools_x.x.x to c:\windows\setup\scripts.

STEP 3: (Optional) Create an answer file for unattended installation on Unidesk desktops

1. In the c:\windows\setup\scripts folder, right-click the unattend.exe tool and choose Run as administrator. The unattend builder form opens.

2. Complete the unattend form.

   • Product key activation
     • For KMS activation, select KMS Server.
     • For KMS with a Multiple Activation Key (MAK), select KMS with MAK and enter the MAK.
     • For Retail Licensing with a MAK, select Retail with MAK, and the MAK.
   • Domain Join
     • Select Enable if you want to configure the unattend.xml file to join desktops to a specific domain. If you plan to use AD join scripts, ensure Enable is not selected.
     • You can add desktops to the Computer's container in Active Directory by deleting the OU entry. However, we recommend that you use an alternate OU for Unidesk desktops, both to segregate the desktop from other machines and to avoid applying virtual desktop-specific GPOs to other types of machines.
     • If you are supporting multiple OUs within one or more domains, you can join machines in different Domains or OUs by creating different unattend.xml files in different application layers.
   • Local Administrator account
     • If you want to use the unattend.xml file to enable the Administrator account on each Unidesk desktop, select Enable. Remember to also enable this account in your OS Image or Operating System Layer revision. It is possible to enable the Administrator account for your OS Image and then have it disabled in the deployed desktops by clearing the check box.
     • If you want to add an alternate Administrator account, select Enable and enter the account information. This account cannot be pre-configured in the OS Image.
     • You can create a desktop where the Administrator is disabled and the alternate administrator is created and enabled. However for this to work, the Administrator account must be enabled in the OS Image and it cannot be renamed.
   • Time zone
     • Select the time zone. If your time zone is not listed, you can add it to the Other box. Be sure to use the time zone, not the display setting. A list of time zone settings can be found here.
   • Disabling automatic activation
     • Select this option if you plan to use the Microsoft Volume Activation Management Tool.

3. Click Save File.

STEP 4: (Optional) Optimize the OS Image for the Unidesk environment

1. In the c:\windows\setup\scripts folder, run the Optimize executable to create a .cmd file (optimization.cmd) that will be run to optimize the image during Desktop creation.

2. Follow the instructions to run the optimize.cmd file on the OS Image. This removes installation-specific drivers and settings.

   If you are using the Unidesk Optimizer script and you are enabling the View Persona feature, you must go to the section of the Optimizer script called Disable Unnecessary Services to Save Memory and CPU, deselect the option to Disable Offline File Service, and click Save File. This is because View Persona folder redirection requires Offline files to be enabled, and by default, the Unidesk Optimizer turns off Offline files, which are not a requirement for Unidesk.

STEP 5: Create a snapshot of the OS Image

Once the OS Image is ready, create a VMware snapshot of it, so that you can return to this state at any time.

Important: It is critical to create a snapshot before installing the Unidesk software onto the OS Image. Without this snapshot, returning to this state requires rebuilding the image.

STEP 6: Install the Unidesk tools onto the OS Image

1. In the Unidesk_OS_Machine_Tools folder, run the Unidesk setup_x86.exe (32-bit) or setup_x64.exe (64-bit).

2. The installation prompts for the location of the unattend.xml file (the default location is c:\windows\panther).

Once this is done, you are ready to create a Unidesk Operating System Layer.

Prepare a Windows 2008 R2 image

STEP 1: Set up a Windows Server 2008 R2 OS Image on a virtual machine

In the vSphere client:

1. Create a VM for your OS image, making sure to choose the default cluster allocation size of 4K.

2. Configure the virtual machine hardware settings, for example, the NIC and video memory.

   Important: You can have just one network device for the virtual machine, and it must be the VMXNET 3 network adapter, as the default E1000 adapter (or even a ghost NIC leftover from an E1000 adapter) can cause customization timeout errors on the VM when attempting to boot the image in environments such as Citrix PVS, Citrix MCS, or VMware Horizon View.

3. If you are using Citrix PVS or VMware Horizon View, install Windows Server 2008 R2 Service Pack 1 (SP1).

   Notes:

   • If you do not install SP1, an error occurs when you try to install View Agent in the virtual machine.
   • When creating the image, be sure to choose the default cluster allocation size of 4K.

4. If using PVS:

   1. In the VM properties, make sure the PCI slot number is 192, as shown below (mouse over the image to enlarge it):

      

   2. Install KB2550978 hotfix:

      https://support.microsoft.com/en-us/kb/2550978

   3. Run cmd as Administrator, and enter the following commands:

      set devmgr_show_nonpresent_devices=1
      run devmgmt.msc in the same cmd window

      Note: You must run these commands, or the next command will not show hidden devices (ghost NICs)

   4. Select View >Show hidden devices in Device Manager. This shows dead NICs as grayed out.

   5. Uninstall the dead NIC and reboot the system.

5. Install VMware Tools on the OS image.

STEP 2: Copy the Unidesk Tools onto the OS Image

1. Download the Unidesk_OS_Machine_Tools ZIP file onto the OS Image.
2. Extract the Unidesk_OS_Machine_Tools_x.x.x to c:\windows\setup\scripts.

STEP 3: (Optional) Create an answer file for unattended installation on Unidesk desktops

1. In the c:\windows\setup\scripts folder, right-click the unattend.exe tool and choose Run as administrator. The unattend builder form opens.

2. Complete the unattend form.

   • Product key activation
     • For KMS activation, select KMS Server.
     • For KMS with a Multiple Activation Key (MAK), select KMS with MAK and enter the MAK.
     • For Retail Licensing with a MAK, select Retail with MAK, and the MAK.
   • Domain Join
     • Select Enable if you want to configure the unattend.xml file to join desktops to a specific domain. If you plan to use AD join scripts, ensure Enable is not selected.
     • You can add desktops to the Computer's container in Active Directory by deleting the OU entry. However, we recommend that you use an alternate OU for Unidesk desktops, both to segregate the desktop from other machines and to avoid applying virtual desktop-specific GPOs to other types of machines.
     • If you are supporting multiple OUs within one or more domains, you can join machines in different Domains or OUs by creating different unattend.xml files in different application layers.

     • For information about domain join scripts, see the following Support articles:

       Debugging Domain Join Problems in Windows 7 and Windows Server 2008 R2

   • Local Administrator account
     • If you want to use the unattend.xml file to enable the Administrator account on each Unidesk desktop, select Enable. Remember to also enable this account in your OS Image or Operating System Layer revision. It is possible to enable the Administrator account for your OS Image and then have it disabled in the deployed desktops by clearing the check box.
     • If you want to add an alternate Administrator account, select Enable and enter the account information. This account cannot be pre-configured in the OS Image.
     • You can create a desktop where the Administrator is disabled and the alternate administrator is created and enabled. However for this to work, the Administrator account must be enabled in the OS Image and it cannot be renamed.
   • Time zone
     • Select the time zone. If your time zone is not listed, you can add it to the Other box. Be sure to use the time zone, not the display setting. A list of time zone settings can be found here.
   • Disabling automatic activation
     • Select this option if you plan to use the Microsoft Volume Activation Management Tool.

3. Click Save File.

STEP 4: (Optional) Optimize the OS Image for the Unidesk environment

1. In the c:\windows\setup\scripts folder, run the Optimize executable to create a .cmd file (optimize.cmd) that will be run to optimize the image during desktop creation.

2. Follow the instructions to run the optimize.cmd file on the OS Image. This removes installation-specific drivers and settings.

   If you are using the Unidesk Optimizer script and you are enabling the View Persona feature, you must go to the section of the Optimizer script called Disable Unnecessary Services to Save Memory and CPU, deselect the option to Disable Offline File Service, and click Save File. This is because View Persona folder redirection requires Offline files to be enabled, and by default, the Unidesk Optimizer turns off Offline files, which are not a requirement for Unidesk.

STEP 5: Create a VMware snapshot of the OS Image

Once the OS Image is ready, create a VMware snapshot of it so you can return to this state at any time.

Important: It is critical to create a snapshot before installing the Unidesk software onto the OS Image. Without this snapshot, returning to this state requires rebuilding the image.

STEP 6: Install the Unidesk tools onto the OS Image

1. In the Unidesk_OS_Machine_Tools folder, run the Unidesk setup_x86.exe (32-bit) or setup_x64.exe (64-bit).

2. The installation prompts for the location of the unattend.xml file (the default location is c:\windows\panther).

Once this is done, you are ready to create a Unidesk Operating System Layer.

Prepare a Windows 10 image

When preparing the OS Image for import into a Unidesk Operating System Layer, you can speed up start times by removing Windows 10 built-in applications. If you do, we recommend removing these applications either on the OS Image itself, or on the Operating System Layer.

STEP 1: Set up a Windows 10 image on a virtual machine

In the vSphere client:

1. Create a VM for your OS image.

   Important: When creating the image, be sure to choose the default cluster allocation size of 4K.

2. Configure the virtual machine hardware settings, for example, the NIC and video memory.

3. Disable Windows System Restore and Windows Automatic Updates:

   1. Log into the VM.

   2. Select Computer Config > Administrative Templates > Windows Components > Windows Updates > Config Auto Updates.
   3. Set this to Disabled.

   The Unidesk system handles restore points for you, and Unidesk layer versions allow you to control when updates occur.

4. If using KMS licensing, run a command window as Administrator, and enter these commands:

   slmgr /skms <kmsserverhost>
   slmgr /rearm
   reboot
   slmgr /ipk XXXX-YOUR-KMS-KEY-XXXX
   slmgr /ato

5. Install the VMware Tools on the OS image.

STEP 2: Copy the Unidesk Tools onto the OS Image

1. Download the Unidesk_OS_Machine_Tools ZIP file onto the OS Image.
2. Extract the Unidesk_OS_Machine_Tools_x.x.x to c:\windows\setup\scripts.

STEP 3: (Optional) Create an answer file for unattended installation on Unidesk Desktops

1. In the c:\windows\setup\scripts folder, right-click the unattend.exe tool and choose Run as administrator. The unattend builder form opens.

2. Complete the unattend form.

   Product key activation

   For KMS activation, select KMS Server.

   For KMS with a Multiple Activation Key (MAK), select KMS with MAK and enter the MAK.

   For Retail Licensing with a MAK, select Retail with MAK, and the MAK.

   Domain Join

   Select Enable if you want to configure the unattend.xml file to join Desktops to a specific domain. If you plan to use AD join scripts, ensure Enable is not selected.

   You can add Desktops to the Computer's container in Active Directory by deleting the OU entry. However, we recommend that you use an alternate OU for Unidesk Desktops, both to segregate the Desktop from other machines and to avoid applying virtual Desktop-specific GPOs to other types of machines.

   If you are supporting multiple OUs within one or more domains, you can join machines in different Domains or OUs by creating different unattend.xml files in different application layers.

   Local Administrator account

   You can enable the Administrator account on each Unidesk Desktop by selecting Enable. Remember to also enable this account in your OS Image or Operating System Layer version. You can also enable the Administrator account for your OS Image and then have it disabled in the deployed Desktops by clearing the check box.

   If you want to add an alternate Administrator account, select Enable and enter the account information. This account cannot be preconfigured in the OS Image.

   You can create a Desktop where the Administrator is disabled and the alternate administrator is created and enabled. However for this to work, the Administrator account must be enabled in the OS Image and it cannot be renamed.

   Time Zone

   If your time zone is not listed, you can add it to the Other box. Be sure to use the time zone, not the display setting.

   Disabling automatic activation

   Select this option if you plan to use the Microsoft Volume Activation Management Tool.

3. Click Save File.

STEP 4: (Optional) Optimize the OS Image for the Unidesk environment

1. In the c:\windows\setup\scripts folder, right-click the optimizations.exe tool and choose Run as administrator. This creates a .cmd file (optimizations.cmd) that will be run during Desktop creation to optimize the image.

2. Follow the instructions to run the optimizations.cmd file on the OS Image. This removes installation-specific drivers and settings.

   If you are using the Unidesk Optimizer script and you are enabling the View Persona feature, you must go to the section of the Optimizer script called Disable Unnecessary Services to Save Memory and CPU, deselect the option to Disable Offline File Service, and click Save File. This is because View Persona folder redirection requires Offline files to be enabled, and by default, the Unidesk Optimizer turns off Offline files, which are not a requirement for Unidesk.

STEP 5: Install .Net Framework 3.5.1

The .Net Framework is a software framework provided by Microsoft that is required for many 3rd party applications to run. To install this feature, follow the steps below.

1. On the Start menu, select Control Panel > Programs and Features.

2. In the left panel select Turn Windows features on or off. A window opens.

3. Select .NET Framework 3.5, click OK, and wait for the installation to complete.

   Important: Even if .NET is already installed, continue with the rest of these steps.

4. Exit the Control Panel.

5. In Notifications in the right-side of your taskbar, click All Settings, and open the Windows 10 Settings app.

6. Select Settings > Update & Security.

7. Check for updates, and install all updates available.

8. Exit Settings.

9. Open an administrator-level command prompt, and enter the following commands:

   cd \windows\Microsoft.Net\Framework\v4.nnnnn
   ngen update /force

10. Wait for the command to complete, and enter the following commands:

    cd \windows\Microsoft.Net\Framework64\v4.nnnnn
    ngen update /force

11. Exit the command prompt.

STEP 6: If using PVS, follow these steps to avoid ghost NICs.

1. Install KB2550978 hotfix.

2. Reboot the VM,

3. Enter the commands:

   set devmgr_show_nonpresent_devices=
   devmgmt.msc

4. Remove any ghost NICs.

5. Reboot the system.

STEP 7: Create a backup copy of the OS Image

Once the OS Image is ready, create a copy of it so you can return to this state at any time.

Important: It is critical to create a backup copy before installing the Unidesk software onto the OS Image. Without this backup copy, returning to this state requires rebuilding the image.

STEP 8: Install the Unidesk software onto the OS Image

1. Run setup_x64.exe from c:\Windows\setup\scripts.

Once this is done, you are ready to create a Unidesk Operating System Layer.

Prepare a Windows 7 image

STEP 1: Set up a Windows 7 OS Image on a virtual machine

In the vSphere client:

1. Create a VM for your OS Image.

   Important: When creating the image, be sure to choose the default cluster allocation size of 4K.

2. Configure the virtual machine hardware settings, for example, the NIC and video memory.

3. Disable Windows System Restore and Windows Automatic Updates. The Unidesk system handles restore points for you, and Unidesk layer versions allow you to control when updates occur.

4. Make sure you have installed VMware Tools on the OS image.

STEP 2: Mount or copy the Unidesk Tools onto the OS Image

1. Download the Unidesk_OS_Machine_Tools ZIP file onto the OS Image.
2. Extract the Unidesk_OS_Machine_Tools_x.x.x to c:\windows\setup\scripts.

STEP 3: (Optional) Create an answer file for unattended installation on Unidesk desktops

1. In the c:\windows\setup\scripts folder, right-click the unattend.exe tool and choose Run as administrator. The unattend builder form opens.

2. Complete the unattend form.

   • Product key activation
     • For KMS activation, select KMS Server.
     • For KMS with a Multiple Activation Key (MAK), select KMS with MAK and enter the MAK.
     • For Retail Licensing with a MAK, select Retail with MAK, and the MAK.
   • Domain Join
     • Select Enable if you want to configure the unattend.xml file to join desktops to a specific domain. If you plan to use AD join scripts, ensure Enable is not selected.
     • You can add desktops to the Computer's container in Active Directory by deleting the OU entry. However, we recommend that you use an alternate OU for Unidesk desktops, both to segregate the desktop from other machines and to avoid applying virtual desktop-specific GPOs to other types of machines.
     • If you are supporting multiple OUs within one or more domains, you can join machines in different Domains or OUs by creating different unattend.xml files in different application layers.

     • For information about domain join scripts,see the following Support articles:

       Debugging Domain Join Problems in Windows 7 and Windows 2008 R2

       Using PowerShell for Advanced Domain Join Operations

   • Local Administrator account
     • If you want to use the unattend.xml file to enable the Administrator account on each Unidesk desktop, select Enable. Remember to also enable this account in your OS Image or Operating System Layer revision. It is possible to enable the Administrator account for your OS Image and then have it disabled in the deployed desktops by clearing the check box.
     • If you want to add an alternate Administrator account, select Enable and enter the account information. This account cannot be pre-configured in the OS Image.
     • You can create a desktop where the Administrator is disabled and the alternate administrator is created and enabled. However for this to work, the Administrator account must be enabled in the OS Image and it cannot be renamed.
   • Time zone
     • Select the time zone. If your time zone is not listed, you can add it to the Other box. Be sure to use the time zone, not the display setting. A list of time zone settings can be found here.
   • Disabling automatic activation
     • Select this option if you plan to use the Microsoft Volume Activation Management Tool.

3. Click Save File.

STEP 4: (Optional) Optimize the OS Image for the Unidesk environment

1. In the c:\windows\setup\scripts folder, run the Optimize executable to create a .cmd file (optimize.cmd) that will be run to optimize the image during desktop creation.

2. Follow the instructions to run the optimize.cmd file on the OS Image. This removes installation-specific drivers and settings.

   If you are using the Unidesk Optimizer script and you are enabling the View Persona feature, you must go to the section of the Optimizer script called Disable Unnecessary Services to Save Memory and CPU, deselect the option to Disable Offline File Service, and click Save File. This is because View Persona folder redirection requires Offline files to be enabled, and by default, the Unidesk Optimizer turns off Offline files, which are not a requirement for Unidesk.

STEP 5: If using PVS, follow these steps to avoid ghost NICs

1. Install KB2550978 hotfix.
2. Reboot the VM,

3. Enter the commands:

   set devmgr_show_nonpresent_devices=1
   devmgmt.msc

4. Remove any ghost NICs.
5. Reboot the system.

STEP 6: Create a VMware snapshot of the OS Image

1. Create a VMware snapshot of the OS image so you can return to this state at any time.

   Important: It is critical to create a snapshot before installing the Unidesk software onto the OS Image. Without this snapshot, returning to this state requires rebuilding the image.

STEP 7: Install the Unidesk software onto the OS Image

1. In the Unidesk_OS_Machine_Tools folder, run the Unidesk setup_x86.exe (32-bit) or setup_x64.exe (64-bit).

2. The installation prompts for the location of the unattend.xml file (the default location is c:\windows\panther).

Once this is done, you are ready to create a Unidesk Operating System Layer.