diff --git a/api/classes/iohyve.rst b/api/classes/iohyve.rst index 57cffde..8343c85 100644 --- a/api/classes/iohyve.rst +++ b/api/classes/iohyve.rst @@ -21,7 +21,7 @@ Every iohyve class request contains the following parameters: | | | | +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ | action | | supported actions include "listvms", "fetchiso", "renameiso", "rmiso", "setup", "issetup", "create", "install", | -| | | "stop" | +| | | "start", "stop" | | | | | +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ @@ -447,6 +447,54 @@ run :command:`iohyve console ` from the system. "namespace": "sysadm" } +.. index:: start, iohyve + +.. _Start VM: + +Start VM +======== + +The "start" action starts the specified VM. + +**REST Request** + +.. code-block:: json + + PUT /sysadm/iohyve + { + "action" : "start", + "name" : "bsdguest" + } + +**WebSocket Request** + +.. code-block:: json + + { + "name" : "iohyve", + "id" : "fooid", + "args" : { + "action" : "start", + "name" : "bsdguest" + }, + "namespace" : "sysadm" + } + +**Response** + +.. code-block:: json + + { + "args": { + "start": { + "name": "bsdguest" + } + }, + "id": "fooid", + "name": "response", + "namespace": "sysadm" + } + .. index:: stop, iohyve .. _Stop VM: