Home Assistant Home Assistant

Proxmox VE

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.

Configuration

You should have at least one VM or container entry configured, else this integration won't do anything.

To use the proxmoxve component, add the following configuration to your configuration.yaml file:

# Example configuration.yaml entry
proxmoxve:
  - host: IP_ADDRESS
    username: USERNAME
    password: PASSWORD
    nodes:
      - node: NODE_NAME
        vms:
          - VM_ID
        containers:
          - CONTAINER_ID

Configuration Variables

Looking for your configuration file?
host string Required

IP address of the Proxmox VE instance. Can include port by appending “:<port>”.

port integer (Optional, default: 8006)

The port number on which Proxmox VE is running.

verify_ssl boolean (Optional, default: true)

Whether to do strict validation on SSL certificates. If you use a self signed SSL certificate you need to set this to false.

username string Required

The username used to authenticate. Can include the realm by appending “@<realm>”.

password string Required

The password used to authenticate.

realm string (Optional, default: pam)

The authentication realm of the user.

nodes map Required

List of the Proxmox VE nodes to monitor.

node string Required

Name of the node

vms list (Optional)

List of the QEMU VMs to monitor.

containers list (Optional)

List of the LXC containers to monitor.

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.

  1. Click Datacenter
  2. Open Permissions and click Groups
  3. Click the Create button above all the existing groups
  4. Name the new group (e.g., HomeAssistant)
  5. Click Create

Add Group Permissions to all Assets

For the group to access the VMs we need to grant it the auditor role

  1. Click Datacenter
  2. Click Permissions
  3. Open Add and click Group Permission
  4. Select “/” for the path
  5. Select your Home Assistant group (HomeAssistant)
  6. Select the Auditor role (PVEAuditor)
  7. 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.

  1. Click Datacenter
  2. Open Permissions and click Users
  3. Click Add
  4. Enter a username (e.g., hass)
  5. Set the realm to “Proxmox VE authentication server”
  6. Enter a secure password (it can be complex as you will only need to copy/paste it into your Home Assistant configuration)
  7. Select the group just created earlier (HomeAssistant) to grant access to Proxmox
  8. Ensure Enabled is checked and Expire is set to “never”
  9. Click Add

In your Home Assistant configuration, use [email protected] for the username and your chosen password for the password.