l.c.d.s.SoftLayerNodeDriver(NodeDriver) : class documentation

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

SoftLayer node driver

Extra node attributes:
    - password: root password
    - hourlyRecurringFee: hourly price (if applicable)
    - recurringFee      : flat rate    (if applicable)
    - recurringMonths   : The number of months in which the recurringFee
     will be incurred.
Method destroy_node Destroy a node.
Method reboot_node Reboot a node.
Method create_node Create a new SoftLayer node
Method list_images List images on a provider
Method list_sizes List sizes on a provider
Method list_locations List data centers for a provider
Method list_nodes List all nodes @return: list of node objects @rtype: C{list} of L{Node}
Method _to_node Undocumented
Method _get_order_information Undocumented
Method _to_image Undocumented
Method _to_size Undocumented
Method _to_loc 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 _to_node(self, host): (source)
Undocumented
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 _get_order_information(self, node_id, timeout=1200, check_interval=5): (source)
Undocumented
def create_node(self, **kwargs): (source)
Create a new SoftLayer node

@inherits: L{NodeDriver.create_node}

@keyword    ex_domain: e.g. libcloud.org
@type       ex_domain: C{str}
@keyword    ex_cpus: e.g. 2
@type       ex_cpus: C{int}
@keyword    ex_disk: e.g. 100
@type       ex_disk: C{int}
@keyword    ex_ram: e.g. 2048
@type       ex_ram: C{int}
@keyword    ex_bandwidth: e.g. 100
@type       ex_bandwidth: C{int}
@keyword    ex_local_disk: e.g. True
@type       ex_local_disk: C{bool}
@keyword    ex_datacenter: e.g. Dal05
@type       ex_datacenter: C{str}
@keyword    ex_os: e.g. UBUNTU_LATEST
@type       ex_os: C{str}
def _to_image(self, img): (source)
Undocumented
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 _to_size(self, id, size): (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 _to_loc(self, loc): (source)
Undocumented
def list_locations(self): (source)
List data centers for a provider

@return: list of node location objects
@rtype: C{list} of L{NodeLocation}
def list_nodes(self): (source)
List all nodes
@return:  list of node objects
@rtype: C{list} of L{Node}
API Documentation for libcloud, generated by pydoctor at 2013-07-01 17:02:02.