Commit Graph

33 Commits

Author SHA1 Message Date
dlavigne
922ceaea43 Doc startupdate action. 2016-02-02 09:23:09 -05:00
dlavigne
d637759e1b Doc getjailsettings action. 2016-02-01 09:57:33 -05:00
dlavigne
e4ca592edc Doc getdefaultsettings action. 2016-02-01 09:49:34 -05:00
dlavigne
f8df6d4325 Clarify UUID and type. 2016-01-26 11:29:53 -05:00
dlavigne
2d407775b4 Doc listjails action. 2016-01-26 10:46:28 -05:00
dlavigne
70b8cd31ed Doc listbranches action. 2016-01-26 10:31:04 -05:00
dlavigne
7c2f15717d Doc systeminfo action. 2016-01-26 10:15:25 -05:00
dlavigne
5abd03bf7c Update to memorystats. 2016-01-26 09:31:31 -05:00
dlavigne
30f12740bc Doc cputemps action. 2016-01-22 10:35:04 -05:00
dlavigne
174f0bc815 Doc cpupercentage action. 2016-01-22 10:28:15 -05:00
dlavigne
3b51062f74 Doc memorypercentage action. 2016-01-22 10:21:36 -05:00
Kris Moore
609bba2ded New API call to get a listing of all the CPU temps on the system,
if the "coretemp" module isn't loaded, it will be loaded beforehand

REST Request:
-------------------------------
PUT /sysadm/systeminfo
{
   "action" : "cputemps"
}

REST Response:
-------------------------------
{
    "args": {
        "cputemps": {
            "cpu0": "27.0C",
            "cpu1": "34.0C",
            "cpu2": "33.0C",
            "cpu3": "31.0C"
        }
    }
}

WebSocket Request:
-------------------------------
{
   "args" : {
      "action" : "cputemps"
   },
   "id" : "fooid",
   "name" : "systeminfo",
   "namespace" : "sysadm"
}

WebSocket Response:
-------------------------------
{
  "args": {
    "cputemps": {
      "cpu0": "34.0C",
      "cpu1": "32.0C",
      "cpu2": "34.0C",
      "cpu3": "31.0C"
    }
  },
  "id": "fooid",
  "name": "response",
  "namespace": "sysadm"
}
2016-01-21 12:58:12 -05:00
dlavigne
9b065a1937 Doc batteryinfo action. 2016-01-20 13:57:07 -05:00
dlavigne
783bca9dbf Doc new systeminfo class. 2016-01-20 13:08:51 -05:00
dlavigne
f2daaddea6 Doc checkupdates action. While here, fix formatting error. 2016-01-19 13:13:35 -05:00
dlavigne
fd4c33a660 Add index entries. 2016-01-15 15:16:54 -05:00
dlavigne
9af179294b Doc runreplication task. 2016-01-15 15:06:06 -05:00
dlavigne
4f14d76418 Doc removereplication action. 2016-01-15 14:40:33 -05:00
dlavigne
7024f74a34 Doc listreplication action. 2016-01-15 14:29:29 -05:00
dlavigne
536ff32d47 Doc initreplication action. 2016-01-15 12:22:58 -05:00
dlavigne
9f2dfc91a9 Doc addreplication action. 2016-01-13 10:01:41 -05:00
dlavigne
5d834fabbd Doc savesettings action. 2016-01-12 14:57:45 -05:00
dlavigne
87196e7053 Doc removesnap action. 2016-01-12 14:17:24 -05:00
dlavigne
ddf29f2148 Document revertsnap action. 2016-01-12 14:10:11 -05:00
dlavigne
dfbfb3afb1 Update listcron example to include scrubs. 2016-01-12 13:28:15 -05:00
dlavigne
bb88295d44 Document cronscrub action. 2016-01-12 13:17:48 -05:00
dlavigne
97c0c1912d Format cronsnap parameters as a table. 2016-01-12 12:44:38 -05:00
Kris Moore
cbf3ce8b8b Add new API call to schedule a cron scrub
Frequency Options: none, daily@XX, weekly@YY@XX, monthly@ZZ@XX
XX = Hour to execute, YY = Day of week to execute, ZZ = Day of month

REST Request:
-------------------------------
PUT /sysadm/lifepreserver
{
   "action" : "cronscrub",
   "pool" : "tank",
   "frequency" : "daily@22"
}

REST Response:
-------------------------------
{
    "args": {
        "cronscrub": {
            "frequency": "daily@22",
            "pool": "tank"
        }
    }
}

WebSocket Request:
-------------------------------
{
   "args" : {
      "action" : "cronscrub",
      "pool" : "tank",
      "frequency" : "daily@22"
   },
   "namespace" : "sysadm",
   "name" : "lifepreserver",
   "id" : "fooid"
}

WebSocket Response:
-------------------------------
{
  "args": {
    "cronscrub": {
      "frequency": "daily@22",
      "pool": "tank"
    }
  },
  "id": "fooid",
  "name": "response",
  "namespace": "sysadm"
}
2016-01-12 12:12:19 -05:00
dlavigne
4595487578 Doc 3 more API actions. 2016-01-11 11:11:11 -05:00
dlavigne
25ecc6f813 Add first action for lifepresever class. 2016-01-07 11:43:17 -05:00
dlavigne
4ee7c0e70d Finish formatting packages class. 2015-12-09 09:57:17 -05:00
dlavigne
538ba5cc1d Start reformat of packages to fit layout. 2015-12-08 15:12:06 -05:00
Kris Moore
611b5f45cc Move over the API docs from pcbsd repo 2015-12-08 14:44:47 -05:00