l.c.d.o.OpsourceNodeDriver(NodeDriver) : class documentation

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

Opsource node driver.
Method create_node Create a new opsource node
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 return a list of available images Currently only returns the default 'base OS images' provided by opsource. Customer images (snapshots) are not yet supported.
Method list_sizes List sizes on a provider
Method list_locations list locations (datacenters) available for instantiating servers and networks.
Method list_networks List networks deployed across all data center locations for your organization. The response includes the location of each network.
Method ex_start_node Powers on an existing deployed server
Method ex_shutdown_graceful No summary
Method ex_power_off No summary
Method ex_list_networks List networks deployed across all data center locations for your organization. The response includes the location of each network.
Method ex_get_location_by_id Get location by ID.
Method _to_base_images Undocumented
Method _to_base_image Undocumented
Method _to_networks Undocumented
Method _to_network Undocumented
Method _to_locations Undocumented
Method _to_location Undocumented
Method _to_nodes Undocumented
Method _to_node Undocumented
Method _to_status 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 create_node(self, **kwargs): (source)
Create a new opsource node

@keyword    name:   String with a name for this new node (required)
@type       name:   C{str}

@keyword    image:  OS Image to boot on node. (required)
@type       image:  L{NodeImage}

@keyword    auth:   Initial authentication information for the
                    node (required)
@type       auth:   L{NodeAuthPassword}

@keyword    ex_description:  description for this node (required)
@type       ex_description:  C{str}

@keyword    ex_network:  Network to create the node within (required)
@type       ex_network: L{OpsourceNetwork}

@keyword    ex_isStarted:  Start server after creation? default
                           true (required)
@type       ex_isStarted:  C{bool}

@return: The newly created L{Node}. NOTE: Opsource does not provide a
         way to determine the ID of the server that was just created,
         so the returned L{Node} is not guaranteed to be the same one
         that was created.  This is only the case when multiple nodes
         with the same name exist.
@rtype: L{Node}
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)
return a list of available images
    Currently only returns the default 'base OS images' provided by
    opsource. Customer images (snapshots) are not yet supported.

@inherits: L{NodeDriver.list_images}
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_locations(self): (source)
list locations (datacenters) available for instantiating servers and
networks.

@inherits: L{NodeDriver.list_locations}
def list_networks(self, location=None): (source)
List networks deployed across all data center locations for your
organization.  The response includes the location of each network.


@keyword location: The location
@type    location: L{NodeLocation}

@return: a list of OpsourceNetwork objects
@rtype: C{list} of L{OpsourceNetwork}
def _to_base_images(self, object): (source)
Undocumented
def _to_base_image(self, element): (source)
Undocumented
def ex_start_node(self, node): (source)
Powers on an existing deployed server

@param      node: Node which should be used
@type       node: L{Node}

@rtype: C{bool}
def ex_shutdown_graceful(self, node): (source)
This function will attempt to "gracefully" stop a server by
initiating a shutdown sequence within the guest operating system.
A successful response on this function means the system has
successfully passed the request into the operating system.

@param      node: Node which should be used
@type       node: L{Node}

@rtype: C{bool}
def ex_power_off(self, node): (source)
This function will abruptly power-off a server.  Unlike
ex_shutdown_graceful, success ensures the node will stop but some OS
and application configurations may be adversely affected by the
equivalent of pulling the power plug out of the machine.

@param      node: Node which should be used
@type       node: L{Node}

@rtype: C{bool}
def ex_list_networks(self): (source)
List networks deployed across all data center locations for your
organization.  The response includes the location of each network.

@return: a list of OpsourceNetwork objects
@rtype: C{list} of L{OpsourceNetwork}
def ex_get_location_by_id(self, id): (source)
Get location by ID.

@param  id: ID of the node location which should be used
@type   id: C{str}

@rtype: L{NodeLocation}
def _to_networks(self, object): (source)
Undocumented
def _to_network(self, element): (source)
Undocumented
def _to_locations(self, object): (source)
Undocumented
def _to_location(self, element): (source)
Undocumented
def _to_nodes(self, object): (source)
Undocumented
def _to_node(self, element): (source)
Undocumented
def _to_status(self, element): (source)
Undocumented
API Documentation for libcloud, generated by pydoctor at 2013-07-01 17:02:02.