l.c.d.o.OpenStackNodeDriver(NodeDriver, OpenStackDriverMixin) : class documentation

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

Known subclasses: libcloud.compute.drivers.openstack.OpenStack_1_0_NodeDriver, libcloud.compute.drivers.openstack.OpenStack_1_1_NodeDriver

Base OpenStack node driver. Should not be used directly.
Method __new__ Undocumented
Method __init__ @param key: API key or username to be used (required) @type key: C{str}
Method destroy_node Destroy a node.
Method reboot_node Reboot a node.
Method list_nodes List all nodes @return: list of node objects @rtype: C{list} of L{Node}
Method list_images @inherits: L{NodeDriver.list_images}
Method list_sizes List sizes on a provider
Method list_locations List data centers for a provider
Method ex_get_node_details Lists details of the specified server.
Method ex_soft_reboot_node Soft reboots the specified server
Method ex_hard_reboot_node Hard reboots the specified server
Method _ex_connection_class_kwargs Return extra connection keyword arguments which are passed to the Connection class constructor.

Inherited from NodeDriver:

Method create_node Create a new node instance.
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 the given nodes are fully booted and have an IP address assigned.
Method _wait_until_running Undocumented
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 OpenStackDriverMixin:

Method openstack_connection_kwargs @rtype: C{dict}
def __new__(cls, key, secret=None, secure=True, host=None, port=None, api_version=DEFAULT_API_VERSION, **kwargs): (source)
Undocumented
def __init__(self, *args, **kwargs): (source)
@param    key:    API key or username to be used (required)
@type     key:    C{str}

@param    secret: Secret password to be used (required)
@type     secret: C{str}

@param    secure: Weither to use HTTPS or HTTP. Note: Some providers
                    only support HTTPS, and it is on by default.
@type     secure: C{bool}

@param    host: Override hostname used for connections.
@type     host: C{str}

@param    port: Override port used for connections.
@type     port: C{int}

@param    api_version: Optional API version. Only used by drivers
                         which support multiple API versions.
@type     api_version: C{str}

@rtype: C{None}
def destroy_node(self, node): (source)
Destroy a node.

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

@param node: The node to be destroyed
@type node: L{Node}

@return: True if the destroy was successful, otherwise False
@rtype: C{bool}
def reboot_node(self, node): (source)
Reboot a node.

@param node: The node to be rebooted
@type node: L{Node}

@return: True if the reboot was successful, otherwise False
@rtype: C{bool}
def list_nodes(self): (source)
List all nodes
@return:  list of node objects
@rtype: C{list} of L{Node}
def list_images(self, location=None, ex_only_active=True): (source)
@inherits: L{NodeDriver.list_images}

@param ex_only_active: True if list only active
@type ex_only_active: C{bool}
def list_sizes(self, location=None): (source)
List sizes on a provider

@keyword location: The location at which to list sizes
@type location: L{NodeLocation}

@return: list of node size objects
@rtype: C{list} of L{NodeSize}
def list_locations(self): (source)
List data centers for a provider

@return: list of node location objects
@rtype: C{list} of L{NodeLocation}
def _ex_connection_class_kwargs(self): (source)
Return extra connection keyword arguments which are passed to the
Connection class constructor.
def ex_get_node_details(self, node_id): (source)
Lists details of the specified server.

@param       node_id: ID of the node which should be used
@type        node_id: C{str}

@rtype: L{Node}
def ex_soft_reboot_node(self, node): (source)
Soft reboots the specified server

@param      node:  node
@type       node: L{Node}

@rtype: C{bool}
def ex_hard_reboot_node(self, node): (source)
Hard reboots the specified server

@param      node:  node
@type       node: L{Node}

@rtype: C{bool}
API Documentation for libcloud, generated by pydoctor at 2013-03-28 10:45:49.