Document listisos action.

This commit is contained in:
dlavigne
2016-03-03 09:28:40 -05:00
parent 1b0cd22e84
commit 682215f6a1

View File

@@ -20,8 +20,8 @@ Every iohyve class request contains the following parameters:
| namespace | sysadm | |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| action | | supported actions include "listvms", "fetchiso", "renameiso", "rmiso", "setup", "issetup", "create", "install", |
| | | "start", "stop" |
| action | | supported actions include "listvms", "fetchiso", "listisos", "renameiso", "rmiso", "setup", "issetup", "create", |
| | | "install", "start", "stop" |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
@@ -148,6 +148,52 @@ The "fetchiso" action is used to retrieve the installation ISO. It is used with
"namespace": "sysadm"
}
.. index:: listisos, iohyve
.. _List ISOs:
List ISOs
=========
The "listisos" action lists all the known ISO files which iohyve can use.
**REST Request**
.. code-block:: json
PUT /sysadm/iohyve
{
"action" : "listisos"
}
**WebSocket Request**
.. code-block:: json
{
"name" : "iohyve",
"namespace" : "sysadm",
"id" : "fooid",
"args" : {
"action" : "listisos"
}
}
**Response**
.. code-block:: json
{
"args": {
"listisos": [
"TRUEOS10.2-RELEASE-08-19-2015-x64-netinstall.iso"
]
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. index:: renameiso, iohyve
.. _Rename ISO: