From 37b55c6f8fd3b19fddf0cc45233a5cb007116995 Mon Sep 17 00:00:00 2001
From: dlavigne <dru@freebsd.org>
Date: Thu, 11 Feb 2016 12:06:36 -0500
Subject: [PATCH] Doc df action.

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

diff --git a/api/classes/iocage.rst b/api/classes/iocage.rst
index 2ae47bb..3c750a9 100644
--- a/api/classes/iocage.rst
+++ b/api/classes/iocage.rst
@@ -20,7 +20,7 @@ Every iocage class request contains the following parameters:
 | namespace                       | sysadm        |                                                                                                                      |
 |                                 |               |                                                                                                                      |
 +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
-| action                          |               | supported actions include "getdefaultsettings", "listjails", "getjailsettings", "startjail", "stopjail",             |
+| action                          |               | supported actions include "getdefaultsettings", "listjails", "getjailsettings", "df", "startjail", "stopjail",       |
 |                                 |               | "capjail", "clonejail", "createjail", "destroyjail", "cleanjails", "cleanreleases", "cleantemplates", "cleanall",    |
 |                                 |               | "activatepool", and "deactivatepool"                                                                                 |
 |                                 |               |                                                                                                                      |
@@ -653,6 +653,68 @@ The "getjailsettings" action lists all of the settings that apply to the specifi
   "namespace": "sysadm"
  }
  
+.. index:: df, iocage
+
+.. _List Resource Usage:
+
+List Resource Usage
+===================
+
+The "df" action lists resource usage for all jails. For each jail, the response includes: CRT (compression ratio), RES (reserved space), QTA (disk quota), USE (used space), AVA (available
+space), and TAG (jail name).
+
+**REST Request**
+
+.. code-block:: json 
+
+ PUT /sysadm/iocage
+ {
+   "action" : "df"
+ }
+
+**WebSocket Request**
+
+.. code-block:: json 
+
+ {
+   "namespace" : "sysadm",
+   "name" : "iocage",
+   "id" : "fooid",
+   "args" : {
+      "action" : "df"
+   }
+ }
+
+**Response**
+
+.. code-block:: json 
+
+ {
+  "args": {
+    "df": {
+      "f250ab25-d062-11e5-8209-d05099728dbf": {
+        "ava": "83.4G",
+        "crt": "2.30x",
+        "qta": "none",
+        "res": "none",
+        "tag": "test",
+        "use": "1.69M"
+      },
+      "f39318ae-d064-11e5-8209-d05099728dbf": {
+        "ava": "83.4G",
+        "crt": "2.30x",
+        "qta": "none",
+        "res": "none",
+        "tag": "test2",
+        "use": "1.69M"
+      }
+    }
+  },
+  "id": "fooid",
+  "name": "response",
+  "namespace": "sysadm"
+ }
+ 
 .. index:: startjail, iocage
 
 .. _Start a Jail: