TrueNAS CE for Home Assistant (Marketplace integration)

Installs: 378 sharing analytics
GitHub stars: 55
Connection: Works locally
Upkeep: Updated in the last 6 months
Version: v2.13.0, October 26, 2026
Category: Computers and network, NAS and servers
Kind: Marketplace integration
Brand: TrueNAS
Needs: Needs the Marketplace (HACS on 2026.10 and older)
Domain: truenas_ce
Source: github.com/kayl-codes/homeassistant-truenas
Issues: Report an issue

Independent directory, made by the developer of Vulpo. Not affiliated with Home Assistant or the Open Home Foundation.

About

TrueNAS CE is an integration that monitors and controls a TrueNAS Community Edition system from Home Assistant. It talks to the TrueNAS instance locally using an API key and needs TrueNAS 25.04 or newer. It adds sensors for system load, memory, temperature, uptime, pools, datasets, disks, network interfaces, alerts and certificate expiry, plus binary sensors, buttons, switches and update entities. Actions can start or stop services, virtual machines, containers and apps, run cloud sync, rsync, replication and snapshot tasks, create a dataset snapshot, and reboot or shut down the system. Event-driven push updates cover several areas, with a fallback to polling, and the poll interval, data size unit and monitored groups can be adjusted in the options. It is set up in the UI, and Home Assistant can discover it on the network.

Automatic summary of the README and code of kayl-codes/homeassistant-truenas. Something wrong, or are you the maintainer and want your own text here? Get in touch

Supports

Works locally Talks to your devices on your own network. No vendor cloud in between.
Found by itself Home Assistant spots it on the network and offers to add it.
From the Marketplace Installed through the Marketplace, formerly HACS.
Actively maintained Its author released or pushed a change in the last six months.

Provides

Switches
Sensors

Setting it up

Install it from the Marketplace and restart Home Assistant, then add it under Settings, Devices and services.

Connect

Name of the integrationA friendly name to tell this TrueNAS instance apart from others, if you set up more than one.
HostThe hostname or IP address of your TrueNAS instance, without "https://", path or trailing slash.
API keyAn API key generated in TrueNAS under Credentials > API Keys. Leave blank to keep a previously configured key when taking over an existing configuration.
Verify SSL certificateVerify the TrueNAS instance's SSL certificate. Disable only if you use a self-signed certificate you cannot otherwise validate.
Skip disabled cronjobsExclude cron jobs that are disabled in TrueNAS from monitoring; no sensor entities are created for them.
Data size unit (GB or GiB)Choose whether data sizes are displayed using decimal (GB) or binary (GiB) units.

Reauthenticate TrueNAS

API keyThe new API key generated in TrueNAS under Credentials > API Keys.

Change the connection

HostThe hostname or IP address of your TrueNAS instance, without "https://", path or trailing slash.
API keyAn API key generated in TrueNAS under Credentials > API Keys. Leave blank to keep the current key unchanged.
Verify SSL certificateVerify the TrueNAS instance's SSL certificate. Disable only if you use a self-signed certificate you cannot otherwise validate.
Skip disabled cronjobsExclude cron jobs that are disabled in TrueNAS from monitoring; no sensor entities are created for them.
Data size unit (GB or GiB)Choose whether data sizes are displayed using decimal (GB) or binary (GiB) units.
Add/update dataset passphrasesEnter DatasetName#PassPhrase pairs (one per line, e.g. tank/encrypted#MySecret) to add or update stored passphrases. Leave empty to keep existing passphrases unchanged. Use the passphrase_remove action to delete a stored passphrase by its dataset path.

After setup

Poll interval (seconds)How often, in seconds, to poll the TrueNAS instance for updated data.
Data size unitChoose whether data sizes are displayed using decimal (GB) or binary (GiB) units.
BehaviourSelect which behaviours are active
Monitored groupsDeselect groups you do not use to reduce sensor count

Texts from the code of kayl-codes/homeassistant-truenas.

Entities

Binary sensorsDisk/Pool issues, healthy, Link, Expired
ButtonsClean up orphaned statistics, Roll back migration, Refresh data, Run scrub, Pause scrub, Resume scrub, Stop scrub, Run
SensorsAlerts, SMB connections, Uptime, Temperature, CPU load shortterm, CPU load midterm, CPU load longterm, CPU usage, Memory usage, ARC size, Memory total, Memory free, and 30 more
SwitchesEnabled

Actions

Cloudsync runStart a cloudsync job (target the cloudsync sensor).
Cloudsync abortAbort a running cloudsync job (target the cloudsync sensor).
Rsync runStart an rsync task on demand (target the rsync task sensor).
Replication runStart a replication task on demand (target the replication sensor).
Snapshot task runRun a periodic snapshot task now (target the snapshot task sensor). Note: if the task's naming schema only has minute resolution (e.g. auto-%Y-%m-%d_%H-%M), running it twice within the same minute fails on TrueNAS because the snapshot name already exists.
Create dataset snapshotCreate an on-demand ZFS snapshot of the targeted dataset. The snapshot is taken immediately and named "custom-" followed by a timestamp, independent of any periodic snapshot task (target a dataset sensor).
Reboot TrueNASReboot the TrueNAS system (target the Uptime sensor).
Shut down TrueNASShut down the TrueNAS system (target the Uptime sensor).
Refresh TrueNAS dataForce an immediate re-poll of TrueNAS so automations can act on current data without waiting for the next poll (target the Uptime sensor).
Service startStart a TrueNAS service (target the service binary sensor).
Service stopStop a TrueNAS service (target the service binary sensor).
Service restartRestart a TrueNAS service (target the service binary sensor).
Service reloadReload a TrueNAS service (target the service binary sensor).
VM startStart a virtual machine (target the VM binary sensor).Fields: Overcommit memory
VM stopStop a virtual machine (target the VM binary sensor).Fields: Force
VM restartRestart a virtual machine (target the VM binary sensor).
Container startStart a container (Incus instance; target the container binary sensor).
Container stopStop a container (Incus instance; target the container binary sensor).
Container restartRestart a container (Incus instance; target the container binary sensor).
App startStart an app (target the app binary sensor).

Troubleshooting

DiagnosticsDownloads a diagnostics file to attach to a bug report.
Repair noticesNotices it can show in Settings, Repairs:Orphaned TrueNAS statistics, TrueNAS CE migration — rollback available, TrueNAS CE migration rollback failed, Old TrueNAS integration left behind

From the README

Note: This is an independent integration, originally forked from the
and now maintained as a standalone project. See the Changelog for a summary of everything that has changed per version.
CPU usage (%)
Memory (bytes)
Network RX/TX per interface (bytes/sec)
Block I/O Read/Write (bytes)

From the README of kayl-codes/homeassistant-truenas, Apache License 2.0. Shortened.