l.c.d.v.VoxelNodeDriver(NodeDriver) : class documentation

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

Voxel VoxCLOUD node driver
Method list_nodes List all nodes @return: list of node objects @rtype: C{list} of L{Node}
Method list_sizes List sizes on a provider
Method list_images List images on a provider
Method create_node Create Voxel Node
Method reboot_node Reboot a node.
Method destroy_node Destroy a node.
Method list_locations List data centers for a provider
Method _initialize_instance_types Undocumented
Method _getstatus Undocumented
Method _to_locations Undocumented
Method _to_nodes Undocumented
Method _to_images Undocumented

Inherited from NodeDriver:

Method __init__ @param key: API key or username to be used (required) @type key: C{str}
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

Inherited from BaseDriver (via NodeDriver):

Method _ex_connection_class_kwargs Return extra connection keyword arguments which are passed to the Connection class constructor.
def _initialize_instance_types(): (source)
Undocumented
def list_nodes(self): (source)
List all nodes
@return:  list of node objects
@rtype: C{list} of L{Node}
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_images(self, location=None): (source)
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 create_node(self, **kwargs): (source)
Create Voxel Node

@keyword name: the name to assign the node (mandatory)
@type    name: C{str}

@keyword image: distribution to deploy
@type    image: L{NodeImage}

@keyword size: the plan size to create (mandatory)
               Requires size.disk (GB) to be set manually
@type    size: L{NodeSize}

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

@keyword ex_privateip: Backend IP address to assign to node;
                       must be chosen from the customer's
                       private VLAN assignment.
@type    ex_privateip: C{str}

@keyword ex_publicip: Public-facing IP address to assign to node;
                      must be chosen from the customer's
                      public VLAN assignment.
@type    ex_publicip: C{str}

@keyword ex_rootpass: Password for root access; generated if unset.
@type    ex_rootpass: C{str}

@keyword ex_consolepass: Password for remote console;
                         generated if unset.
@type    ex_consolepass: C{str}

@keyword ex_sshuser: Username for SSH access
@type    ex_sshuser: C{str}

@keyword ex_sshpass: Password for SSH access; generated if unset.
@type    ex_sshpass: C{str}

@keyword ex_voxel_access: Allow access Voxel administrative access.
                          Defaults to False.
@type    ex_voxel_access: C{bool}

@rtype: L{Node} or C{None}
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 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 list_locations(self): (source)
List data centers for a provider

@return: list of node location objects
@rtype: C{list} of L{NodeLocation}
def _getstatus(self, element): (source)
Undocumented
def _to_locations(self, object): (source)
Undocumented
def _to_nodes(self, object): (source)
Undocumented
def _to_images(self, object): (source)
Undocumented
API Documentation for libcloud, generated by pydoctor at 2013-07-01 17:02:02.