truenas-jsonrpc-debug

Community

Debug TrueNAS NVMe and storage via JSON-RPC.

Authoraldengolab
Version1.0.0
Installs0

System Documentation

What problem does it solve?

The TrueNAS REST API is deprecated as of v25.10 and all queries now go through a JSON-RPC 2.0 WebSocket endpoint, enabling direct diagnostics of NVMe-oF, pools, datasets, and service status from within Kubernetes debugging sessions.

Core Features & Use Cases

  • Unified diagnostic access: NVMe subsystem, ports, namespaces, pool health, and CSI datasets via a single client.
  • Creds automation: extracts host/port and API key from cluster secrets and supports optional username for authenticated API calls.
  • Reusable in CI and debugging: script-driven workflow that can be invoked across clusters to verify health and provisioning state.

Quick Start

Install the required Python dependencies and run the truenas_query.py script with --diag all using the generated creds file.

Dependency Matrix

Required Modules

websocketspyyaml

Components

scripts

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: truenas-jsonrpc-debug
Download link: https://github.com/aldengolab/lorist/archive/main.zip#truenas-jsonrpc-debug

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.