Document the 'session.get' vPoller method

dnaeon · Sep 24, 2014 · 7374c77 · 7374c77
1 parent 4dcc83d
commit 7374c77
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -174,3 +174,27 @@ specific ``Datastore``.
    $ vpoller-client --method datastore.host.get --vsphere-host vc01.example.org \
 		--name ds:///vmfs/volumes/5190e2a7-d2b7c58e-b1e2-90b11c29079d/
 		
+Viewing established Sessions
+============================
+
+vPoller can also be used for viewing the established
+sessions to your vSphere hosts.
+
+.. note::
+
+   Viewing vSphere sessions by unauthorized parties may be
+   considered as a security hole, as it may provide an attacker
+   with information such as Session IDs, which could be used for
+   spoofing a user's session.
+
+   If security is a concern make sure that your ``vSphere Agents`` are
+   configured to use an account with restricted set of privileges,
+   which cannot view the established vSphere sessions.
+
+Here is an example command that will return the established sessions
+for your vSphere host:
+
+.. code-block:: bash
+
+   $ vpoller-client --method session.get --vsphere-host vc01.example.org
+
diff --git a/docs/methods.rst b/docs/methods.rst
@@ -14,6 +14,8 @@ with description for each of them.
 +------------------------+--------------------------------------------------------------------------+
 | event.latest           | Get the latest registered event from a vSphere host                      |
 +------------------------+--------------------------------------------------------------------------+
+| session.get            | Get the established vSphere sessions                                     |
++------------------------+--------------------------------------------------------------------------+
 | net.discover           | Discover all vim.Network managed objects                                 |
 +------------------------+--------------------------------------------------------------------------+
 | net.get                | Get properties of a vim.Network managed object                           |