libcloud.compute.drivers.hostvirtual.HostVirtualNodeDriver : API documentation

def __init__(self, key): (source)

overrides libcloud.compute.base.NodeDriver.__init__

@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 _to_node(self, data): (source)

Undocumented

def list_locations(self): (source)

overrides libcloud.compute.base.NodeDriver.list_locations

List data centers for a provider

@return: list of node location objects
@rtype: C{list} of L{NodeLocation}

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

overrides libcloud.compute.base.NodeDriver.list_sizes

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_images(self): (source)

overrides libcloud.compute.base.NodeDriver.list_images

List images on a provider

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

@return: list of node image objects
@rtype: C{list} of L{NodeImage}

def list_nodes(self): (source)

overrides libcloud.compute.base.NodeDriver.list_nodes

List all nodes
@return:  list of node objects
@rtype: C{list} of L{Node}

def _wait_for_node(self, node_id, timeout=30, interval=5.0): (source)

@param node_id: ID of the node to wait for.
@type node_id: C{int}

@param timeout: Timeout (in seconds).
@type timeout: C{int}

@param interval: How long to wait (in seconds) between each attempt.
@type interval: C{float}

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

overrides libcloud.compute.base.NodeDriver.create_node

Create a new node instance.

@keyword    name:   String with a name for this new node (required)
@type       name:   C{str}

@keyword    size:   The size of resources allocated to this node.
                    (required)
@type       size:   L{NodeSize}

@keyword    image:  OS Image to boot on node. (required)
@type       image:  L{NodeImage}

@keyword    location: Which data center to create a node in. If empty,
                      undefined behavoir will be selected. (optional)
@type       location: L{NodeLocation}

@keyword    auth:   Initial authentication information for the node
                    (optional)
@type       auth:   L{NodeAuthSSHKey} or L{NodeAuthPassword}

@return: The newly created node.
@rtype: L{Node}

def reboot_node(self, node): (source)

overrides libcloud.compute.base.NodeDriver.reboot_node

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 destroy_node(self, node): (source)

overrides libcloud.compute.base.NodeDriver.destroy_node

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 ex_get_node(self, node_id): (source)

Get a single node.

@param      node_id: id of the node that we need the node object for
@type       node_id: C{str}

@rtype: L{Node}

def ex_stop_node(self, node): (source)

Stop a node.

@param      node: Node which should be used
@type       node: L{Node}

@rtype: C{bool}

def ex_start_node(self, node): (source)

Start a node.

@param      node: Node which should be used
@type       node: L{Node}

@rtype: C{bool}

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

Provision a server on a VR package and get it booted

@keyword node: node which should be used
@type    node: L{Node}

@keyword image: The distribution to deploy on your server (mandatory)
@type    image: L{NodeImage}

@keyword auth: an SSH key or root password (mandatory)
@type    auth: L{NodeAuthSSHKey} or L{NodeAuthPassword}

@keyword location: which datacenter to create the server in
@type    location: L{NodeLocation}

@return: Node representing the newly built server
@rtype: L{Node}

def ex_delete_node(self, node): (source)

Delete a node.

@param      node: Node which should be used
@type       node: L{Node}

@rtype: C{bool}

Method	__init__	`@param key: API key or username to be used (required) @type key: C{str}`
Method	list_locations	`List data centers for a provider`
Method	list_sizes	`List sizes on a provider`
Method	list_images	`List images on a provider`
Method	list_nodes	`List all nodes @return: list of node objects @rtype: C{list} of L{Node}`
Method	create_node	`Create a new node instance.`
Method	reboot_node	`Reboot a node.`
Method	destroy_node	`Destroy a node.`
Method	ex_get_node	`Get a single node.`
Method	ex_stop_node	`Stop a node.`
Method	ex_start_node	`Start a node.`
Method	ex_provision_node	`Provision a server on a VR package and get it booted`
Method	ex_delete_node	`Delete a node.`
Method	_to_node	Undocumented
Method	_wait_for_node	`@param node_id: ID of the node to wait for. @type node_id: C{int}`

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	_connect_and_run_deployment_script	Undocumented
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

l.c.d.h.HostVirtualNodeDriver(NodeDriver) : class documentation