Support SSH key auth

[JitteryDoodle]

Is your feature request related to a problem? Please describe.
My server only uses SSH keys and password auth is disabled. Because of this, it's not possible to complete the integration setup.

Describe the solution you'd like
It would be great if SSH key support was added.

Use Case or Why Do You Want This?
Describe a specific scenario where this feature would be helpful or explain why you think it's necessary.
Remove reliance on SSH username and password

Priority of Request
How important is this feature to you?

• High
• Medium
• Low

Additional context
Add any other context or screenshots about the feature request here.

[domalab]

Thanks for the request.

I'll add it to my list of improvements to look at.

[soricesg]

Also interested in using SSH keys rather than password. https://www.youtube.com/watch?v=u2iQACDuoeU if its useful

[domalab]

@soricesg @JitteryDoodle I'm currently experimenting with this feature and will let you know if I get this working

[domalab]

@JitteryDoodle @soricesg I managed to get it working. Was actually easier than I thought it would be to implement since I am already using pythons ssh library.

Had to change the config flow from single step to multi-step flow that now looks like this.

First Step: Enter Unraid Hostname / IP, username and select authentication method

Second Step: Specify location on HA were key is kept

Last Step: Specify port, UPS and sensor update settings

And the integration is up and running.

I'll add this as a pre-release feature soon and you can try it out

[domalab]

@soricesg @JitteryDoodle When you have time feel free to try out the multi-step-auth feature.

1. Backup and remove the exisiting Unraid integration if using it
2. Download the source code zip here (Not Release version), extract and copy the unraid folder over to your HA server and restart.
   https://github.com/domalab/ha-unraid/tree/feature/multi-step-auth
3. Add Unraid integration and follow the steps.

I provided a configuration guide here but I'm sure you know how ssh keys work 😃

https://github.com/domalab/ha-unraid/wiki/Unraid-Integration-Setup-Guide

[soricesg]

I’m away from my devices for the next week or 2 and don’t want to risk doing anything remotely while I’m away. I’ll absolutely give it a try and any feedback once I’m back home

[l3ztum]

Hi @domalab, wanted to try ssh key auth as well. Followed your steps for manual install and got a error during adding the integration:
Error
"Config flow could not be loaded: {"message":"Invalid handler specified"}"

Home assistant log:
Logger: homeassistant.config_entries
Source: config_entries.py:3314
First occurred: 11:55:40 AM (1 occurrences)
Last logged: 11:55:40 AM
Error occurred loading flow for integration unraid: cannot import name 'CONF_AUTH_METHOD' from 'custom_components.unraid.const' (/config/custom_components/unraid/const.py)

const.py seems to be missing from the commit

after adding these consts with some own random keys the integration works 👍
just tested ssh key auth since i don't want to activate password based authentication

unraid.execute_command seems to fail with the following message:
Failed to perform the action unraid.execute_command. Error executing command: '192.168.178.250'

 action: unraid.execute_command
 data:
   entry_id: 192.168.178.250
   command: ip addr

Unraid (please complete the following information):

Version 7.0.0

Home Assistant (please complete the following information):

Version 2025.1.1

[domalab]

Hi @domalab, wanted to try ssh key auth as well. Followed your steps for manual install and got a error during adding the integration: Error "Config flow could not be loaded: {"message":"Invalid handler specified"}"

Home assistant log: Logger: homeassistant.config_entries Source: config_entries.py:3314 First occurred: 11:55:40 AM (1 occurrences) Last logged: 11:55:40 AM Error occurred loading flow for integration unraid: cannot import name 'CONF_AUTH_METHOD' from 'custom_components.unraid.const' (/config/custom_components/unraid/const.py)

const.py seems to be missing from the commit

after adding these consts with some own random keys the integration works 👍 just tested ssh key auth since i don't want to activate password based authentication

unraid.execute_command seems to fail with the following message: Failed to perform the action unraid.execute_command. Error executing command: '192.168.178.250'

 action: unraid.execute_command
 data:
   entry_id: 192.168.178.250
   command: ip addr

Unraid (please complete the following information):

Version 7.0.0

Home Assistant (please complete the following information):

Version 2025.1.1

Thanks for picking up the missing entries in const.py. I re-synced the branch and its now back.

[domalab]

@l3ztum Regarding the action: unraid.execute_command failed. Can you please follow this updated wiki article?

https://github.com/domalab/ha-unraid/wiki/How-to-Use-Unraid-Service-Commands

My fault, I forgot to update the article that IP addresses are not supported anymore.