l.c.d.g.GandiNodeDriver(NodeDriver) : class documentation

@keyword    key:    API key or username to used
@type       key:    str

@keyword    secret: Secret password to be used
@type       secret: str

@keyword    secure: Weither to use HTTPS or HTTP. Note: Some providers
                    only support HTTPS, and it is on by default.
@type       secure: bool

@keyword    host: Override hostname used for connections.
@type       host: str

@keyword    port: Override port used for connections.
@type       port: int

Wait for an operation to succeed

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

Reboot a node.
@return: C{bool} True if the reboot was successful, otherwise False

Destroy a node.

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

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

Create a new node, and start deployment.

Depends on a Provider Driver supporting either using a specific password
or returning a generated password.

This function may raise a L{DeploymentException}, if a create_node
call was successful, but there is a later error (like SSH failing or
timing out).  This exception includes a Node object which you may want
to destroy if incomplete deployments are not desirable.

@keyword    deploy: Deployment to run once machine is online and availble to SSH.
@type       deploy: L{Deployment}

@keyword    ssh_username: Optional name of the account which is used when connecting to
                          SSH server (default is root)
@type       ssh_username: C{str}

@keyword    ssh_port: Optional SSH server port (default is 22)
@type       ssh_port: C{int}

@keyword    ssh_timeout: Optional SSH connection timeout in seconds
                         (default is None)
@type       ssh_timeout: C{float}

See L{NodeDriver.create_node} for more keyword args.

>>> from libcloud.compute.drivers.dummy import DummyNodeDriver
>>> from libcloud.deployment import ScriptDeployment, MultiStepDeployment
>>> from libcloud.compute.base import NodeAuthSSHKey
>>> driver = DummyNodeDriver(0)
>>> key = NodeAuthSSHKey('...') # read from file
>>> script = ScriptDeployment("yum -y install emacs strace tcpdump")
>>> msd = MultiStepDeployment([key, script])
>>> def d():
...     try:
...         node = driver.deploy_node(deploy=msd)
...     except NotImplementedError:
...         print "not implemented for dummy driver"
>>> d()
not implemented for dummy driver

Deploy node is typically not overridden in subclasses.  The
existing implementation should be able to handle most such.

Create a new Gandi node

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

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

@keyword    location: Which data center to create a node in. If empty,
                      undefined behavoir will be selected. (optional)
@type       location: L{NodeLocation}

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

@keyword    login:  user name to create for login on this machine (required)
@type       login: String

@keyword    password: password for user that'll be created (required)
@type       password: String

@keywork    inet_family: version of ip to use, default 4 (optional)
@type       inet_family: int

List images on a provider
@return: C{list} of L{NodeImage} objects

List sizes on a provider
@return: C{list} of L{NodeSize} objects

List data centers for a provider
@return: C{list} of L{NodeLocation} objects