From 40f629230a62640add523d992d8e4ee4958f3e6c Mon Sep 17 00:00:00 2001
From: dlavigne <dru@freebsd.org>
Date: Thu, 4 Feb 2016 12:43:29 -0500
Subject: [PATCH] Doc deactivatepool action.

---
 api/classes/iocage.rst | 64 ++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 62 insertions(+), 2 deletions(-)

diff --git a/api/classes/iocage.rst b/api/classes/iocage.rst
index 425e718..81d79f1 100644
--- a/api/classes/iocage.rst
+++ b/api/classes/iocage.rst
@@ -21,7 +21,7 @@ Every iocage class request contains the following parameters:
 |                                 |               |                                                                                                                      |
 +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
 | action                          |               | supported actions include "getdefaultsettings", "listjails", "getjailsettings", "startjail", "stopjail",             |
-|                                 |               | "activatepool"                                                                                                       |
+|                                 |               | "activatepool", and "deactivatepool"                                                                                 |
 |                                 |               |                                                                                                                      |
 +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
 
@@ -905,4 +905,64 @@ These examples show responses when the pool is not specified:
   "id": "fooid",
   "name": "response",
   "namespace": "sysadm"
- }
\ No newline at end of file
+ }
+ 
+ .. index:: deactivatepool, iocage
+
+.. _Deactivate a Pool:
+
+Deactivate a Pool
+=================
+
+The "deactivatepool" action can be used to prevent jail creation on the specified ZFS pool. 
+
+**REST Request**
+
+.. code-block:: json
+
+ PUT /sysadm/iocage
+ {
+   "action" : "deactivatepool",
+   "pool" : "tank"
+ }
+
+**REST Response**
+
+.. code-block:: json
+
+ {
+    "args": {
+        "deactivatepool": {
+            "success": "pool tank deactivated."
+        }
+    }
+ }
+
+**WebSocket Request**
+
+.. code-block:: json
+
+ {
+   "id" : "fooid",
+   "name" : "iocage",
+   "args" : {
+      "pool" : "tank",
+      "action" : "deactivatepool"
+   },
+   "namespace" : "sysadm"
+ }
+
+**WebSocket Response**
+
+.. code-block:: json
+
+ {
+  "args": {
+    "deactivatepool": {
+      "success": "pool tank deactivated."
+    }
+  },
+  "id": "fooid",
+  "name": "response",
+  "namespace": "sysadm"
+ }