The syntax of the template file is as follows:

• Anything behind the pound or hash sign (#) is a comment.
• Strings are delimited with double quotes (“), if the a double quote is part of the string it needs to be escaped (\”).
• Single Attributes are in the form:

NAME=VALUE

• Vector Attributes that contain several values can be defined as follows:

NAME=[NAME1=VALUE1,NAME2=VALUE2]

• Vector Attributes must contain at least one value.
• Attribute names are case insensitive, in fact the names are converted to uppercase internally.

The following attributes can be defined to specified the capacity of a VM.

Example:

  NAME   = test-vm
  MEMORY = 128 
  CPU    = 1

The OS system is defined with the OS vector attribute. The following sub-attributes are supported:

Note the hypervisor column states that the attribute is Optional, Mandatory, or - not supported for that hypervisor

(*) Xen needs a kernel or a bootloader to be specified. If both are set in the template, the kernel boot method will be used.

Example, a VM booting from sda1 with kernel /vmlinuz :

OS = [ KERNEL     = /vmlinuz,
       INITRD     = /initrd.img,
       ROOT       = sda1,
       KERNEL_CMD = "ro xencons=tty console=tty1"]

The disks of a VM are defined with the DISK vector attribute. You can define as many DISK attributes as you need.

There are two ways to attach a disk to a VM: using an OpenNebula image from the image repository, or declaring a disk type that can be created from a source disk file in your system. Both kinds of disks can be combined, with some considerations to be taken into account.

The image repository was introduced in OpenNebula v2.0. To use the registered images in your VMs, you need to specify the IMAGE_ID sub-attribute.

Once the VM machine is shut down, the changes made to the images can be saved back to the repository. To do so, use the onevm saveas command.

You can define a DISK from a disk file without having to register it first in the image repository. There are two special disk types that are created on-the-fly in the target resource: swap and fs. The following sub-attributes for DISK are supported:

Note the hypervisor column states that the attribute is Optional, Mandatory, or - not supported for that hypervisor

* only for users in oneadmin group

When using the Image Catalog (not specifying the SOURCE attribute), these attributes (this note especially applies to SAVE and CLONE attributes) will be overridden and automatically modified by the Image Catalog module.

When you use images in your VM template, you don't have to define the target device to mount them. OpenNebula will mount the disks as follows:

• sda: OS type Image.
• sdb: Contextualization CDROM.
• sdc: CDROM type Image.
• sdd: Swap disk.
• sd[e,f,g…]: DATABLOCK type Images.

This automatic mapping doesn't take into account any disk defined by type (those that do not use an image from the repository), apart from the swap ones.

Only one OS type image per VM template can be declared, the same applies for CDROM type images. You can use as many DATABLOCK images as you need. Please visit the guide for managing images and the image template reference to learn more about the different image types.

You can find a complete description of the contextualization features in the contextualization guide.

The device prefix sd can be changed to hd or other prefix that suits your virtualization hypervisor requirements. You can find more information in the daemon configuration guide.

This a sample section for disks. There are three disks using the image repository, and two beeing defined by type. The fs disk target has been set to sdg to avoid conflicts with the other disks that are mapped automatically. Note that fs and swap are generated on-the-fly:

# OS image, mapped to sda. Use image with ID 2
DISK = [ IMAGE_ID  = 2 ]
 
# First DATABLOCK image, mapped to sde.
# Use the Image named Data, owned by the user named oneadmin.
DISK = [ IMAGE        = "Data",
         IMAGE_UNAME  = "oneadmin" ]
 
# Second DATABLOCK image, mapped to sdf
# use the Image named Results owned by user with ID 7.
DISK = [ IMAGE        = "Results",
         IMAGE_UID    = 7 ]
 
# Third DATABLOCK image, mapped to sdg
# use the Image named Experiments owned by user instantiating the VM.
DISK = [ IMAGE        = "Experiments" ]
 
# swap, sdd
DISK = [ TYPE     = swap,
         SIZE     = 1024,
         READONLY = "no" ]
 
DISK = [ TYPE   = fs,
         SIZE   = 4096,
         FORMAT = ext3,
         SAVE   = yes,
         TARGET = sdg ]

For more information on image management and moving please check the Storage guide.

Each network interface of a VM is defined with the NIC vector attribute. You can define as many NIC attributes as you need. The following sub-attributes for NIC are supported:

Note the hypervisor column states that the attribute is Optional, Mandatory, or - not supported for that hypervisor

* only for users in oneadmin group

iptables_range is a list of ports separated by commas or a ranges separated by semilocolons, e.g.: 22,80,5900:6000.

The PORTS and ICMP attributes require the firewalling functionality to be configured. Please read the firewall configuration guide.

Example, a VM with two NIC attached to two different networks:

NIC = [ NETWORK_ID = 1 ]
 
NIC = [ NETWORK     = "Blue",
        NETWORK_UID = 0 ]

For more information on setting up virtual networks please check the Managing Virtual Networks guide.

The following I/O interfaces can be defined for a VM:

Note the hypervisor column states that the attribute is Optional, Mandatory, or - not supported for that hypervisor

Example:

GRAPHICS = [ 
  TYPE    = "vnc",              
  LISTEN  = "0.0.0.0",
  PORT    = "5"]

For KVM hypervisor the port number is a real one, not the VNC port. So for VNC port 0 you should specify 5900, for port 1 is 5901 and so on.

If the user does not specify the port variable, OpenNebula will automatically assign $VNC_BASE_PORT + $VMID, allowing to generate different ports for VMs so they do not collide. The VNC_BASE_PORT is specified inside the oned.conf file.

Context information is passed to the Virtual Machine via an ISO mounted as a partition. This information can be defined in the VM template in the optional section called Context, with the following attributes:

* only for users in oneadmin group

The values referred to by VARIABLE can be defined :

• Hardcoded values:

  HOSTNAME   = "MAINHOST"

• Using template variables
  • $<template_variable>: any single value variable of the VM template, like for example:

    IP_GEN     = "10.0.0.$VMID"

  • $<template_variable>[<attribute>]: Any single value contained in a multiple value variable in the VM template, like for example:

    IP_PRIVATE = $NIC[IP]

  • $<template_variable>[<attribute>, <attribute2>=<value2>]: Any single value contained in the variable of the VM template, setting one attribute to discern between multiple variables called the same way, like for example:

    IP_PUBLIC = "$NIC[IP, NETWORK=\"Public\"]"

• Using Virtual Network template variables
  • $NETWORK[<vnet_attribute>, <NETWORK_ID|NETWORK>=<vnet_id|vnet_name>]: Any single value variable in the Virtual Network template, like for example:

    dns = "$NETWORK[DNS, NETWORK_ID=3]"

    Note that the network MUST be in used by any of the NICs defined in the template. The vnet_attribute can be TEMPLATE to include the whole vnet template in XML (base64 encoded).

• Using Image template variables
  • $IMAGE[<image_attribute>, <IMAGE_ID|IMAGE>=<img_id|img_name>]: Any single value variable in the Image template, like for example:

    root = "$IMAGE[ROOT_PASS, IMAGE_ID=0]"

    Note that the image MUST be in used by any of the DISKs defined in the template. The image_attribute can be TEMPLATE to include the whole image template in XML (base64 encoded).

• Using User template variables
  • $USER[<user_attribute>]: Any single value variable in the user (owner of the VM) template, like for example:

    ssh_key = "$USER[SSH_KEY]"

    The user_attribute can be TEMPLATE to include the whole user template in XML (base64 encoded).

• Pre-defined variables, apart from those defined in the template you can use:
  • $UID, the uid of the VM owner
  • $TEMPLATE, the whole template in XML format and encoded in base64

Example:

CONTEXT = [
  HOSTNAME   = "MAINHOST",
  IP_PRIVATE = "$NIC[IP]",
  DNS        = "$NETWORK[DNS, NAME=\"Public\"]",
  IP_GEN     = "10.0.0.$VMID",
  FILES      = "/service/init.sh /service/certificates /service/service.conf",
  TARGET     = "sdc"
]

The following attributes placement constraints and preferences for the VM:

Note the hypervisor column states that the attribute is Optional, Mandatory, or - not supported for that hypervisor

Example:

REQUIREMENTS = "CPUSPEED > 1000"
RANK         = FREECPU

The syntax of the requirement expressions is defined as:

<xterm>

stmt::= expr';'
expr::= VARIABLE '=' NUMBER
      | VARIABLE '!''=' NUMBER
      | VARIABLE '>' NUMBER
      | VARIABLE '<' NUMBER
      | VARIABLE '=' STRING
      | VARIABLE '!''=' STRING
      | expr '&' expr
      | expr '|' expr
      | '!' expr
      | '(' expr ')'

</xterm>

Each expression is evaluated to 1 (TRUE) or 0 (FALSE). Only those hosts for which the requirement expression is evaluated to TRUE will be considered to run the VM.

Logical operators work as expected ( less '<', greater '>', '&' AND, '|' OR, '!' NOT), '=' means equals with numbers (floats and integers). When you use '=' operator with strings, it performs a shell wildcard pattern matching.

Any variable defined by the Information Manager driver can be used in the requirements. Check the configuration guide to find out how to extend the information model

There are some predefined variables that can be used: NAME, TOTALCPU, TOTALMEMORY, FREEMEMORY, FREECPU, USEDMEMORY, USEDCPU, HYPERVISOR

Examples:

  REQUIREMENTS = "NAME = \"aquila*\"" #Only aquila nodes, note the quotes
  REQUIREMENTS = FREECPU > 0.6          #Only those resources with more than 60% of free CPU

If using OpenNebula's default match-making scheduler in a hypervisor heterogeneous environment, it is a good idea to add an extra line like the following to the VM template to ensure its placement in a VMWare hypervisor enabled machine.

REQUIREMENTS = "HYPERVISOR=\"vmware\""

Template variables can be used in the REQUIREMENTS section.

• $<template_variable>: any single value variable of the VM template.
• $<template_variable>[<attribute>]: Any single value contained in a multiple value variable in the VM template.
• $<template_variable>[<attribute>, <attribute2>=<value2>]: Any single value contained in a multiple value variable in the VM template, setting one atribute to discern between multiple variables called the same way.

For example, if you have a custom probe that generates a MACS attribute for the hosts, you can do short of a MAC pinning, so only VMs with a given MAC runs in a given host.

REQUIREMENTS = "MAC=\"$NIC[MAC]\""

The syntax of the rank expressions is defined as:

<xterm>

stmt::= expr';'
expr::= VARIABLE
      | NUMBER
      | expr '+' expr
      | expr '-' expr
      | expr '*' expr
      | expr '/' expr
      | '-' expr
      | '(' expr ')'

</xterm>

Rank expressions are evaluated using each host information. '+', '-', '*', '/' and '-' are arithmetic operators. The rank expression is calculated using floating point arithmetics, and then round to an integer value.

The rank expression is evaluated for each host, those hosts with a higher rank are used first to start the VM. The rank policy must be implemented by the scheduler. Check the configuration guide to configure the scheduler.

Similar to the requirements attribute, any number (integer or float) attribute defined for the host can be used in the rank attribute

Examples:

  RANK = FREECPU                     # First those resources with a higher Free CPU
  RANK = FREECPU * 100 - TEMPERATURE # Consider also the CPU temperature

This optional section of the VM template is used whenever the need to pass special attributes to the underlying hypervisor arises. Anything placed in the data attribute gets passed straight to the hypervisor, unmodified.

Example

RAW     = [
      TYPE  = "xen",
      DATA  = "builder=\"linux\"
               bootloader=\"/usr/lib/xen/boot/domUloader.py\"
               bootargs=\"--entry=xvda2:/boot/vmlinuz-xenpae,/boot/vmlinuz-xenpae\""]

All the restricted attributes to users in the oneadmin group are summarized in the following list:

• CONTEXT/FILES
• DISK/SOURCE
• NIC/MAC
• NIC/VLAN_ID
• RANK