Doc deletedisk action.

This commit is contained in:
dlavigne
2016-03-03 13:49:57 -05:00
parent 1b46761032
commit 1edaf3ff6e

View File

@@ -21,7 +21,7 @@ Every iohyve class request contains the following parameters:
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| action | | supported actions include "listvms", "fetchiso", "listisos", "renameiso", "rmiso", "setup", "issetup", "create", |
| | | "install", "start", "stop", "delete", "adddisk", and "listdisks" |
| | | "install", "start", "stop", "delete", "adddisk", "listdisks", and "deletedisk" |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
@@ -735,4 +735,55 @@ The "listdisks" action lists the disks connected to the specified VM.
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. index:: deletedisk, iohyve
.. _Delete a Disk:
Delete a Disk
=============
The "deletedisk" action removes the specified disk from the specified VM.
**REST Request**
.. code-block:: json
PUT /sysadm/iohyve
{
"disk" : "disk1",
"name" : "bsdguest",
"action" : "deletedisk"
}
**WebSocket Request**
.. code-block:: json
{
"namespace" : "sysadm",
"id" : "fooid",
"name" : "iohyve",
"args" : {
"name" : "bsdguest",
"action" : "deletedisk",
"disk" : "disk1"
}
}
**Response**
.. code-block:: json
{
"args": {
"deletedisk": {
"disk": "disk1",
"name": "bsdguest"
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}