l.c.d.o.OpsourceNodeDriver(NodeDriver) : class documentation

Create a new opsource node

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

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

@keyword    auth:   Initial authentication information for the
                    node (required)
@type       auth:   L{NodeAuthPassword}

@keyword    ex_description:  description for this node (required)
@type       ex_description:  C{str}

@keyword    ex_network:  Network to create the node within (required)
@type       ex_network: L{OpsourceNetwork}

@keyword    ex_isStarted:  Start server after creation? default
                           true (required)
@type       ex_isStarted:  C{bool}

@return: The newly created L{Node}. NOTE: Opsource does not provide a
         way to determine the ID of the server that was just created,
         so the returned L{Node} is not guaranteed to be the same one
         that was created.  This is only the case when multiple nodes
         with the same name exist.
@rtype: L{Node}

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}

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}

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

return a list of available images
    Currently only returns the default 'base OS images' provided by
    opsource. Customer images (snapshots) are not yet supported.

@inherits: L{NodeDriver.list_images}

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 locations (datacenters) available for instantiating servers and
networks.

@inherits: L{NodeDriver.list_locations}

List networks deployed across all data center locations for your
organization.  The response includes the location of each network.


@keyword location: The location
@type    location: L{NodeLocation}

@return: a list of OpsourceNetwork objects
@rtype: C{list} of L{OpsourceNetwork}

Powers on an existing deployed server

@param      node: Node which should be used
@type       node: L{Node}

@rtype: C{bool}

This function will attempt to "gracefully" stop a server by
initiating a shutdown sequence within the guest operating system.
A successful response on this function means the system has
successfully passed the request into the operating system.

@param      node: Node which should be used
@type       node: L{Node}

@rtype: C{bool}

This function will abruptly power-off a server.  Unlike
ex_shutdown_graceful, success ensures the node will stop but some OS
and application configurations may be adversely affected by the
equivalent of pulling the power plug out of the machine.

@param      node: Node which should be used
@type       node: L{Node}

@rtype: C{bool}

List networks deployed across all data center locations for your
organization.  The response includes the location of each network.

@return: a list of OpsourceNetwork objects
@rtype: C{list} of L{OpsourceNetwork}

Get location by ID.

@param  id: ID of the node location which should be used
@type   id: C{str}

@rtype: L{NodeLocation}