You can configure images for Windows guest customization directly in the VMware Integrated OpenStack dashboard by applying the guest customization metadata to the Glance image used to create an instance.

The Windows guest customization feature provides an alternative to the cloudbase-init approach to enabling guest customization. If an image currently uses cloudbase-init, do not use the VMware Integrated OpenStack Windows guest customization feature.

Verify that you are logged in to the VMware Integrated OpenStack dashboard as a cloud administrator.

Verify that you have an appropriate Windows OS image available in the Glance Image Service.

Verify that the correct versions of the Microsoft System Preparation tools (sysprep) for each guest operating system you want to customize are installed in vSphere. See Installing the Microsoft Sysprep Tool in the vSphere product documentation.

Verify that VMware Tools is installed on the source image.

Verify that the image disk type property correctly reflects the image disk type prior to import.

This applies only to images imported into Glance in VMware Integrated OpenStack versions earlier than 2.0. In version 2.0.x and later, image properties (such as disk type) are automatically introspected during the Glance import process.


Log in to the VMware Integrated OpenStack dashboard as a cloud administrator.


Select the admin project from the drop-down menu in the title bar.


(Optional) Preview the Guest Customization Options metadata definition.


Select Admin > System > Metadata Definitions.


Click Guest Customization Options.


Click the Contents tab.

You can only view the metadata definitions in the VMware Integrated OpenStack dashboard. You cannot modify the metadata.


Select Admin > System > Images.


Locate the Windows image to modify.


In the Actions column of the image listing, click the down arrow and select Update Metadata.


In the column under Available Metadata, expand the Guest Customization Options tab.


If the Guest Customization Options tab is not present, the related metadata properties might already be configured.


Click the plus sign (+) next to the guest customization option you want to add.


You can add all the options simultaneously by the clicking the plus sign (+) on the top Guest Customization Options tab.

In the column under Existing Metadata, the newly added metadata properties appear.


You may need to scroll to the bottom of this column to see the newly added metadata properties.


Configure the metadata properties.

Metadata Property


Auto logon count

Applies the windows_logon_count metadata property.

Enter the number of times the machine can automatically logged in to as Administrator . Typically, this value is set to 1, but you can increase the value if your configuration requires multiple reboots. This value might be determined by the list of commands executed by the GuiRunOnce command.

Automatic logon

Applies the windows_auto_logon metadata property.

If selected, the VM is automatically logged in to as Administrator.

Maximum number of connections

Applies the windows_max_connect metadata property.

Enter the number of client licenses purchased for the Windows server being installed.


This property is applied only if the windows_license_mode metadata property, described below, is set to PerServer.

Product Key

Applies the windows_product_key metadata property.

Enter a valid serial number which is included in the answer file when mini-setup runs.


This serial number is ignored if the original guest operating system was installed using a volume-licensed CD.

Server licensing mode

Applies the windows_license_mode metadata property.

Select the licensing mode that matches your source image: PerServer or PerSeat.

Windows workgroup to join

Applies the windows_join_workgroup metadata property.

Select the workgroup that the VM should join.


Click Save.

The image metadata is now configured for Windows guest customization and are applied for all future VMs that are created from this image.