l.c.d.r.RimuHostingNodeDriver(NodeDriver) : class documentation

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

RimuHosting node driver
Method __init__ @param key: API key (required) @type key: C{str}
Method list_sizes List sizes on a provider
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 reboot_node Reboot a node.
Method destroy_node Destroy a node.
Method create_node Creates a RimuHosting instance
Method list_locations List data centers for a provider
Method _order_uri Undocumented
Method _to_node Undocumented
Method _to_size Undocumented
Method _to_image Undocumented

Inherited from NodeDriver:

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 __init__(self, key, host=API_HOST, port=443, api_context=API_CONTEXT, secure=True): (source)
@param    key: API key (required)
@type     key: C{str}

@param    host: hostname for connection
@type     host: C{str}

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

@param    api_context: Optional API context.
@type     api_context: C{str}

@param    secure: Weither to use HTTPS or HTTP.
@type     secure: C{bool}

@rtype: C{None}
def _order_uri(self, node, resource): (source)
Undocumented
def _to_node(self, order): (source)
Undocumented
def _to_size(self, plan): (source)
Undocumented
def _to_image(self, image): (source)
Undocumented
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_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 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 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 create_node(self, **kwargs): (source)
Creates a RimuHosting instance

@inherits: L{NodeDriver.create_node}

@keyword    name: Must be a FQDN. e.g example.com.
@type       name: C{str}

@keyword    ex_billing_oid: If not set,
                            a billing method is automatically picked.
@type       ex_billing_oid: C{str}

@keyword    ex_host_server_oid: The host server to set the VPS up on.
@type       ex_host_server_oid: C{str}

@keyword    ex_vps_order_oid_to_clone: Clone another VPS to use as
                                        the image for the new VPS.
@type       ex_vps_order_oid_to_clone: C{str}

@keyword    ex_num_ips: Number of IPs to allocate. Defaults to 1.
@type       ex_num_ips: C{int}

@keyword    ex_extra_ip_reason: Reason for needing the extra IPs.
@type       ex_extra_ip_reason: C{str}

@keyword    ex_memory_mb: Memory to allocate to the VPS.
@type       ex_memory_mb: C{int}

@keyword    ex_disk_space_mb: Diskspace to allocate to the VPS.
    Defaults to 4096 (4GB).
@type       ex_disk_space_mb: C{int}

@keyword    ex_disk_space_2_mb: Secondary disk size allocation.
                                Disabled by default.
@type       ex_disk_space_2_mb: C{int}

@keyword    ex_control_panel: Control panel to install on the VPS.
@type       ex_control_panel: C{str}
def list_locations(self): (source)
List data centers for a provider

@return: list of node location objects
@rtype: C{list} of L{NodeLocation}
API Documentation for libcloud, generated by pydoctor at 2013-07-01 17:02:02.