l.c.d.g.GoGridNodeDriver(BaseGoGridDriver, NodeDriver) : class documentation

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

GoGrid node driver
Method list_images List images on a provider
Method list_nodes List all nodes @return: list of Node objects
Method reboot_node Reboot a node.
Method destroy_node Destroy a node.
Method list_sizes List sizes on a provider
Method list_locations List data centers for a provider @return: list of NodeLocation objects
Method ex_create_node_nowait Don't block until GoGrid allocates id for a node but return right away with id == None.
Method create_node Create a new GoGird node
Method ex_save_image Create an image for node.
Method ex_edit_node Change attributes of a node.
Method ex_edit_image Edit metadata of a server image.
Method ex_list_ips Return list of IP addresses assigned to the account.
Method _get_state Undocumented
Method _get_ip Undocumented
Method _get_id Undocumented
Method _to_node Undocumented
Method _to_image Undocumented
Method _to_images Undocumented
Method _to_location Undocumented
Method _to_locations Undocumented
Method _server_list Undocumented
Method _password_list Undocumented
Method _server_power Undocumented
Method _server_delete Undocumented
Method _get_first_ip Undocumented

Inherited from BaseGoGridDriver:

Method _to_ip Undocumented
Method _to_ips Undocumented

Inherited from NodeDriver:

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

Inherited from BaseDriver (via NodeDriver):

Method _ex_connection_class_kwargs Return extra connection keyword arguments which are passed to the Connection class constructor.
def _get_state(self, element): (source)
Undocumented
def _get_ip(self, element): (source)
overrides libcloud.common.gogrid.BaseGoGridDriver._get_ip
Undocumented
def _get_id(self, element): (source)
Undocumented
def _to_node(self, element, password=None): (source)
Undocumented
def _to_image(self, element): (source)
Undocumented
def _to_images(self, object): (source)
Undocumented
def _to_location(self, element): (source)
overrides libcloud.common.gogrid.BaseGoGridDriver._to_location
Undocumented
def _to_locations(self, object): (source)
overrides libcloud.common.gogrid.BaseGoGridDriver._to_locations
Undocumented
def list_images(self, location=None): (source)
overrides libcloud.compute.base.NodeDriver.list_images
List images on a provider
ParameterslocationThe location at which to list images (type: NodeLocation)
Returnslist of NodeImage objects
def list_nodes(self): (source)
overrides libcloud.compute.base.NodeDriver.list_nodes
List all nodes
Returnslist of Node objects
def reboot_node(self, node): (source)
overrides libcloud.compute.base.NodeDriver.reboot_node
Reboot a node.
ParametersnodeThe node to be rebooted (type: Node)
Returnsbool True if the reboot was successful, otherwise False
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)
Returnsbool True if the destroy was successful, otherwise False
def _server_list(self): (source)
Undocumented
def _password_list(self): (source)
Undocumented
def _server_power(self, id, power): (source)
Undocumented
def _server_delete(self, id): (source)
Undocumented
def _get_first_ip(self, location=None): (source)
overrides libcloud.common.gogrid.BaseGoGridDriver._get_first_ip
Undocumented
def list_sizes(self, location=None): (source)
overrides libcloud.compute.base.NodeDriver.list_sizes
List sizes on a provider
ParameterslocationThe location at which to list sizes (type: NodeLocation)
Returnslist of NodeSize objects
def list_locations(self): (source)
overrides libcloud.compute.base.NodeDriver.list_locations
List data centers for a provider
Returnslist of NodeLocation objects
def ex_create_node_nowait(self, **kwargs): (source)
Don't block until GoGrid allocates id for a node but return right away with id == None.

The existance of this method is explained by the fact that GoGrid assigns id to a node only few minutes after creation.

def create_node(self, **kwargs): (source)
overrides libcloud.compute.base.NodeDriver.create_node
Create a new GoGird node

See NodeDriver.create_node for more keyword args.

Parametersex_descriptionDescription of a Node (type: string)
ex_ipPublic IP address to use for a Node. If not specified, first available IP address will be picked (type: string)
def ex_save_image(self, node, name): (source)
Create an image for node.

Please refer to GoGrid documentation to get info how prepare a node for image creation:

http://wiki.gogrid.com/wiki/index.php/MyGSI

Parametersnodenode to use as a base for image (type: Node)
namename for new image (type: string)
def ex_edit_node(self, **kwargs): (source)
Change attributes of a node.
Parametersnodenode to be edited (type: Node)
sizenew size of a node (type: NodeSize)
ex_descriptionnew description of a node (type: string)
def ex_edit_image(self, **kwargs): (source)
Edit metadata of a server image.
Parametersimageimage to be edited (type: NodeImage)
publicshould be the image public? (type: bool)
ex_descriptiondescription of the image (optional) (type: string)
namename of the image @type name string
def ex_list_ips(self, **kwargs): (source)
overrides libcloud.common.gogrid.BaseGoGridDriver.ex_list_ips
Return list of IP addresses assigned to the account.
Parameterspublicset to True to list only public IPs or False to list only private IPs. Set to None or not specify at all not to filter by type (type: bool)
assignedset to True to list only addresses assigned to servers, False to list unassigned addresses and set to None or don't set at all not no filter by state (type: bool)
locationfilter IP addresses by location (type: NodeLocation)
Returnslist of GoGridIpAddresses
API Documentation for libcloud, generated by pydoctor at 2012-07-15 18:49:10.