libcloud.compute.drivers.opennebula.OpenNebulaNodeDriver : API documentation

Method	__new__	Undocumented
Method	create_node	Create a new OpenNebula node.
Method	destroy_node	Destroy a node.
Method	list_nodes	List all nodes @return: list of node objects @rtype: `list` of `Node`
Method	list_images	List images on a provider
Method	list_sizes	Return list of sizes on a provider.
Method	list_locations	List data centers for a provider
Method	ex_list_networks	List virtual networks on a provider.
Method	ex_node_action	Build action representation and instruct node to commit action.
Method	_to_images	Request a list of images and convert that list to a list of NodeImage objects.
Method	_to_image	Take XML object containing an image description and convert to NodeImage object.
Method	_to_networks	Request a list of networks and convert that list to a list of OpenNebulaNetwork objects.
Method	_to_network	Take XML object containing a network description and convert to OpenNebulaNetwork object.
Method	_to_nodes	Request a list of compute nodes and convert that list to a list of Node objects.
Method	_to_node	Take XML object containing a compute node description and convert to Node object.
Method	_extract_networks	Extract networks from a compute node XML representation.
Method	_extract_images	Extract image disks from a compute node XML representation.

Inherited from NodeDriver:

Method	__init__
Method	reboot_node	Reboot a node.
Method	deploy_node	Create a new node, and start deployment.
Method	create_volume	Create a new volume.
Method	destroy_volume	Destroys a storage volume.
Method	attach_volume	Attaches volume to node.
Method	detach_volume	Detaches a volume from a node.
Method	_wait_until_running	Block until node is fully booted and has an IP address assigned.
Method	_ssh_client_connect	Try to connect to the remote SSH server. If a connection times out or is refused it is retried up to timeout number of seconds.
Method	_run_deployment_script	Run the deployment script on the provided node. At this point it is assumed that SSH connection has already been established.
Method	_get_size_price	Undocumented

Inherited from BaseDriver (via NodeDriver):

Method

_ex_connection_class_kwargs

Return extra connection keyword arguments which are passed to the Connection class constructor.

def create_node(self, **kwargs): (source)

overrides libcloud.compute.base.NodeDriver.create_node

overridden in libcloud.compute.drivers.opennebula.OpenNebula_2_0_NodeDriver

Create a new OpenNebula node.

Parameters	networks	List of virtual networks to which this node should connect. (optional) (type: `OpenNebulaNetwork` or `list` of `OpenNebulaNetwork`)
Unknown Field: inherits	`NodeDriver.create_node`

def destroy_node(self, node): (source)

overrides libcloud.compute.base.NodeDriver.destroy_node

overridden in libcloud.compute.drivers.opennebula.OpenNebula_2_0_NodeDriver

Destroy a node.

Depending upon the provider, this may destroy all data associated with the node, including backups.

Parameters	node	The node to be destroyed (type: `Node`)
Returns	True if the destroy was successful, otherwise False (type: `bool`)

def list_images(self, location=None): (source)

overrides libcloud.compute.base.NodeDriver.list_images

List images on a provider

Parameters	location	The location at which to list images (type: `NodeLocation`)
Returns	list of node image objects (type: `list` of `NodeImage`)

def list_sizes(self, location=None): (source)

overrides libcloud.compute.base.NodeDriver.list_sizes

overridden in libcloud.compute.drivers.opennebula.OpenNebula_2_0_NodeDriver

Return list of sizes on a provider.

Returns	List of compute node sizes supported by the cloud provider. (type: `list` of `OpenNebulaNodeSize`)
Unknown Field: inherits	`NodeDriver.list_sizes`

def ex_list_networks(self, location=None): (source)

List virtual networks on a provider.

Parameters	location	Location from which to request a list of virtual networks. (optional) (type: `NodeLocation`)
Returns	List of virtual networks available to be connected to a compute node. (type: `list` of `OpenNebulaNetwork`)

def ex_node_action(self, node, action): (source)

Build action representation and instruct node to commit action.

Build action representation from the compute node ID, and the action which should be carried out on that compute node. Then instruct the node to carry out that action.

Parameters	node	Compute node instance. (type: `Node`)
	action	Action to be carried out on the compute node. (type: `str`)
Returns	False if an HTTP Bad Request is received, else, True is returned. (type: `bool`)

def _to_images(self, object): (source)

overridden in libcloud.compute.drivers.opennebula.OpenNebula_2_0_NodeDriver

Request a list of images and convert that list to a list of NodeImage objects.

Request a list of images from the OpenNebula web interface, and issue a request to convert each XML object representation of an image to a NodeImage object.

Returns List of images. (type: list of NodeImage)

def _to_image(self, image): (source)

overridden in libcloud.compute.drivers.opennebula.OpenNebula_2_0_NodeDriver

Take XML object containing an image description and convert to NodeImage object.

Parameters	image	XML representation of an image. (type: `ElementTree`)
Returns	The newly extracted `NodeImage`. (type: `NodeImage`)

def _to_networks(self, object): (source)

Request a list of networks and convert that list to a list of OpenNebulaNetwork objects.

Request a list of networks from the OpenNebula web interface, and issue a request to convert each XML object representation of a network to an OpenNebulaNetwork object.

Returns List of virtual networks. (type: list of OpenNebulaNetwork)

def _to_network(self, element): (source)

overridden in libcloud.compute.drivers.opennebula.OpenNebula_3_0_NodeDriver

Take XML object containing a network description and convert to OpenNebulaNetwork object.

Take XML representation containing a network description and convert to OpenNebulaNetwork object.

Returns The newly extracted OpenNebulaNetwork. (type: OpenNebulaNetwork)

def _to_nodes(self, object): (source)

Request a list of compute nodes and convert that list to a list of Node objects.

Request a list of compute nodes from the OpenNebula web interface, and issue a request to convert each XML object representation of a node to a Node object.

Returns A list of compute nodes. (type: list of Node)

def _to_node(self, compute): (source)

overridden in libcloud.compute.drivers.opennebula.OpenNebula_2_0_NodeDriver

Take XML object containing a compute node description and convert to Node object.

Take XML representation containing a compute node description and convert to Node object.

Parameters	compute	XML representation of a compute node. (type: `ElementTree`)
Returns	The newly extracted `Node`. (type: `Node`)

def _extract_networks(self, compute): (source)

overridden in libcloud.compute.drivers.opennebula.OpenNebula_2_0_NodeDriver

Extract networks from a compute node XML representation.

Extract network descriptions from a compute node XML representation, converting each network to an OpenNebulaNetwork object.

Parameters	compute	XML representation of a compute node. (type: `ElementTree`)
Returns	List of virtual networks attached to the compute node. (type: `list` of `OpenNebulaNetwork`s.)

def _extract_images(self, compute): (source)

overridden in libcloud.compute.drivers.opennebula.OpenNebula_2_0_NodeDriver

Extract image disks from a compute node XML representation.

Extract image disk descriptions from a compute node XML representation, converting the disks to an NodeImage object.

Parameters	compute	XML representation of a compute node. (type: `ElementTree`)
Returns	First disk attached to a compute node. (type: `NodeImage`.)

l.c.d.o.OpenNebulaNodeDriver(NodeDriver) : class documentation