UNRAID Integration

Darklirah · April 28, 2025, 12:19pm

@ ruaandeysel
Very nice, thank you, setup was easy (- if I would have known only “root” gets ssh acces ist would be a pleasure to intall)
regards
Franky

dale3h · May 4, 2025, 1:12am

Great work on this integration! I found out about it from the most recent Self-Hosted podcast episode and decided to set it up today.

I doubt it is a bug in the integration, but I am experiencing some warnings in the HA logs every 5 minutes:

2025-05-03 20:05:36.043 WARNING (MainThread) [custom_components.unraid.api.smart_operations] SMART command failed for nvme0n1: exit_code=2
2025-05-03 20:05:36.696 WARNING (MainThread) [custom_components.unraid.api.smart_operations] SMART command failed for nvme0n1: exit_code=2
2025-05-03 20:05:41.558 WARNING (MainThread) [custom_components.unraid.coordinator] Skipping invalid date: 1969 Dec 31 18:00:00

Do you have any insight as to how I could go about address this issue? I tried to figure out which disk was connected as nvme0n1 but I can’t find it anywhere on the unRAID GUI or filesystem.

Keep up the great work!

ruaandeysel · May 6, 2025, 3:38am

You can try the updated source code by manually copying the unraid folder to your HA instance.

IvanDobsky · May 6, 2025, 5:09pm

I did a manual update of copying the code on top. Deleted my old UNRAID servers to start clean. Restarted HA. Added servers back. And now I have nice clean naming of entities. Double names gone. Thank you.

laurens362 · May 7, 2025, 2:13pm

Am i correct that it kinda takes a long time when a container goes offline on unraid to show the change in HA ? Is there a way to live monitor a container?

wvanderspek · May 8, 2025, 9:13am

I really love this integration and it is working very well. But would it also be possible to include GPU usage in the Unraid sensors?

ruaandeysel · May 9, 2025, 12:24am

It’s possible. I tested it in the past and could only get it to work on Intel as I have iGPU in my Unraid Server. I’ll need AMD and Nividia GPUs to get code to work on them.

ruaandeysel · June 3, 2025, 10:39pm

You can try this beta version of unraid integration that uses Unraid API. It doesn’t provide the same features yet as the SSH based integration

comet424 · June 4, 2025, 3:55pm

hi i unable to install my unraid servers

i enabled
Enable Developer Sandbox:

The developer sandbox is available at /graphql.

i ran

unraid-api apikey --create

i then followed the options and got

Creating API Key...{"create":true,"name":"Home Assistant Tardis API Key","description":"Home Assistant Tardis API Key","roles":["ADMIN"],"permissions":[{"resource":"ARRAY","actions":["read"]},{"resource":"INFO","actions":["read"]},{"resource":"SHARE","actions":["read"]}]}
d094165bc832f06d467885aec12844a6d15c1bd9d4c78c45d9ebb3ed84411652

i enter the intergration add
url : http://192.168.0.3

i check and uncheck the ssl didnt matter
and for the key i enter
d094165bc832f06d467885aec12844a6d15c1bd9d4c78c45d9ebb3ed84411652


but when i click submit

Recived an Error response from Unraid: Int cannot represent non 32-bit signed integer value: 67345485824


so what am i doing wrong to create the api key to get it to work

laurens362 · June 4, 2025, 4:46pm

What cards do people use? Kinda interested to see some cool dashboards of unraid

comet424 · June 4, 2025, 6:39pm

@ruaandeysel do you have a video , screen shots how to set things up i tried following documentation i got a generated key but it wont work in home assistant… i struggling and unraid docs have no pics and sucks on trying to understand things with graphQL
could you help me set it up since i cant get past the key cli

i also now get error
Recived an Error response from Unraid: API key validation failed, API key validation failed

from the previous error of the 32bit

i dunno what i doing wrong

ruaandeysel · June 5, 2025, 10:10am

You can have a look at this thread on GitHub and the readme.md contains a lot of info too about the integration.

github.com/domalab/ha-unraid-connect

Can you include a more details step by step of how to set up

opened 07:01PM - 04 Jun 25 UTC

blair287

question

How do you obtain an APi key and where on earth is this option in the connect pl…ugin? Important: Add your Home Assistant URL to the "API extra origins" setting: ive been told that option doesnt even exist in the connect settings. the set up is very vauge. does the api need admin or connect role? I selected admin all roles and i just get unknown error occurred not sure if its a set up issue or an integration issue without detailed instructions on how this should be set up.

The 32bit Int error is a bug in the Unraid API. Need to wait for Unraid API Dev Team to fix it.

comet424 · June 5, 2025, 12:12pm

@ruaandeysel ok thanks ill take a look… as i trying to make option to reboot my unraid servers… but the shell_command doesnt work when u got quotes for the command…
so wanted to add the unraid reboot entity but so far i havent been able to add the unraid servers yet …
but ill take a look i appreciate it as documentions not enough examples etc

comet424 · June 5, 2025, 12:37pm

@ruaandeysel so i read it it didnt help as those are what i did ithe the 2 post prior where i posted the the api key… and the commands i used…

i dont know how to edit the graphQL i go there and i dunno how to save the file once you post the api key from the unraid docs… way to confusing

i figured like above i create the key and then just paste it in HA but that doesnt work… i also saw the word “extra options” in your step by step

as i dont know how to create

{
    "x-api-key": "YOUR_API_KEY"
}

i seen in sandbox QL but github doesnt say how to create an api key file to paste the key and what do i call it where do i save it or anything i flipped throug hteh sandbox graphql page but it doesnt make sense to me and googling it didnt help

so like my post 2 replies ago… i stuck

and i dont have option for extra origins to add the home assistant ip address wen i googled and read on a redit…

i thought it was just simple run the
unraid-api apikey --create
get
d094165bc832f06d467885aec12844a6d15c1bd9d4c78c45d9ebb3ed84411652

then paste it in home assistant intergration but its like there is 10 steps you gotta do in sandbox graphQL before you can get to home assistant

i did try the last option in the steps choose A for all permissions and copied it pasted the key and didnt bother doing the sand box but came up with that same bug 32 bit you mentioned… so i guess at this time un able to add unraid api servers.

hopefully soon i can do that

ruaandeysel · June 9, 2025, 8:04pm

Have you followed this guide?

github.com/domalab/ha-unraid-connect

docs/setup.md

d580f787f

# Unraid Connect Integration Setup Guide

This guide walks you through setting up the Unraid Connect integration for Home Assistant.

## Prerequisites

- **Unraid Server**: Running Unraid 6.12+ with Unraid Connect plugin
- **Home Assistant**: Version 2025.1.0 or later
- **Network Access**: Home Assistant can reach your Unraid server

## Step 1: Install and Configure Unraid Connect Plugin

1. **Install Plugin**: Make sure you have the latest Unraid Connect plugin installed in Unraid (version 2025.05.01.2159 or later)

2. **Enable Developer Sandbox**: Access the plugin via Settings → Management Access. Make sure "Enable Developer Sandbox" is enabled.

![Image](https://github.com/user-attachments/assets/6aef1b02-b348-4f96-a370-c327e85156e0)

3. **Verify GraphQL API**: Click the /graphql link to open the Unraid GraphQL Developer Sandbox in a new tab. This confirms the API is working.

This file has been truncated. show original

ruaandeysel · June 9, 2025, 8:07pm

What GPU do you use? Make and Model

ruaandeysel · June 9, 2025, 8:09pm

Is this still an issue for you? I released new version

IvanDobsky · June 10, 2025, 9:38am

Quick question. Are you still going to keep this non-cloud integration updated or are you planning to swap to the cloudy one instead?

My ultimate aim is simple. Ideally just have a “once a day” check on hard drive states so I know if something is failing. But for this I don’t want my Unraid servers connected to external anything.

Will there be a way of running your new integration without signing up to Unraid Connect? Or will I just have to rely on the old integration?

Thanks

ruaandeysel · June 10, 2025, 10:23am

The Unraid Connect integration uses Unraid’s new GraphQL API which runs locally. The integration connects to local API. No Cloud API involved. Just requires an API key you need to create from command line.

The Unraid API Dev team mentioned that eventually in a later version of Unraid the local API components will be moved from the Connect plugin into the Unraid OS.

The Unraid integration will still be maintained as it can do a lot more than the Unraid Connect integration at present until the Unraid API provides more features.

IvanDobsky · June 11, 2025, 6:54am

Thanks. Now that does sound good. As long as I don’t need Connect to connect to their cloud I can drop it into place and try the new code out. Currently you are only really using “Connect” as a library to get at the new API. Makes sense.

For me, all my servers stay inside my firewall. The only access is a VPN.