System Interfaces on

Overview

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

OpenNebula has been designed to be easily adapted to any infrastructure and easily extended with new components. The result is a modular system that can implement a variety of cloud architectures and can interface with multiple data center services. In this Guide we review the main interfaces of OpenNebula and their.

How Should I Read This Chapter

You should be reading this Chapter if you are trying to automate tasks in your deployed OpenNebula cloud, and you have already read all of the previous guides.

XML-RPC API

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

This reference documentation describes the xml-rpc methods exposed by OpenNebula. Each description consists of the method name and the input and output values.

All xml-rpc responses share a common structure.

Type	Data Type	Description
OUT	Boolean	True or false whenever is successful or not.
OUT	String	If an error occurs this is the error message.
OUT	Int	Error code.

The output will always consist of three values. The first and third ones are fixed, but the second one will contain the String error message only in case of failure. If the method is successful, the returned value may be of another Data Type.

Ruby OpenNebula Cloud API

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

This page contains the OpenNebula Cloud API Specification for Ruby. It has been designed as a wrapper for the XML-RPC methods, with some basic helpers. This means that you should be familiar with the XML-RPC API and the XML formats returned by the OpenNebula core. As stated in the XML-RPC documentation, you can download the XML Schemas (XSD) here.

API Documentation

You can consult the doc online.

Python OpenNebula Cloud API

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

PyONE is an implementation of OpenNebula XML-RPC bindings in Python. It has been designed as a wrapper for the XML-RPC methods, with some basic helpers. This means that you should be familiar with the XML-RPC API and the XML formats returned by the OpenNebula core. As stated in the XML-RPC documentation, you can download the XML Schemas (XSD) here.

PyONE also supports gRPC as a high-performance, alternative transport mechanism, while keeping the same public API as for XML-RPC.

Java OpenNebula Cloud API

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

This page contains the OpenNebula Cloud API Specification for Java. It has been designed as a wrapper for the XML-RPC methods, with some basic helpers. This means that you should be familiar with the XML-RPC API and the XML formats returned by the OpenNebula core. As stated in the XML-RPC documentation, you can download the XML Schemas (XSD) here.

Download

You can download the .jar file compiled using Java 11, the required libraries, and the javadoc packaged in a tar.gz file following this link in the OpenNebula version you have installed.

Go OpenNebula Cloud API

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

This page contains the OpenNebula Cloud API Specification for Go. It has been designed as a wrapper for the XML-RPC methods, with some basic helpers. This means that you should be familiar with the XML-RPC API and the XML formats returned by the OpenNebula core. As stated in the XML-RPC documentation, you can download the XML Schemas (XSD) here.

Go OpenNebula Cloud API covers the resources lists below:

OneFlow Server API

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

The OpenNebula OneFlow API is a RESTful service to create, control and monitor services composed of interconnected Virtual Machines (VMs) with deployment dependencies among them. Each group of VMs is deployed and managed as a single entity, and it is completely integrated with the advanced OpenNebula user and group management. There are two kinds of resources: service templates and services. All data is sent and received as JSON.

OneForm Server API

Mon, 01 Jan 0001 00:00:00 +0000

The OpenNebula OneForm API is a RESTful service designed to register, configure, and orchestrate infrastructure provisioning workflows across multiple Providers. It enables users to define and create Providers and launch full provisioning cycles, each consisting of one or more cloud resources such as Hosts, networks, and datastores. All data is sent and received in JSON format.

This guide is intended for developers and integrators. For other purposes, OneForm is accessible via its own OneForm Command Line Interface.

OneGate API

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

OneGate provides a REST API. To use this API you will need to get some data from the CONTEXT file. The contextualization cdrom should contain the context.sh and token.txt files.

# mkdir /mnt/context
# mount /dev/hdb /mnt/context
# cd /mnt/context
# ls
context.sh token.txt
# cat context.sh
# Context variables generated by OpenNebula
DISK_ID='1'
ONEGATE_ENDPOINT='http://192.168.0.1:5030'
VMID='0'
TARGET='hdb'
TOKEN='yes'

# cat token.txt
yCxieDUS7kra7Vn9ILA0+g==

With that data, you can obtain the headers required for all the ONEGATE API methods:

Using Hooks

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

The Hook subsystem enables the execution of custom scripts tied to a change in state in a particular resource or API call. This opens a wide area of automation for system administrators to tailor their cloud infrastructures. It also features a logging mechanism that allows a convenient way to query the execution history or to retry the execution of a given hook.

Overview

The hook subsystem has two main components: