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

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

VCL node driver

@keyword   host: The VCL host to which you make requests(required)
@type      host: C{str}
Method __init__ @param key: API key or username to used (required) @type key: C{str}
Method create_node Create a new VCL reservation size and name ignored, image is the id from list_image
Method destroy_node End VCL reservation for the node passed in. Throws error if request fails.
Method list_images List images available to the user provided credentials
Method list_sizes VCL does not choosing sizes for node creation. Size of images are statically set by administrators.
Method list_nodes List nodes
Method ex_update_node_access Update the remote ip accessing the node.
Method ex_extend_request_time Time in minutes to extend the requested node's reservation time
Method ex_get_request_end_time Get the ending time of the node reservation.
Method _vcl_request Undocumented
Method _to_image Undocumented
Method _to_connect_data Undocumented
Method _to_status Undocumented
Method _to_nodes Undocumented

Inherited from NodeDriver:

Method reboot_node Reboot a node.
Method list_locations List data centers for a provider
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 BaseDriver (via NodeDriver):

Method _ex_connection_class_kwargs Return extra connection keyword arguments which are passed to the Connection class constructor.
def __init__(self, key, secret, *args, secure=True, host=None, port=None, **kwargs): (source)
@param    key:    API key or username to 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.
@type     secure: C{bool}

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

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

@rtype: C{None}
def _vcl_request(self, method, *args): (source)
Undocumented
def create_node(self, **kwargs): (source)
Create a new VCL reservation
size and name ignored, image is the id from list_image

@inherits: L{NodeDriver.create_node}

@keyword    image: image is the id from list_image
@type       image: C{str}

@keyword    start: start time as unix timestamp
@type       start: C{str}

@keyword    length: length of time in minutes
@type       length: C{str}
def destroy_node(self, node): (source)
End VCL reservation for the node passed in.
Throws error if request fails.

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

@rtype: C{bool}
def _to_image(self, img): (source)
Undocumented
def list_images(self, location=None): (source)
List images available to the user provided credentials

@inherits: L{NodeDriver.list_images}
def list_sizes(self, location=None): (source)
VCL does not choosing sizes for node creation.
Size of images are statically set by administrators.

@inherits: L{NodeDriver.list_sizes}
def _to_connect_data(self, request_id, ipaddr): (source)
Undocumented
def _to_status(self, requestid, imagename, ipaddr): (source)
Undocumented
def _to_nodes(self, res, ipaddr): (source)
Undocumented
def list_nodes(self, ipaddr): (source)
List nodes

@param  ipaddr: IP address which should be used
@type   ipaddr: C{str}

@rtype: C{list} of L{Node}
def ex_update_node_access(self, node, ipaddr): (source)
Update the remote ip accessing the node.

@param node: the reservation node to update
@type  node: L{Node}

@param ipaddr: the ipaddr used to access the node
@type  ipaddr: C{str}

@return: node with updated information
@rtype: L{Node}
def ex_extend_request_time(self, node, minutes): (source)
Time in minutes to extend the requested node's reservation time

@param node: the reservation node to update
@type  node: L{Node}

@param minutes: the number of mintes to update
@type  minutes: C{str}

@return: true on success, throws error on failure
@rtype: C{bool}
def ex_get_request_end_time(self, node): (source)
Get the ending time of the node reservation.

@param node: the reservation node to update
@type  node: L{Node}

@return: unix timestamp
@rtype: C{int}
API Documentation for libcloud, generated by pydoctor at 2013-02-18 10:41:20.