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

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

Known subclasses: libcloud.compute.drivers.vcloud.HostingComDriver, libcloud.compute.drivers.vcloud.TerremarkDriver, libcloud.compute.drivers.vcloud.VCloud_1_5_NodeDriver

vCloud node driver
Method __new__ Undocumented
Method vdcs vCloud virtual data centers (vDCs).
Method networks Undocumented
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 ex_list_nodes List all nodes across all vDCs. Using 'vdcs' you can specify which vDCs should be queried.
Method list_sizes List sizes on a provider
Method list_images List images on a provider
Method create_node Creates and returns node.
Method _to_vdc Undocumented
Method _get_vdc Undocumented
Method _to_image Undocumented
Method _to_node Undocumented
Method _get_catalog_hrefs Undocumented
Method _wait_for_task_completion Undocumented
Method _to_size Undocumented
Method _get_catalogitems_hrefs Given a catalog href returns contained catalog item hrefs
Method _get_catalogitem Given a catalog item href returns elementree
Method _uniquer Undocumented

Inherited from NodeDriver:

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 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 __new__(cls, key, secret=None, secure=True, host=None, port=None, api_version=DEFAULT_API_VERSION, **kwargs): (source)
Undocumented
@property
def vdcs(self): (source) 
vCloud virtual data centers (vDCs).

@return: list of vDC objects
@rtype: C{list} of L{Vdc}
def _to_vdc(self, vdc_elm): (source)
overridden in libcloud.compute.drivers.vcloud.VCloud_1_5_NodeDriver
Undocumented
def _get_vdc(self, vdc_name): (source)
Undocumented
@property
def networks(self): (source)
Undocumented
def _to_image(self, image): (source)
Undocumented
def _to_node(self, elm): (source)
overridden in libcloud.compute.drivers.vcloud.VCloud_1_5_NodeDriver
Undocumented
def _get_catalog_hrefs(self): (source)
Undocumented
def _wait_for_task_completion(self, task_href, timeout=DEFAULT_TASK_COMPLETION_TIMEOUT): (source)
Undocumented
def destroy_node(self, node): (source)
overrides libcloud.compute.base.NodeDriver.destroy_node
overridden in libcloud.compute.drivers.vcloud.VCloud_1_5_NodeDriver
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)
overrides libcloud.compute.base.NodeDriver.reboot_node
overridden in libcloud.compute.drivers.vcloud.VCloud_1_5_NodeDriver
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)
overrides libcloud.compute.base.NodeDriver.list_nodes
List all nodes
@return:  list of node objects
@rtype: C{list} of L{Node}
def ex_list_nodes(self, vdcs=None): (source) 
List all nodes across all vDCs. Using 'vdcs' you can specify which vDCs
should be queried.

@param vdcs: None, vDC or a list of vDCs to query. If None all vDCs
             will be queried.
@type vdcs: L{Vdc}

@rtype: C{list} of L{Node}
def _to_size(self, ram): (source)
Undocumented
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 _get_catalogitems_hrefs(self, catalog): (source) 
Given a catalog href returns contained catalog item hrefs
def _get_catalogitem(self, catalog_item): (source) 
Given a catalog item href returns elementree
def list_images(self, location=None): (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 _uniquer(self, seq, idfun=None): (source)
Undocumented
def create_node(self, **kwargs): (source)
overrides libcloud.compute.base.NodeDriver.create_node
overridden in libcloud.compute.drivers.vcloud.VCloud_1_5_NodeDriver
Creates and returns node.


@inherits: L{NodeDriver.create_node}

@keyword    ex_network: link to a "Network" e.g.,
  "https://services.vcloudexpress.terremark.com/api/v0.8/network/7"
@type       ex_network: C{str}

@keyword    ex_vdc: Name of organisation's virtual data
    center where vApp VMs will be deployed.
@type       ex_vdc: C{str}

@keyword    ex_cpus: number of virtual cpus (limit depends on provider)
@type       ex_cpus: C{int}

@keyword    ex_row: ????
@type       ex_row: C{str}

@keyword    ex_group: ????
@type       ex_group: C{str}
API Documentation for libcloud, generated by pydoctor at 2013-02-18 10:41:20.