libcloud.compute.drivers.opsource.OpsourceNodeDriver : API documentation

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

overrides libcloud.compute.base.NodeDriver.create_node

Create a new opsource node

Parameters	name	String with a name for this new node (required) (type: `str`)
	image	OS Image to boot on node. (required) (type: `NodeImage`)
	auth	Initial authentication information for the node (required) (type: `NodeAuthPassword`)
	ex_description	description for this node (required) (type: `str`)
	ex_network	Network to create the node within (required) (type: `OpsourceNetwork`)
	ex_isStarted	Start server after creation? default true (required) (type: `bool`)
Returns	The newly created `Node`. NOTE: Opsource does not provide a way to determine the ID of the server that was just created, so the returned `Node` is not guaranteed to be the same one that was created. This is only the case when multiple nodes with the same name exist. (type: `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.

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

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 list_nodes(self): (source)

overrides libcloud.compute.base.NodeDriver.list_nodes

List all nodes

Returns list of node objects (type: list of Node)

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

overrides libcloud.compute.base.NodeDriver.list_images

return a list of available images
    Currently only returns the default 'base OS images' provided by
    opsource. Customer images (snapshots) are not yet supported.

@inherits: L{NodeDriver.list_images}

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 list_locations(self): (source)

overrides libcloud.compute.base.NodeDriver.list_locations

list locations (datacenters) available for instantiating servers and networks.

Unknown Field: inherits NodeDriver.list_locations

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

List networks deployed across all data center locations for your organization. The response includes the location of each network.

Parameters	location	The location (type: `NodeLocation`)
Returns	a list of OpsourceNetwork objects (type: `list` of `OpsourceNetwork`)

def _to_base_images(self, object): (source)

Undocumented

def _to_base_image(self, element): (source)

Undocumented

def ex_start_node(self, node): (source)

Powers on an existing deployed server

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

def ex_shutdown_graceful(self, node): (source)

This function will attempt to "gracefully" stop a server by initiating a shutdown sequence within the guest operating system. A successful response on this function means the system has successfully passed the request into the operating system.

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

def ex_power_off(self, node): (source)

This function will abruptly power-off a server. Unlike ex_shutdown_graceful, success ensures the node will stop but some OS and application configurations may be adversely affected by the equivalent of pulling the power plug out of the machine.

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

def ex_list_networks(self): (source)

List networks deployed across all data center locations for your organization. The response includes the location of each network.

Returns a list of OpsourceNetwork objects (type: list of OpsourceNetwork)

def ex_get_location_by_id(self, id): (source)

Get location by ID.

Parameters	id	ID of the node location which should be used (type: `str`)
Returns	(type: `NodeLocation`)

def _to_networks(self, object): (source)

Undocumented

def _to_network(self, element): (source)

Undocumented

def _to_locations(self, object): (source)

Undocumented

def _to_location(self, element): (source)

Undocumented

def _to_nodes(self, object): (source)

Undocumented

def _to_node(self, element): (source)

Undocumented

def _to_status(self, element): (source)

Undocumented

Method	__init__
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 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	create_node	Create a new opsource node
Method	destroy_node	Destroy a node.
Method	reboot_node	Reboot a node.
Method	list_nodes	List all nodes @return: list of node objects @rtype: `list` of `Node`
Method	list_images	return a list of available images Currently only returns the default 'base OS images' provided by opsource. Customer images (snapshots) are not yet supported.
Method	list_sizes	List sizes on a provider
Method	list_locations	list locations (datacenters) available for instantiating servers and networks.
Method	list_networks	List networks deployed across all data center locations for your organization. The response includes the location of each network.
Method	ex_start_node	Powers on an existing deployed server
Method	ex_shutdown_graceful	No summary
Method	ex_power_off	No summary
Method	ex_list_networks	List networks deployed across all data center locations for your organization. The response includes the location of each network.
Method	ex_get_location_by_id	Get location by ID.
Method	_to_base_images	Undocumented
Method	_to_base_image	Undocumented
Method	_to_networks	Undocumented
Method	_to_network	Undocumented
Method	_to_locations	Undocumented
Method	_to_location	Undocumented
Method	_to_nodes	Undocumented
Method	_to_node	Undocumented
Method	_to_status	Undocumented

l.c.d.o.OpsourceNodeDriver(NodeDriver) : class documentation