You are here: Learn about Citrix App Layering [UnideskVersion Layering 4.0.8] > Layer > OS Layer > In VMware vSphere

Add a version to an OS Layer (vSphere)

In this article:

Before you start

Add a Version to an OS Layer

Deploy a Packaging Machine

Install your changes

Verify the Layer and shut down the Packaging Machine

Finalize the OS Layer

Reference: Create OS Version Wizard values

The Unidesk Operating System (OS) Layer contains the Windows Operating System that is assigned to any Unidesk Layered Images you create using that OS Layer. Once created, you can use the OS Layer to build as many Layered Images as you want.

The OS Layer includes a virtual machine in your infrastructure running the Unidesk-supported Windows Operating System that you want to use for your Layered Images.

Before you start

Before you can create an OS Layer version, you'll need to:

Add a version of an OS Layer

To add a version of an OS Layer, take the following steps:

  1. In the Unidesk Management Console, select Layers > OS Layers.

  2. Select or right-click an OS Layer icon and click Add Version. This opens the Create OS Version Wizard.

  3. (Required) In the Version Details tab, enter a Version identifier. This can be the application version, or anything you choose.

  4. In the Connector tab, select a Platform Connector configuration for the platform where you'll be publishing your Layered Images. You can also modify an existing configuration by selecting it and clicking Edit. If you have not yet created a Platform Connector configuration or if the configuration you need is not present, click New to create a new Connector Configuration and select it from this list.

  5. In the Platform Layer tab, select a Platform Layer that contains the tools and hardware settings that you need to install and package an application when adding a Layer Version. Once created, the new Layer Version can be used in Layered Images published to any platform.

  6. In the Packaging Disk tab, enter a file name for the Packaging Disk, and select the disk format. This disk will be used for the Packaging Machine (the VM) where you will install the application, as described in the next two sections.

  7. Confirm and Complete tab - Verify your settings and click Create Version. Unidesk runs the task of creating a new OS version. When the task completes, it shows a status of Action Required. When you double-click the task to expand it, the task contains the following text (refer to the image in the next section):

    "The Packaging Disk has been published. The virtual machine '<...>' can be found in folder '<...>' in datacenter '<...>'. Power on this virtual machine to install your application. When the installation is complete, power off the virtual machine before clicking Finalize on the Action bar."

Next, you can deploy a Packaging Machine for this OS Layer.

Deploy a Packaging Machine to vSphere

The Packaging Machine is a virtual machine where you install any updates or applications you want to include in the OS Layer. It is strongly recommended that you use a unique Packaging Machine for each Layer. The Packaging Machine is a temporary VM that will be deleted once the OS Layer has been finalized.

The Task Description (example shown in the last step above) contains directions to navigate to the location in vSphere where the Packaging Machine for this Layer has been created.

To create your Packaging Machine in vSphere, begin with the expanded Packaging Disk task shown in step 2 below.

  1. Log into your vSphere web client.
  2. Back in the Unidesk Management Console, use the instructions in the expanded Packaging Disk Task (example shown below) to navigate to the Packaging Machine.

    The Packaging Machine will be powered on.

Install the OS update

  1. Remote log into the Packaging Machine in vSphere. Be sure to log in with the User account you used to create the OS in vSphere.

  2. Install any updates or applications you want to include in the new OS Layer version, such as Windows Updates or anti-virus applications.

    If an application installation requires a system restart, restart it manually. The Packaging Machine does not restart automatically.

  3. Make sure the Packaging Machine is in the state you want it to be for the user:

Next, you will shut down the Packaging Machine and verify that the Layer is ready to finalize.

Verify the Layer and shut down the Packaging Machine

Once the application is installed on the Packaging Machine, the next step is to verify that the Layer is ready to be finalized. To be ready for finalization, any required post-installation processing needs to be completed. For example, a reboot may be required, or a Microsoft NGen process may need to complete.

To verify that any outstanding processes are complete, you can run the Shutdown For Finalize tool (icon below), which appears on the Packaging Machine's desktop.

To use the Shutdown For Finalize tool:

  1. If you are not logged into the Packaging Machine, remote log in as the user who created the machine.
  2. Double-click the Shutdown For Finalize icon. A command line window displays messages detailing the layer verification process.
  3. If there is an outstanding operation that must be completed before the Layer can be finalized, you are prompted to complete the process. For example, if a Microsoft NGen operation needs to complete, you may be able to expedite the NGen operation, as detailed below.
  4. Once any pending operations are complete, double-click the Shutdown For Finalize icon again. This shuts down the Packaging Machine.

The Layer is now ready to finalize.

Layer integrity messages you may see during

Layer integrity messages let you know what queued tasks must be completed before a Layer is finalized.

The new Layer or Version can only be finalized when the following conditions have been addressed:

Expediting a Microsoft NGen operation

NGen is the Microsoft Native Image Generator. It is part of the .NET system, and basically re-compiles .NET byte code into native images and constructs the registry entries to manage them. Windows will decide when to run NGen, based on what is being installed and what Windows detects in the configuration. When NGen is running, you must let it complete. An interrupted NGen operation can leave you with non-functioning .NET assemblies or other problems in the .NET system.

You have the choice of waiting for the NGen to complete in the background, or you can force the NGen to the foreground. You can also check the status of the NGen operation, as described below. However, every time you check the queue status, you are creating foreground activity, which might cause the background processing to temporarily pause.

Forcing the NGen to the foreground will allow you to view the progress and once the output has completed, you should be able to finalize the layer.

  1. Force an NGen operation to the foreground.

    Normally, NGen is a background operation and will pause if there is foreground activity. Bringing the task into the foreground can help the task to complete as quickly as possible. To do this:

    1. Open a command prompt as Administrator.

    2. Go to the Microsoft .NET Framework directory for the version currently in use:

      cd C:\Windows\Microsoft.NET\FrameworkNN\vX.X.XXXXX
    3. Enter the NGen command to execute the queued items:

      ngen update /force

      This brings the NGen task to the foreground in the command prompt, and lists the assemblies being compiled.

      Note: It’s okay if you see several compilation failed messages!

    4. Look in the Task Manager to see if an instance of MSCORSVW.EXE is running. If it is, you must allow it to complete, or re-run ngen update /force. Do not reboot to stop the task. You must allow it to complete.
  2. Check the status of an NGen operation

    1. Open a command prompt as Administrator.

    2. Check status by running this command:

      ngen queue status
    3. When you receive the following status, the NGen is complete, and you can finalize the Layer.

      The .NET Runtime Optimization Service is stopped

Finalize the OS Layer

Once the Packaging Machine is created and any apps or updates installed, you'll need to finalize the layer.

Note: When you finalize a new version of an OS Layer, Unidesk deletes the Packaging Machine so as not to incur more costs.

When a layer is ready to finalize:

  1. Return to the Unidesk Management Console.

  2. In the Layers module, select the layer.

  3. Select Finalize in the Action bar.

  4. Monitor the Task bar to verify that the action completes successfully and that the layer is deployable.

Reference: Create OS Version Wizard values