diff --git a/api/classes/iocage.rst b/api/classes/iocage.rst index 1b13d25..e0306ed 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" | +| action | | supported actions include "getdefaultsettings", "listjails", "getjailsettings", "startjail", "stopjail" | | | | | +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ @@ -653,7 +653,6 @@ The "getjailsettings" action lists all of the settings that apply to the specifi .. index:: startjail, iocage - .. _Start a Jail: Start a Jail @@ -718,4 +717,74 @@ The "startjail" action starts the specified jail. "id": "fooid", "name": "response", "namespace": "sysadm" + } + +.. index:: stopjail, iocage + +.. _Stop a Jail: + +Stop a Jail +=========== + +The "stopjail" action stops the specified jail. + +.. note:: since a jail can only be stopped once, you will receive an error if the jail is not running. + +**REST Request** + +.. code-block:: json + + PUT /sysadm/iocage + { + "action" : "stopjail", + "jail" : "test" + } + +**REST Response** + +.. code-block:: json + + { + "args": { + "stopjail": { + "test": { + "* Stopping 0bf985de-ca0f-11e5-8d45-d05099728dbf (test)": "", + "+ Removing jail process OK": "", + "+ Running post-stop OK": "", + "+ Running pre-stop OK": "", + "+ Stopping services OK": "" + } + } + } + } + +**WebSocket Request** + +.. code-block:: json + + { + "args" : { + "jail" : "test", + "action" : "stopjail" + }, + "namespace" : "sysadm", + "id" : "fooid", + "name" : "iocage" + } + +**WebSocket Response** + +.. code-block:: json + + { + "args": { + "stopjail": { + "test": { + "INFO": " 0bf985de-ca0f-11e5-8d45-d05099728dbf (test) is already down" + } + } + }, + "id": "fooid", + "name": "response", + "namespace": "sysadm" } \ No newline at end of file