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: list of 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__
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 _initialize_instance_types(): (source)
Undocumented
def list_nodes(self): (source)
List all nodes
Returnslist of node objects (type: list of Node)
def list_sizes(self, location=None): (source)
List sizes on a provider
ParameterslocationThe location at which to list sizes (type: NodeLocation)
Returnslist of node size objects (type: list of NodeSize)
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 create_node(self, **kwargs): (source)
Create Voxel Node
Parametersnamethe name to assign the node (mandatory) (type: str)
imagedistribution to deploy (type: NodeImage)
sizethe plan size to create (mandatory) Requires size.disk (GB) to be set manually (type: NodeSize)
locationwhich datacenter to create the node in (type: NodeLocation)
ex_privateipBackend IP address to assign to node; must be chosen from the customer's private VLAN assignment. (type: str)
ex_publicipPublic-facing IP address to assign to node; must be chosen from the customer's public VLAN assignment. (type: str)
ex_rootpassPassword for root access; generated if unset. (type: str)
ex_consolepassPassword for remote console; generated if unset. (type: str)
ex_sshuserUsername for SSH access (type: str)
ex_sshpassPassword for SSH access; generated if unset. (type: str)
ex_voxel_accessAllow access Voxel administrative access. Defaults to False. (type: bool)
Returns (type: Node or None)
def reboot_node(self, node): (source)
Reboot a node.
ParametersnodeThe node to be rebooted (type: Node)
ReturnsTrue if the reboot was successful, otherwise False (type: 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.

ParametersnodeThe node to be destroyed (type: Node)
ReturnsTrue if the destroy was successful, otherwise False (type: bool)
def list_locations(self): (source)
List data centers for a provider
Returnslist of node location objects (type: list of 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 2012-07-28 18:57:18.