Configuration References on

Virtual Machine Template

Mon, 17 Feb 2025 00:00:00 +0000

A template file consists of a set of attributes that defines a Virtual Machine. Using the command onetemplate create, a template can be registered in OpenNebula to be instantiated later. For compatibility with previous versions, you can also create a new Virtual Machine directly from a template file by using the onevm create command.

Warning

Some template attributes can compromise the security of the system or the security of other VMs, and can be used only by users in the oneadmin group. These attributes can be configured in oned.conf. In the following tables, default attributes are marked with *. For the complete list, see the Restricted Attributes section.

Note

If not explicitly stated, the described attributes are valid for all supported hypervisors.

Syntax

The syntax of the template file is as follows:

Image Template

Mon, 17 Feb 2025 00:00:00 +0000

This page describes how to define a new image template. An image template follows the same syntax as the VM template.

Warning

Template Attributes

The following attributes can be defined in the template:

Virtual Network Template

Mon, 17 Feb 2025 00:00:00 +0000

This page describes how to define a new Virtual Network. A Virtual Network includes three different aspects:

Physical network attributes.
Address Range.
Configuration attributes for the guests.

When writing a Virtual Network template in a file, it follows the same syntax as the VM template.

Physical Network Attributes

These define the underlying networking infrastructure that will support the Virtual Network, such as the VLAN ID or the hypervisor interface to bind the Virtual Network to.

Provider

Mon, 17 Feb 2025 00:00:00 +0000

A Provider defines the structure and configuration of a external cloud Provider in OpenNebula. These objects are stored as JSON documents within the OpenNebula database.

Provider attributes

The following table describes the primary attributes used in Provider:

Attribute	Description
`name`	Name used to identify the Provider.
`description`	Short summary of the Provider’s purpose or context.
`driver`	Internal identifier used to map the Provider to its corresponding driver folder.
`version`	Version string used to track updates to the driver.
`fireedge`	Metadata for the FireEdge UI (e.g., icons, labels or layout information).
`connection`	Connection inputs parameters and authentication details for accessing the Provider.
`registration_time`	Timestamp indicating when the document was registered.

Dynamic template generation

Providers are dynamically generated from the content within each driver’s directory. OneForm automatically extracts relevant Provider parameters directly from the Terraform files within the driver’s terraform folder. This process includes identifying variables and default values used by Terraform for infrastructure provisioning.

Provision Template

Mon, 17 Feb 2025 00:00:00 +0000

A Provision defines the configuration and parameters used to create infrastructure resources with OneForm. These objects are stored as JSON Documents within the OpenNebula database.

Provision Attributes

The following table describes all the required attributes used in Provision objects:

Attribute	Description
`name`	Name of the Provision.
`description`	Short explanation of the purpose of the Provision.
`deployment_file`	Identifier used to locate the deployment configuration (onedeploy inventory) for this Provision.
`cloud_provider`	Internal identifier used to map the Provider to its corresponding driver folder.
`version`	Version string used to track updates to the driver.
`fireedge`	UI metadata used by FireEdge.
`user_inputs`	Array of input definitions required from the user to customize the Provision.
`user_inputs_values`	Actual values provided by the user during creation, matched to the input fields.
`provider_id`	ID of the registered Provider used for provisioning the infrastructure.
`state`	Current state of the Provision.
`one_objects`	Collection of OpenNebula resources (Cluster, Hosts, networks, datastores) linked to the Provision.
`registration_time`	Unix timestamp recording when the Provision was created.
`historic`	Chronological list of relevant events and state transitions during the lifecycle of the Provision.
`tags`	Optional key-value pairs used to categorize or label the Provision.

Provisioning Life Cycle

Once created, OneForm manages the provisioning lifecycle using a state machine that defines the key operational states and the transitions between them. Each state is linked to specific actions, triggers, and callbacks that guide the execution and progression of the provisioning workflow.

Virtual Machine States Reference

Mon, 17 Feb 2025 00:00:00 +0000

This page is a complete reference of all the VM states that will be useful for developers and administrators doing troubleshooting.

The simplified life cycle is explained in Virtual Machine Instances. That simplified guide uses a smaller number of state names. The names here are the ones used by onevm list, e.g., prolog, prolog_migrate, and prolog_resume are all presented as prol. This section is intended as a reference for end users. However, the information in the Virtual Machine Instances guide should be enough for everyday administration tasks.

Image States Reference

Mon, 17 Feb 2025 00:00:00 +0000

This page is a complete reference of all the Image states that will be useful for developers and administrators doing troubleshooting.

The simplified life-cycle is explained in the Virtual Machines Images guide. This simplified diagram uses a smaller number of state names. That section should be enough for end users and everyday administration tasks.

List of States

OpenNebula’s images define their state using the STATE variable. The state can be seen from the CLI (oneimage show) and from Sunstone (Info panel for the Image).

Host States Reference

Mon, 17 Feb 2025 00:00:00 +0000

This page is a complete reference of all the Host states that will be useful for developers and administrators doing troubleshooting.

The simplified life-cycle is explained in the Hosts guide. This simplified diagram uses a smaller number of state names. That section should be enough for end users and everyday administration tasks.

List of States

OpenNebula’s Hosts define their state using the STATE variable. The state can be seen from the CLI (onehost show) and from Sunstone (Info panel for Hosts).