shtops_* — SHTops host operations

The SHTops ops-host tool namespace — service control, status, system info, process and task listings, and the shell workhorse for the SHTops host.

The shtops_* family operates the SHTops ops host (10.10.0.24) — the machine running LibreNMS alerting, the UniFi cache, and the shtops-dashboard API. It’s a distinct namespace because SHTops is a separate ops surface from Leif and nvrbackup: don’t reach it with local_* (that’s Leif) or remote_* (that’s nvrbackup). See SHTops for the host itself.

Shell & services

shtops_execute_command

shtops_execute_command(command, timeout=30)

The general shell on the SHTops host. Since there are no shtops_read_file / shtops_write_file tools, file work goes through here (cat, heredoc, etc.).

shtops_check_service / shtops_restart_service

shtops_check_service(service_name)
shtops_restart_service(service_name)

Status and restart for a systemd unit on SHTops — e.g. the shtops-dashboard service on :5000.

Status & inventory

shtops_get_status

shtops_get_status(mode="compact")

The headline health read for SHTops. mode defaults to compact; widen it for more detail.

shtops_get_system_info

shtops_get_system_info()

shtops_list_processes

shtops_list_processes()

Lists high-memory processes — the quick way to spot a runaway on SHTops.

shtops_list_tasks

shtops_list_tasks()

The supported automation tasks SHTops exposes. Check here before scripting something by hand — there may already be a task for it.

Bootstrap

shtops_bootstrap

shtops_bootstrap(include_content=True)

A compatibility alias for bootstrap_context(scope="shtops") — loads the SHTops living docs and latest handoff. Prefer this (or bootstrap_context) at the start of SHTops-scoped work so you’re operating from current state. See Memory & State.

  • SHTops — the host: dashboard, LibreNMS, UniFi cache
  • unifi — the UniFi data cached on this host
  • Shell & file tools — the other host-scoped shell families
  • obs-01 — the observability host that watches SHTops