Proxmox VE is an open-source server virtualization environment. This integration allows you to poll various data from your instance.
After configuring this component, the binary sensors automatically appear.
To use the
proxmoxve component, add the following configuration to your
# Example configuration.yaml entry proxmoxve: - host: IP_ADDRESS username: USERNAME password: PASSWORD nodes: - node: NODE_NAME vms: - VM_ID containers: - CONTAINER_ID
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
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
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.
Before creating the user, we need to create a group for the user. Privileges can be either applied to Groups or Roles.
- Click the
Createbutton above all the existing groups
- Name the new group (e.g., “HomeAssistant”)
For the group to access the VMs we need to grant it the auditor role
- Select “/” for the path
- Select your Home Assistant group (
- Select the Auditor role (
- Make sure
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.
- 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
Enabledis checked and
Expireis set to “never”
In your Home Assistant configuration, use
[email protected] for the username and your chosen password for the password.
Suggest an edit to this page, or provide/view feedback for this page.