l.c.d.l.LibvirtNodeDriver(NodeDriver) : class documentation

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

Libvirt (http://libvirt.org/) node driver.

Usage: LibvirtNodeDriver(uri='vbox:///session'). To enable debug mode, set LIBVIR_DEBUG environment variable.

Method __init__
Method list_nodes List all nodes @return: list of Node objects
Method reboot_node Reboot a node.
Method destroy_node Destroy a node.
Method ex_start Start a stopped node.
Method ex_shutdown Shutdown a running node.
Method ex_suspend Suspend a running node.
Method ex_resume Resume a suspended node.
Method _get_domain_for_node Undocumented

Inherited from NodeDriver:

Method create_node Create a new node instance.
Method list_images List images on a provider
Method list_sizes List sizes on a provider
Method list_locations List data centers for a provider @return: list of NodeLocation objects
Method deploy_node Create a new node, and start deployment.
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 __init__(self, uri): (source)
ParameterskeyAPI key or username to used (type: str)
secretSecret password to be used (type: str)
secureWeither to use HTTPS or HTTP. Note: Some providers only support HTTPS, and it is on by default. (type: bool)
hostOverride hostname used for connections. (type: str)
portOverride port used for connections. (type: int)
api_versionOptional API version. Only used by drivers which support multiple API versions. (type: str)
def list_nodes(self): (source)
List all nodes
Returnslist of Node objects
def reboot_node(self, node): (source)
Reboot a node.
ParametersnodeThe node to be rebooted (type: Node)
Returnsbool True if the reboot was successful, otherwise False
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)
Returnsbool True if the destroy was successful, otherwise False
def ex_start(self, node): (source)
Start a stopped node.
def ex_shutdown(self, node): (source)
Shutdown a running node.
def ex_suspend(self, node): (source)
Suspend a running node.
def ex_resume(self, node): (source)
Resume a suspended node.
def _get_domain_for_node(self, node): (source)
Undocumented
API Documentation for libcloud, generated by pydoctor at 2012-07-15 18:49:10.