Built-in Modules

Note

This document lists all available built-in modules.

Overview

Purpose

A module in Sysinspect is a standalone executable that receives JSON on stdin and returns JSON on stdout. Modules can inspect, enforce, or query system state — from installing packages to managing firewall rules.

Module Types

  • Control modules are Rust (or Lua) binaries that perform a specific system operation.

  • Runtime modules execute user-written scripts (Lua, Python, Wasm) in a sandboxed environment inside the Sysinspect ecosystem.

Important

Refer to the communication protocol in chapter Communication Protocol.

System (sys.*)

Core system operations: processes, packages, services, users, commands, and network interfaces.

Module

Purpose

sys.run

Run arbitrary local commands with env/STDIN control

sys.ssrun

Run commands on remote hosts over SSH

sys.proc

Inspect and manage processes (search, start, stop)

sys.pkg

Cross-platform package management (install/remove/query)

sys.service | Cross-platform service management (start/stop/enable)

sys.user

Manage users and groups (create/modify/delete)

sys.net

Query network interfaces, routes, and addresses

Filesystem (fs.*)

State enforcement for files, directories, content, and symlinks.

Module

Purpose

fs.file

Create, copy, delete, inspect files. Content line ops.

fs.dir

Ensure directory state with mode, uid, gid

Configuration (cfg.*)

Artifact push/pull between master and minions.

Module

Purpose

cfg.resource

Push/pull configuration artifacts to/from the master

Network (net.*)

Outbound network operations and firewall management.

Module

Purpose

net.http

One-shot HTTP client with auth, TLS, and JSON parsing

net.ipfw

Cross-platform firewall rules (pf, ipfw, nftables, iptables)

Operating System (os.*)

Kernel-level and system-facts introspection.

Module

Purpose

os.kernel

Kernel module management (load/unload/list)

os.facts

Collect system hardware and software facts

Runtime

Sandboxed script execution in Lua, Python, and Wasm. Each runtime provides isolation, portability, and language-specific libraries.

Module

Purpose

runtime.lua

Lua 5.4 runtime with full stdlib and site-packages

runtime.py3

Python 3.14 runtime with site-packages support