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

Part of libcloud.compute.drivers.opennebula View Source View In Hierarchy

Known subclasses: libcloud.compute.drivers.opennebula.OpenNebula_1_4_NodeDriver, libcloud.compute.drivers.opennebula.OpenNebula_2_0_NodeDriver

OpenNebula.org node driver.
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 __new__(cls, key, secret=None, api_version=DEFAULT_API_VERSION, **kwargs): (source)
Undocumented
def create_node(self, **kwargs): (source)
Create a new OpenNebula node.
ParametersnetworksList of virtual networks to which this node should connect. (optional) (type: OpenNebulaNetwork or list of OpenNebulaNetwork)
Unknown Field: inheritsNodeDriver.create_node
def destroy_node(self, node): (source)
Destroy a node.

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

ParametersnodeThe node to be destroyed (type: Node)
ReturnsTrue if the destroy was successful, otherwise False (type: bool)
def list_nodes(self): (source)
List all nodes
Returnslist of node objects (type: list of Node)
def list_images(self, location=None): (source)
List images on a provider
ParameterslocationThe location at which to list images (type: NodeLocation)
Returnslist of node image objects (type: list of NodeImage)
def list_sizes(self, location=None): (source)
Return list of sizes on a provider.
ReturnsList of compute node sizes supported by the cloud provider. (type: list of OpenNebulaNodeSize)
Unknown Field: inheritsNodeDriver.list_sizes
def list_locations(self): (source)
List data centers for a provider
Returnslist of node location objects (type: list of NodeLocation)
def ex_list_networks(self, location=None): (source)
List virtual networks on a provider.
ParameterslocationLocation from which to request a list of virtual networks. (optional) (type: NodeLocation)
ReturnsList 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.

ParametersnodeCompute node instance. (type: Node)
actionAction to be carried out on the compute node. (type: str)
ReturnsFalse if an HTTP Bad Request is received, else, True is returned. (type: bool)
def _to_images(self, object): (source)
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.

ReturnsList of images. (type: list of NodeImage)
def _to_image(self, image): (source)
Take XML object containing an image description and convert to NodeImage object.
ParametersimageXML representation of an image. (type: ElementTree)
ReturnsThe 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.

ReturnsList of virtual networks. (type: list of OpenNebulaNetwork)
def _to_network(self, element): (source)
Take XML object containing a network description and convert to OpenNebulaNetwork object.

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

ReturnsThe 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.

ReturnsA list of compute nodes. (type: list of Node)
def _to_node(self, compute): (source)
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.

ParameterscomputeXML representation of a compute node. (type: ElementTree)
ReturnsThe newly extracted Node. (type: Node)
def _extract_networks(self, compute): (source)
Extract networks from a compute node XML representation.

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

ParameterscomputeXML representation of a compute node. (type: ElementTree)
ReturnsList of virtual networks attached to the compute node. (type: list of OpenNebulaNetworks.)
def _extract_images(self, compute): (source)
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.

ParameterscomputeXML representation of a compute node. (type: ElementTree)
ReturnsFirst disk attached to a compute node. (type: NodeImage.)
API Documentation for libcloud, generated by pydoctor at 2012-07-28 18:57:18.