l.c.d.b.BrightboxNodeDriver(NodeDriver) : class documentation

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

Brightbox node driver
Method __init__
Method create_node Create a new Brightbox node
Method destroy_node Destroy a node.
Method list_nodes List all nodes @return: list of node objects @rtype: list of Node
Method list_images List images on a provider
Method list_sizes List sizes on a provider
Method list_locations List data centers for a provider
Method ex_list_cloud_ips List Cloud IPs
Method ex_create_cloud_ip Requests a new cloud IP address for the account
Method ex_update_cloud_ip Update some details of the cloud IP address
Method ex_map_cloud_ip Maps (or points) a cloud IP address at a server's interface or a load balancer to allow them to respond to public requests
Method ex_unmap_cloud_ip Unmaps a cloud IP address from its current destination making it available to remap. This remains in the account's pool of addresses
Method ex_destroy_cloud_ip Release the cloud IP address from the account's ownership
Method _to_node Undocumented
Method _to_image Undocumented
Method _to_size Undocumented
Method _to_location Undocumented
Method _post Undocumented
Method _put Undocumented

Inherited from NodeDriver:

Method reboot_node Reboot a node.
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

Inherited from BaseDriver (via NodeDriver):

Method _ex_connection_class_kwargs Return extra connection keyword arguments which are passed to the Connection class constructor.
def __init__(self, key, secret=None, secure=True, host=None, port=None, api_version=API_VERSION, **kwargs): (source)
overrides libcloud.compute.base.NodeDriver.__init__
Unknown Field: requireskey, secret
def _to_node(self, data): (source)
Undocumented
def _to_image(self, data): (source)
Undocumented
def _to_size(self, data): (source)
Undocumented
def _to_location(self, data): (source)
Undocumented
def _post(self, path, data={}): (source)
Undocumented
def _put(self, path, data={}): (source)
Undocumented
def create_node(self, **kwargs): (source)
overrides libcloud.compute.base.NodeDriver.create_node
Create a new Brightbox node

Reference: https://api.gb1.brightbox.com/1.0/#server_create_server

Parametersex_userdataUser data (type: str)
ex_servergroupName or list of server group ids to add server to (type: str or list of str)
Unknown Field: inheritsNodeDriver.create_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.

ParametersnodeThe node to be destroyed (type: Node)
ReturnsTrue if the destroy was successful, otherwise False (type: bool)
def list_nodes(self): (source)
overrides libcloud.compute.base.NodeDriver.list_nodes
List all nodes
Returnslist of node objects (type: list of Node)
def list_images(self): (source)
overrides libcloud.compute.base.NodeDriver.list_images
List images on a provider
ParameterslocationThe location at which to list images (type: NodeLocation)
Returnslist of node image objects (type: list of NodeImage)
def list_sizes(self): (source)
overrides libcloud.compute.base.NodeDriver.list_sizes
List sizes on a provider
ParameterslocationThe location at which to list sizes (type: NodeLocation)
Returnslist of node size objects (type: list of NodeSize)
def list_locations(self): (source)
overrides libcloud.compute.base.NodeDriver.list_locations
List data centers for a provider
Returnslist of node location objects (type: list of NodeLocation)
def ex_list_cloud_ips(self): (source)
List Cloud IPs
Returns (type: list of dict)
NoteThis is an API extension for use on Brightbox
def ex_create_cloud_ip(self, reverse_dns=None): (source)
Requests a new cloud IP address for the account
Parametersreverse_dnsReverse DNS hostname (type: str)
Returns (type: dict)
NoteThis is an API extension for use on Brightbox
def ex_update_cloud_ip(self, cloud_ip_id, reverse_dns): (source)
Update some details of the cloud IP address
Parameterscloud_ip_idThe id of the cloud ip. (type: str)
reverse_dnsReverse DNS hostname (type: str)
Returns (type: dict)
NoteThis is an API extension for use on Brightbox
def ex_map_cloud_ip(self, cloud_ip_id, interface_id): (source)
Maps (or points) a cloud IP address at a server's interface or a load balancer to allow them to respond to public requests
Parameterscloud_ip_idThe id of the cloud ip. (type: str)
interface_idThe Interface ID or LoadBalancer ID to which this Cloud IP should be mapped to (type: str)
ReturnsTrue if the mapping was successful. (type: bool)
NoteThis is an API extension for use on Brightbox
def ex_unmap_cloud_ip(self, cloud_ip_id): (source)
Unmaps a cloud IP address from its current destination making it available to remap. This remains in the account's pool of addresses
Parameterscloud_ip_idThe id of the cloud ip. (type: str)
ReturnsTrue if the unmap was successful. (type: bool)
NoteThis is an API extension for use on Brightbox
def ex_destroy_cloud_ip(self, cloud_ip_id): (source)
Release the cloud IP address from the account's ownership
Parameterscloud_ip_idThe id of the cloud ip. (type: str)
ReturnsTrue if the unmap was successful. (type: bool)
NoteThis is an API extension for use on Brightbox
API Documentation for libcloud, generated by pydoctor at 2012-07-28 18:57:18.