diff --git a/api/classes/iohyve.rst b/api/classes/iohyve.rst index 42db703..a27d3b8 100644 --- a/api/classes/iohyve.rst +++ b/api/classes/iohyve.rst @@ -20,7 +20,7 @@ Every iohyve class request contains the following parameters: | namespace | sysadm | | | | | | +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ -| action | | supported actions include "listvms", "fetchiso" | +| action | | supported actions include "listvms", "fetchiso", "renameiso" | | | | | +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ @@ -145,4 +145,55 @@ The "fetchiso" action is used to retrieve the installation ISO. It is used with "id": "fooid", "name": "response", "namespace": "sysadm" + } + +.. index:: renameiso, iohyve + +.. _Rename ISO: + +Rename ISO +========== + +The "renameiso" action is used to to rename an existing ISO file on disk. Specify the existing name with "source" and the new name with "target". + +**REST Request** + +.. code-block:: json + + PUT /sysadm/iohyve + { + "source" : "test.iso", + "target" : "102.iso", + "action" : "renameiso" + } + +**WebSocket Request** + +.. code-block:: json + + { + "args" : { + "target" : "102.iso", + "source" : "test.iso", + "action" : "renameiso" + }, + "id" : "fooid", + "name" : "iohyve", + "namespace" : "sysadm" + } + +**Response** + +.. code-block:: json + + { + "args": { + "renameiso": { + "source": "test.iso", + "target": "102.iso" + } + }, + "id": "fooid", + "name": "response", + "namespace": "sysadm" } \ No newline at end of file