README.md

TrueNAS Integration

Monitor and control your TrueNAS CORE/SCALE device from Home Assistant.

• Monitor System (Cpu, Load, Memory, Temperature, Network, ARC/L2ARC, Uptime)
• Monitor Disks
• Monitor Pools (including boot-pool)
• Monitor Datasets
• Monitor Replication Tasks
• Monitor Snapshot Tasks
• Control and Monitor Services
• Control and Monitor Virtual Machines
• Control and Monitor Jails (TrueNAS CORE only)
• Control and Monitor Cloudsync
• Create a Dataset Snapshot
• Update Sensor
• Reboot and Shutdown TrueNAS system

Features

Pools

Monitor status for each TrueNAS pool.

Datasets

Monitor usage and attributes for each TrueNAS dataset.

Disks

Monitor temperature and attributes for each TrueNAS disk.

Virtual Machines

Control and monitor status and attributes for each TrueNAS Virtual Machines. Virtual Machines control is available through services.

Jails

TrueNAS CORE only

Control and monitor status and attributes for each TrueNAS jail. Jail control is available through services.

Cloudsync

Control and monitor status and attributes for each TrueNAS cloudsync task. Jail control is available through services.

Replication Tasks

Monitor status and attributes for each TrueNAS replication task.

Snapshot Tasks

Monitor status and attributes for each TrueNAS snapshot task.

Dataset Snapshot

Create a Dataset Snapshot using Homeassistant service. Snapshot name will be automatically generated using datetime iso format with microseconds and "custom" prefix.

Services

Control and monitor status and attributes for each TrueNAS service. Service control is available through services.

Reboot and Shutdown

Reboot or Shutdown a TrueNAS system. Service control is available through services. Target system uptime sensor.

Install integration

This integration is distributed using HACS.

You can find it under "Integrations", named "TrueNAS"

Minimum requirements:

• TrueNAS Core 12.0 or TrueNAS Scale (Any version)
• Home Assistant 2022.2.0

Using TrueNAS development branch

If you are using development branch for TrueNAS, some features may stop working.

Setup integration

1. Create an API key for Home Assistant on your TrueNAS system.

2. Setup this integration for your TrueNAS device in Home Assistant via Configuration -> Integrations -> Add -> TrueNAS. You can add this integration several times for different devices.

NOTES:

• If you dont see "TrueNAS" integration, clear your browser cache.

• "Name of the integration" - Friendly name for this router
• "Host" - Use hostname or IP
• "API key" - TrueNAS API key for Home Assistant

Development

Translation

To help out with the translation you need an account on Lokalise, the easiest way to get one is to click here then select "Log in with GitHub". After you have created your account click here to join TrueNAS Integrations project on Lokalise.

If you want to add translations for a language that is not listed please open a Feature request.

Enabling debug

To enable debug for TrueNAS integration, add following to your configuration.yaml:

logger:
  default: info
  logs:
    custom_components.truenas: debug