Client API for ONE 1.0
This documentation provides a description of the xmlrpc methods exposed by OpenNebula. The methods consist of the name of the method that will be invoked, input values needed to the execution and results of execution as outputs.
* * this parameter functionality is not fully implemented so dummy values must be used.
Actions for Virtual Machine Management
VM Allocation
Type | Data Type | Description |
IN | String | the session string associated to connected the user * * |
IN | String | a string containing the template of the vm |
OUT | Boolean | true or false whenever is successful or not |
OUT | String | if an error occurs this is error message, if successful this is the associated id (int vid) generated |
VM Deployment
Type | Data Type | Description |
IN | String | the session string associated to the connected user. * * |
IN | Int | the virtual machine Id (vid)to start |
IN | Int | the host id (hid) of the target host where the VM will be instantiated. |
OUT | Boolean | true or false whenever is successful or not |
OUT | String | if an error occurs this is error message, otherwise it is null. |
VM Actions
Type | Data Type | Description |
IN | String | the session string associated to the connected user. * * |
IN | String | the action name to be performed, can be: “shutdown”, “hold”, “release”, “stop”, “suspend”, “resume” |
IN | Int | the id (vid) of the vm that we want to execute the action on. |
OUT | Boolean | true or false whenever is successful or not |
OUT | String | if an error occurs this is error message, otherwise is empty. |
VM Migration
Type | Data Type | Description |
IN | String | the session string associated to the connected user. * * |
IN | Int | the virtual machine Id (vid) of the instance we want to migrate. |
IN | Int | the target host id (hid) where we want to migrate the vm. |
IN | Boolean | if true we are indicating that we want livemigration, otherwise false. |
OUT | Boolean | true or false whenever is successful or not |
OUT | String | if an error occurs this is error message, otherwise is empty. |
Type | Data Type | Description |
IN | String | the session string associated to the connected user. * * |
IN | Int | the virtual machine Id (vid) of the instance we want information about. |
OUT | Boolean | true or false whenever is successful or not |
OUT | String | if an error occurs this is error message, if succesful this is the information string. |
Actions for Hosts Management
Host Allocation
Type | Data Type | Description |
IN | String | the session string associated to the connected user. * * |
IN | String | hostname of the machine we want to add |
IN | String | the name of the information manager (im_mad_name), this values are taken from the oned.conf with the tag name IM_MAD (name) |
IN | String | the name of the virtual machine manager mad name (vmm_mad_name), this values are taken from the oned.conf with the tag name VM_MAD (name) |
IN | String | the transfer manager mad name to be used with this host * * |
IN | Boolean | this is the “managed” flag of the host, that indicates whenever this host is part of our administrative domain or not |
OUT | Boolean | true or false whenever is successful or not |
OUT | String | if an error occurs this is error message, if successful this is the associated id (int hid) generated to this host |
Type | Data Type | Description |
IN | String | the session string associated to the connected user. * * |
IN | Int | the host id (hid) of the target machine. |
OUT | Boolean | true or false whenever is successful or not |
OUT | String | if an error occurs this is error message, if successful this is the string with the information returned by OpenNebula. |
Host Delete
Type | Data Type | Description |
IN | String | the session string associated to the connected user. * * |
IN | Int | the host id (hid) of the target host we want to delete. |
OUT | Boolean | true or false whenever is successful or not |
OUT | String | if an error occurs this is error message, otherwise it is null. |
Host Enable
Type | Data Type | Description |
IN | String | the session string associated to the connected user. * * |
IN | Int | the target host id (hid) of the machine you want to enable/disable. |
IN | Boolean | if set true OpenNebula will enable the target host, if set false it will disable it. |
OUT | Boolean | true or false whenever is successful or not |
OUT | String | if an error occurs this is error message, otherwise it is null. |