Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.


Abiquo 5.0

Skip to end of metadata
Go to start of metadata


Before you begin:
  1. Log in or switch enterprises to the tenant that owns the template

To modify a VM template:

  1. Select the template and click on the control menu button in the top-right corner and select Edit

Privilege: Manage VM templates from Apps library

In private cloud datacenters, standard templates have disks that will deploy to the hypervisor datastore, in contrast to persistent templates that have disks on external storage volumes. This documentation describes standard templates.

Edit template

Basic template details


Field

Value

Name

A short name to identify the VM template. This will be the default name of a VM created from this template.

Description

A description of the services and applications installed on the VM template

Category

Logical grouping of VM templates to enable you to organize them

Icon

Enter the URL for the template's icon. This must be a URL with a public IP address, not localhost or 127.0.0.1. It may contain the IP address of the API server.

If you do not assign an icon, the platform will assign a default icon. Square icon images with a size of 128x128 pixels and a transparent background look best. The compatible image formats are PNG, JPG, and GIF.

If an administrator shares the template with other tenants, then all users will see this icon. If you change the icon of a template with instances, when you create the next instance, it will have the new icon

CPU and RAM values

When you are not using hardware profiles, you can set values for template CPU and RAM as follows

Field

Value

CPU

When you create a VM from the template, it will have this template CPU value

RAM

When you create a VM from the template, it will have this RAM memory size

RAM unitsMB or GB

Min CPU and
Min RAM

In private cloud, the minimum value of CPU or RAM. If 0 or empty, then there is no constraint. You cannot set a minimum below the current template value. Changes apply to new VMs, not existing VMs

Max CPU and
Max RAM 

In private cloud, maximum value of CPU or RAM. If 0 or empty, then there is no constraint. Changes apply to new VMs, not existing VMs

Cores per socketThe number of cores per socket. The number of CPUs must be divisible by the number of cores per socket. The maximum value is 32

Troubleshooting minimum and maximum CPU and RAM values

  • The platform stores 0 as an empty value, so if you enter "0", it will disappear!
  • If users edit existing VMs that already had out-of-range values, the platform displays a warning but does not enforce the range.
  • Changes can affect recommended hardware profiles on the Advanced tab, so you may need to review them
  • Users with the Override VM constraints privilege can enter values outside this range
 



To edit VM template disks in private cloud, edit a template and go to Disks.

To change the boot order of a disk

  1. Click the pencil edit button near the Sequence number and enter a new number.  There must always be a boot disk in the 0 position, and the boot disk cannot be an empty disk.

To download a disk

  1. Select the disk
  2. Click the Download symbol on the right-hand side of the disk details

To add a disk:

  1. Click the + Add button in the top right of the Disk dialog
  2. Select one of the options: Disk from local file, Disk from iso file, Empty disk or Template disk.

  3. Enter the Details of the disk as described here.

  • Disk from local file

     Click here to display details of Disk from local file

    When you upload a disk you can enter these disk options.


    Field

    Value

    Type

    The disk type of the template. You must enter the correct type (not Unknown) to be able to use the template in the platform. See Disk Format Information. The V2V conversion process will generate the different conversions for each hypervisor installed or for all hypervisors if you have not added any hypervisors yet.

    Capacity

    The hard disk size required for the deployed disk in MB, GB, or TB. It is important to enter a correct value. See Determine the size of a VM Disk File. This is a required field.

    File nameClick Select file and use your browser to choose the file to upload.
    Require datastore tierSelect Datastore tier will be required when creating a virtual machine to ensure that the user will select a datastore tier
    Controller typeDepending on the hypervisor, the platform supports IDE, SCSI, and on KVM, it also supports VIRTIO.
    ControllerOn ESXi you can enter a SCSI controller type. The default value is the lsilogic controller.
    NameDisk name in the platform
    BootableSelect this checkbox to indicate that this is a system disk that can be used to boot the VM

  • Disk from ISO file

     Click here to display details of Disk from ISO file

      

    Field

    Value

    Type

    ISO

    File name

    Click Select file and use your browser to choose the file to upload

    Datastore tier will be required while creating a virtual machineOptionally select this checkbox to require the user to select a datastore tier. To create a VM, the user will require the privilege to Manage virtual machine hard disks
    NameFriendly name of the disk in the platform
    BootableSelect this checkbox to indicate that this is a system disk that can be used to boot the VM
    Add an extra empty diskIf you enter a disk size, the platform will create this hard disk and use it to install the ISO

  • Empty disk

     Click here to show/hide the details of an empty disk

    Enter the Capacity (or size) of the deployed disk and the disk Controller type and for SCSI disks, the Controller information.

    Field

    Description

    Capacity

    The deployed size of the hard disk and units

    Datastore tierOnly available for existing disks
    Datastore tier will be required while creating a virtual machineOptionally select. The user will require the privilege to manage hard disks in order to create a VM
    Allocation typeOptional. Allocation type of the disk.
    Controller type

    The controller type of disk

     

    Controller

    Optional. On supported hypervisors (ESXi), to force the creation of a new controller of the same type as an existing one, assign a new bus value. Access ESXi to confirm bus values.

    Bus

    Optional. Select an existing an existing bus number or to create a new controller, specify a new bus number. The user requests a bus number but the platform will use the bus number assigned by ESXi. When there is more than one controller, to identify the controller and bus number, the platform displays the bus number as a suffix to the controller. Access ESXi to confirm bus numbers that are not displayed

    Name

    The name of the hard disk

    When you deploy the VM, the platform will create the empty disk on the hypervisor datastore.


  • Template disk

    Select a template from the Apps library and then select a disk from the template. 

     Click here to show/hide the screenshot

    Abiquo will select the original disk, not the conversions. If you require other formats, generate conversions for these formats. 

Manage template disk conversions

To display and manage disk conversions
  1. Go to Disks, select the disk and check the conversion details in the Selected disk conversions panel

To manually launch conversions to template formats:

  1. Click Generate missing conversions. The platform will create conversions for any new hypervisor types

To restart a failed conversion:

  1. Beside the conversion, click the Restart conversion link


 Click here to show/hide the screenshot


Edit a template disk

 To edit a disk:

  1. Select the Disk
  2. Click the pencil Edit button and make changes as described below


Field

Value

Type

The disk type of the template. If the type is incorrect or UNKNOWN, you cannot deploy a VM with the disk. See Disk Format Information.

Capacity

The hard disk space that is required to deploy this disk. See Determining the size of a VM Disk File.

Capacity unitsMB, GB, or TB
File nameTo download the disk, click Download beside the file name
Datastore tierTo set the storage service level of the template disk, select a Datastore tier. You can modify this value in a VM before you deploy it
Datastore tier will be required while creating a virtual machineOptional. The user will require privileges to select a datastore tier in order to create a VM
Allocation typeThe user with appropriate privileges can modify this value in a VM before they deploy it
Controller typeIf you change the controller type your VM may not boot. The user can modify this value after they create a VM and before they deploy it.
Controller

On ESXi for SCSI

  • You can use multiple controllers on a VM and you can change the controller, even after deploy
  • The default value is lsilogic or a value set by the system administrator

See Template disk controllers for SCSI

NameHard disk name
BootableSelect this checkbox to indicate that this is a system disk that can boot the VM



Delete a template disk

Before you begin, check that the template is not in use. A template is in use if it has deployed VMs or dependent instances. 

To delete a template disk:

  1. Select the Disk to delete
  2. Click the Delete trash can icon.



Edit VM template variables

To add variables to a VM template, enter the Key and Value, then click Add

To edit an existing value, click the pencil icon, enter the new Value, then click ok. To save your changes to the template, click Save.

The variables will be added automatically to new VMs. Users can edit the variables when configuring the VM.

The variables will be added automatically to new VMs. Users can edit the variables when configuring the VM. Users can then access variables in the guest, for example, in AWS, the variables are stored in the ~/vm-variables.rc file. Variables may be used by cloud-init.



Scopes tab for sharing VM templates

To share a template with the enterprises in one or more scopes, select template scopes.

To remove enterprise access to a template, remove the scope containing the enterprise. 

  • You cannot remove a scope from the template if an enterprise in the scope is using the template, for example, if it has deployed VMs or instances of VMs. 

To make a template private to the owner enterprise, unselect all scopes. 



Recommended tab

The Administrator can edit recommended hardware profiles and datastore tiers

Field

Value

Enable only recommended HPsSelect this checkbox to allow the user to select from recommended hardware profiles only.
Hardware profiles - RecommendedSelect the hardware profiles to recommend for this template. The platform will display these profiles in the selection list with "(Recommended)" beside them. Remember that the administrator must allow the user's tenant to access the hardware profiles.
Enable only recommended DS TiersIn private cloud, select this checkbox to allow the user to select from recommended datastore tiers only.
Datastore tiers - RecommendedIn private cloud, select the datastore tiers to recommend for this template. The platform will display these tiers in the selection list with "(Recommended)" beside them. Remember that the administrator must allow the user's tenant to access the datastore tiers.


Advanced tab

The Administrator can edit advanced template elements. These values can also be specified through the OVF and the API. See Extended OVF Support and Template Definition

Field

Value

Guest setupSelect guest setup option of Cloud-init or Hypervisor tools.
Guest initial passwordIf Guest setup is selected, select this option to request an initial password
Cost codePricing cost code for this template. Requires the "Add a cost code in VM Template edition" privilege. See Pricing View
Operating system

Sets the VMware guest operating system type. Select from the pull-down list. For more details, see Guest operating system definition for VMware vSphere 5 and 6 and Extended OVF Support and Template Definition. This attribute also enables users to search for templates in public cloud (e.g. Ubuntu 64-bit template). To use the latest version of an operating system, select a generic type, e.g. WINDOWS, and do not enter the version. 

Os Version

OS version is used to:

  • add operating systems not included in the list of codes
  • provide details of operating systems
  • set the VMware guest operating system type

See Guest operating system definition for VMware vSphere 5 and 6 and Extended OVF Support and Template Definition for further details. 

User

Default user for a VM created from this template for SSH access.

PasswordDefault password for the default User of a VM created from this template.

NIC driver

  • Abiquo always supports E1000 drivers
  • On ESXi, Abiquo also supports PCNet32 and VMXNET3
  • On KVM, Abiquo supports VIRTIO drivers
Enable hot add / reconfigure in VMSee separate section

Creation user

SYSTEM means that the platform created the template, for example, from an OVF file in the NFS repository.

Creation date

Date and time when the template was created.

Enable hot add and hot reconfigure for VM templates

To allow users to reconfigure their VMs without powering off, set these values as described on the Advanced tab of the VM edit dialog.


OptionDescription

Enable hot-add or
hot reconfigure in VM

Supported providers only with supported guest operating systems. 
Check that the Operating system and OS version are correctly set for your system
ESXi: See VMware documentation. After you hot-add or hot-reconfigure, remember to update your guest system as required

CPU hot-add

Enable users to add CPUs in the platform while the VM is powered on

RAM hot-add

Enable users to add RAM in the platform while the VM is powered on

Disks hot-reconfigure

Enable users to remove SCSI disks from the boot sequence and add SCSI disks to the end of the boot sequence while the VM is powered on

  • IDE disks are not supported
  • The platform will save other changes to the boot sequence but it will not implement them in the hypervisor. 
  • To implement these changes, power off the VM and make another configuration change that will trigger a reconfigure
NICs hot-reconfigureEnable users to add and remove NICs in the platform while the VM is powered on
Remote access hot-reconfigureEnable users to reset remote access in the platform while the VM is powered on



Manage VM templates with the API

API Documentation

For the Abiquo API documentation of this feature, see Abiquo API Resources and the page for this resource VirtualMachineTemplatesResource.


Pages related to VM templates