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

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}

List all nodes
@return:  list of node objects
@rtype: C{list} of L{Node}

Reboot a node.

@param node: The node to be rebooted
@type node: L{Node}

@return: True if the reboot was successful, otherwise False
@rtype: C{bool}

Destroy a node.

Depending upon the provider, this may destroy all data associated with
the node, including backups.

@param node: The node to be destroyed
@type node: L{Node}

@return: True if the destroy was successful, otherwise False
@rtype: C{bool}

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}

List data centers for a provider

@return: list of node location objects
@rtype: C{list} of L{NodeLocation}

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{Node}

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}

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{Node}

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

@rtype: L{NodeImage}

Change attributes of a node.

@keyword    node: node to be edited
@type       node: L{Node}

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

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

@rtype: L{Node}

Edit metadata of a server image.

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

@keyword    public: should be the image public?
@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}

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}