Modify a VM template
- 1 Modify a virtual machine template
- 2 Modify VM template disks
- 3 Edit VM template variables
- 4 Share VM templates
- 5 Activate hardware profiles for a VM template
- 6 Activate datastore tiers for a VM template
- 7 Add a bootstrap script to a VM template
- 8 Edit template advanced tab
- 9 Enable hot add and hot reconfigure for VM templates
- 10 Add cost codes for extra charges for a VM template
- 11 Add tags to a VM template
- 12 Manage VM templates with the API
- 13 Pages related to VM templates
This page describes how to modify a VM template in private cloud.
For public cloud, see Modify a VM template in public cloud
Modify a virtual machine template
Modify VM template disks
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.
After the VM deploys, users can then access variables in the guest.
For example, AWS stores the variables in the ~/vm-variables.rc file. Cloud-init may use variables. Remember to check your provider documentation about metadata security.
Share VM templates
In the Catalogue view, shared templates are marked with the outstretched hand symbol.
Privileges: Allow user to switch enterprises
By default, templates are local to the tenant that creates them (the "owner" enterprise). To share templates, assign scopes to them.
Users who belong to the owner enterprise or enterprises in a template's scopes can display and use the template.
To share a template with a scope:
Go to Users → Scopes
Create a scope
For enterprises to use the template, select them in the scope
Log in or switch to the enterprise that owns the template
Go to Catalogue → Templates
Edit a template
Go to Scopes
Select the scope
For more information, see Manage scopes and Manage resource scopes
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.
In private cloud, the instances of shared templates belong to the enterprise that created them. When a template has instances, it is "in use" by the enterprises with instances. This may mean that you cannot delete a template without deleting or promoting the instances first.
When you make a shared template unavailable, other enterprises cannot deploy it, but it may not be marked as "unavailable" in the Catalogue of other enterprises until you refresh your Catalogue.
Activate hardware profiles for a VM template
When you edit a VM template, you can recommend some hardware profiles for users when they create VMs from this template. You can also activate only the recommended hardware profiles.
By default, users can access all hardware profiles that are active in the infrastructure (see Create a hardware profile) and allowed for their enterprise (see Configure an enterprise in a cloud location).
To activate a set of selected hardware profiles for a VM template:
Go to Apps library → Public/Private → select region or datacenter → Templates
Edit a template
Go to Recommended
Select the hardware profiles to recommend for this template. When the user creates a VM, the platform will display (Recommended) beside them.
For shared templates, remember that the administrator must allow the user's tenant to access the hardware profiles. See Configure an enterprise in a cloud location.To activate and display the recommended hardware profiles only, select the Enable only recommended HPs option
Activate datastore tiers for a VM template
When you edit a VM template in private cloud, you can recommend some datastore tiers for users when they create VMs from this template. You can also restrict users to the recommended tiers.
By default, when users configure VMs, they can access all datastore tiers that are appropriately configured in the infrastructure and allowed for their enterprise.
To activate a set of selected datastore tiers for a template:
Go to Apps library → Private → select region or datacenter → Templates
Edit the template
Go to Recommended
Select the datastore tiers to recommend for this template. The platform will display these datastore tiers in the selection list with (Recommended) beside them. Remember that the administrator must allow the user's tenant to access the datastore tiers
To activate and display the recommended datastore tiers only, select the Enable only recommended DS tiers option
Add a bootstrap script to a VM template
Add a bootstrap script to a VM template and the platform will add it to all VMs created from the template to use with the Cloud-init or similar options for Guest setup.
Before you begin:
Prepare a template that is compatible with cloud-init version 0.7.9 or above, or cloudbase-init, or a similar system
In private cloud, the platform will create an ISO disk for Configuration drive
To add a VM bootstrap configuration or script:
Go to Catalogue → Edit VM template
Go to Bootstrap
Paste your configuration or script in the Bootstrap script text box
Continue to configure the VM template or click Save to finish
Note: when you save VM disks to an instance template, Abiquo copies the VM bootstrap script to the instance template.
Edit template advanced tab
You can also specify some Advanced template values using the OVF and the API. See Extended OVF support and template definition.
Field | Value |
---|---|
Guest setup | Select Guest setup option of Cloud-init or Hypervisor tools. |
Guest initial password | If Guest setup is selected, select this option to request an initial password |
Cost codes | The cost codes for extra charges are now on the separate Extra charges tab. For more details, see Multiple cost codes. |
Operating system | Sets the VMware guest operating system type. Select from the pull-down list. |
Os Version | OS version is used to:
See Guest operating system definition for VMware and Extended OVF support and template definition for further details. |
User | Default user for a VM created from this template for SSH access.
|
Password | Default password for the default User of a VM created from this template. |
NIC driver |
|
Enable UEFI boot | When selected, disable BIOS boot and enable UEFI boot.
For VMs, the uefiEnabled attribute is read-only and it is available via the API. |
Enable hot add / reconfigure in VM | See 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:
Go to Apps library and select Private or Public
Select datacenter or public cloud region
Select and edit the VM template
Go to Advanced tab
Select the options under Enable hot-add/reconfigure
Save the template
Hot add and hot reconfigure options table
Option | Description |
---|---|
Enable hot-add or | Supported providers only with supported guest operating systems. |
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
|
NICs hot-reconfigure | Enable users to add and remove NICs in the platform while the VM is powered on |
Remote access hot-reconfigure | Enable users to reset remote access in the platform while the VM is powered on. |
Add cost codes for extra charges for a VM template
When you edit a VM template, you can add cost codes for extra charges for cloud billing.
Create cost codes for extra charges. See “Create a new extra charge” in Pricing view
For the Type select VM template or All
Set values for cost codes for extra charges. See Create a new pricing model
Go to the Catalogue
Edit a VM template
Go to cost codes for Extra charges
Add cost codes for extra charges as required.
Add tags to a VM template
When you edit a VM template, you can add tags to group resources and manage them in Control view.
To manage tags for a template:
Go to Apps library → select a datacenter or public cloud region
Go to Templates
Edit a template
Go to Tags
Add tags
For more details see Edit resource tags
Manage VM templates with the API
Pages related to VM templates
Main Apps library page with links to related pages: Catalogue view
Copyright © 2006-2024, Abiquo Holdings SL. All rights reserved