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

Skip to end of metadata
Go to start of metadata

Private cloud

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 tab

The General information tab contains the basic template details.

Modify shared templates

Users can only modify templates that belong to their own enterprise or their current enterprise.

 

Field

Value

Name

A short name to identify the VM 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

CPU

Number of CPUs assigned to this template. If you are using hardware profiles, you cannot change this value

RAM

RAM memory size assigned for this template in MB, GB or TB. If you are using hardware profiles, you cannot change this value

Min CPU
Min RAM

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 

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

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.

Restrict CPU and RAM from VM templates

Set the Min CPU/RAM and Max CPU/RAM as described in the above table. 

Disks tab

The Disks tab contains details of disks and SCSI/IDE information. It shows the disks currently attached to the machine and enables the user to edit and add new disks, as well as download disks to their local file system, depending on the user's privileges. 


Disks table 

Field

Value

Sequence

The boot order of the disk. You can edit the disk sequence by clicking the pencil icon near the sequence number. There must always be a boot disk in the 0 position, and the boot disk cannot be an empty disk.

Type

Local file

Path

The relative path and filename on the NFS repository filesystem. You cannot edit this value

File sizeSize of the disk file on the disk
Capacity

Size of the deployed disk, also called the provisioned size. If the size registered in the template's definition does not match the provisioned size, deployment may fail with a message such as "is not a virtual disk". To correct this error, edit the capacity and change it to match the physical size. See Determining the size of a VM Disk File.

State

Template disk state can be

  • DONE: disk is ready, but note that conversions may still be in progress
  • IN PROGRESS
  • UNAVAILABLE: disk defined in template but not present in Apps library
  • FAILED: caused by disk issue during template creation

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

Download symbolClick to download the template disk. Not applicable to empty disks
Disk Conversions

Abiquo should convert all of your templates to all of the available hypervisor formats. If no hypervisors have been added, Abiquo will convert to ALL possible hypervisor formats. 

To display the conversions for a disk, select that disk in the Disks table. For each conversion, Abiquo will list the following details:

Field

Value

Target format

The format your disk has been converted into. See Template Compatibility Table

State

Conversion state can be ENQUEUED, FINISHED, FAILED.

Date

Time stamp of when the conversion was completed

Action

If a conversion Failed, the link to Restart conversion will be available. Click Restart conversion to launch the conversion again

To manually launch conversions to new template formats if you have added any new hypervisor types after the initial conversion process ended, click Generate missing conversions.

If a conversion failed, one or more of its disks are missing from the NFS Repository. To launch a failed conversion again, click Restart.

Add a disk to a template

To add a disk to a template, click the + button in the top right of the disk dialog and 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

 

Disk from local file

Enter the details of the 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

Enter the details of the local 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

To add an empty disk to a VM template, enter the size of the disk and the disk controller type and controller information.

Abiquo will store the disk definition in the template and when you deploy a VM based on this template, Abiquo will create the disk on the hypervisor datastore.

 Click here to show/hide the screenshot

 

Template disk

To add a template disk to a VM template, select a template from the Apps library and then select a disk from the template. 

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

 Click here to show/hide the screenshot


Edit a template disk


When you edit a disk you can modify the following values. To reset a selection to the default value, click the x beside its 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.
Require datastore tierSelect this checkbox to require the user to select a datastore tier when they are creating a VM
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



Disk controller table

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

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

You cannot delete a disk of a template that is in use. A template is in use if it has deployed VMs or dependent instances. To delete a template disk, click the delete icon.

Variables tab

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.

Scopes tab for sharing VM templates

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. 


Recommended tab

The administrator can select recommended hardware profiles and datastore tiers for the template and restrict the user to these hardware profiles and tiers.

FieldDescription
Enable only recommended HPsOptionally mark this checkbox to allow the user to work with recommended hardware profiles only. When creating a VM, the user will only be able to select from the recommended hardware profiles.
Hardware profiles - RecommendedOptionally select the hardware profiles to recommend for this template. When the user creates a VM, Abiquo will display recommended hardware profiles in the selection list with (Recommended) beside them. Note that Abiquo will not allow you to recommend hardware profiles that have values outside the allowed range for minimum and maximum CPU and RAM, which are set on the General information tab.
Enable only recommended DS TiersIn private cloud to allow the user to work with recommended datastore tiers only select this option. When creating a VM, the user will only be able to select from the recommended datastore tiers.
Datastore tiers - RecommendedIn private cloud, optionally select the datastore tiers to recommend for this template. When the user creates a VM, Abiquo will display recommended datastore tiers in the selection list with (Recommended) beside them. .

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 setupMark the template as compatible with guest setup. Select option of Cloud-init or Hypervisor tools
Guest initial passwordIf guest setup is used, Abiquo can inject 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. See Examples of Operating system and OS version below (and Extended OVF Support and Template Definition) for further details. This element offers compatibility with the jclouds compute service implementation, to enable users to search for templates (e.g. Ubuntu 64-bit template).

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 Operating system and OS version below (and Extended OVF Support and Template Definition) for further details. 

User

Default user for a VM created from this template for SSH access. Enter a valid user name for this template. Users should change their password immediately after first login.

PasswordDefault password for the default User of a VM created from this template. Enter a valid user password. Users should change their password immediately after first login.

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 hypervisors only on 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
  • Abiquo 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 modify 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 template was generated by Abiquo from an OVF file in the NFS repository. You cannot edit this value. When you select a template to create a VM, this value will display for each instance in the list of instances for that template to help you select the appropriate instance.

Creation date

Date and time when the template was created. You cannot edit this value. When you select a template to create a VM, this value will display for each instance in the list of instances for that template to help you select the appropriate instance.

Enable only recommended HPsMark this checkbox to allow the user to work with recommended hardware profiles only. When creating a VM, the user will only be able to select from the recommended hardware profiles.
Hardware profiles - RecommendedSelect the hardware profiles to recommend for this template. When the user creates a VM, Abiquo will display recommended hardware profiles in the selection list with (Recommended) beside them. Note that Abiquo will not allow you to recommend hardware profiles that have values outside the allowed range for minimum and maximum CPU and RAM, which are set on the General information tab.
Enable hot add and 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. 

Operating system and OS version

The following table gives Operating system and OS version values. To use the latest version of an operating system, select a generic type, e.g. WINDOWS, and do not enter the version. 

 Click here to show/hide the Operating System table

Abiquo Operating system / osType

Abiquo OS version / osVersion

vSphere GuestOsIdentifier
vSphere 5.0+

vSphere GuestOsIdentifier
vSphere 5.5+
vSphere GuestOsIdentifier
vSphere 6.0
vSphere GuestOsIdentifier
vSphere 6.5+
Select this value in the UI or enter with APIEnter this version To deploy with this guest OS
in ESX 5.X
To deploy with this guest OS
in ESX 5.5+
To deploy with this guest OS
in ESX 6.X
To deploy with this guest OS
in ESX 6.5+

MACOS

("10.6" & "64")

darwin10_64Guest

   

MACOS

("10.6")

darwin10Guest

   

MACOS

("10.7" & "64")

darwin11_64Guest

   

MACOS

("10.7")

darwin11Guest

   

MACOS

("64")

darwin64Guest

   

MACOS

 

darwinGuest

   
MACOSstarts with "12" darwin12_64Guest  
MACOSstarts with "13" darwin13_64Guest  
MACOSstarts with "14"   darwin14_64Guest 
MACOSstarts with "15"    darwin15_64Guest
MACOSstarts with "16"    darwin16_64Guest

SOLARIS

starts with "6"

solaris6Guest

   

SOLARIS

starts with "7"

solaris7Guest

   

SOLARIS

starts with "8"

solaris8Guest

   

SOLARIS

starts with "9"

solaris9Guest

   

SOLARIS

starts with "10"

solaris10Guest

   

SOLARIS

("Sun Java Desktop System")

sjdsGuest

   

SOLARIS

 

solaris10Guest

   

SOLARIS_64

starts with "10"

solaris10_64Guest

   

SOLARIS_64

 

solaris11_64Guest

   
RHEL redhatGuest   

RHEL

starts with "2"

rhel2Guest

   

RHEL

starts with "3"

rhel3Guest

   

RHEL

starts with "4"

rhel4Guest

   

RHEL

starts with "5"

rhel5Guest

   

RHEL

starts with "6"

rhel6Guest

   

RHEL

starts with "7"

 

rhel7  

RHEL_64

starts with "3"

rhel3_64Guest

   

RHEL_64

starts with "4"

rhel4_64Guest

   

RHEL_64

starts with "5"

rhel5_64Guest

   

RHEL_64

starts with "6"

rhel6_64Guest

   
RHEL_64starts with "7" rhel7_64Guest  

SUSE

("Open")

opensuseGuest

   

SUSE

 

suseGuest (warning)

   

SUSE_64

("Open")

opensuse64Guest (warning)

   

SUSE_64

 

suse64Guest

   

SLES

 

slesGuest

   

SLES

starts with "10"

sles10Guest

   

SLES

starts with "11"

sles11Guest

   
SLESstarts with "12" sles12  
SLES_64 sles64Guest   

SLES_64

starts with "10"

sles10_64Guest

   

SLES_64

starts with "11"

sles11_64Guest

   
SLES_64starts with "12" sles12_64Guest  

NOVELL_OES

 

oesGuest

   

NOVELL_OES

starts with "9"

nld9Guest

   

NOVELL_OES

("NetWare 4")

netware4Guest

   

NOVELL_OES

("NetWare 5")

netware5Guest

   

NOVELL_OES

("NetWare 6")

netware6Guest

   

MANDRIVA

 

mandrivaGuest

   

MANDRIVA_64

 

mandriva64Guest

   

TURBOLINUX

 

turboLinuxGuest

   

TURBOLINUX_64

 

turboLinux64Guest

   

UBUNTU

 

ubuntuGuest

   

UBUNTU_64

 

ubuntu64Guest

   

DEBIAN

starts with "4"

debian4Guest

   

DEBIAN

starts with "5"

debian5Guest

   

DEBIAN

starts with "6"

debian6Guest

   
DEBIANstarts with "7" debian7  
DEBIANstarts with "8"  debian8 
DEBIANstarts with "9"   debian9Guest
DEBIANstarts with "10"   debian10Guest

DEBIAN_64

starts with "4"

debian4_64Guest

   

DEBIAN_64

starts with "5"

debian5_64Guest

   

DEBIAN_64

starts with "6"

debian6_64Guest

   
DEBIAN_64starts with "7" debian7_64Guest  
DEBIAN_64starts with "8"  debian8_64Guest 
DEBIAN_64starts with "9"   debian9_64Guest
DEBIAN_64starts with "10"   debian10_64Guest

FREEBSD

 

freebsdGuest

   

FREEBSD_64

 

freebsd64Guest

   

WINDOWS_SERVER_2008

 

windows7Server64Guest

   

WINDOWS_SERVER_2008_64

 

windows7Server64Guest

   

WINDOWS_SERVER_2008_R2

 

windows7Server64Guest

   

WINDOWS_7

("Server")

windows7Server64Guest

   

WINDOWS_7

("64")

windows7_64Guest

   

WINDOWS_7

 

windows7Guest

   

WINDOWS_8

 

windows8Guest

   

WINDOWS

 

windows8Guest

   

WINDOWS

("64")

windows8_64Guest

   

WINDOWS_8_64

 

windows8Server64Guest

   

WINDOWS

starts with "8" ("Server")

windows8Server64Guest

   
WINDOWS("Hyper") ("hyper") windowsHyperVGuest  
WINDOWSstarts with "9" or starts with "10" ("server") ("Server")  windows9Server64Guest 
WINDOWSstarts with "9" or starts with "10" ("64")  windows9_64Guest 
WINDOWSstarts with "9"  windows9 

WINDOWS_SERVER_2003

("Web")

winNetWebGuest

   

WINDOWS_SERVER_2003

("Business")

winNetBusinessGuest

   

WINDOWS_SERVER_2003

("Enterprise")

winNetEnterpriseGuest

   

WINDOWS_SERVER_2003

("Datacenter")

winNetDatacenterGuest

   

WINDOWS_SERVER_2003

 

winNetStandardGuest

   

WINDOWS_SERVER_2003_64

("Enterprise")

winNetEnterprise64Guest

   

WINDOWS_SERVER_2003_64

("Datacenter")

winNetDatacenter64Guest

   

WINDOWS_SERVER_2003_64

 

winNetStandard64Guest

   

WINDOWS

starts with "3.1"

win31Guest

   

WINDOWS

starts with "95"

win95Guest

   

WINDOWS

starts with "98"

win98Guest

   

WINDOWS

("ME" OR "Millenium")

winMeGuest

   

WINDOWS

starts with "NT"

winNTGuest

   

WINDOWS

starts with "2000" ("Pro")

win2000ProGuest

   

WINDOWS

starts with "2000" ("Avd")

win2000AdvServGuest

   

WINDOWS

starts with "2000"

win2000ServGuest

   

WINDOWS

starts with "XP" ("Home")

winXPHomeGuest

   

WINDOWS

starts with "XP" ("64")

winXPPro64Guest

   

WINDOWS

starts with "XP"

winXPProGuest

   

WINDOWS

starts with "Longhorn" ("64")

winLonghorn64Guest

   

WINDOWS

starts with "Longhorn"

winLonghornGuest

   

WINDOWS

starts with "Vista" ("64")

winVista64Guest

   

WINDOWS

starts with "Vista"

winVistaGuest

   

ESXI

starts with "4"

vmkernelGuest

   

ESXI

starts with "5"

vmkernel5Guest

   

ESXI

starts with "6"

 

 vmkernel6Guest 

ESXI

starts with "6.5"

 

  vmkernel65Guest

ESXI

starts with "6"

 

  vmwarePhoton64Guest

LINUX_2_4

 

other24xLinuxGuest

   

LINUX_2_4_64

 

other24xLinux64Guest

   

LINUX_2_6

 

other26xLinuxGuest

   

LINUX_2_6_64

 

other26xLinux64Guest

   

LINUX

 

otherLinuxGuest

   

LINUX

("Fedora")

fedoraGuest(warning)

   
LINUX("generic") genericLinuxGuest  

LINUX_64

 

otherLinux64Guest

   

LINUX_64

("Fedora")

fedora64Guest (warning)

   
LINUX_64("3x") other3xLinuxGuest  
LINUX("3x") other3xLinux  
LINUX("core") ("Core")  coreos64Guest 

CENTOS

 

centosGuest

   

CENTOS

starts with "6"

 

  centos6Guest

CENTOS

starts with "7"

 

  centos7Guest

CENTOS_64

 

centos64Guest

   

CENTOS_64

starts with "6" 

 

   centos6_64Guest

CENTOS_64

starts with "7"

 

  centos7_64Guest

ORACLE_ENTERPRISE_LINUX

 

oracleLinuxGuest

   

ORACLE_ENTERPRISE_LINUX

starts with "6"

 

  oracleLinux6Guest

ORACLE_ENTERPRISE_LINUX

starts with "7"

 

  oracleLinux7Guest

ORACLE_ENTERPRISE_LINUX_64

 

oracleLinux64Guest

   

ORACLE_ENTERPRISE_LINUX_64

starts with "6" 

 

  oracleLinux6_64Guest

ORACLE_ENTERPRISE_LINUX_64

starts with "7"

 

  oracleLinux7_64Guest

ECOMSTATION_32

starts with "1"

eComStationGuest

   

ECOMSTATION_32

 

eComStation2Guest

   

OTHER_64

 

otherGuest64

   

NETBSD, OPENBSD, NOT_APPLICABLE,
OTHER, UNRECOGNIZED

 

otherGuest

   

 

Key
  • Values are given in quotation marks. Enter these values without quotation marks
  • Ampersand (&) means that the osversion must contain both values to use this template 
    • e.g. OS type ID = 2, OS version = 10.6_64 will translate to darwin10_64Guest
  • An OR means that one value only is required 
    • e.g. OS type ID = 67, OS version = ME will translate to winMeGuest
  • (warning) = This operating might not be supported by all versions of VMware; please check the documentation for your version. If it is not available, a similar operating system will be used