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

Browse Source
This commit is contained in:
dlavigne
2016-01-22 10:21:36 -05:00
parent f8f8762616
commit 3b51062f74
1 changed files with 61 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
api/classes/systeminfo.rst
View File

@@ -18,12 +18,70 @@ The systeminfo class is used to retrieve information about the system. Every sys
| namespace | sysadm | |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| action | | supported actions include "batteryinfo", "externalmounts" |
| action | | supported actions include "memorypercentage", "batteryinfo", "externalmounts" |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
The rest of this section provides examples of the available *actions* for each type of request, along with their responses.
.. index:: memorypercentage, systeminfo
.. _Memory Usage:
Memory Usage
============
The "memorypercentage" action returns the total memory in use.
**REST Request**
.. code-block:: json
PUT /sysadm/systeminfo
{
"action" : "memorypercentage"
}
**REST Response**
.. code-block:: json
{
"args": {
"memorypercentage": {
"memoryused": 42
}
}
}
**WebSocket Request**
.. code-block:: json
{
"id" : "fooid",
"args" : {
"action" : "memorypercentage"
},
"namespace" : "sysadm",
"name" : "systeminfo"
}
**WebSocket Response**
.. code-block:: json
{
"args": {
"memorypercentage": {
"memoryused": 42
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. index:: batteryinfo, systeminfo
.. _Battery Information:
@@ -31,9 +89,8 @@ The rest of this section provides examples of the available *actions* for each t
Battery Information
===================
The "batteryinfo" action will indicate whether or not a battery exists. If it does, it will also report its current charge percentage level (1-99) and its
status (offline, charging, on backup, or unknown) and estimated time left (in seconds)
timeleft (1-XXXXXX)
The "batteryinfo" action will indicate whether or not a battery exists. If it does, it will also report its current charge percentage level (1-99). its
status (offline, charging, on backup, or unknown), and estimated time left (in seconds).
**REST Request**