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 deactivatepool action.

Browse Source
This commit is contained in:
dlavigne
2016-02-04 12:43:29 -05:00
parent b848d76be0
commit 40f629230a
1 changed files with 62 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
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", |
| | | "activatepool" |
| | | "activatepool", and "deactivatepool" |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
@@ -905,4 +905,64 @@ These examples show responses when the pool is not specified:
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
}
.. 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"
}