Diagnose the connection to TrueNAS: shows the configured URL, whether an API key is present (never the key itself), which API generation was detected (WebSocket JSON-RPC vs legacy REST), and whether authentication succeeded. Call this first when any other truenas_ tool fails.

Get system information from TrueNAS: product version, hostname, uptime, CPU model and core count, physical memory, load averages, boot time, and timezone.

List all ZFS storage pools with health status (ONLINE/DEGRADED/FAULTED), capacity (size, allocated, free, usage %), fragmentation, and any running scrub/resilver. The first stop for 'how are my pools?' or 'how full is my NAS?'.

List ZFS datasets (filesystems and zvols) with space used/available, snapshot usage, quota, compression, and mountpoint. Filter by pool and paginate for large systems.

List current TrueNAS alerts (warnings, errors, hardware problems, update notices). By default hides alerts the user already dismissed. Use min_level to only see serious ones.

List physical disks with model, serial number, size, type (HDD/SSD), which pool each belongs to, and optionally the current temperature in °C (readings are cached ~5 minutes by TrueNAS).

List TrueNAS services (SMB, NFS, SSH, iSCSI, ...) with running state and whether they start on boot.

List TrueNAS background jobs (scrubs, replications, updates, ...), most recent first, with state (WAITING/RUNNING/SUCCESS/FAILED/ABORTED), progress percent, and errors. Use state=RUNNING to see what the NAS is doing right now, state=FAILED to find recent failures.

List ZFS snapshots with creation time and space used. Systems often have thousands of snapshots — filter by dataset and paginate. Works across TrueNAS versions (the underlying API differs; this tool picks the right one automatically).

Check whether a TrueNAS base-OS (system) update is available, and whether the system is waiting on a reboot. Reports the current version and, if an update exists, the candidate version and release notes. Note: this covers the TrueNAS OS only — it does NOT check for app/catalog updates.

List installed TrueNAS apps (the Docker-based Apps catalog, 24.10+) with their running state, current version, and — the key part — whether an app or catalog update is available (upgrade_available / image_updates_available). Also reports the Docker backend's status. This is the app-level counterpart to truenas_check_updates, which only covers the base OS.

List configured ZFS replication tasks (backup jobs that send snapshots to another dataset or a remote box) with direction, transport, whether they're enabled, and last-run state. Unlike truenas_list_jobs, this shows the task CONFIGURATION even when nothing is running.

List configured cloud sync tasks (backups to/from S3, Google Drive, Backblaze, etc.) with local path, direction, provider, schedule, and last-run state. Credentials, tokens, and secrets are deliberately never included.

List all configured file and block shares in one call: SMB shares, NFS exports, and iSCSI targets, each with their name/path and enabled state. Answers 'what is this NAS actually serving?'.

Compact network health view: a summary of IP addresses per interface, default routes, and DNS nameservers, plus per-interface type, link state, MAC, addresses, and MTU. The first stop for 'is the NAS's networking okay?' or diagnosing a down NIC.

List configured periodic (automatic) snapshot tasks with their dataset, retention policy, schedule, and whether they're enabled. truenas_list_snapshots shows the snapshots that EXIST; this shows whether an automatic snapshot POLICY is actually running.

List scheduled pool scrub tasks with their pool, schedule, threshold (minimum days between scrubs), and enabled state. Complements truenas_list_pools, which shows a scrub only while it's running.

List virtual machines with their run state, autostart, vCPU/memory allocation, bootloader, and a device summary (disk/NIC counts, whether a display is attached). Device details, including any VNC display password, are deliberately omitted.