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

Browse Source
This commit is contained in:
dlavigne
2016-03-28 09:50:29 -04:00
parent d268651000
commit 85de30526f
1 changed files with 64 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
api/classes/iohyve.rst
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", "listdisks", "resizedisk", "deletedisk", and "version" |
| | | "install", "start", "stop", "delete", "adddisk", "listdisks", "resizedisk", "deletedisk", "version", and "getprops" |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
@@ -886,4 +886,67 @@ The "version" action displays the iohyve version.
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. index:: getprops, iohyve
.. _List Guest Properties:
List Guest Properties
=====================
The "getprops" action lists the properties for the specified guest.
**REST Request**
.. code-block:: json
PUT /sysadm/iohyve
{
"action" : "getprops",
"name" : "bsdguest"
}
**WebSocket Request**
.. code-block:: json
{
"id" : "fooid",
"namespace" : "sysadm",
"args" : {
"name" : "bsdguest",
"action" : "getprops"
},
"name" : "iohyve"
}
**Response**
.. code-block:: json
{
"args": {
"getprops": {
"bsdguest": {
"autogrub": "\\n",
"bargs": "-A_-H_-P",
"boot": "0",
"con": "nmdm0",
"cpu": "1",
"description": "Tue",
"install": "no",
"loader": "bhyveload",
"name": "bsdguest",
"os": "default",
"persist": "1",
"ram": "256M",
"size": "10G",
"tap": "tap0"
}
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}