Windows Guest Customization (Image Preparation)¶
This guide covers preparing Windows virtual images for provisioning with HPE Morpheus Software guest customization — including hostname assignment, network configuration, and Active Directory domain join. The approach varies by cloud type.
Customization Approaches by Cloud Type¶
Cloud Type |
Primary Method |
How It Works |
|---|---|---|
HVM (KVM) |
Pre-sysprep’d image |
Image is sysprep’d before capture. On first boot, Windows completes OOBE, HPE Morpheus Software Agent installs and handles hostname/domain join. |
VMware / VME |
Force Guest Customization |
VM is provisioned from a template with VMware Tools installed. HPE Morpheus Software triggers a guest customization pass — transferring the unattend.xml to the running VM, then rebooting to apply hostname, network, and domain settings. |
SCVMM / Hyper-V |
Pre-sysprep’d image + unattend.xml |
Image must be sysprep’d before capture into the SCVMM library. When provisioning from a template, HPE Morpheus Software injects an unattend.xml to configure hostname, network, and domain join. For clone operations, unattend.xml injection is not supported — HPE Morpheus Software installs the Agent post-provisioning to handle configuration. |
AWS / Azure / GCP |
Cloud-native (userdata) |
Cloud provider handles customization via instance metadata and userdata. Image prep follows cloud-specific requirements. |
Force Guest Customization (VMware / VME)¶
On VMware and VME clouds, Force Guest Customization works differently than on other platforms:
The VM is provisioned from a template that has VMware Tools installed (not necessarily sysprep’d)
HPE Morpheus Software boots the VM
VMware guest customization transfers an unattend.xml into the running guest via VMware Tools
The VM reboots to apply the customization (hostname, network, SID regeneration, domain join)
This means the source template does not need to be in a sysprep’d state — VMware Tools handles the customization injection and triggers the re-specialize pass.
Note
Force Guest Customization on VMware requires VMware Tools to be installed and running in the template. Without Tools, the customization payload cannot be delivered to the guest.
Pre-Sysprep’d Images (HVM / General Use)¶
For HVM clusters (and any cloud where Force Guest Customization is not available), the image must be sysprep’d before capture:
Step 1: Prepare the Template VM¶
Install Windows (Server 2016, 2019, 2022, 2025 or Windows 10/11)
Install all Windows Updates
Install VirtIO drivers (for HVM — use the Attach VirtIO Drivers advanced option during initial ISO provisioning)
Install any required software or roles
Configure Windows Firewall to allow WinRM (port 5985/5986)
Step 2: Sysprep¶
& "$env:SystemRoot\System32\Sysprep\sysprep.exe" /generalize /oobe /shutdown
The VM shuts down after generalizing. Do not boot it again — capture it as a virtual image at this point.
Step 3: Upload as Virtual Image¶
Navigate to , click + Add, and configure:
Setting |
Value |
Purpose |
|---|---|---|
Is Sysprep |
Enabled |
Indicates the image is in a generalized state and will go through OOBE on first boot |
Install Agent |
Enabled |
Installs the HPE Morpheus Software Agent for management and domain join |
Username |
|
Local admin account for initial agent connection |
Password |
(set password) |
Local admin password for agent authentication |
Virtual Image Options Reference¶
Option |
Applicable Clouds |
Description |
|---|---|---|
Is Force Customization |
VMware, VME |
Triggers guest customization via VMware Tools — transfers unattend.xml and reboots the VM to apply settings. Does NOT require the image to be pre-sysprep’d. |
Is Sysprep |
All |
Indicates the image is in a sysprep’d (generalized) state. Used by HPE Morpheus Software to know the VM will go through OOBE on first boot. |
Is Cloud Init |
HVM, OpenStack |
Generates a cloud-init ISO with metadata/userdata and attaches it to the VM. Used for Linux guests primarily. |
Is Auto Join Domain |
All |
Automatically triggers domain join when a Network Domain is configured, without requiring explicit domain selection during provisioning. |
Install Agent |
All |
Installs the HPE Morpheus Software Agent on the guest for management, monitoring, and remote execution. |
Skip Network Wait |
All |
Skips waiting for network availability before proceeding with provisioning. Useful for isolated networks. |
VirtIO Supported |
HVM |
Indicates the image has VirtIO drivers installed. When disabled, HPE Morpheus Software uses IDE/SATA disk bus instead of VirtIO. |
Domain Join Configuration¶
Domain join is triggered by the Network Domain configuration, not by image settings. The Network Domain can be associated via:
Network selection at provisioning — The network chosen during instance creation has an associated Network Domain with Domain Controller enabled
Cloud default — A default Network Domain set on the Cloud configuration applies to all VMs in that Cloud unless overridden
See Windows VM Domain Join for full domain join setup instructions.
What Gets Customized¶
Customization |
VMware/VME (Force Customization) |
HVM (Pre-Sysprep’d) |
|---|---|---|
Hostname |
Applied via unattend.xml during reboot |
Set by HPE Morpheus Software Agent after OOBE completes |
Network (static IP) |
Applied via guest customization spec |
Configured by HPE Morpheus Software Agent |
Domain join |
Can be included in unattend OR handled by HPE Morpheus Software Agent post-boot |
Handled by HPE Morpheus Software Agent post-boot |
SID regeneration |
Yes (forced re-specialize) |
Yes (sysprep generalize) |
Admin password |
Set via customization spec |
Set from Virtual Image credentials |
Troubleshooting¶
Force Customization Not Working (VMware)¶
Verify VMware Tools is installed and running in the template
Check that the template is powered off (not suspended)
Verify Is Force Customization is enabled on the Virtual Image in HPE Morpheus Software
VM Boots to OOBE Setup Screen (HVM)¶
Verify Is Sysprep is enabled on the Virtual Image
Check that the image was properly sysprep’d before capture (not booted after sysprep)
Ensure the HPE Morpheus Software Agent can reach the appliance to receive configuration
Hostname Not Applied¶
Verify the HPE Morpheus Software Agent is running (check Services for “Morpheus Windows Agent”)
Check that the Instance name does not exceed 15 characters (NetBIOS limit)
For VMware, verify guest customization completed (check vCenter recent tasks)