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 config 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.
The port number on which Proxmox VE is running.
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.
The password used to authenticate.
The authentication realm of the user.
List of the Proxmox VE nodes to monitor.
Example with multiple VMs and no containers:
proxmoxve: - host: IP_ADDRESS username: USERNAME password: PASSWORD 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 permissions role for the user.
- Click the
Createbutton above all the existing roles
- name the new role (e.g. “home-assistant”)
- Click the arrow next to privileges and select
VM.Auditin the dropdown
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.
- 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”
Enabledis checked and
Expireis set to “never”
To apply the user and role just created, we need to give it permissions
- Select “" for the path
- Select your hass user (“hass”)
- Select the Home Assistant role (“home-assistant”)
- Make sure