Skip to Content

System

Load, memory and disks, and power.

OperationKindHTTP
system.statscallGET /v1/stats
system.powercallPOST /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

FieldTypeDescription
coresnumber[]
cpunumberPercent busy over 200 ms, all cores together.
filesystemsFilesystem[]
gpus (optional)Gpu[]
hostnamestring
loadnumber[]
memoryMemory
networkInterface[]
reboot_requiredboolean
sessions_runninginteger
swapMemory
unitsUnitState[]
uptimeintegerSeconds.
Request
{
  "id": 1,
  "op": "system.stats"
}
Reply
{
  "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

NameWhereRequiredDescription
verbpathyesreboot or poweroff.
forcequerynotrue to do it although sessions run.

Result

FieldTypeDescription
okboolean
Request
{
  "id": 1,
  "op": "system.power",
  "args": {
    "verb": "reboot"
  }
}
Reply
{
  "id": 1,
  "result": {
    "ok": true
  }
}

Types

The named types used on this page.

Filesystem

FieldTypeDescription
availableinteger
devicestring
kindstring
mountstring
totalinteger
usedinteger

Gpu

FieldTypeDescription
memory_totalinteger
memory_usedinteger
namestring
utilizationnumberPercent.

Memory

FieldTypeDescription
availableinteger
totalinteger
usedinteger

Interface

FieldTypeDescription
namestring
rx_bytesinteger
tx_bytesinteger

UnitState

FieldTypeDescription
activestring
unitstring

On this page