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

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

GoGrid node driver
Method __init__ @inherits: L{NodeDriver.__init__}
Method list_images List images on a provider
Method list_nodes @inherits: L{NodeDriver.list_nodes} @rtype: C{list} of L{GoGridNode}
Method reboot_node @inherits: L{NodeDriver.reboot_node} @type node: L{GoGridNode}
Method destroy_node @inherits: L{NodeDriver.reboot_node} @type node: L{GoGridNode}
Method list_sizes List sizes on a provider
Method list_locations List data centers for a provider
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 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 the given nodes are fully booted and have an IP address assigned.
Method _wait_until_running Undocumented
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, *args, **kwargs): (source)
@inherits: L{NodeDriver.__init__}
def _get_state(self, element): (source)
Undocumented
def _get_ip(self, element): (source)
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)
Undocumented
def _to_locations(self, object): (source)
Undocumented
def list_images(self, location=None): (source)
List images on a provider

@keyword location: The location at which to list images
@type location: L{NodeLocation}

@return: list of node image objects
@rtype: C{list} of L{NodeImage}
def list_nodes(self): (source)
@inherits: L{NodeDriver.list_nodes}
@rtype: C{list} of L{GoGridNode}
def reboot_node(self, node): (source)
@inherits: L{NodeDriver.reboot_node}
@type node: L{GoGridNode}
def destroy_node(self, node): (source)
@inherits: L{NodeDriver.reboot_node}
@type node: L{GoGridNode}
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)
Undocumented
def list_sizes(self, location=None): (source)
List sizes on a provider

@keyword location: The location at which to list sizes
@type location: L{NodeLocation}

@return: list of node size objects
@rtype: C{list} of L{NodeSize}
def list_locations(self): (source)
List data centers for a provider

@return: list of node location objects
@rtype: C{list} of L{NodeLocation}
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.


@keyword    name:   String with a name for this new node (required)
@type       name:   C{str}

@keyword    size:   The size of resources allocated to this node .
                    (required)
@type       size:   L{NodeSize}

@keyword    image:  OS Image to boot on node. (required)
@type       image:  L{NodeImage}

@keyword    ex_description: Description of a Node
@type       ex_description: C{str}

@keyword    ex_ip: Public IP address to use for a Node. If not
    specified, first available IP address will be picked
@type       ex_ip: C{str}

@rtype: L{GoGridNode}
def create_node(self, **kwargs): (source)
Create a new GoGird node

@inherits: L{NodeDriver.create_node}

@keyword    ex_description: Description of a Node
@type       ex_description: C{str}

@keyword    ex_ip: Public IP address to use for a Node. If not
            specified, first available IP address will be picked
@type       ex_ip: C{str}

@rtype: L{GoGridNode}
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

@keyword    node: node to use as a base for image
@type       node: L{GoGridNode}

@keyword    name: name for new image
@type       name: C{str}

@rtype: L{NodeImage}
def ex_edit_node(self, **kwargs): (source)
Change attributes of a node.

@keyword    node: node to be edited (required)
@type       node: L{GoGridNode}

@keyword    size: new size of a node (required)
@type       size: L{NodeSize}

@keyword    ex_description: new description of a node
@type       ex_description: C{str}

@rtype: L{Node}
def ex_edit_image(self, **kwargs): (source)
Edit metadata of a server image.

@keyword    image: image to be edited (required)
@type       image: L{NodeImage}

@keyword    public: should be the image public (required)
@type       public: C{bool}

@keyword    ex_description: description of the image (optional)
@type       ex_description: C{str}

@keyword    name: name of the image
@type       name C{str}

@rtype: L{NodeImage}
def ex_list_ips(self, **kwargs): (source)
Return list of IP addresses assigned to
the account.

@keyword    public: set 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       public: C{bool}

@keyword    assigned: set 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       assigned: C{bool}

@keyword    location: filter IP addresses by location
@type       location: L{NodeLocation}

@rtype: C{list} of L{GoGridIpAddress}
API Documentation for libcloud, generated by pydoctor at 2013-02-18 10:41:20.