System
Load, memory and disks, and power.
| Operation | Kind | HTTP |
|---|---|---|
system.stats | call | GET /v1/stats |
system.power | call | POST /v1/power/{verb} |
system.stats
Load, CPU, memory, filesystems, network, GPU and unit states, read now.
Host level only. Through rookery serve it needs the role view.
Result
| Field | Type | Description |
|---|---|---|
cores | number[] | |
cpu | number | Percent busy over 200 ms, all cores together. |
filesystems | Filesystem[] | |
gpus (optional) | Gpu[] | |
hostname | string | |
load | number[] | |
memory | Memory | |
network | Interface[] | |
reboot_required | boolean | |
sessions_running | integer | |
swap | Memory | |
units | UnitState[] | |
uptime | integer | Seconds. |
{
"id": 1,
"op": "system.stats"
}{
"id": 1,
"result": {
"cores": [
0
],
"cpu": 0,
"filesystems": [
{
"available": 0,
"device": "text",
"kind": "process",
"mount": "text",
"total": 0,
"used": 0
}
],
"hostname": "text",
"load": [
0
],
"memory": {
"available": 0,
"total": 0,
"used": 0
},
"network": [
{
"name": "status",
"rx_bytes": 0,
"tx_bytes": 0
}
],
"reboot_required": true,
"sessions_running": 0,
"swap": {
"available": 0,
"total": 0,
"used": 0
},
"units": [
{
"active": "text",
"unit": "rookeryd.service"
}
],
"uptime": 0
}
}system.power
Reboot the host or power it off. Refused while sessions run.
Host level only. Through rookery serve it needs the role operate.
Arguments
| Name | Where | Required | Description |
|---|---|---|---|
verb | path | yes | reboot or poweroff. |
force | query | no | true to do it although sessions run. |
Result
| Field | Type | Description |
|---|---|---|
ok | boolean |
{
"id": 1,
"op": "system.power",
"args": {
"verb": "reboot"
}
}{
"id": 1,
"result": {
"ok": true
}
}Types
The named types used on this page.
Filesystem
| Field | Type | Description |
|---|---|---|
available | integer | |
device | string | |
kind | string | |
mount | string | |
total | integer | |
used | integer |
Gpu
| Field | Type | Description |
|---|---|---|
memory_total | integer | |
memory_used | integer | |
name | string | |
utilization | number | Percent. |
Memory
| Field | Type | Description |
|---|---|---|
available | integer | |
total | integer | |
used | integer |
Interface
| Field | Type | Description |
|---|---|---|
name | string | |
rx_bytes | integer | |
tx_bytes | integer |
UnitState
| Field | Type | Description |
|---|---|---|
active | string | |
unit | string |