# Add Virtual Image

## About this task

Virtual Images can be uploaded to VM Essentials from local files or URLs.

WARNING

Be conscious of your Storage Provider selection. The default Storage Provider is the VM Essentials Appliance at `/var/opt/morpheus/morpheus-ui/vms`. Uploading large images to the VM Essentials 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:

## Procedure

1. Select + Add in the Virtual Images page.
2. Select Image format: 

   - ISO
   - QCOW2
   - RAW
   - VMware (vmdk/ovf/ova)
3. Configure the following on the Virtual Image: 

   Name
   :   Name of the Virtual Image in VM Essentials. 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 VM Essentials 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 or Cloudbase-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. This is required for authentication, unless VM Essentials is able to add user data, Cloud-Init, Cloudbase-Init or Guest Customizations. If Cloud-Init, Cloudbase-Init or Guest Customizations are used, credentials are defined in Administration > Settings > Provisioning and User Settings. If credentials are defined on the image and Cloud-Init is enabled, VM Essentials will add that user during provisioning, so ensure that user does not already exist on the image (such as `root`). For Windows Guest Customizations, VM Essentials will set the Administrator password to what is defined on the image if Administrator user is defined. Do not define any other user than Administrator for Windows Images unless using Cloudbase-init. VM Essentials 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

   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 in Infrastructure  >  Storage

   Cloud-Init User Data
   :   Accepts what would go in `runcmd` and can assume Bash syntax. Example use: Script to configure satellite registration at provision time

   Create Image ID
   :   Select FILE to browse locally for an image or drop an image file into the dropzone. Alternatively, select URL to download the image from an accessible URL. It is recommend to configure the rest of the settings below prior to uploading the source Image File(s)

   Permissions
   :   Set Tenant permissions in a multi-tenant VM Essentials 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  >  Network and 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, VM Essentials will install the FIPS-compliant VM Essentials Agent package

   VM Tools Installed?
   :   On by default, uncheck if VMware Tools (including OpenVMTools) are not installed on the Virtual Image. VM Essentials will skip network wait during provisioning when deselected

   Force Guest Customization?
   :   VMware only, forces guest customizations to run during provisioning, typically when provisioning to a DHCP network where guest customizations would not run by default. This options requires that VMware Tools is installed on the image

   Trial Version
   :   Enable to automatically re-arm the expiration on Windows Trial Images during provisioning

   Enabled Sysprep?
   :   Applicable to VMware vCenter Clouds. Enable if the Windows Image has been sysprepped. If enabled, VM Essentials will inject `unattend.xml`

   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 Administration > Settings > Provisioning when using Cloud-Init or Guest Customizations and new credentials are not set on the Virtual Image.
4. 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 upload will finish in the background. When selecting/drag and dropping a file, the image files must upload completely before saving the Virtual Image record or the Image will not be valid.
5. Save Changes.

**Subtopics**  

- **[VMware - VM Templates Copies](https://support.hpe.com/hpesc/public/api/document/sd00007735en_us/render?page=GUID-83AF39C3-5542-4739-B9ED-C867C472CDCE.html)**
