libcloud-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From anthonys...@apache.org
Subject [1/5] libcloud git commit: Fixed documentation format
Date Tue, 16 Feb 2016 02:23:59 GMT
Repository: libcloud
Updated Branches:
  refs/heads/trunk 90b263cdd -> 67cd0a7ca


Fixed documentation format


Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/323469c1
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/323469c1
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/323469c1

Branch: refs/heads/trunk
Commit: 323469c17046ef94f2681ab802a6461de7e9b48a
Parents: 3a5dd0c
Author: Juan Font <juanfontalonso@gmail.com>
Authored: Mon Feb 15 23:53:57 2016 +0100
Committer: anthony-shaw <anthony.p.shaw@gmail.com>
Committed: Tue Feb 16 13:21:35 2016 +1100

----------------------------------------------------------------------
 libcloud/compute/drivers/vcloud.py | 29 +++++++++++++++++------------
 1 file changed, 17 insertions(+), 12 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/libcloud/blob/323469c1/libcloud/compute/drivers/vcloud.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/vcloud.py b/libcloud/compute/drivers/vcloud.py
index e02a5ab..e09ad84 100644
--- a/libcloud/compute/drivers/vcloud.py
+++ b/libcloud/compute/drivers/vcloud.py
@@ -2190,18 +2190,23 @@ class VCloud_5_5_NodeDriver(VCloud_5_1_NodeDriver):
     def ex_acquire_mks_ticket(self, vapp_or_vm_id, vm_num=0):
         """
         Retrieve a mks ticket that you can use to gain access to the console
-        of a running VM.
-        :param vapp_or_vm_id: vApp or VM ID you want to connect to.
-        :param vm_num: If a vApp ID is provided, vm_num is position in the vApp
-                    VM list of the VM you want to get a screen ticket.
-                    Default is 0.
-        :return: If successful, a dict with the following keys:
-                - host: host (or proxy) through which the console connection
-                        is made
-                - vmx: a reference to the VMX file of the VM for which this
-                       ticket was issued
-                - ticket: screen ticket to use to authenticate the client
-                - port: host port to be used for console access
+        of a running VM. If successful, returns a dict with the following keys:
+        - host: host (or proxy) through which the console connection
+                is made
+        - vmx: a reference to the VMX file of the VM for which this
+               ticket was issued
+        - ticket: screen ticket to use to authenticate the client
+        - port: host port to be used for console access
+
+        :param  vapp_or_vm_id: vApp or VM ID you want to connect to.
+        :type   vapp_or_vm_id: ``str``
+
+        :param  vm_num: If a vApp ID is provided, vm_num is position in the vApp
+                VM list of the VM you want to get a screen ticket.
+                Default is 0.
+        :type   vm_num: ``int``
+
+        :rtype: ``dict``
         """
         vm = self._get_vm_elements(vapp_or_vm_id)[vm_num]
         try:


Mime
View raw message