Virtual Images¶
Overview¶
The Virtual Image section displays a list of all images, local and synced, that are available to deploy. HPE Morpheus Software includes a rich catalog of pre-configured System Images available for every cloud type. User Images are automatically synced from Cloud Integrations and added to the Virtual Images section. Images can also be uploaded directly into HPE Morpheus Software via local file or url. Amazon and Azure Marketplace images can also be added to the Virtual Images Section.
Understanding the process of prepping images for consumption in HPE Morpheus Software is a very important step toward building an effective HPE Morpheus Software environment. In addition to the information contained in this section on Virtual Images, it may be helpful to see a complete image prep example walkthrough. Our getting started guide for HPE Morpheus Software and VMware includes a section on preparing images that may provide a helpful example.
Tip
HPE Morpheus Software includes a wide catalog of system image types as examples to show how the product can be used and to give users a starting point for implementing their own library. The included images are not intended to be production-ready images. HPE Morpheus Software always recommends its users create their own gold images which meet their required specifications.
Important
Invalid Image Settings cause provisioning failures. HPE Morpheus Software syncs in as much meta-data as possible for synced images, but additional configuration may be needed to ensure successful provisioning.
Warning
Cloud-init is enabled by default for all Linux images. If your Linux image does not have Cloud-init installed, Cloud-init Enabled must be unchecked before provisioning the image or it will fail immediately.
Image Types¶
HPE Morpheus Software provides a vast System Image repo with pre-configured images for every Cloud. All other images are User Images. User images can be added directly to HPE Morpheus Software, or automatically synced from integrated clouds. It is important to configure synced User Images for metadata, including specifying the Platform and User Credentials, prior to provisioning. Provisioning a User Image that has not been configured may result in failed provisioning.
Important
Synced User Images need to be configured prior to provisioning.
Linked Clone Images¶
A linked clone Virtual Image is a record backed by a snapshot of an existing VMware or HVM/KVM VM. Provisioning from it creates a small writable disk that shares the snapshot’s base data, reducing deployment time and initial storage consumption. It is not an independent copy of the source disk.
Linked clone images are created from an Instance’s Backups tab, not from the Virtual Images page. Prepare the guest, create a snapshot, and select More > Create Linked Clone for that snapshot. See the Creating Linked Clone Images section in Storage for the complete workflow and platform constraints.
After creation, edit the record in and verify the inherited operating system, cloud-init or Sysprep, guest customization, agent, credentials, and permissions. Keep the source VM and backing snapshot for as long as the image or provisioned linked-clone VMs are needed.
Configuring Virtual Images¶
System Images¶
System Virtual Images are pre-configured with metadata and have Cloud-Init or Cloudbase-Init installed. These images are ready to be provisioned with no configuration necessary, however it is required to populate , Cloud-Init section, with user data as well as User Profile(s) users data when creating additional users prior to provisioning, as the user data from these sections is required when provisioning System provided Virtual Images.
Note
System Images settings are not editable.
User Images¶
Typically HPE Morpheus Software does not have sufficient metatdata to successfully provision synced User Images. After integrating clouds and User Images have synced, it is highly recommended to configure the images prior to provisioning.
To edit and configure an existing Virtual Image:
Select the pencil icon at the right of any row on the Virtual Images list page, or click EDIT on a Virtual Image detail page.
Configure the following on the Image:
- Name
Name of the Virtual Image in HPE Morpheus Software. This can be changed from the name of the image, but editing will not change the name of the actual image
- Operating System
Specifies the platform and OS of the image. All Windows images will need to have the operating system specified on the Virtual Image, as HPE Morpheus Software will assign Linux as the platform for all images without an operating system specified
- Minimum Memory
The Minimum Memory setting will filter available Service Plan options during provisioning. Service Plans that do not meet the minimum value set on the Virtual Image will not be provided as Service Plan choices
- Cloud Init Enabled?
On by default, uncheck for any Image that does not have Cloud-Init installed
- Install Agent?
On by default, uncheck to skip Agent install. Note this will result in the loss of utilization statistics, logs, script execution, and monitoring. (Some utilization stats are still collected for Agent-less hosts and VMs depending on the cloud)
- Username
Existing username on the image for authentication. Can be left blank if global default credentials are configured in (separate defaults exist for Linux and Windows). If Cloud-Init or Guest Customizations are used, credentials from and User Settings are applied. If credentials are defined on the image and Cloud-Init is enabled, HPE Morpheus Software will add that user during provisioning, so ensure that user does not already exist on the image (such as
root). For Windows, do not define any user other than Administrator. HPE Morpheus Software recommends running Guest Customizations for all Windows Images, which is required when joining Domains as the SID will change.- Password
Password for the user on the image if username is populated. Can be left blank if global defaults are set in .
- Bucket
Location where the Virtual Image will be stored. Default Virtual Image Storage location is
/var/opt/morpheus/morpheus-ui/vms. Additional Storage Providers can be configured inInfrastructure > Storage- Cloud-Init User Data
Accepts what would go in
runcmdand can assume Bash syntax. Example use: Script to configure satellite registration at provision time- Permissions
Set Tenant permissions in a multi-tenant HPE Morpheus Software environment. Select private visibility and select specific Tenants to which the Virtual Image will be made available. Select public visibility to share the Virtual Image with all Tenants
- Auto Join Domain?
Enable to have Instances provisioned with this image auto-join configured domains (Windows only, domain controller must be configured in
Infrastructure > Networkand the configured domain set on the provisioned to Cloud or Network)- VirtIO Drivers Loaded?
Enable if VirtIO Drivers are installed on the image for provisioning to KVM-based hypervisors
- FIPS Compliant Image?
When selected, HPE Morpheus Software will install the FIPS-compliant HPE Morpheus Software Agent package
- VM Tools Installed?
On by default, uncheck if guest tools are not installed on the Virtual Image (VMware Tools for VMware, QEMU Guest Agent for HVM). HPE Morpheus Software will skip network wait during provisioning when deselected
- Force Guest Customization?
Forces guest customizations to run during provisioning. On VMware/VME, transfers unattend via VMware Tools and reboots. On HVM, injects unattend via the guest agent. Requires guest tools to be installed on the image.
- Trial Version
Enable to automatically re-arm the expiration on Windows Trial Images during provisioning
- Enabled Sysprep?
Applicable to multiple Clouds, including VMware vCenter, SCVMM, Nutanix, Hyper-V, KVM, and Google GCP. Enable if the Windows Image has been sysprepped. If enabled, HPE Morpheus Software will inject
unattend.xml
Click Save Changes
Note
Cloud-Init is enabled by default on all images. Images without Cloud-Init installed must have the cloud-init flag disabled on the Virtual Image setting or Provisioning may fail.
Important
HPE Morpheus Software does not validate or restrict image uploads to certain file types and any type of file may be uploaded as a Virtual Image. For security purposes, these files are stored in a non-executable state so users need not worry about potentially dangerous file types being uploaded (ex. executables).
Provisioning Images¶
When provisioning a system image, HPE Morpheus Software will stream the image from Amazon S3 to the target Cloud if the image is not local to the Cloud.
When using images that already exist in the destination Cloud, such as synced, marketplace, or previously copied images, no image stream from S3 through the HPE Morpheus Software Appliance to the destination cloud will take place.
Note
The HPE Morpheus Software Appliance must be able to download from Amazon S3 when provisioning system images.
Note
The HPE Morpheus Software Appliance must be able reach and resolve the destination Host when provisioning System Images or uploaded Images for the first time. This included being able to resolve ESXi host names in VMware vCenter clouds, and reach the destination ESXi host over port 443.
Add Virtual Image¶
Virtual Images can be upload to HPE Morpheus Software from local files or URL’s. Amazon and Azure Marketplace metadata can also be added to the Virtual Images library, enabling the creation of custom catalog Instance Type from Marketplace images (no image is transferred to HPE Morpheus Software when adding Marketplace images).
Warning
Be conscious of your Storage Provider selection. The default Storage Provider is the HPE Morpheus Software Appliance at /var/opt/morpheus/morpheus-ui/vms. Uploading large images to the HPE Morpheus Software Appliance when there is inadequate space will cause upload failures and impact Appliance functionality. Ensure there is adequate space on your selected Storage Provider. Additional Storage Provider can be added at Infrastructure > Storage, which can be configured as the default Virtual Image Store or selected when uploading Images.
Note
VMware-type OVF Virtual Images do not support mounted ISO uploads
To Add Virtual Image:
Select + Add in the Virtual Images page.
Select Image format:
Alibaba
Amazon AMI
Azure Marketplace
Digital Ocean
ISO
PXE Boot
QCOW2
RAW
VHD
VMware (vmdk/ovf/ova)
Configure the Virtual Image settings (see Configuring Virtual Images above for a description of each option).
Upload Image
- Images can be uploaded by File or URL:
- File
Drag and Drop the image file, or select Add File to select the image file.
- Url
Select the URL radio button, and enter URL of the Image.
Note
The Virtual Image configuration can be saved when using a URL and the import will finish in the background. When selecting or dragging and dropping a file, the browser upload must complete before saving the Virtual Image record or the Image will not be valid.
Choose the source method based on where the image is available:
Use File when the image is on your workstation. Keep the browser session connected until the file upload completes.
Use URL when the image is available from an HTTP or HTTPS endpoint that the HPE Morpheus Software Appliance can resolve and reach. The appliance retrieves the image after the record is saved, so the browser does not carry the image data.
Transfer duration depends on image size, the path between the source and the appliance, available bandwidth, and the selected Storage Provider. URL import can avoid a slow workstation, VPN, or browser path, but it does not guarantee a faster transfer. Use only a trusted endpoint and verify the image checksum against its publisher-provided value before use.
If an import appears stalled, do not create a second Virtual Image immediately. Check the Virtual Image status, available capacity on the selected Storage Provider, appliance reachability to a URL source, and any proxy or TLS errors in the appliance logs. Retry only after confirming the first transfer has failed.
Save Changes.
Note
Default Storage location is /var/opt/morpheus/morpheus-ui/vms. Additional Storage Providers can be configured in Infrastructure > Storage. Ensure local folders are owned by morpheus-app.morpheus-app if used.
Warning
Provisioning will fail if Cloud init Enabled is checked and Cloud-Init is not installed on the Image.
Note
Existing Image credentials are required for Linux Images that are not Cloud-Init enabled and for Windows Images when Guest Customizations are not used. Cloud-Init and Windows user settings need to be configured in when using Cloud-Init or Guest Customizations and new credentials are not set on the Virtual Image.
Multi-Disk QCOW2 Images for HVM/KVM¶
HVM/KVM supports Virtual Images containing multiple QCOW2 disks. Upload every QCOW2 file and a JSON manifest named exactly metadata.json as files on the same Virtual Image. The manifest maps each QCOW2 file to its guest device, disk size, and order.
Without metadata.json, HPE Morpheus Software treats a QCOW2 Virtual Image as a single-disk image even when multiple QCOW2 files have been uploaded.
The following example defines a 50 GiB boot disk and a 100 GiB data disk:
{
"disks": [
{
"file": "root.qcow2",
"capacity": 53687091200,
"guestDeviceName": "vda",
"position": 0,
"name": "root",
"boot": true
},
{
"file": "data.qcow2",
"capacity": 107374182400,
"guestDeviceName": "vdb",
"position": 1,
"name": "data"
}
]
}
Field |
Required |
Description |
|---|---|---|
|
Yes |
Top-level array containing one object for each uploaded disk. |
|
Yes |
Exact, unique filename of the uploaded QCOW2 file, including the |
|
Recommended |
Virtual disk capacity in bytes. Convert GiB to bytes with |
|
Recommended |
Device name presented to the guest, such as |
|
Recommended |
Zero-based disk order. Use unique, sequential values beginning with |
|
No |
Descriptive source-disk label, such as |
|
No |
Set to |
|
No |
Unit number on a referenced storage controller. Omit for a basic VirtIO disk set. |
|
No |
Controller reference used when a specific imported controller topology must be preserved. It requires a matching object in a top-level |
Disk records are sorted by controller bus number, unit number, and then position. For a basic manifest without controller fields, position determines the order. Use distinct filenames, positions, and guest device names to avoid ambiguous mappings.
Only disks and a resolvable file value are strictly needed for file discovery, but include the recommended fields shown above so HPE Morpheus Software can build predictable disk capacities, devices, and ordering.
To upload a multi-disk QCOW2 image:
Navigate to Library > Virtual Images and click + ADD.
Select QCOW2 as the image format.
Configure the Virtual Image, including Operating System, Cloud-Init, Agent, credentials, VirtIO, and guest tools settings as appropriate for the image.
Select File upload. Multi-disk upload requires adding multiple files to the same Virtual Image.
Upload every referenced
.qcow2file and wait for each upload to complete.Upload
metadata.jsonlast. Uploading the manifest triggers disk-map processing, so all referenced disk files must already be present.Confirm the file list contains
metadata.jsonand every filename referenced by itsdisksarray.Save the Virtual Image and wait for its status to become Active.
Open the Virtual Image details and verify that every disk is present with the expected capacity, device order, and root disk before provisioning.
Important
Do not upload metadata.json before the QCOW2 files. If the manifest is processed while referenced files are missing, the resulting disk records can be incomplete. Remove and re-upload the manifest after all disk files are present, or recreate the Virtual Image if the stored volume map is incorrect.
Troubleshooting multi-disk uploads:
Only one disk is shown: Confirm the file is named exactly
metadata.json, contains a top-leveldisksarray, and was uploaded after all QCOW2 files.A disk is missing: Confirm its
filevalue exactly matches a unique uploaded filename and includes the.qcow2extension.Disk capacity is wrong: Confirm
capacityis in bytes rather than GiB. Multiply GiB by1073741824.Wrong disk boots: Set
boottotrueon the intended root disk and ensure its ordering fields do not conflict with another disk.Device order is wrong: Use sequential
positionvalues and matchingguestDeviceNamevalues such asvda,vdb, andvdc.Manifest is ignored or the image remains invalid: Validate the file as JSON, ensure there are no comments or trailing commas, and upload the corrected manifest after the disk files.
Virtual Image Options — Cloud Applicability¶
Not all Virtual Image settings apply to all cloud types. The following matrix clarifies which options have an effect depending on the target cloud. Options marked as having no effect are ignored during provisioning to that cloud type.
Option |
HVM (KVM) |
VMware / VME |
AWS |
Azure |
Nutanix |
Notes |
|---|---|---|---|---|---|---|
Cloud Init Enabled |
Yes |
Yes |
Yes |
Yes |
Yes |
Must be unchecked if cloud-init is not installed on the image |
Install Agent |
Yes |
Yes |
Yes |
Yes |
Yes |
Universal — works on all clouds |
Force Guest Customization |
Yes |
Yes |
No effect |
No effect |
No effect |
Triggers guest customization during provisioning. On VMware/VME, transfers unattend via VMware Tools and reboots. On HVM, injects unattend and triggers customization via the guest agent. |
VirtIO Drivers Loaded |
Yes |
No effect |
No effect |
No effect |
No effect |
HVM/KVM only. When unchecked, HPE Morpheus Software uses IDE/SATA bus instead of VirtIO. |
VM Tools Installed |
Yes |
Yes |
No effect |
No effect |
No effect |
Indicates guest tools are present (VMware Tools for VMware, QEMU Guest Agent for HVM). When unchecked, HPE Morpheus Software skips network wait during provisioning. |
Enabled Sysprep |
Yes |
Yes |
No effect |
No effect |
Yes |
Windows images. HPE Morpheus Software injects unattend.xml when enabled. Works on VMware, HVM, Nutanix, SCVMM, Hyper-V, GCP. |
Auto Join Domain |
Yes |
Yes |
No effect |
No effect |
Yes |
Windows only. Requires Network Domain with Domain Controller configured. |
Trial Version |
Yes |
Yes |
No effect |
No effect |
Yes |
Windows trial re-arm. Applicable to any on-prem cloud. |
FIPS Compliant Image |
Yes |
Yes |
Yes |
Yes |
Yes |
Universal — controls which Agent package is installed. |
Important
The most common source of confusion is Force Guest Customization — this setting works on VMware/VME (via VMware Tools) and HVM (via the guest agent). On public clouds (AWS, Azure), customization is handled by the cloud provider’s metadata service and this setting has no effect.
Note
ISO image types — When uploading ISO images (used for manual OS installations or boot media), disable both Cloud Init Enabled and Enabled Sysprep. ISO-based images are typically booted interactively for OS installation and do not use cloud-init or sysprep-based guest customization. Leaving these options enabled on an ISO image will cause provisioning failures or unexpected behavior.
For HVM, provision the VM from the ISO, complete the installer through the VM console, eject the ISO media, and restart the VM from its installed disk. For the related HVM boot controls and the separate network-boot path, see VM Advanced Options.
Import an HVM Instance as an Image¶
Before selecting Actions > Import as Image for an HVM VM installed from ISO, verify that the guest boots from its installed disk and eject the installation ISO. The import excludes ISO volumes and exports the installed disks.
Existing file-based snapshots do not need to be deleted before import. When a disk has a qcow2 backing chain, HPE Morpheus Software copies and merges the chain into a temporary export disk without modifying the VM’s existing snapshots. Other supported storage backends create their own temporary export snapshot.
After the import finishes, verify that the resulting Virtual Image contains metadata.json and every disk file referenced by the manifest. A Virtual Image record or metadata file without the referenced disk files is incomplete, even if its status is Active. Leave the source VM and snapshots unchanged and contact Support with the HVM version, storage backend, snapshot list, and import process output. Deleting an existing snapshot is not a required import step and should not be used as an import workaround.
VMware - VM Templates Copies¶
In a VMware environment, you may have a single VM template that you use across different vCenters. Uploading an image to HPE Morpheus Software, mentioned in the Add Virtual Image section, is one method to solve this. Alternatively, an organization may decide to create a VM template in one vCenter and then transfer it to other vCenters, which then could be sync’d into HPE Morpheus Software.
If all the vCenters are added as Clouds into HPE Morpheus Software and the templates are named the same in each vCenter, they will be aggregated under a single virtual image in HPE Morpheus Software. This means that as you deploy to the various vCenter Clouds in HPE Morpheus Software using this virtual image, it will choose the correct VM template to use based on the Cloud deployed to.
This eliminates the need for creating multiple Node Types for each virtual image if the templates were named differently in each vCenter. This can reduce the overhead of maintaining multiple Node Types and reduces user selections. As well, this can reduce the cloning time of VMs by avoiding network transfers of images between geographic locations, ensuring the closest VM template is selected.
HPE Morpheus Software supports VMware Content Libraries storing VM templates and syncing into HPE Morpheus Software, the same as a template in a folder. Additionally, the Content Library can be used to house the same template in multiple libraries. If they have the same name, these templates will be aggregated under a single virtual image. If the Content Library is stored on a datastore that the target host/cluster has access to, it will use that library first, to reduce the cloning time. If the Content Library is not stored in a datastore accessible by the cluster/host, a copy of the VM template will be performed to the target host/cluster instead.
Note
VM templates are a Data Center level object. The same process above applies to a single VMware cloud with multiple logical data centers. It will not apply to clusters, as a template is not associated with a cluster, only when it is converted to a VM.