libcloud.compute.drivers.ec2.EC2NodeDriver : API documentation

def _pathlist(self, key, arr): (source)

Converts a key and an array of values into AWS query param format.

def _get_boolean(self, element): (source)

Undocumented

def _get_state_boolean(self, element): (source)

Checks for the instances's state

def _get_terminate_boolean(self, element): (source)

Undocumented

def _to_nodes(self, object, xpath, groups=None): (source)

Undocumented

def _to_node(self, element, groups=None): (source)

Undocumented

def _to_images(self, object): (source)

Undocumented

def _to_image(self, element): (source)

Undocumented

def _to_volume(self, element, name): (source)

Undocumented

def list_nodes(self, ex_node_ids=None): (source)

overrides libcloud.compute.base.NodeDriver.list_nodes

List all nodes

Ex_node_ids parameter is used to filter the list of nodes that should be returned. Only the nodes with the corresponding node ids will be returned.

Parameters	ex_node_ids	List of `node.id` (type: `list` of `str`)
Returns	(type: `list` of `Node`)

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

overrides libcloud.compute.base.NodeDriver.list_sizes

List sizes on a provider

Parameters	location	The location at which to list sizes (type: `NodeLocation`)
Returns	list of node size objects (type: `list` of `NodeSize`)

def _get_sizes(self, ignored_size_ids=None): (source)

Undocumented

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

overrides libcloud.compute.base.NodeDriver.list_images

List images on a provider

Parameters	location	The location at which to list images (type: `NodeLocation`)
Returns	list of node image objects (type: `list` of `NodeImage`)

def list_locations(self): (source)

overrides libcloud.compute.base.NodeDriver.list_locations

overridden in libcloud.compute.drivers.ec2.EucNodeDriver

List data centers for a provider

Returns list of node location objects (type: list of NodeLocation)

def create_volume(self, size, name, location=None, snapshot=None): (source)

overrides libcloud.compute.base.NodeDriver.create_volume

Create a new volume.

Parameters	size	Size of volume in gigabytes (required) (type: `int`)
	name	Name of the volume to be created (type: `str`)
	location	Which data center to create a volume in. If empty, undefined behavoir will be selected. (optional) (type: `NodeLocation`)
	snapshot	Name of snapshot from which to create the new volume. (optional) (type: `str`)
Returns	The newly created volume. (type: `StorageVolume`)

def destroy_volume(self, volume): (source)

overrides libcloud.compute.base.NodeDriver.destroy_volume

Destroys a storage volume.

Parameters	volume	Volume to be destroyed (type: `StorageVolume`)
Returns	(type: `bool`)

def attach_volume(self, node, volume, device): (source)

overrides libcloud.compute.base.NodeDriver.attach_volume

Attaches volume to node.

Parameters	node	Node to attach volume to (type: `Node`)
	volume	Volume to attach (type: `StorageVolume`)
	device	Where the device is exposed, e.g. '/dev/sdb (optional) (type: `str`)
Returns	(type: `bool`)

def detach_volume(self, volume): (source)

overrides libcloud.compute.base.NodeDriver.detach_volume

Detaches a volume from a node.

Parameters	volume	Volume to be detached (type: `StorageVolume`)
Returns	(type: `bool`)

def ex_create_keypair(self, name): (source)

Creates a new keypair

Parameters	name	The name of the keypair to Create. This must be unique, otherwise an InvalidKeyPair.Duplicate exception is raised. (type: `str`)
Returns	(type: `dict`)
Note	This is a non-standard extension API, and only works for EC2.

def ex_import_keypair(self, name, keyfile): (source)

imports a new public key

Parameters	name	The name of the public key to import. This must be unique, otherwise an InvalidKeyPair.Duplicate exception is raised. (type: `str`)
	keyfile	The filename with path of the public key to import. (type: `str`)
Returns	(type: `dict`)
Note	This is a non-standard extension API, and only works for EC2.

def ex_describe_keypairs(self, name): (source)

Describes a keypair by name

Parameters	name	The name of the keypair to describe. (type: `str`)
Returns	(type: `dict`)
Note	This is a non-standard extension API, and only works for EC2.

def ex_create_security_group(self, name, description): (source)

Creates a new Security Group

Parameters	name	The name of the security group to Create. This must be unique. (type: `str`)
	description	Human readable description of a Security Group. (type: `str`)
Returns	(type: `str`)
Note	This is a non-standard extension API, and only works for EC2.

def ex_authorize_security_group_permissive(self, name): (source)

Edit a Security Group to allow all traffic.

Parameters	name	The name of the security group to edit (type: `str`)
Returns	(type: `list` of `str`)
Note	This is a non-standard extension API, and only works for EC2.

def ex_list_availability_zones(self, only_available=True): (source)

Return a list of ExEC2AvailabilityZone objects for the current region.

Note: This is an extension method and is only available for EC2 driver.

Parameters	only_available	If true, return only availability zones with state 'available' (type: `str`)
Returns	(type: `list` of `ExEC2AvailabilityZone`)

def ex_describe_tags(self, resource): (source)

Return a dictionary of tags for a resource (Node or StorageVolume).

Parameters	resource	resource which should be used (type: `Node` or `StorageVolume`)
Returns	dict Node tags (type: `dict`)

def ex_create_tags(self, resource, tags): (source)

overridden in libcloud.compute.drivers.ec2.NimbusNodeDriver

Create tags for a resource (Node or StorageVolume).

Parameters	resource	Resource to be tagged (type: `Node` or `StorageVolume`)
	tags	A dictionary or other mapping of strings to strings, associating tag names with tag values. (type: `dict`)
Returns	(type: `bool`)

def ex_delete_tags(self, resource, tags): (source)

Delete tags from a resource.

Parameters	resource	Resource to be tagged (type: `Node` or `StorageVolume`)
	tags	A dictionary or other mapping of strings to strings, specifying the tag names and tag values to be deleted. (type: `dict`)
Returns	(type: `bool`)

def _add_instance_filter(self, params, node): (source)

overridden in libcloud.compute.drivers.ec2.EucNodeDriver

Add instance filter to the provided params dictionary.

def ex_describe_all_addresses(self, only_allocated=False): (source)

Return all the Elastic IP addresses for this account optionally, return only the allocated addresses

Parameters	only_allocated	If true, return only those addresses that are associated with an instance (type: `str`)
Returns	list list of elastic ips for this particular account. (type: `list` of `str`)

def ex_associate_addresses(self, node, elastic_ip_address): (source)

Associate an IP address with a particular node.

Parameters	node	Node instance (type: `Node`)
	elastic_ip_address	IP address which should be used (type: `str`)
Returns	(type: `bool`)

def ex_describe_addresses(self, nodes): (source)

overridden in libcloud.compute.drivers.ec2.NimbusNodeDriver

Return Elastic IP addresses for all the nodes in the provided list.

Parameters	nodes	List of `Node` instances (type: `list` of `Node`)
Returns	Dictionary where a key is a node ID and the value is a list with the Elastic IP addresses associated with this node. (type: `dict`)

def ex_describe_addresses_for_node(self, node): (source)

Return a list of Elastic IP addresses associated with this node.

Parameters	node	Node instance (type: `Node`)
Returns	list Elastic IP addresses attached to this node. (type: `list` of `str`)

def ex_modify_instance_attribute(self, node, attributes): (source)

Modify node attributes. A list of valid attributes can be found at http://goo.gl/gxcj8

Parameters	node	Node instance (type: `Node`)
	attributes	Dictionary with node attributes (type: `dict`)
Returns	True on success, False otherwise. (type: `bool`)

def ex_change_node_size(self, node, new_size): (source)

Change the node size. Note: Node must be turned of before changing the size.

Parameters	node	Node instance (type: `Node`)
	new_size	NodeSize intance (type: `NodeSize`)
Returns	True on success, False otherwise. (type: `bool`)

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

overrides libcloud.compute.base.NodeDriver.create_node

Create a new EC2 node

Reference: http://bit.ly/8ZyPSy [docs.amazonwebservices.com]

Parameters	ex_mincount	Minimum number of instances to launch (type: `int`)
	ex_maxcount	Maximum number of instances to launch (type: `int`)
	ex_securitygroup	Name of security group (type: `str`)
	ex_keyname	The name of the key pair (type: `str`)
	ex_userdata	User data (type: `str`)
	ex_clienttoken	Unique identifier to ensure idempotency (type: `str`)
Unknown Field: inherits	`NodeDriver.create_node`

def reboot_node(self, node): (source)

overrides libcloud.compute.base.NodeDriver.reboot_node

Reboot a node.

Parameters	node	The node to be rebooted (type: `Node`)
Returns	True if the reboot was successful, otherwise False (type: `bool`)

def ex_start_node(self, node): (source)

Start the node by passing in the node object, does not work with instance store backed instances

Parameters	node	Node which should be used (type: `Node`)
Returns	(type: `bool`)

def ex_stop_node(self, node): (source)

Stop the node by passing in the node object, does not work with instance store backed instances

Parameters	node	Node which should be used (type: `Node`)
Returns	(type: `bool`)

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.

Parameters	node	The node to be destroyed (type: `Node`)
Returns	True if the destroy was successful, otherwise False (type: `bool`)

Method	__init__
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

Method	list_nodes	List all nodes
Method	list_sizes	List sizes on a provider
Method	list_images	List images on a provider
Method	list_locations	List data centers for a provider
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	ex_create_keypair	Creates a new keypair
Method	ex_import_keypair	imports a new public key
Method	ex_describe_keypairs	Describes a keypair by name
Method	ex_create_security_group	Creates a new Security Group
Method	ex_authorize_security_group_permissive	Edit a Security Group to allow all traffic.
Method	ex_list_availability_zones	Return a list of `ExEC2AvailabilityZone` objects for the current region.
Method	ex_describe_tags	Return a dictionary of tags for a resource (Node or StorageVolume).
Method	ex_create_tags	Create tags for a resource (Node or StorageVolume).
Method	ex_delete_tags	Delete tags from a resource.
Method	ex_describe_all_addresses	Return all the Elastic IP addresses for this account optionally, return only the allocated addresses
Method	ex_associate_addresses	Associate an IP address with a particular node.
Method	ex_describe_addresses	Return Elastic IP addresses for all the nodes in the provided list.
Method	ex_describe_addresses_for_node	Return a list of Elastic IP addresses associated with this node.
Method	ex_modify_instance_attribute	Modify node attributes. A list of valid attributes can be found at http://goo.gl/gxcj8
Method	ex_change_node_size	Change the node size. Note: Node must be turned of before changing the size.
Method	create_node	Create a new EC2 node
Method	reboot_node	Reboot a node.
Method	ex_start_node	Start the node by passing in the node object, does not work with instance store backed instances
Method	ex_stop_node	Stop the node by passing in the node object, does not work with instance store backed instances
Method	destroy_node	Destroy a node.
Method	_pathlist	Converts a key and an array of values into AWS query param format.
Method	_get_boolean	Undocumented
Method	_get_state_boolean	Checks for the instances's state
Method	_get_terminate_boolean	Undocumented
Method	_to_nodes	Undocumented
Method	_to_node	Undocumented
Method	_to_images	Undocumented
Method	_to_image	Undocumented
Method	_to_volume	Undocumented
Method	_get_sizes	Undocumented
Method	_add_instance_filter	Add instance filter to the provided params dictionary.

l.c.d.e.EC2NodeDriver(NodeDriver) : class documentation