l.c.d.o.OpenStack_1_1_NodeDriver(OpenStackNodeDriver) : class documentation

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

OpenStack node driver.
Method __init__
Method create_node Create a new node
Method ex_set_password Undocumented
Method ex_rebuild Rebuild a Node.
Method ex_resize Change a node size.
Method ex_confirm_resize Undocumented
Method ex_revert_resize Undocumented
Method ex_save_image Undocumented
Method ex_set_server_name Sets the Node's name.
Method ex_get_metadata Get a Node's metadata.
Method ex_set_metadata Sets the Node's metadata.
Method ex_update_node Update the Node's editable attributes. The OpenStack API currently supports editing name and IPv4/IPv6 access addresses.
Method ex_get_size Undocumented
Method ex_get_image Undocumented
Method ex_delete_image Undocumented
Method _to_images Undocumented
Method _to_image Undocumented
Method _to_nodes Undocumented
Method _to_sizes Undocumented
Method _create_args_to_params Undocumented
Method _files_to_personality Undocumented
Method _reboot_node Undocumented
Method _node_action Undocumented
Method _update_node Updates the editable attributes of a server, which currently include its name and IPv4/IPv6 access addresses.
Method _to_node_from_obj Undocumented
Method _to_node Undocumented
Method _to_size Undocumented
Method _get_size_price Undocumented

Inherited from OpenStackNodeDriver:

Method __new__ Undocumented
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 ex_get_node_details Undocumented
Method ex_soft_reboot_node Undocumented
Method ex_hard_reboot_node Undocumented
Method _ex_connection_class_kwargs Return extra connection keyword arguments which are passed to the Connection class constructor.

Inherited from NodeDriver (via OpenStackNodeDriver):

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.
def __init__(self, *args, **kwargs): (source)
overrides libcloud.compute.base.NodeDriver.__init__
ParameterskeyAPI key or username to used (type: str)
secretSecret password to be used (type: str)
secureWeither to use HTTPS or HTTP. Note: Some providers only support HTTPS, and it is on by default. (type: bool)
hostOverride hostname used for connections. (type: str)
portOverride port used for connections. (type: int)
api_versionOptional API version. Only used by drivers which support multiple API versions. (type: str)
def create_node(self, **kwargs): (source)
overrides libcloud.compute.base.NodeDriver.create_node
Create a new node

See NodeDriver.create_node for more keyword args.

Parametersex_metadataKey/Value metadata to associate with a node (type: dict)
ex_filesFile Path => File contents to create on the node (type: dict)
def _to_images(self, obj, ex_only_active): (source)
Undocumented
def _to_image(self, api_image): (source)
Undocumented
def _to_nodes(self, obj): (source)
Undocumented
def _to_sizes(self, obj): (source)
Undocumented
def _create_args_to_params(self, node, **kwargs): (source)
Undocumented
def _files_to_personality(self, files): (source)
Undocumented
def _reboot_node(self, node, reboot_type='SOFT'): (source)
Undocumented
def ex_set_password(self, node, password): (source)
Undocumented
def ex_rebuild(self, node, image): (source)
Rebuild a Node.
ParametersnodeNode to rebuild. (type: Node)
imageNew image to use. (type: NodeImage)
def ex_resize(self, node, size): (source)
Change a node size.
ParametersnodeNode to resize. (type: Node)
imageNew size to use. (type: NodeSize)
def ex_confirm_resize(self, node): (source)
Undocumented
def ex_revert_resize(self, node): (source)
Undocumented
def ex_save_image(self, node, name, metadata=None): (source)
Undocumented
def ex_set_server_name(self, node, name): (source)
Sets the Node's name.
def ex_get_metadata(self, node): (source) 
Get a Node's metadata.

@return     Key/Value metadata associated with node.
@type       C{dict}
def ex_set_metadata(self, node, metadata): (source)
Sets the Node's metadata.
ParametersmetadataKey/Value metadata to associate with a node (type: dict)
def ex_update_node(self, node, **node_updates): (source)
Update the Node's editable attributes. The OpenStack API currently supports editing name and IPv4/IPv6 access addresses.

The driver currently only supports updating the node name.

ParametersnameNew name for the server (type: str)
def ex_get_size(self, size_id): (source)
Undocumented
def ex_get_image(self, image_id): (source)
Undocumented
def ex_delete_image(self, image): (source)
Undocumented
def _node_action(self, node, action, **params): (source)
Undocumented
def _update_node(self, node, **node_updates): (source)
Updates the editable attributes of a server, which currently include its name and IPv4/IPv6 access addresses.
def _to_node_from_obj(self, obj): (source)
Undocumented
def _to_node(self, api_node): (source)
Undocumented
def _to_size(self, api_flavor, price=None, bandwidth=None): (source)
Undocumented
def _get_size_price(self, size_id): (source)
overrides libcloud.compute.base.NodeDriver._get_size_price
Undocumented
API Documentation for libcloud, generated by pydoctor at 2012-07-15 18:46:59.