From 85de30526f31a3422e265dd6f766de099f3019cc Mon Sep 17 00:00:00 2001
From: dlavigne <dru@freebsd.org>
Date: Mon, 28 Mar 2016 09:50:29 -0400
Subject: [PATCH] Doc getprops action.

---
 api/classes/iohyve.rst | 65 +++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 64 insertions(+), 1 deletion(-)

diff --git a/api/classes/iohyve.rst b/api/classes/iohyve.rst
index 9575a59..0b04431 100644
--- a/api/classes/iohyve.rst
+++ b/api/classes/iohyve.rst
@@ -21,7 +21,7 @@ Every iohyve class request contains the following parameters:
 |                                 |               |                                                                                                                      |
 +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
 | action                          |               | supported actions include "listvms", "fetchiso", "listisos", "renameiso", "rmiso", "setup",  "issetup", "create",    |
-|                                 |               | "install", "start", "stop", "delete", "adddisk", "listdisks", "resizedisk", "deletedisk", and "version"              |
+|                                 |               | "install", "start", "stop", "delete", "adddisk", "listdisks", "resizedisk", "deletedisk", "version", and "getprops"  |
 |                                 |               |                                                                                                                      |
 +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
 
@@ -886,4 +886,67 @@ The "version" action displays the iohyve version.
   "id": "fooid",
   "name": "response",
   "namespace": "sysadm"
+ }
+ 
+.. index:: getprops, iohyve
+
+.. _List Guest Properties:
+
+List Guest Properties
+=====================
+
+The "getprops" action lists the properties for the specified guest.
+
+**REST Request**
+
+.. code-block:: json
+
+ PUT /sysadm/iohyve
+ {
+   "action" : "getprops",
+   "name" : "bsdguest"
+ }
+
+**WebSocket Request**
+
+.. code-block:: json
+
+ {
+   "id" : "fooid",
+   "namespace" : "sysadm",
+   "args" : {
+      "name" : "bsdguest",
+      "action" : "getprops"
+   },
+   "name" : "iohyve"
+ }
+
+**Response**
+
+.. code-block:: json
+
+ {
+  "args": {
+    "getprops": {
+      "bsdguest": {
+        "autogrub": "\\n",
+        "bargs": "-A_-H_-P",
+        "boot": "0",
+        "con": "nmdm0",
+        "cpu": "1",
+        "description": "Tue",
+        "install": "no",
+        "loader": "bhyveload",
+        "name": "bsdguest",
+        "os": "default",
+        "persist": "1",
+        "ram": "256M",
+        "size": "10G",
+        "tap": "tap0"
+      }
+    }
+  },
+  "id": "fooid",
+  "name": "response",
+  "namespace": "sysadm"
  }
\ No newline at end of file