Proxmox VE
Proxmox VE
After configuring this integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more], the binary sensors automatically appear.
Configuration
You should have at least one VM or container entry configured, else this integration won’t do anything.
To use the proxmoxve
integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more], add the following configuration to your configuration.yaml
The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file.
After changing the configuration.yaml
The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.
# Example configuration.yaml entry
proxmoxve:
- host: IP_ADDRESS
username: USERNAME
password: PASSWORD
nodes:
- node: NODE_NAME
vms:
- VM_ID
containers:
- CONTAINER_ID
Configuration Variables
IP address of the Proxmox VE instance. Can include port by appending “:<port>”.
Whether to do strict validation on SSL certificates. If you use a self signed SSL certificate you need to set this to false.
The username used to authenticate. Can include the realm by appending “@<realm>”.
Example with multiple VMs, no containers, self-signed certificate and pve realm for the user setup described below:
proxmoxve:
- host: IP_ADDRESS
username: USERNAME
password: PASSWORD
verify_ssl: false
realm: pve
nodes:
- node: NODE_NAME
vms:
- VM_ID_1
- VM_ID_2
Binary sensor
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 Group
Before creating the user, we need to create a group for the user. Privileges can be either applied to Groups or Roles.
- Click
Datacenter
- Open
Permissions
and clickGroups
- Click the
Create
button above all the existing groups - Name the new group (e.g.,
HomeAssistant
) - Click
Create
Add Group Permissions to all Assets
For the group to access the VMs we need to grant it the auditor role
- Click
Datacenter
- Click
Permissions
- Open
Add
and clickGroup Permission
- Select “/” for the path
- Select your Home Assistant group (
HomeAssistant
) - Select the Auditor role (
PVEAuditor
) - Make sure
Propagate
is checked
Create Home Assistant User
Creating a dedicated user for Home Assistant, limited to only to the access 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 configuration.
- Click
Datacenter
- Open
Permissions
and clickUsers
- Click
Add
- Enter a username (e.g.,
hass
) - Set the realm to “Proxmox VE authentication server”
- Enter a secure password (it can be complex as you will only need to copy/paste it into your Home Assistant configuration)
- Select the group just created earlier (
HomeAssistant
) to grant access to Proxmox - Ensure
Enabled
is checked andExpire
is set to “never” - Click
Add
In your Home Assistant configuration, use hass@pve
for the username and your chosen password for the password.