jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-27 19:26:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add Proxmox Permissions Information (#11713)

Browse Source
This commit is contained in:
John Hollowell 2020-01-12 03:31:12 -05:00 committed by Franck Nijhof
parent 846f2367f7
commit 64dc7f5442
1 changed files with 40 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
source/_integrations/proxmoxve.markdown
View File

@ -102,3 +102,43 @@ proxmoxve:
The integration will automatically create a binary sensor for each tracked virtual machine or container. The binary sensor will either be on if the VM's state is running or off if the VM's state is different.
The created sensor will be called `binary_sensor.NODE_NAME_VMNAME_running`.
## Proxmox Permissions
To be able to retrieve the status of VMs and containers, the user used to connect must minimally have the `VM.Audit` privilege. Below is a guide to how to configure a new user with the minimum required permissions.
### Create Home Assistant Role
Before creating the user, we need to create a permissions role for the user.
* Click `Datacenter`
* Open `Permissions` and click `Roles`
* Click the `Create` button above all the existing roles
* name the new role (e.g. "home-assistant")
* Click the arrow next to privileges and select `VM.Audit` in the dropdown
* Click `Create`
### Create Home Assistant User
Creating a dedicated user for home assistant limited to only the role just created is the most secure method. These instructions use the `pve` realm for the user. This allows a connection, but ensures that the user is not authenticated for SSH connections. If you use the `pve` realm, just be sure to add `realm: pve` to your config.
* Click `Datacenter`
* Open `Permissions` and click `Users`
* Click `Add`
* Enter a username (e.g. "hass")
* Enter a secure password (it can be complex as you will only need to copy/paste it into your Home Assistant configuration)
* Set the realm to "Proxmox VE authentication server"
* Ensure `Enabled` is checked and `Expire` is set to "never"
* Click `Add`
### Add User Permissions to Assets
To apply the user and role just created, we need to give it permissions
* Click `Datacenter`
* Click `Permissions`
* Open `Add` and click `User Permission`
* Select "\" for the path
* Select your hass user ("hass")
* Select the Home Assistant role ("home-assistant")
* Make sure `Propigate` is checked