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

Browse Source
This commit is contained in:
dlavigne
2016-01-26 10:46:28 -05:00
parent 70b8cd31ed
commit 2d407775b4
1 changed files with 93 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

95
api/classes/iocage.rst
View File

@@ -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"
}