diff --git a/api/classes/iocage.rst b/api/classes/iocage.rst index f8be2d7..0150f91 100644 --- a/api/classes/iocage.rst +++ b/api/classes/iocage.rst @@ -1,7 +1,98 @@ .. _iocage: iocage -====== +****** -Some intro text here... +The iocage class is used to manage jails which provide a light-weight, operating system-level virtualization for running applications or services. +Every iocage class request contains the following parameters: + ++---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ +| **Parameter** | **Value** | **Description** | +| | | | ++=================================+===============+======================================================================================================================+ +| id | | any unique value for the request; examples include a hash, checksum, or uuid | +| | | | ++---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ +| name | iocage | | +| | | | ++---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ +| namespace | sysadm | | +| | | | ++---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ +| action | | supported actions include "listjails" | +| | | | ++---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ + +The rest of this section provides examples of the available *actions* for each type of request, along with their responses. + +.. index:: listjails, iocage + +.. _List Jails: + +List Jails +========== + +The "listjails" action lists information about currently installed jails. For each jail, the response includes whether or not the jail has been configured to start at system boot, the jail +ID (only applies to running jails), whether or not the jail is running, a friendly name for the jail (tag), and the type of jail. + +**REST Request** + +.. code-block:: json + + PUT /sysadm/iocage + { + "action" : "listjails" + } + +**REST Response** + +.. code-block:: json + + { + "args": { + "listjails": { + "611c89ae-c43c-11e5-9602-54ee75595566": { + "boot": "off", + "jid": "-", + "state": "down", + "tag": "testjail", + "type": "basejail" + } + } + } + } + +**WebSocket Request** + +.. code-block:: json + + { + "args" : { + "action" : "listjails" + }, + "name" : "iocage", + "id" : "fooid", + "namespace" : "sysadm" + } + +**WebSocket Response** + +.. code-block:: json + + { + "args": { + "listjails": { + "611c89ae-c43c-11e5-9602-54ee75595566": { + "boot": "off", + "jid": "-", + "state": "down", + "tag": "testjail", + "type": "basejail" + } + } + }, + "id": "fooid", + "name": "response", + "namespace": "sysadm" + }