Skip to main content

Preparing to Add an Image with Amazon WorkSpaces Core

Before you can add an Amazon WorkSpaces Core image in Horizon Cloud, you must first prepare the image.

The preparation steps differ depending on whether you are adding a Windows Server-based images or a Windows 11-based image. The process also varies based on the image source, whether the image is created as an Amazon WorkSpaces Core Custom Image or as an Amazon EC2 Custom Instance source in Horizon Cloud.

After the image is prepared, you can add it in Horizon Cloud according to its source type.

Preparing to Add an Amazon EC2 Custom Instance

Use the following procedure to prepare and add Windows 11 images as an Amazon EC2 Custom Instance.

  1. Enable Amazon WorkSpaces Core BYOL (Microsoft 365 Bring Your Own License) for the AWS account.

  2. Obtain a Microsoft Windows 11 license and create an Amazon Machine Image (AMI).

  3. Create an EC2 instance from the AMI.

  4. Run the BYOL checker on the EC2 VM. To run the BYOL checker, follow Step 3 of Bring Your Own Windows desktop licenses in WorkSpaces in AWS documentation. Resolve any issues that the BYOL checker reports before proceeding.

  5. The IMS will install the Horizon Agent and pairing configuration file automatically during publishing. If you use IMS, skip Steps 6-8.

    Note:

    • Install the required Horizon Agent (HAI) and agent pairing configuration file manually or allow the Image Management Service (IMS) to install them automatically during image publishing.

    • Ensure that the Amazon SSM agent is installed and running on the EC2 instance before using IMS. The IMS requires the SSM agent to perform remote installation of the Horizon Agent and pairing configuration file.

      For information about SSM, see Working with SSM Agent - AWS Systems Manager.

  6. Install the latest Horizon Agent (HAI version 25.1.0 or later) on the EC2 instance as described in Omnissa Horizon Cloud: Installing Horizon Agents manually (91998).

    Amazon WorkSpaces Core images require an HAI agent version of 25.1 or greater.

  7. Install the agent pairing configuration file in the EC2 instance as follows:

    1. Obtain the file by navigating to the Edge Details or Providers page of an existing Amazon WorkSpaces Core Edge provider type (or when creating a new Horizon Edge using the Amazon WorkSpaces Core provider type).

    2. Click Copy agent pairing configuration to copy the hidden configuration content to the clipboard.

    3. Save the copied content in a new file named Config.bin.

    4. Place the Config.bin file in the EC2 instance at C:\AzureData\Config.bin.

      Note: The agent pairing configuration file is valid for five years.

  8. Change the owner of the file to the system by running the following PwerShell script in Administrator mode:

           # Set the owner of the agent pairing configuration file as NT AUTHORITY\SYSTEM for the agent to trust it
           $owner = New-Object System.Security.Principal.NTAccount("NT AUTHORITY\SYSTEM")
           $acl = get-acl "$Env:SystemDrive\AzureData\Config.bin"
           $acl.SetOwner($owner)
           set-acl $Env:SystemDrive"\AzureData\Config.bin" $acl
    
  9. Once the EC2 instance is available in the Amazon EC2 catalog, the Horizon Cloud Universal Console > Images > Add > Amazon WorkSpaces Core workflow to add the Amazon EC2 Custom Instance in your Horizon Cloud organization, as described in Add and Publish an Image with Amazon WorkSpaces Core.

Preparing to Add an Amazon WorkSpaces Core Custom Image

Prepare Amazon WorkSpaces Core Custom Images by using one of the following two procedures, depending on whether you are preparing Windows Server-based images or Windows 11-based images.

Note: The Image Management Service (IMS) can automate key steps for Windows 11 images such as installing the Horizon Agent and the agent pairing configuration file during image publishing. This reduces the need for manual installation and helps streamline image preparation.

Preparing Windows Server Images

Use the following procedure to prepare Windows server images by creating a bundle from the Amazon WorkSpaces Core Console.

Note: Use this option when preparing your own Windows Server images. Amazon EC2-based Windows Server images are not currently supported.

  1. Create an Amazon WorkSpaces Core VM from the public Windows server-based bundle.

  2. Run the following PowerShell command in Admininstrator mode to enable the Remote Desktop Services feature:

           Add-WindowsFeature –Name RDS-RD-Server -Restart
    

    Note: This step must be completed before installing the Horizon Agent, as the agent requires this feature to integrate with Remote Desktop Services.

    The workspace may reboot automatically. If it does not, restart it manually.

  3. Connect to the WorkSpaces Core VM and install the latest Horizon Agent (HAI agent version 25.1 or higher) as described in Omnissa Horizon Cloud: Installing Horizon Agents manually (91998).

  4. Navigate to the Edge Details or Providers page of an existing Amazon WorkSpaces Core Edge (or when creating a new Horizon Edge using the Amazon WorkSpaces Core provider type) and locate the Copy agent pairing configuration option.

    For related information, see Copy an Agent Pairing Spec for Image Preparation.

  5. Copy the contents from the clipboard to a new file named Config.bin and place the file in the WorkSpaces Core VM at C:\AzureData\Config.bin.

    Note: The C:\AzureData\Config.bin agent pairing configuration file is required for adding Amazon WorkSpaces Core images in Horizon Cloud and is valid for five years.

  6. Change the owner of the file to the system account by running the following PowerShell script in Admininstrator mode:

           # Set the owner of the agent pairing configuration file as NT AUTHORITY\SYSTEM for the agent to trust it
           $owner = New-Object System.Security.Principal.NTAccount("NT AUTHORITY\SYSTEM")
           $acl = get-acl "$Env:SystemDrive\AzureData\Config.bin"
           $acl.SetOwner($owner)
           set-acl $Env:SystemDrive"\AzureData\Config.bin" $acl
    
  7. In the AWS Console, create or convert a Windows Server image from the Amazon WorkSpaces Core VM.

  8. Once the image is available in the WorkSpaces Core image catalog, use the Horizon Cloud Add > Image > Amazon WorkSpaces Core workflow to add the Amazon WorkSpaces Core Custom Image in your Horizon Cloud organization, as described in Add and Publish an Image with Amazon WorkSpaces Core.

Preparing Windows 11 Images

Use the following procedure to prepare Windows 11 images by creating a bundle from the Amazon WorkSpaces Core Console.

Note:

  • Microsoft has ended support for Windows 10. For the best long-term compatibility and security, Omnissa recommends using Windows 11-based images when creating new deployments.
  • The Image Management Service (IMS) can automate several of the steps in this process for Windows 11 images, such as installing the Horizon Agent and pairing file. Using IMS simplifies image preparation and reduces manual setup.
  1. Enable Amazon WorkSpaces Core BYOL (Microsoft 365 Bring Your Own License) for the AWS account.

  2. Obtain a Microsoft Windows 11 license and create an Amazon Machine Image (AMI).

    For detailed guidance, see Bring Your Own Windows desktop licenses in WorkSpaces and Deploying Omnissa Horizon with Amazon EC2 and Amazon Workspaces.

  3. Create an EC2 instance from the AMI.

  4. Install the latest HAI agent (version 25.1 or higher).

    To manually install the Horizon Agent, follow the instructions in Omnissa Horizon Cloud: Installing Horizon Agents manually (91998).

    Amazon WorkSpaces Core images require an HAI agent version 25.1 or greater.

  5. Navigate to the Edge Details or Providers page of an existing Amazon WorkSpaces Core Edge provider type (or when creating a new Horizon Edge using the Amazon WorkSpaces Core provider type) and locate the Copy Agent Pairing Configuration File option.

    For related information, see Copy an Agent Pairing Spec for Image Preparation.

  6. Copy the contents from the configuration file to a new file named Config.bin and place the file in the WorkSpaces Core VM or EC2 instance at C:\AzureData\Config.bin.

    Note: The C:\AzureData\Config.bin agent pairing configuration file is required for adding Amazon WorkSpaces Core images in Horizon Cloud and is valid for five years.

  7. Change the owner of the file to the system account by running the following PowerShell script in Administrator mode:

           # Set the owner of the agent pairing configuration file as NT AUTHORITY\SYSTEM for the agent to trust it
           $owner = New-Object System.Security.Principal.NTAccount("NT AUTHORITY\SYSTEM")
           $acl = get-acl "$Env:SystemDrive\AzureData\Config.bin"
           $acl.SetOwner($owner)
           set-acl $Env:SystemDrive"\AzureData\Config.bin" $acl
    
  8. Run the BYOL checker on the EC2 VM.

    To run the BYOL checker, follow Step 4 of Step 4: Confirm that the Windows VM in Amazon WorkSpaces meets the requirements for Microsoft BYOL in AWS documentation.

  9. Create or convert the EC2 instance to a Workspaces Core BYOL image.

    To convert an EC2 instance to a Workspaces Core BYOL image, see Step 8: Create a BYOL image using the WorkSpaces console.

  10. Once the image is available in the WorkSpaces Core image catalog, use the Horizon Cloud Add > Image > Amazon WorkSpaces Core UI workflow to add an Amazon WorkSpaces Core Custom Image in your Horizon Cloud organization as described in Add and Publish an Image with Amazon WorkSpaces Core.

    Note: The Image Management Service (IMS) also allows you to add and publish EC2-based Windows 11 instances directly. If you prefer this option, use the Add > Image > Amazon WorkSpaces Core UI workflow to add an Amazon WorkSpaces Core Custom Image as described in Add and Publish an Image with Amazon WorkSpaces Core.

Adding an Image

After you have prepared the image using one of the above procedures, you are ready to add an image by using either of the following methods:

  • Adding an image from an Amazon EC2 Custom Instance
  • Adding an image from an Amazon WorkSpaces Core Custom Image

For detailed steps, see Add an Image with Amazon WorkSpaces Core.

Note: Both the Amazon EC2 Custom Instance and Amazon WorkSpaces Core Custom Image methods are supported for adding images. The EC2 Custom Instance is typically used when automation through the Image Management Service (IMS) is already in place.

Questa pagina è stata utile?

Invia un feedback su questo argomento

Questo argomento è stato utile?

Non includere informazioni personali o riservate.

Generazione del link…