l.c.d.i.IBMNodeDriver(NodeDriver) : class documentation

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

Node driver for IBM SmartCloud Enterprise
Method create_node Creates a node in the IBM Developer Cloud.
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 list_images List images on a provider
Method list_sizes Returns a generic list of sizes. See list_images() for a list of supported sizes for specific images.
Method list_locations List data centers for a provider
Method _to_nodes Undocumented
Method _to_node Undocumented
Method _to_images Undocumented
Method _to_image Undocumented
Method _to_locations Undocumented
Method _to_location Undocumented
Method _to_node_sizes Undocumented
Method _to_node_size Undocumented

Inherited from NodeDriver:

Method __init__ @requires: key, secret
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 create_node(self, **kwargs): (source)
Creates a node in the IBM Developer Cloud.

@inherits: L{NodeDriver.create_node}

@keyword    auth: Name of the pubkey to use. When constructing
    C{NodeAuthSSHKey} instance, 'pubkey' argument must be the name of
    the public key to use. You chose this name when creating
    a new public key on the IBM server.
@type       auth: L{NodeAuthSSHKey}

@keyword    ex_configurationData: Image-specific configuration
    parameters. Configuration parameters are defined in the parameters
    .xml file.  The URL to this file is defined in the NodeImage at
    extra[parametersURL].
    Note: This argument must be specified when launching a Windows
    instance. It must contain 'UserName' and 'Password' keys.
@type       ex_configurationData: C{dict}
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 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 list_nodes(self): (source)
List all nodes
@return:  list of node objects
@rtype: C{list} of L{Node}
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 list_sizes(self, location=None): (source)
Returns a generic list of sizes.  See list_images() for a
list of supported sizes for specific images.

@inherits: L{NodeDriver.list_sizes}
def list_locations(self): (source)
List data centers for a provider

@return: list of node location objects
@rtype: C{list} of L{NodeLocation}
def _to_nodes(self, object): (source)
Undocumented
def _to_node(self, instance): (source)
Undocumented
def _to_images(self, object): (source)
Undocumented
def _to_image(self, image): (source)
Undocumented
def _to_locations(self, object): (source)
Undocumented
def _to_location(self, location): (source)
Undocumented
def _to_node_sizes(self, object): (source)
Undocumented
def _to_node_size(self, object): (source)
Undocumented
API Documentation for libcloud, generated by pydoctor at 2012-11-19 11:53:43.