Added: websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.gogrid.GoGridNodeDriver.html ============================================================================== --- websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.gogrid.GoGridNodeDriver.html (added) +++ websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.gogrid.GoGridNodeDriver.html Thu May 24 04:03:26 2012 @@ -0,0 +1,858 @@ + + + + libcloud.compute.drivers.gogrid.GoGridNodeDriver : API documentation + + + + + + +

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

+

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

+
+ +
+
GoGrid node driver
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methodlist_imagesList images on a provider
Methodlist_nodesList all nodes @return: C{list} of L{Node} objects
Methodreboot_nodeReboot a node.
Methoddestroy_nodeDestroy a node.
Methodlist_sizesList sizes on a provider
Methodlist_locationsList data centers for a provider @return: C{list} of L{NodeLocation} objects
Methodex_create_node_nowaitDon't block until GoGrid allocates id for a node but return right away with id == None.
Methodcreate_nodeCreate a new GoGird node
Methodex_save_imageCreate an image for node.
Methodex_edit_nodeChange attributes of a node.
Methodex_edit_imageEdit metadata of a server image.
Methodex_list_ipsReturn list of IP addresses assigned to the account.
Method_get_stateUndocumented
Method_get_ipUndocumented
Method_get_idUndocumented
Method_to_nodeUndocumented
Method_to_imageUndocumented
Method_to_imagesUndocumented
Method_to_locationUndocumented
Method_to_locationsUndocumented
Method_server_listUndocumented
Method_password_listUndocumented
Method_server_powerUndocumented
Method_server_deleteUndocumented
Method_get_first_ipUndocumented
+ +

+ Inherited from BaseGoGridDriver: +

+ + + + + + + + + + + + + + + + + +
Method_to_ipUndocumented
Method_to_ipsUndocumented
+ +

+ Inherited from NodeDriver: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method__init__@keyword key: API key or username to used @type key: str
Methoddeploy_nodeCreate a new node, and start deployment.
Method_wait_until_runningBlock until node is fully booted and has an IP address assigned.
Method_ssh_client_connectTry 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_scriptRun the deployment script on the provided node. At this point it is assumed that SSH connection has already been established.
Method_get_size_priceUndocumented
+ +

+ Inherited from BaseDriver (via NodeDriver): +

+ + + + + + + + + + + +
Method_ex_connection_class_kwargsReturn 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) + +
+
+ +
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: C{list} of L{NodeImage} objects
+
+
+ + + + + + +
+ + def + list_nodes(self): + + + (source) + +
+
+ +
List all nodes
+@return: C{list} of L{Node} objects
+
+
+ + + + + + +
+ + def + reboot_node(self, node): + + + (source) + +
+
+ +
Reboot a node.
+
+@param node: The node to be rebooted
+@type node: L{Node}
+
+@return: C{bool} True if the reboot was successful, otherwise False
+
+
+ + + + + + +
+ + def + destroy_node(self, node): + + + (source) + +
+
+ +
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: C{bool} 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) + +
+
+ +
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: C{list} of L{NodeSize} objects
+
+
+ + + + + + +
+ + def + list_locations(self): + + + (source) + +
+
+ +
List data centers for a provider
+@return: C{list} of L{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) + +
+
+ +
Create a new GoGird node
+
+See L{NodeDriver.create_node} for more keyword args.
+
+@keyword    ex_description: Description of a Node
+@type       ex_description: C{string}
+@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{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
+
+@keyword    node: node to use as a base for image
+@type       node: L{Node}
+@keyword    name: name for new image
+@type       name: C{string}
+
+
+ + + + + + +
+ + def + ex_edit_node(self, **kwargs): + + + (source) + +
+
+ +
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{string}
+
+
+ + + + + + +
+ + def + ex_edit_image(self, **kwargs): + + + (source) + +
+
+ +
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{string}
+@keyword    name: name of the image
+@type       name C{string}
+
+
+ + + + + + +
+ + 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}
+@return:    C{list} of L{GoGridIpAddress}es
+
+
+
+ API Documentation for libcloud, generated by pydoctor at 2012-05-23 21:00:54. +
+ + \ No newline at end of file Added: websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.gogrid.html ============================================================================== --- websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.gogrid.html (added) +++ websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.gogrid.html Thu May 24 04:03:26 2012 @@ -0,0 +1,57 @@ + + + + libcloud.compute.drivers.gogrid : API documentation + + + + + + +

l.c.d.gogrid : module documentation

+

+ Part of libcloud.compute.drivers + View Source + +

+
+ +
+
GoGrid driver
+ + + +
+ + + + + + + + + + + + + + + + + +
ClassGoGridNodeUndocumented
ClassGoGridNodeDriverGoGrid node driver
+ + +
+ + + + + +
+ API Documentation for libcloud, generated by pydoctor at 2012-05-23 21:00:54. +
+ + \ No newline at end of file Added: websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.html ============================================================================== --- websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.html (added) +++ websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.html Thu May 24 04:03:26 2012 @@ -0,0 +1,231 @@ + + + + libcloud.compute.drivers : API documentation + + + + + + +

l.c.drivers : package documentation

+

+ Part of libcloud.compute + View Source + +

+
+ +
+
Drivers for working with different providers
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Moduleblueboxlibcloud driver for the Blue Box Blocks API
ModulebrightboxBrightbox Driver
ModulecloudsigmaCloudSigma Driver
ModulecloudstackNo module docstring; 4/4 classes documented
ModuledreamhostDreamHost Driver
ModuledummyDummy Driver
Moduleec2Amazon EC2 driver
ModuleecpEnomaly ECP driver
ModuleelastichostsElasticHosts Driver
ModuleelasticstackBase driver for the providers based on the ElasticStack platform - http://www.elasticstack.com.
ModulegandiGandi driver for compute
ModulegogridGoGrid driver
Moduleibm_sceDriver for IBM SmartCloud Enterprise
ModulejoyentUndocumented
Modulelibvirt_driverNo module docstring; 1/1 classes documented
Modulelinodelibcloud driver for the Linode(R) API
ModuleninefoldNo module docstring; 1/1 classes documented
ModuleopennebulaOpenNebula.org driver.
ModuleopenstackOpenStack driver
ModuleopsourceOpsource Driver
ModulerackspaceRackspace driver
ModulerackspacenovaRackspace driver
ModulerimuhostingRimuHosting Driver
ModuleserverloveServerLove Driver
Moduleskalicloudskalicloud Driver
ModuleslicehostSlicehost Driver
ModulesoftlayerSoftlayer driver
ModulevclVCL driver
ModulevcloudVMware vCloud driver.
ModulevoxelVoxel VoxCloud driver
ModulevpsnetVPS.net driver
+ + +
+ + + + + +
+ API Documentation for libcloud, generated by pydoctor at 2012-05-23 21:00:54. +
+ + \ No newline at end of file Added: websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.ibm_sce.IBMConnection.html ============================================================================== --- websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.ibm_sce.IBMConnection.html (added) +++ websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.ibm_sce.IBMConnection.html Thu May 24 04:03:26 2012 @@ -0,0 +1,97 @@ + + + + libcloud.compute.drivers.ibm_sce.IBMConnection : API documentation + + + + + + +

l.c.d.i.IBMConnection(ConnectionUserAndKey) : class documentation

+

+ Part of libcloud.compute.drivers.ibm_sce + View Source + View In Hierarchy +

+
+ +
+
Connection class for the IBM Developer Cloud driver
+ + + +
+ + + + + + + + + + + + + + + + + +
Methodadd_default_headersUndocumented
Methodencode_dataUndocumented
+ + +
+ + + + +
+ + + + + + +
+ + def + add_default_headers(self, headers): + + + (source) + +
+
+ +
Undocumented
+
+
+ + + + + + +
+ + def + encode_data(self, data): + + + (source) + +
+
+ +
Undocumented
+
+
+
+ API Documentation for libcloud, generated by pydoctor at 2012-05-23 21:00:54. +
+ + \ No newline at end of file Added: websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.ibm_sce.IBMNodeDriver.html ============================================================================== --- websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.ibm_sce.IBMNodeDriver.html (added) +++ websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.ibm_sce.IBMNodeDriver.html Thu May 24 04:03:26 2012 @@ -0,0 +1,539 @@ + + + + libcloud.compute.drivers.ibm_sce.IBMNodeDriver : API documentation + + + + + + +

l.c.d.i.IBMNodeDriver(NodeDriver) : class documentation

+

+ Part of libcloud.compute.drivers.ibm_sce + View Source + View In Hierarchy +

+
+ +
+
Node driver for IBM SmartCloud Enterprise
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methodcreate_nodeCreates a node in the IBM Developer Cloud.
Methoddestroy_nodeDestroy a node.
Methodreboot_nodeReboot a node.
Methodlist_nodesList all nodes @return: C{list} of L{Node} objects
Methodlist_imagesList images on a provider
Methodlist_sizesReturns a generic list of sizes. See list_images() for a list of supported sizes for specific images.
Methodlist_locationsList data centers for a provider @return: C{list} of L{NodeLocation} objects
Method_to_nodesUndocumented
Method_to_nodeUndocumented
Method_to_imagesUndocumented
Method_to_imageUndocumented
Method_to_locationsUndocumented
Method_to_locationUndocumented
Method_to_node_sizesUndocumented
Method_to_node_sizeUndocumented
+ +

+ Inherited from NodeDriver: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method__init__@keyword key: API key or username to used @type key: str
Methoddeploy_nodeCreate a new node, and start deployment.
Method_wait_until_runningBlock until node is fully booted and has an IP address assigned.
Method_ssh_client_connectTry 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_scriptRun the deployment script on the provided node. At this point it is assumed that SSH connection has already been established.
Method_get_size_priceUndocumented
+ +

+ Inherited from BaseDriver (via NodeDriver): +

+ + + + + + + + + + + +
Method_ex_connection_class_kwargsReturn extra connection keyword arguments which are passed to the Connection class constructor.
+ + +
+ + + + +
+ + + + + + +
+ + def + create_node(self, **kwargs): + + + (source) + +
+
+ +
Creates a node in the IBM Developer Cloud.
+
+See L{NodeDriver.create_node} for more keyword args.
+
+@keyword    auth Name of the pubkey to use. When constructing
+                 C{NodeAuthSSHKey} instance, 'pubkey' argument must be
+                 the name of the public key to use.
+                 You chose this name when creating a new public key on
+                 the IBM server.
+@type       auth C{NodeAuthSSHKey}
+
+@keyword    ex_configurationData: Image-specific configuration parameters.
+                               Configuration parameters are defined in
+                               the parameters.xml file.  The URL to
+                               this file is defined in the NodeImage
+                               at extra[parametersURL].
+
+                               Note: This argument must be specified
+                               when launching a Windows instance. It
+                               must contain 'UserName' and 'Password'
+                               keys.
+@type       ex_configurationData: C{dict}
+
+
+ + + + + + +
+ + def + destroy_node(self, node): + + + (source) + +
+
+ +
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: C{bool} True if the destroy was successful, otherwise False
+
+
+ + + + + + +
+ + def + reboot_node(self, node): + + + (source) + +
+
+ +
Reboot a node.
+
+@param node: The node to be rebooted
+@type node: L{Node}
+
+@return: C{bool} True if the reboot was successful, otherwise False
+
+
+ + + + + + +
+ + def + list_nodes(self): + + + (source) + +
+
+ +
List all nodes
+@return: C{list} of L{Node} objects
+
+
+ + + + + + +
+ + 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: C{list} of L{NodeImage} objects
+
+
+ + + + + + +
+ + def + list_sizes(self, location=None): + + + (source) + +
+
+ +
Returns a generic list of sizes.  See list_images() for a list of supported sizes for specific
+images.
+
+
+ + + + + + +
+ + def + list_locations(self): + + + (source) + +
+
+ +
List data centers for a provider
+@return: C{list} of L{NodeLocation} objects
+
+
+ + + + + + +
+ + def + _to_nodes(self, object): + + + (source) + +
+
+ +
Undocumented
+
+
+ + + + + + +
+ + def + _to_node(self, instance): + + + (source) + +
+
+ +
Undocumented
+
+
+ + + + + + +
+ + def + _to_images(self, object): + + + (source) + +
+
+ +
Undocumented
+
+
+ + + + + + +
+ + def + _to_image(self, image): + + + (source) + +
+
+ +
Undocumented
+
+
+ + + + + + +
+ + def + _to_locations(self, object): + + + (source) + +
+
+ +
Undocumented
+
+
+ + + + + + +
+ + def + _to_location(self, location): + + + (source) + +
+
+ +
Undocumented
+
+
+ + + + + + +
+ + def + _to_node_sizes(self, object): + + + (source) + +
+
+ +
Undocumented
+
+
+ + + + + + +
+ + def + _to_node_size(self, object): + + + (source) + +
+
+ +
Undocumented
+
+
+
+ API Documentation for libcloud, generated by pydoctor at 2012-05-23 21:00:54. +
+ + \ No newline at end of file Added: websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.ibm_sce.IBMResponse.html ============================================================================== --- websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.ibm_sce.IBMResponse.html (added) +++ websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.ibm_sce.IBMResponse.html Thu May 24 04:03:26 2012 @@ -0,0 +1,144 @@ + + + + libcloud.compute.drivers.ibm_sce.IBMResponse : API documentation + + + + + + +

l.c.d.i.IBMResponse(XmlResponse) : class documentation

+

+ Part of libcloud.compute.drivers.ibm_sce + View Source + View In Hierarchy +

+
+ +
+
Undocumented
+ + + +
+ + + + + + + + + + + + + + + + + +
MethodsuccessDetermine if our request was successful.
Methodparse_errorParse the error messages.
+ +

+ Inherited from XmlResponse: +

+ + + + + + + + + + + +
Methodparse_bodyParse response body.
+ +

+ Inherited from Response (via XmlResponse): +

+ + + + + + + + + + + + + + + + + +
Method__init__Undocumented
Method_decompress_responseDecompress a response body if it is using deflate or gzip encoding.
+ + +
+ + + + +
+ + + + + + +
+ + def + success(self): + + + (source) + +
+
+ +
Determine if our request was successful.
+
+The meaning of this can be arbitrary; did we receive OK status? Did
+the node get created? Were we authenticated?
+
+@return: C{True} or C{False}
+
+
+ + + + + + +
+ + def + parse_error(self): + + + (source) + +
+
+ +
Parse the error messages.
+
+Override in a provider's subclass.
+
+@return: Parsed error.
+
+
+
+ API Documentation for libcloud, generated by pydoctor at 2012-05-23 21:00:54. +
+ + \ No newline at end of file Added: websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.ibm_sce.html ============================================================================== --- websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.ibm_sce.html (added) +++ websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.ibm_sce.html Thu May 24 04:03:26 2012 @@ -0,0 +1,67 @@ + + + + libcloud.compute.drivers.ibm_sce : API documentation + + + + + + +

l.c.d.ibm_sce : module documentation

+

+ Part of libcloud.compute.drivers + View Source + +

+
+ +
+
Driver for IBM SmartCloud Enterprise
+
+Formerly known as:
+- IBM Developer Cloud.
+- IBM SmartBusiness Cloud
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + +
ClassIBMResponseUndocumented
ClassIBMConnectionConnection class for the IBM Developer Cloud driver
ClassIBMNodeDriverNode driver for IBM SmartCloud Enterprise
+ + +
+ + + + + +
+ API Documentation for libcloud, generated by pydoctor at 2012-05-23 21:00:54. +
+ + \ No newline at end of file Added: websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.joyent.JoyentConnection.html ============================================================================== --- websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.joyent.JoyentConnection.html (added) +++ websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.joyent.JoyentConnection.html Thu May 24 04:03:26 2012 @@ -0,0 +1,71 @@ + + + + libcloud.compute.drivers.joyent.JoyentConnection : API documentation + + + + + + +

l.c.d.j.JoyentConnection(ConnectionUserAndKey) : class documentation

+

+ Part of libcloud.compute.drivers.joyent + View Source + View In Hierarchy +

+
+ +
+
Undocumented
+ + + +
+ + + + + + + + + + + +
Methodadd_default_headersUndocumented
+ + +
+ + + + +
+ + + + + + +
+ + def + add_default_headers(self, headers): + + + (source) + +
+
+ +
Undocumented
+
+
+
+ API Documentation for libcloud, generated by pydoctor at 2012-05-23 21:00:54. +
+ + \ No newline at end of file Added: websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.joyent.JoyentNodeDriver.html ============================================================================== --- websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.joyent.JoyentNodeDriver.html (added) +++ websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.joyent.JoyentNodeDriver.html Thu May 24 04:03:26 2012 @@ -0,0 +1,403 @@ + + + + libcloud.compute.drivers.joyent.JoyentNodeDriver : API documentation + + + + + + +

l.c.d.j.JoyentNodeDriver(NodeDriver) : class documentation

+

+ Part of libcloud.compute.drivers.joyent + View Source + View In Hierarchy +

+
+ +
+
Undocumented
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method__init__@keyword key: API key or username to used @type key: str
Methodlist_imagesList images on a provider
Methodlist_sizesList sizes on a provider
Methodlist_nodesList all nodes @return: C{list} of L{Node} objects
Methodreboot_nodeReboot a node.
Methoddestroy_nodeDestroy a node.
Methodcreate_nodeCreate a new node instance.
Methodex_stop_nodeUndocumented
Method_to_nodeUndocumented
+ +

+ Inherited from NodeDriver: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methodlist_locationsList data centers for a provider @return: C{list} of L{NodeLocation} objects
Methoddeploy_nodeCreate a new node, and start deployment.
Method_wait_until_runningBlock until node is fully booted and has an IP address assigned.
Method_ssh_client_connectTry 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_scriptRun the deployment script on the provided node. At this point it is assumed that SSH connection has already been established.
Method_get_size_priceUndocumented
+ +

+ Inherited from BaseDriver (via NodeDriver): +

+ + + + + + + + + + + +
Method_ex_connection_class_kwargsReturn extra connection keyword arguments which are passed to the Connection class constructor.
+ + +
+ + + + +
+ + + + + + +
+ + def + __init__(self, *args, **kwargs): + + + (source) + +
+
+ +
@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
+
+@keyword    api_version: Optional API version. Only used by drivers
+                         which support multiple API versions.
+@type       api_version: str
+
+
+ + + + + + +
+ + def + list_images(self): + + + (source) + +
+
+ +
List images on a provider
+
+@keyword location: The location at which to list images
+@type location: L{NodeLocation}
+
+@return: C{list} of L{NodeImage} objects
+
+
+ + + + + + +
+ + def + list_sizes(self): + + + (source) + +
+
+ +
List sizes on a provider
+
+@keyword location: The location at which to list sizes
+@type location: L{NodeLocation}
+
+@return: C{list} of L{NodeSize} objects
+
+
+ + + + + + +
+ + def + list_nodes(self): + + + (source) + +
+
+ +
List all nodes
+@return: C{list} of L{Node} objects
+
+
+ + + + + + +
+ + def + reboot_node(self, node): + + + (source) + +
+
+ +
Reboot a node.
+
+@param node: The node to be rebooted
+@type node: L{Node}
+
+@return: C{bool} True if the reboot was successful, otherwise False
+
+
+ + + + + + +
+ + def + destroy_node(self, node): + + + (source) + +
+
+ +
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: C{bool} True if the destroy was successful, otherwise False
+
+
+ + + + + + +
+ + def + create_node(self, **kwargs): + + + (source) + +
+
+ +
Create a new node instance.
+
+@keyword    name:   String with a name for this new node (required)
+@type       name:   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    location: Which data center to create a node in. If empty,
+                      undefined behavoir will be selected. (optional)
+@type       location: L{NodeLocation}
+
+@keyword    auth:   Initial authentication information for the node
+                    (optional)
+@type       auth:   L{NodeAuthSSHKey} or L{NodeAuthPassword}
+
+@return: The newly created L{Node}.
+
+
+ + + + + + +
+ + def + ex_stop_node(self, node): + + + (source) + +
+
+ +
Undocumented
+
+
+ + + + + + +
+ + def + _to_node(self, data): + + + (source) + +
+
+ +
Undocumented
+
+
+
+ API Documentation for libcloud, generated by pydoctor at 2012-05-23 21:00:54. +
+ + \ No newline at end of file Added: websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.joyent.JoyentResponse.html ============================================================================== --- websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.joyent.JoyentResponse.html (added) +++ websites/staging/libcloud/trunk/content/apidocs/0.10.1/libcloud.compute.drivers.joyent.JoyentResponse.html Thu May 24 04:03:26 2012 @@ -0,0 +1,144 @@ + + + + libcloud.compute.drivers.joyent.JoyentResponse : API documentation + + + + + + +

l.c.d.j.JoyentResponse(JsonResponse) : class documentation

+

+ Part of libcloud.compute.drivers.joyent + View Source + View In Hierarchy +

+
+ +
+
Undocumented
+ + + +
+ + + + + + + + + + + + + + + + + +
Methodparse_errorParse the error messages.
MethodsuccessDetermine if our request was successful.
+ +

+ Inherited from JsonResponse: +

+ + + + + + + + + + + +
Methodparse_bodyParse response body.
+ +

+ Inherited from Response (via JsonResponse): +

+ + + + + + + + + + + + + + + + + +
Method__init__Undocumented
Method_decompress_responseDecompress a response body if it is using deflate or gzip encoding.
+ + +
+ + + + +
+ + + + + + +
+ + def + parse_error(self): + + + (source) + +
+
+ +
Parse the error messages.
+
+Override in a provider's subclass.
+
+@return: Parsed error.
+
+
+ + + + + + +
+ + def + success(self): + + + (source) + +
+
+ +
Determine if our request was successful.
+
+The meaning of this can be arbitrary; did we receive OK status? Did
+the node get created? Were we authenticated?
+
+@return: C{True} or C{False}
+
+
+
+ API Documentation for libcloud, generated by pydoctor at 2012-05-23 21:00:54. +
+ + \ No newline at end of file