libcloud.base.NodeDriver : API documentation

def __init__(self, key, secret=None, secure=True, host=None, port=None): (source)

overridden in libcloud.drivers.dummy.DummyNodeDriver, libcloud.drivers.ec2.EucNodeDriver, libcloud.drivers.linode.LinodeNodeDriver, libcloud.drivers.rimuhosting.RimuHostingNodeDriver, libcloud.drivers.softlayer.SoftLayerNodeDriver

Parameters	key	API key or username to used (type: str)
	secret	Secret password to be used (type: str)
	secure	Weither to use HTTPS or HTTP. Note: Some providers only support HTTPS, and it is on by default. (type: bool)
	host	Override hostname used for connections. (type: str)
	port	Override port used for connections. (type: int)

def create_node(self, **kwargs): (source)

Create a new node instance.

Parameters	name	String with a name for this new node (required) (type: str)
	size	The size of resources allocated to this node. (required) (type: `NodeSize`)
	image	OS Image to boot on node. (required) (type: `NodeImage`)
	location	Which data center to create a node in. If empty, undefined behavoir will be selected. (optional) (type: `NodeLocation`)
	auth	Initial authentication information for the node (optional) (type: `NodeAuthSSHKey` or `NodeAuthPassword`)
Returns	The newly created `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.

Returns bool True if the destroy was successful, otherwise False

def reboot_node(self, node): (source)

Reboot a node.

Returns bool True if the reboot was successful, otherwise False

def list_nodes(self): (source)

List all nodes

Returns list of Node objects

def list_images(self, location=None): (source)

List images on a provider

Returns list of NodeImage objects

def list_sizes(self, location=None): (source)

List sizes on a provider

Returns list of NodeSize objects

def list_locations(self): (source)

List data centers for a provider

Returns list of NodeLocation objects

def deploy_node(self, **kwargs): (source)

overridden in libcloud.drivers.elastichosts.ElasticHostsBaseNodeDriver

Create a new node, and start deployment.

Depends on a Provider Driver supporting either using a specific password or returning a generated password.

This function may raise a DeploymentException, if a create_node call was successful, but there is a later error (like SSH failing or timing out). This exception includes a Node object which you may want to destroy if incomplete deployments are not desirable.

Parameters deploy Deployment to run once machine is online and availble to SSH. (type: Deployment)

ssh_username Optional name of the account which is used when connecting to SSH server (default is root) (type: str)

ssh_port

Optional SSH server port (default is 22) (type: int

See NodeDriver.create_node for more keyword args.

>>> from libcloud.drivers.dummy import DummyNodeDriver
>>> from libcloud.deployment import ScriptDeployment, MultiStepDeployment
>>> from libcloud.base import NodeAuthSSHKey
>>> driver = DummyNodeDriver(0)
>>> key = NodeAuthSSHKey('...') # read from file
>>> script = ScriptDeployment("yum -y install emacs strace tcpdump")
>>> msd = MultiStepDeployment([key, script])
>>> def d():
...     try:
...         node = driver.deploy_node(deploy=msd)
...     except NotImplementedError:
...         print "not implemented for dummy driver"
>>> d()
not implemented for dummy driver

Deploy node is typically not overridden in subclasses. The existing implementation should be able to handle most such.

)

Method	__init__
Method	create_node	Create a new node instance.
Method	destroy_node	Destroy a node.
Method	reboot_node	Reboot a node. @return: `bool` True if the reboot was successful, otherwise False
Method	list_nodes	List all nodes @return: `list` of `Node` objects
Method	list_images	List images on a provider @return: `list` of `NodeImage` objects
Method	list_sizes	List sizes on a provider @return: `list` of `NodeSize` objects
Method	list_locations	List data centers for a provider @return: `list` of `NodeLocation` objects
Method	deploy_node	Create a new node, and start deployment.

l.b.NodeDriver(object) : class documentation