github-personal/sysadm
1
0
Fork 0
mirror of https://github.com/outbackdingo/sysadm.git synced 2026-01-27 10:20:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doc cleanjails action.

Browse Source
This commit is contained in:
dlavigne
2016-02-05 11:56:34 -05:00
parent 91358a6b35
commit 8760097189
1 changed files with 47 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
api/classes/iocage.rst
View File

@@ -21,7 +21,7 @@ Every iocage class request contains the following parameters:
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| action | | supported actions include "getdefaultsettings", "listjails", "getjailsettings", "startjail", "stopjail", |
| | | "capjail", "activatepool", and "deactivatepool" |
| | | "capjail", "cleanjails", "activatepool", and "deactivatepool" |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
@@ -839,6 +839,52 @@ the jail.
"namespace": "sysadm"
}
.. index:: cleanjails, iocage
.. _Clean Jails:
Clean Jails
===========
The "cleanjails" action destroys all existing jail datasets.
**REST Request**
.. code-block:: json
PUT /sysadm/iocage
{
"action" : "cleanjails"
}
**WebSocket Request**
.. code-block:: json
{
"namespace" : "sysadm",
"args" : {
"action" : "cleanjails"
},
"id" : "fooid",
"name" : "iocage"
}
**Response**
.. code-block:: json
{
"args": {
"cleanjails": {
"success": "All jails have been cleaned."
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. index:: activatepool, iocage
.. _Activate a Pool: