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 4.5

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.

General information

The General information tab contains the 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. "Others" is a default category that cannot be deleted

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 be the URL of the Abiquo Server. A default icon is assigned if the template does not have one.  Abiquo recommends that you use square icon images with a size of 128x128 pixels. A transparent background also makes icons look better. The compatible image formats are PNG, JPG and GIF.

If the template is a shared template, then all users will see the icon. Changing the icon of a master template will not change the icon of instances you created earlier. However, new instances will be created with the new icon.

 It also contains the CPU and RAM, or hardware profile selection.

Set CPU and RAM

Field

Value

CPU

Number of CPUs assigned to this template.

RAM

RAM memory size assigned for this template in MB or GB.

Min CPU
Min RAM

In private cloud, minimum value of CPU or RAM. If 0 or empty, then there is no constraint. The platform stores 0 as an empty value, so if you enter "0", it will disappear! You cannot set a minimum below the current template value. Changes apply to new VMs, they are not retroactive. However, 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

Max CPU
Max RAM 

In private cloud, maximum value of CPU or RAM. If 0 or empty, then there is no constraint. The platform stores 0 as an empty value, so if you enter "0", it will disappear! Changes apply to new VMs, they are not retroactive. However, 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

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

Set hardware profile

Field

Value

Hardware profileSelect a hardware profile

CPU

Number of CPUs assigned to this template.

RAM

RAM memory size assigned for this template in MB or GB.




VM template disks

The Disks tab displays the disks currently attached to the VM.




In private cloud, the user may edit, delete, and add new disks, as well as download disks to their local file system. 

States of disks in private cloud

Template disks and their conversions can be in the following states:

  • The platform uses the state of the disks to determine the template's state. 

    • DONE: the disk is ready, but conversions may still be in progress
    • IN PROGRESS
    • UNAVAILABLE: the disk is defined in the template but not present in the Apps library
    • FAILED: the disk was not properly created because of an issue during its creation
  • The state of a disk conversion can be as follows
    • ENQUEUED 
    • FINISHED
    • FAILED

Manage VM template disks in private cloud

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 icon 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 manually launch conversions to new template formats if you have added any new hypervisor types after the initial conversion process ended

  1. Click Generate missing conversions.

To display and manage disk conversions

  1. Select the disk and check the conversion details in the lower panel

To restart a failed conversion:

  1. Click the Restart conversion link beside the conversion

To add a disk:

  1. Click the + 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.

     Click here to show/hide the screenshot

  3. Enter the details of the disk

    • 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.
      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

      BootableSelect this checkbox to indicate that this is a system disk that can be used to boot the VM
      Create 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 size of the disk and the disk controller type and controller information.

      The platform will store the disk definition in the VM template and when you deploy a VM based on this template, the platform will create the 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. 

Edit a template disk

 To edit a disk:

  1. Select the disk
  2. Click the pencil edit button and make changes as described below

When you edit a disk you can modify the following values. To reset a value to the default, click the x beside the value.

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 Abiquo. See Disk Format Information.

Capacity

Hard disk size required for this template in MB, GB or TB. It is important to enter a correct value. See Determining the size of a VM Disk File.

File nameTo download the disk, click Download beside the virtual disk file name
Datastore tierSet the storage service level for the template disk by selecting a datastore tier. The user can modify this value after a VM is created and before it is deployed.
Allocation typeThe user with appropriate privileges can modify this value after a VM is created and before it is deployed.
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

  • You can select multiple controllers on a VM and the controller can be changed, even after deploy
  • If no value is entered, the platform will use the default value of lsilogic or the value set by the system administrator

See table of values below

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

 You can enter a disk controller value, according to the following table.

 Click here to show/hide the disk controller table

ResourceSubType value

diskController saved in template and created on VMware

contains "paravirtual"ParaVirtualSCSIController
contains "bus"VirtualBusLogicController
contains "sas"VirtualLsiLogicSASController
other (default value)VirtualLsiLogicController


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

  1. Enter the Key and Value, then click Add. The maximum length for VM template variables is a key of 255 characters and a value of 255 characters.

To edit an existing value

  1. Click the pencil icon on the right side beside the variable value, 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.




Scopes tab for sharing VM templates


In Appliance Library view, shared templates are marked with the orange user symbol. 

 

Privilege: Allow user to switch enterprises

By default, templates are local to the tenant that creates them (which is the owner enterprise). To share templates, administrators assign scopes. Users who belong to the owner enterprise or one of the enterprises in the template's scopes can display and use the template. 

To create a template scope, go to Users view on the Scopes tab, in the same way as a standard administration scope. However, you assign the template scope to a template, not a user. For more information, see Manage Scopes and Manage resource scopes

Select one or more template scopes to share the template with the enterprises in these scopes.

To remove enterprise access, remove the scope containing that 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 again, unselect all scopes. 

Instances of shared templates belong to the enterprise that created them, and these instances mean that the template is in use by these enterprises.

When you make a shared template unavailable, other enterprises cannot deploy it, but it may not be marked as unavailable in the Apps library of other enterprises until you refresh your Apps library,


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 VM template operating systems 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 VM template operating systems 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 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: https://www.vmware.com/resources/compatibility/search.php?deviceCategory=software

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

Creation user

SYSTEM - 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 only recommended HPsMark 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.

Enable hot add and hot reconfigure for VM templates

To allow users to reconfigure their VMs without powering off, set these values as described under Enable hot-add/reconfigure in VM in the above table. 




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

  • No labels