libcloud.compute.drivers.cloudstack.CloudStackNodeDriver : API documentation

host =

The host where the API can be reached.

path =

The path where the API can be reached.

async_poll_frequency =

How often (in seconds) to poll for async job completion. (type: int)

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

overrides libcloud.common.cloudstack.CloudStackDriverMixIn.__init__

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)
	api_version	Optional API version. Only used by drivers which support multiple API versions. (type: str)

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

overrides libcloud.compute.base.NodeDriver.list_images

List images on a provider

Returns list of NodeImage objects

def list_locations(self): (source)

overrides libcloud.compute.base.NodeDriver.list_locations

List data centers for a provider

Returns list of NodeLocation objects

def list_nodes(self): (source)

overrides libcloud.compute.base.NodeDriver.list_nodes

List all nodes

Returns list of Node objects

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

overrides libcloud.compute.base.NodeDriver.list_sizes

List sizes on a provider

Returns list of NodeSize objects

def create_node(self, name, size, image, location=None, **kwargs): (source)

overrides libcloud.compute.base.NodeDriver.create_node

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)

overrides libcloud.compute.base.NodeDriver.destroy_node

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)

overrides libcloud.compute.base.NodeDriver.reboot_node

Reboot a node.

Returns bool True if the reboot was successful, otherwise False

def ex_allocate_public_ip(self, node): (source)

Allocate a public IP and bind it to a node.

def ex_release_public_ip(self, node, address): (source)

Release a public IP.

def ex_add_ip_forwarding_rule(self, node, address, protocol, start_port, end_port=None): (source)

Add a NAT/firewall forwarding rule.

def ex_delete_ip_forwarding_rule(self, node, rule): (source)

Remove a NAT/firewall forwading rule.

Method	_sync_request	Undocumented
Method	_async_request	Undocumented

Method	deploy_node	Create a new node, and start deployment.
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

Class Variable	host	The host where the API can be reached.
Class Variable	path	The path where the API can be reached.
Class Variable	async_poll_frequency	How often (in seconds) to poll for async job completion. (type: `int`)
Method	__init__
Method	list_images	List images on a provider @return: `list` of `NodeImage` objects
Method	list_locations	List data centers for a provider @return: `list` of `NodeLocation` objects
Method	list_nodes	List all nodes @return: `list` of `Node` objects
Method	list_sizes	List sizes on a provider @return: `list` of `NodeSize` objects
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	ex_allocate_public_ip	Allocate a public IP and bind it to a node.
Method	ex_release_public_ip	Release a public IP.
Method	ex_add_ip_forwarding_rule	Add a NAT/firewall forwarding rule.
Method	ex_delete_ip_forwarding_rule	Remove a NAT/firewall forwading rule.

l.c.d.c.CloudStackNodeDriver(CloudStackDriverMixIn, NodeDriver) : class documentation