OpenNebula
Cloud API
A C D E F G H I L M O P R S U V X

A

action(String) - Method in class org.opennebula.client.vm.VirtualMachine
Submits an action to be performed on the virtual machine.
allocate(Client, String, String, String, String) - Static method in class org.opennebula.client.host.Host
Allocates a new host in OpenNebula
allocate(Client, String, String) - Static method in class org.opennebula.client.user.User
Allocates a new user in OpenNebula.
allocate(Client, String) - Static method in class org.opennebula.client.vm.VirtualMachine
Allocates a new VM in OpenNebula.
allocate(Client, String) - Static method in class org.opennebula.client.vnet.VirtualNetwork
Allocates a new virtual network in OpenNebula.

C

call(String, Object...) - Method in class org.opennebula.client.Client
Performs an XML-RPC call.
cancel() - Method in class org.opennebula.client.vm.VirtualMachine
Cancels the running VM.
Client - Class in org.opennebula.client
This class represents the connection with the core and handles the xml-rpc calls.
Client() - Constructor for class org.opennebula.client.Client
Creates a new xml-rpc client with default options: the auth. file will be assumed to be at $ONE_AUTH, and the endpoint will be set to $ONE_XMLRPC.
Client(String, String) - Constructor for class org.opennebula.client.Client
Creates a new xml-rpc client with specified options.
client - Variable in class org.opennebula.client.Pool
 
client - Variable in class org.opennebula.client.PoolElement
 

D

delete(Client, int) - Static method in class org.opennebula.client.host.Host
Deletes a host from OpenNebula.
delete() - Method in class org.opennebula.client.host.Host
Deletes the host from OpenNebula.
delete(Client, int) - Static method in class org.opennebula.client.user.User
Deletes a user from OpenNebula.
delete() - Method in class org.opennebula.client.user.User
Deletes the user from OpenNebula.
delete(Client, int) - Static method in class org.opennebula.client.vnet.VirtualNetwork
Deletes a network from OpenNebula.
delete() - Method in class org.opennebula.client.vnet.VirtualNetwork
Deletes the network from OpenNebula.
deploy(int) - Method in class org.opennebula.client.vm.VirtualMachine
Initiates the instance of the VM on the target host.

E

elementName - Variable in class org.opennebula.client.Pool
 
enable(Client, int, boolean) - Static method in class org.opennebula.client.host.Host
Enables or disables a given host.
enable(boolean) - Method in class org.opennebula.client.host.Host
Enables or disables the host.

F

factory(Node) - Method in class org.opennebula.client.host.HostPool
 
factory(Node) - Method in class org.opennebula.client.Pool
The factory method returns a suitable PoolElement object from an XML node.
factory(Node) - Method in class org.opennebula.client.user.UserPool
 
factory(Node) - Method in class org.opennebula.client.vm.VirtualMachinePool
 
factory(Node) - Method in class org.opennebula.client.vnet.VirtualNetworkPool
 
finalizeVM() - Method in class org.opennebula.client.vm.VirtualMachine
Deletes the VM from the pool and database.

G

getErrorMessage() - Method in class org.opennebula.client.OneResponse
Returns a string containing the error message, or null if the response isn't an error.
getId() - Method in class org.opennebula.client.PoolElement
Returns the element's ID.
getLength() - Method in class org.opennebula.client.Pool
The number of elements in the pool.
getMessage() - Method in class org.opennebula.client.OneResponse
Returns a string containing the response information, or null if the response was an error.
getName() - Method in class org.opennebula.client.PoolElement
Returns the element's name.

H

hold() - Method in class org.opennebula.client.vm.VirtualMachine
Sets the VM to hold state.
Host - Class in org.opennebula.client.host
This class represents an OpenNebula host.
Host(int, Client) - Constructor for class org.opennebula.client.host.Host
Creates a new Host representation.
Host(Node, Client) - Constructor for class org.opennebula.client.host.Host
 
HostPool - Class in org.opennebula.client.host
This class represents an OpenNebula host pool.
HostPool(Client) - Constructor for class org.opennebula.client.host.HostPool
Creates a new host pool

I

id - Variable in class org.opennebula.client.PoolElement
 
info(Client, int) - Static method in class org.opennebula.client.host.Host
Retrieves the information of the given host.
info() - Method in class org.opennebula.client.host.Host
Loads the xml representation of the host.
info(Client) - Static method in class org.opennebula.client.host.HostPool
Retrieves all the hosts in the pool.
info() - Method in class org.opennebula.client.host.HostPool
Loads the xml representation of the host pool.
info(Client, int) - Static method in class org.opennebula.client.user.User
Retrieves the information of the given user.
info() - Method in class org.opennebula.client.user.User
Loads the xml representation of the user.
info() - Method in class org.opennebula.client.user.UserPool
Loads the xml representation of the user pool.
info(Client, int) - Static method in class org.opennebula.client.vm.VirtualMachine
Retrieves the information of the given VM.
info() - Method in class org.opennebula.client.vm.VirtualMachine
Loads the xml representation of the virtual machine.
info(Client, int) - Static method in class org.opennebula.client.vm.VirtualMachinePool
Retrieves all or part of the VMs in the pool.
info() - Method in class org.opennebula.client.vm.VirtualMachinePool
Loads the xml representation of all or part of the VMs in the pool.
info(Client, int) - Static method in class org.opennebula.client.vnet.VirtualNetwork
Retrieves the information of the given virtual network
info() - Method in class org.opennebula.client.vnet.VirtualNetwork
Loads the xml representation of the virtual network.
info(Client, int) - Static method in class org.opennebula.client.vnet.VirtualNetworkPool
Retrieves all or part of the VNs in the pool.
info() - Method in class org.opennebula.client.vnet.VirtualNetworkPool
Loads the xml representation of all or part of the VNs in the pool.
isError() - Method in class org.opennebula.client.OneResponse
Returns true if the call resulted in error.
item(int) - Method in class org.opennebula.client.Pool
Returns the indexth element in the pool.
iterator() - Method in class org.opennebula.client.host.HostPool
 
iterator() - Method in class org.opennebula.client.user.UserPool
 
iterator() - Method in class org.opennebula.client.vm.VirtualMachinePool
 
iterator() - Method in class org.opennebula.client.vnet.VirtualNetworkPool
 

L

lcmState() - Method in class org.opennebula.client.vm.VirtualMachine
Returns the LCM state of the VirtualMachine (numeric value).
lcmStateStr() - Method in class org.opennebula.client.vm.VirtualMachine
Returns the LCM state of the VirtualMachine (string value).
liveMigrate(int) - Method in class org.opennebula.client.vm.VirtualMachine
Performs a live migration of the virtual machine to the target host (hid).

M

migrate(int, boolean) - Method in class org.opennebula.client.vm.VirtualMachine
Migrates the virtual machine to the target host (hid).
migrate(int) - Method in class org.opennebula.client.vm.VirtualMachine
Migrates the virtual machine to the target host (hid).

O

OneResponse - Class in org.opennebula.client
This class encapsulates OpenNebula's XML-RPC responses.
OneResponse(boolean, String) - Constructor for class org.opennebula.client.OneResponse
Creates a new response.
org.opennebula.client - package org.opennebula.client
Provides the Java bindings for the OpenNebula Cloud API (OCA).
org.opennebula.client.host - package org.opennebula.client.host
 
org.opennebula.client.user - package org.opennebula.client.user
 
org.opennebula.client.vm - package org.opennebula.client.vm
 
org.opennebula.client.vnet - package org.opennebula.client.vnet
 

P

Pool - Class in org.opennebula.client
Represents a generic OpenNebula Pool in XML format and provides the basic functionality to handle the Pool elements.
Pool(String, Client) - Constructor for class org.opennebula.client.Pool
Sets the Pool attributes.
PoolElement - Class in org.opennebula.client
Represents a generic element of a Pool in XML format.
PoolElement(int, Client) - Constructor for class org.opennebula.client.PoolElement
Creates a new PoolElement with the specified attributes.
PoolElement(Node, Client) - Constructor for class org.opennebula.client.PoolElement
Creates a new PoolElement from the xml provided.
poolElements - Variable in class org.opennebula.client.Pool
 
processInfo(OneResponse) - Method in class org.opennebula.client.Pool
After a *pool.info call, this method builds the internal xml representation of the pool.
processInfo(OneResponse) - Method in class org.opennebula.client.PoolElement
After a *.info call, this method builds the internal xml representation of the pool.

R

release() - Method in class org.opennebula.client.vm.VirtualMachine
Releases a virtual machine from hold state.
restart() - Method in class org.opennebula.client.vm.VirtualMachine
Resubmits the virtual machine after failure.
resume() - Method in class org.opennebula.client.vm.VirtualMachine
Resumes the execution of a saved VM.

S

shortStateStr() - Method in class org.opennebula.client.host.Host
Returns the short length string state of the Host.
shutdown() - Method in class org.opennebula.client.vm.VirtualMachine
Shuts down the already deployed VM.
state() - Method in class org.opennebula.client.PoolElement
Performs an xpath evaluation for the "state" expression.
state() - Method in class org.opennebula.client.vm.VirtualMachine
 
stateStr() - Method in class org.opennebula.client.host.Host
Returns the state of the Host.
stateStr() - Method in class org.opennebula.client.vm.VirtualMachine
Returns the VM state of the VirtualMachine (string value).
status() - Method in class org.opennebula.client.vm.VirtualMachine
Returns the short status string for the VirtualMachine.
stop() - Method in class org.opennebula.client.vm.VirtualMachine
Stops the virtual machine.
suspend() - Method in class org.opennebula.client.vm.VirtualMachine
Suspends the virtual machine.

U

User - Class in org.opennebula.client.user
This class represents an OpenNebula User.
User(int, Client) - Constructor for class org.opennebula.client.user.User
Creates a new User representation.
User(Node, Client) - Constructor for class org.opennebula.client.user.User
 
UserPool - Class in org.opennebula.client.user
This class represents an OpenNebula user pool.
UserPool(Client) - Constructor for class org.opennebula.client.user.UserPool
Creates a new user pool

V

VirtualMachine - Class in org.opennebula.client.vm
This class represents an OpenNebula VM.
VirtualMachine(int, Client) - Constructor for class org.opennebula.client.vm.VirtualMachine
Creates a new VM representation.
VirtualMachine(Node, Client) - Constructor for class org.opennebula.client.vm.VirtualMachine
 
VirtualMachinePool - Class in org.opennebula.client.vm
This class represents an OpenNebula VM pool.
VirtualMachinePool(Client) - Constructor for class org.opennebula.client.vm.VirtualMachinePool
Creates a new VM pool with the default filter flag value set to 0 (VMs belonging to user with UID 0)
VirtualMachinePool(Client, int) - Constructor for class org.opennebula.client.vm.VirtualMachinePool
Creates a new VM pool.
VirtualNetwork - Class in org.opennebula.client.vnet
This class represents an OpenNebula virtual network.
VirtualNetwork(int, Client) - Constructor for class org.opennebula.client.vnet.VirtualNetwork
Creates a new virtual network representation.
VirtualNetwork(Node, Client) - Constructor for class org.opennebula.client.vnet.VirtualNetwork
 
VirtualNetworkPool - Class in org.opennebula.client.vnet
This class represents an OpenNebula Virtual Network pool.
VirtualNetworkPool(Client) - Constructor for class org.opennebula.client.vnet.VirtualNetworkPool
Creates a new VN pool with the default filter flag value set to 0 (VNs belonging to user with UID 0)
VirtualNetworkPool(Client, int) - Constructor for class org.opennebula.client.vnet.VirtualNetworkPool
Creates a new VN pool.

X

xml - Variable in class org.opennebula.client.PoolElement
 
xpath - Static variable in class org.opennebula.client.PoolElement
 
xpath(String) - Method in class org.opennebula.client.PoolElement
Evaluates an XPath expression and returns the result as a String.

A C D E F G H I L M O P R S U V X
OpenNebula
Cloud API

Visit OpenNebula.org
Copyright 2002-2010 © OpenNebula Project Leads (OpenNebula.org).