Documentation

Reference

A technical dictionary of the entities exposed by Proxmox Extended Sensors. Search by entity name, resource or capability, or browse the categories below.

PVE Node Sensors

28 entries

Entities attached to a Proxmox VE node. Conditional entries appear only when the relevant option or data is available.

Status & System

Node status / overview

Sensoroffline or health classificationConditional

Overall node state, with a detailed overview and cluster association in its attributes.

Attributes:
  • Node overview
  • Cluster association and scope

Available when node-list monitoring is enabled.

Sidecar Status

Sensorok / degraded / error / unknown

Health of the sidecar endpoints used for extended node information.

Attributes:
  • Sensors endpoint
  • SMART endpoint
  • Memory endpoint
  • Mounts endpoint

CPU Info

Sensor

CPU model reported by the node, with a core-count fallback.

KSM Status

SensorConfigured / Not configured / Unavailable

Configuration and available activity details for Kernel Samepage Merging.

Attributes:
  • Activity
  • ksm_run
  • ksmtuned status
  • Page counters
Show all attributes
  • Full scans
  • Saved-memory bytes
  • Total RAM bytes

Updates

SensorAvailable update count

Number of available updates; retrieval failures can expose an error or message.

Attributes:
  • Availability
  • Package and version list

Uptime

Sensor

Node uptime returned in the PVE node data.

Kernel Version

Sensor

Kernel version reported by the PVE node.

PVE Version

Sensor

Proxmox VE version reported by the node.

Additional Node Metrics

SensorDynamic

Other node-data keys may create additional sensors. Their names and number depend on the data returned by the monitored node; they are not a fixed universal list.

CPU & Memory

CPU Usage

Sensor%

Current processor utilization of the PVE node.

Memory Usage

Sensor%

Current node memory utilization.

Swap Usage

Sensor%

Current node swap utilization.

KSM Shared

SensorGBConditional

Memory saved or shared through Kernel Samepage Merging.

Available when the node reports KSM data.

Performance & Network

I/O Wait

Sensor%

Time the node spends waiting on I/O, with diagnostic details.

Attributes:
  • I/O-wait diagnostics

Load Average 1m

Sensor

One-minute node load average.

Attributes:
  • Additional load information

Node Score

Sensor

Calculated performance and pressure score; lower is better.

Attributes:
  • Interpretation
  • Classified state

Network RX

SensorkB/s

Receive rate calculated from monitored VM and CT network counters.

Attributes:
  • Total bytes
  • Per-guest usage
  • Top guests
  • Top-guest percentages

Network TX

SensorkB/s

Transmit rate calculated from monitored VM and CT network counters.

Attributes:
  • Total bytes
  • Per-guest usage
  • Top guests
  • Top-guest percentages

Storage & Tasks

RootFS Usage

Sensor%

Utilization of the node root filesystem.

Storages

SensorAvailable storage countConditional

Number of available storages for the node.

Attributes:
  • Storage summary

Available when storage-list monitoring is enabled.

Backup Progress

Sensoridle / running / error / okConditional

Progress and results of PVE backup tasks from the last 24 hours.

Attributes:
  • Task counts
  • Percentage
  • Current task
  • Recent backups

Available when backup-progress monitoring is enabled.

Last Task

Sensor

Latest node task summary.

Attributes:
  • Task details
  • Node task history

Health

Node Overloaded

Binary sensorOn / Off

On when CPU exceeds 85%, RAM exceeds 90%, or active tasks exceed five.

Attributes:
  • CPU %
  • Memory %
  • Active tasks
  • Reason

Disk Overloaded

Binary sensorOn / Off

Problem signal that turns on when I/O wait exceeds 10%.

Attributes:
  • I/O wait %
  • Threshold
  • Status

Node Stressed

Binary sensorOn / Off

On when CPU exceeds 85%, I/O wait exceeds 10%, or one-minute load exceeds the node core count.

Attributes:
  • CPU
  • I/O wait
  • Load 1m
  • Cores
  • Load ratio

Actions

Reboot Node

ButtonConditional

Reboots the PVE node.

Available when node controls are enabled.

Shutdown Node

ButtonConditional

Shuts down the PVE node.

Available when node controls are enabled.

Wake Node

ButtonConditional

Sends a Wake-on-LAN request for the node.

Available when a Wake-on-LAN MAC is configured for the node.

↑ Back to top

Hardware & Memory

7 entries

Hardware monitoring must be enabled and compatible sidecar or lm-sensors data must be available. Exact dynamic names and quantities vary with the monitored system.

Temperatures

CPU Temperature

Sensor°CConditional

Grouped CPU temperature using package, Tctl or Tdie data when available, with an averaged-core fallback and support for ARM cpu_thermal data.

Attributes:
  • Package temperature
  • Per-core and TCCD temperatures
Show all attributes
  • Critical CPU temperature
  • Thermal margin

Available when hardware monitoring is enabled and compatible sidecar or lm-sensors data is detected.

Chipset Temperature

Sensor°CConditional

Primary PCH or chipset temperature detected on the monitored node.

Attributes:
  • Average ACPI temperature when available

Available when hardware monitoring is enabled and a compatible chipset sensor is detected.

NVMe Temperature

Sensor°CConditionalDynamic

Temperature for a detected NVMe device, using lm-sensors data with SMART temperature fallback when available.

Attributes:
  • NVMe temperature channels and labels
  • SMART-derived information

Available when hardware monitoring is enabled and an NVMe device is detected.

Other Hardware Temperatures

Sensor°CConditionalDynamic

Additional compatible temperature channels reported by lm-sensors. Adapter and PWM entries are skipped, and ACPI-only blocks are not exposed as standalone sensors.

Available when hardware monitoring is enabled and compatible temperature data exists.

Fans & Voltages

Fan Sensors

SensorRPMConditionalDynamic

Fan-speed sensors created from detected fan input channels. Exact names and quantity depend on the monitored hardware.

Available when hardware monitoring is enabled and fan input data is detected.

Voltage Sensors

SensorVConditionalDynamic

Voltage sensors created from detected voltage input channels. Exact names and quantity depend on the monitored hardware.

Available when hardware monitoring is enabled and voltage input data is detected.

Physical Memory

DIMM Capacity

SensorGBConditionalDynamic

Capacity of a detected physical memory module. One entity is created per DIMM returned by the sidecar inventory.

Attributes:
  • speed
  • configured_speed
  • type
  • manufacturer
  • locator

Available for DIMMs detected in the physical memory inventory.

↑ Back to top

VM & CT

29 entries

Sensors are created for virtual machines and containers selected for detailed monitoring. Controls appear when their corresponding guest-control features are enabled.

Virtual Machines

8 sensors · 8 actions

Virtual Machine Sensors

VM Status

SensorVM state

Current state of a monitored QEMU virtual machine.

Attributes:
  • current node
  • onboot
  • expected state
  • actual state matches onboot
Show all attributes
  • replication_status
  • replication_jobs
  • replication_failed_jobs
  • replication details when applicable

VM CPU Usage

Sensor%

Current processor utilization of the virtual machine.

Attributes:
  • core count
  • CPU per core when available

VM Memory Used

SensorGB

Memory currently used by the virtual machine.

Attributes:
  • usage_percent

VM Memory Total

SensorGB

Total memory assigned to the virtual machine.

VM Disk Total

SensorGB

Total disk capacity reported for the virtual machine.

VM Uptime

Sensorh

Current virtual-machine uptime in hours.

VM Network RX

SensorGB

Cumulative network data received by the virtual machine.

VM Network TX

SensorGB

Cumulative network data transmitted by the virtual machine.

Virtual Machine Actions

Start VM

ButtonConditional

Starts the virtual machine.

Available when VM controls and the corresponding feature are enabled.

Shutdown VM

ButtonConditional

Requests a virtual-machine shutdown.

Available when VM controls and the corresponding feature are enabled.

Stop VM

ButtonConditional

Stops the virtual machine.

Available when VM controls and the corresponding feature are enabled.

Reboot VM

ButtonConditional

Reboots the virtual machine.

Available when VM controls and the corresponding feature are enabled.

Reset VM

ButtonConditional

Resets the virtual machine.

Available when VM controls and the corresponding feature are enabled.

Pause VM

ButtonConditional

Pauses the virtual machine.

Available when VM controls and the corresponding feature are enabled.

Hibernate VM

ButtonConditional

Hibernates the virtual machine.

Available when VM controls and the corresponding feature are enabled.

Resume VM

ButtonConditional

Resumes the virtual machine.

Available when VM controls and the corresponding feature are enabled.

Containers

9 sensors · 4 actions

Container Sensors

Container Status

SensorContainer state

Current state of a monitored LXC container.

Attributes:
  • current node
  • onboot
  • expected state
  • actual state matches onboot
Show all attributes
  • replication_status
  • replication_jobs
  • replication_failed_jobs
  • replication details when applicable

Container CPU Usage

Sensor%

Current processor utilization of the container.

Attributes:
  • core count
  • CPU per core when available

Container Memory Used

SensorGB

Memory currently used by the container.

Attributes:
  • usage_percent

Container Memory Total

SensorGB

Total memory assigned to the container.

Container Disk Total

SensorGB

Total disk capacity reported for the container.

Container Disk Used

SensorGB

Disk capacity currently used by the container.

Attributes:
  • usage_percent

Container Uptime

Sensorh

Current container uptime in hours.

Container Network RX

SensorGB

Cumulative network data received by the container.

Container Network TX

SensorGB

Cumulative network data transmitted by the container.

Container Actions

Start Container

ButtonConditional

Starts the container.

Available when CT controls and the corresponding feature are enabled.

Shutdown Container

ButtonConditional

Requests a container shutdown.

Available when CT controls and the corresponding feature are enabled.

Stop Container

ButtonConditional

Stops the container.

Available when CT controls and the corresponding feature are enabled.

Reboot Container

ButtonConditional

Reboots the container.

Available when CT controls and the corresponding feature are enabled.

↑ Back to top

Storage, Disks & ZFS

8 entries

Storage entities follow selected PVE resources, while physical disks, mounted disks and ZFS pools depend on the corresponding detected data.

PVE Storage

Storage Usage

Sensor%ConditionalDynamic

Utilization of a selected and applicable PVE storage resource.

Available for storage resources discovered for the node and included in selected_storage.

Storage Used Space

SensorGBConditionalDynamic

Space currently used on a selected PVE storage resource.

Available for storage resources discovered for the node and included in selected_storage.

Storage Free Space

SensorGBConditionalDynamic

Space currently available on a selected PVE storage resource.

Available for storage resources discovered for the node and included in selected_storage.

Storage Total Capacity

SensorGBConditionalDynamic

Total capacity of a selected PVE storage resource.

Available for storage resources discovered for the node and included in selected_storage.

Storage Type

SensorStorage typeConditionalDynamic

Storage type reported for a selected PVE storage resource.

Available for storage resources discovered for the node and included in selected_storage.

Physical Disks

Disk Size

SensorGBConditionalDynamic

Capacity of a detected non-boot physical disk. SMART details vary by disk type and the smartctl data available.

Attributes:
  • model
  • serial
  • type
  • raw capacity
  • firmware
  • SMART availability and health
  • temperature
  • power-on hours
  • derived age
Show all attributes
  • reallocated sectors
  • pending sectors
  • uncorrectable sectors
  • NVMe media errors
  • spin retry count
  • seek error rate
  • SMART return code
  • available spare
  • spare threshold
  • percentage used
  • data units read and written
  • TB read and written
  • host read and write commands
  • controller busy time
  • error log entries
  • warning temperature time
  • critical temperature time
  • critical warning
  • Health Score
  • Disk Health

Available when physical-disk monitoring is enabled and a supported non-boot disk is detected; SMART attributes require corresponding SMART data.

Mounted Disks

Mounted Disks

SensorMounted disk count

Summary of currently mounted, unmounted and missing local or network mounts.

Attributes:
  • mounted_disks
  • unmounted_disks
  • total_disks
  • mounted_count
  • missing_mounts
Show all attributes
  • all_mounted
  • mount_points
  • mount_points_count
  • network_mounts
  • local_mounts

ZFS

ZFS Pool Health

SensorONLINE / DEGRADED / FAULTED / OFFLINE / unknownConditionalDynamic

Current health of a detected ZFS pool.

Attributes:
  • pool
  • node
  • health
  • size GB
  • used GB
  • free GB
  • fragmentation
  • deduplication

Available only when ZFS pool data is detected.

↑ Back to top

PBS Server & Datastores

23 entries

Server-level status and task entities are accompanied by a dynamic entity family for each discovered PBS datastore.

PBS Server

PBS Version

Sensor

Proxmox Backup Server version reported by the server.

PBS Release

Sensor

Proxmox Backup Server release reported by the server.

PBS Auth Status

SensorAuthentication status

Current authentication status for the PBS connection.

PBS CPU Usage

Sensor%Conditional

Current PBS processor utilization.

Attributes:
  • cores
  • CPU model
  • load average 1m
  • load average 5m
  • load average 15m

Node-status data can be unavailable when the optional capability is not supported.

PBS RAM Usage

Sensor%

Current PBS memory utilization.

Attributes:
  • total GB
  • used GB
  • free GB

PBS RAM Total

SensorGB

Total memory reported by the PBS server.

PBS RAM Used

SensorGB

Memory currently used by the PBS server.

PBS RAM Free

SensorGB

Memory currently available on the PBS server.

PBS Tasks

PBS Last Task

Sensorworker type: status

Summary of the latest PBS task.

PBS Last Task Type

Sensor

Worker type of the latest PBS task.

PBS Last Task Status

SensorTask status

Result or current status of the latest PBS task.

Attributes:
  • task type
  • worker or vmid
  • node
  • UPID
  • start time
  • end time

PBS Last Task Message

Sensor

Latest task message or status text.

PBS Last Task Duration

Sensors

Duration of the latest task; running duration is calculated when no end time exists.

PBS Datastore

Datastore Usage

Sensor%ConditionalDynamic

Current utilization of a discovered PBS datastore.

Created for each discovered PBS datastore.

Datastore Total

SensorGBConditionalDynamic

Total datastore capacity.

Created for each discovered PBS datastore.

Datastore Used

SensorGBConditionalDynamic

Datastore capacity currently used.

Created for each discovered PBS datastore.

Datastore Free

SensorGBConditionalDynamic

Datastore capacity currently available.

Created for each discovered PBS datastore.

Datastore Dedup

SensorxConditionalDynamic

Deduplication ratio reported for the datastore.

Created for each discovered PBS datastore.

Datastore Last Backup

SensorLocal date and timeConditionalDynamic

Timestamp of the latest backup stored in the datastore.

Created for each discovered PBS datastore.

Datastore Last Size

SensorGBConditionalDynamic

Size of the latest stored backup.

Created for each discovered PBS datastore.

Datastore Last Backup Status

SensorVerified OK / Verification Failed / Finished (Not Verified) / No backupsConditionalDynamic

Verification-aware status of the latest datastore backup.

Created for each discovered PBS datastore.

Datastore Backup Errors

SensorError countConditionalDynamic

Number of backup errors associated with the datastore.

Created for each discovered PBS datastore.

Datastore Backups Summary

SensorSnapshot countConditionalDynamic

Summary of the backup snapshots stored in the datastore.

Attributes:
  • latest backup per resource
  • total snapshots
  • datastore name

Created for each discovered PBS datastore.

↑ Back to top

PBS Maintenance & Actions

11 entries

Maintenance status and datastore actions reflect discovered datastores and, where required, their matched jobs.

Maintenance Status

GC Status

SensorIniciado / Running / OK / ErrorConditionalDynamic

Current or latest Garbage Collection execution for a PBS datastore.

Attributes:
  • UPID
  • task timing
  • status
  • duration
Show all attributes
  • byte and chunk counters
  • removed and pending sizes
  • Garbage Collection statistics

Created for each discovered PBS datastore.

Verify Status

SensorTask statusConditionalDynamic

Current or latest Verify execution for a PBS datastore.

Attributes:
  • UPID
  • status
  • start and end timing
  • duration

Created for each discovered PBS datastore.

Prune Status

SensorTask statusConditionalDynamic

Current or latest Prune execution for a PBS datastore.

Attributes:
  • UPID
  • status
  • start and end timing
  • duration

Created for each discovered PBS datastore.

Last Action

SensorLatest maintenance actionConditionalDynamic

Most recent Garbage Collection, Prune, Verify or Sync action matched to the datastore when possible.

Attributes:
  • task type
  • status
  • start and end timing
  • duration
Show all attributes
  • error
  • message
  • exit status
  • raw task type

Created for each discovered PBS datastore.

Datastore Actions

Garbage Collect

ButtonConditionalDynamic

Starts Garbage Collection for the datastore.

Created for each discovered PBS datastore.

Prune

ButtonConditionalDynamic

Starts the matched Prune operation for the datastore.

Availability and behaviour can depend on a configured and matched datastore job.

Verify

ButtonConditionalDynamic

Starts the matched Verify operation for the datastore.

Availability and behaviour can depend on a configured and matched datastore job.

Sync

ButtonConditionalDynamic

Starts the matched Sync operation for the datastore.

Availability and behaviour can depend on a configured and matched datastore job.

PBS Node Actions

Shutdown PBS

ButtonConditional

Requests shutdown of the PBS server.

Available when PBS node controls are enabled.

Reboot PBS

ButtonConditional

Reboots the PBS server.

Available when PBS node controls are enabled.

Wake PBS

ButtonConditional

Sends a Wake-on-LAN request for the PBS server.

Available when a PBS Wake-on-LAN MAC is configured.

↑ Back to top

Cluster Sensors

9 entries

Cluster-wide entities combine quorum, node availability, resources, guests, storage, firewall and HA data.

Cluster Status

Cluster Status

Sensorquorate / no quorum

Overall Proxmox VE cluster quorum state.

Attributes:
  • cluster name
  • version
  • quorum
  • total nodes
  • online nodes
  • offline nodes
  • node list

Nodes Online

Sensornodes

Number of cluster nodes currently online.

Attributes:
  • total
  • online
  • offline
  • online-node list
  • offline-node list

Cluster CPU Usage

Sensor%

Aggregate cluster CPU utilization weighted by node core count.

Attributes:
  • total cores
  • per-node CPU percentages

Cluster RAM Usage

Sensor%

Aggregate cluster memory utilization.

Attributes:
  • total GB
  • used GB
  • per-node total and used GB

VMs Running

SensorVMs

Number of virtual machines currently running across the cluster.

Attributes:
  • total
  • running
  • stopped
  • other
  • running VM list with name, node and vmid

CTs Running

SensorCTs

Number of containers currently running across the cluster.

Attributes:
  • total
  • running
  • stopped
  • running CT list with name, node and vmid

Cluster Storage Usage

Sensor%

Aggregate utilization across cluster storage resources.

Attributes:
  • total used GB
  • total GB
  • per-storage details

Cluster Firewall

SensorEnabled / Disabled / Unknown

Current cluster firewall state.

Attributes:
  • raw enable value
  • firewall options

HA Status

Sensoractive / inactive / unavailableConditional

Current high-availability status for the cluster.

Attributes:
  • availability and quorum
  • master node
  • timestamp

Available only when cluster HA data exists.

↑ Back to top

Backup & Replication

9 entries

Cluster backup health and replication entities appear only when their corresponding jobs and runtime data apply.

Cluster Backup Monitoring

Backup Jobs

Sensorok / error / unknown

Overall state of known cluster backup jobs.

Attributes:
  • total jobs

Backup Age

Sensorh

Hours since the latest cluster backup task.

Attributes:
  • age
  • last backup timestamp
  • status
  • total jobs

Backup Health

Sensorhealthy / warning / critical / unknown

Cluster backup health classification based on backup age and state.

Attributes:
  • last backup
  • total jobs

Failed Tasks

SensorFailed task count

Count of failed or non-OK cluster tasks within the last 24 hours.

Attributes:
  • failed count
  • latest failure timestamp
  • node
  • task type
  • task details

Replication Summary

Replication Jobs

SensorJob countConditionalDynamic

Number of known replication jobs.

Attributes:
  • job list
  • inventory freshness
  • runtime freshness
  • runtime-unknown job count

Available when applicable replication inventory or jobs exist.

Replication Status

Sensorok / error count / unknownConditionalDynamic

Overall replication state derived from job runtime and inventory data.

Attributes:
  • failed-job list
  • inventory freshness
  • runtime freshness
  • runtime-unknown job count

Available when applicable replication inventory or jobs exist.

Per-job Replication Sensors

Replication Last Sync

SensorTimestampConditionalDynamic

Time of the latest synchronization for an active replication job; attached to the corresponding VM or CT device.

Attributes:
  • current replication job record

Created for applicable active replication jobs.

Replication Next Sync

SensorTimestampConditionalDynamic

Scheduled time of the next synchronization for an active replication job; attached to the corresponding VM or CT device.

Attributes:
  • current replication job record

Created for applicable active replication jobs.

Replication Duration

SensorsConditionalDynamic

Duration of the active replication job's latest synchronization; attached to the corresponding VM or CT device.

Attributes:
  • current replication job record

Created for applicable active replication jobs.

↑ Back to top

Entities, Devices & Availability

5 topics

Identity rules explain why entities remain stable across migrations and why conditional families may not appear in every environment.

Entity & Device Identity

PVE-local resources

Node, storage, mounted-disk and similar resources use identities associated with the relevant PVE environment.

VM & CT migration identity

When a PVE entry participates in an active cluster scope, monitored VM and CT identity is cluster-scoped. A guest can migrate between cluster nodes while retaining its Home Assistant identity.

  • Preserves entity identity and configuration
  • Maintains history and statistics relationships
  • Keeps dashboard and automation references stable

PBS server identity

PBS datastore and maintenance identities are server-scoped, so same-named datastores on different PBS servers remain distinct.

Replication identity

Replication measurements use stable job-based identity and attach to the existing VM or CT device.

Conditional Availability

Why don't I have this entity?

Many entity families appear only when their feature, resource and source data are available.

  • PVE hardware — hardware monitoring enabled and compatible sidecar or lm-sensors data detected
  • DIMMs — returned by the sidecar physical-memory inventory
  • Physical disks — physical-disk monitoring enabled; SMART details additionally require SMART data
  • Storage — discovered, applicable and selected storage resources only
  • VM & CT — effectively selected monitored guests only
  • ZFS — detected pools present in zfs_pools
  • PVE node controls — node controls enabled; Wake additionally requires a MAC
  • PVE backup progress — backup-progress monitoring enabled
  • Cluster HA — HA data available
  • Replication — applicable replication inventory and jobs available
  • PBS datastore and maintenance — created per discovered datastore
  • PBS Wake — a Wake-on-LAN MAC configured
  • PBS Shutdown and Reboot — PBS node controls enabled
↑ Back to top

Troubleshooting

9 topics

Use these checks to locate missing entities and understand environment-dependent Reference content.

Finding & Understanding Entities

I cannot find an entity

Confirm that the related integration resource or device is configured, the feature is enabled, and the entity is not conditional on unavailable data. Also check that the VM, CT, storage or datastore is selected or discovered as required.

Hardware entity missing

Hardware sensors depend on environment-specific sidecar and lm-sensors data. Exact temperature, fan and voltage entities vary by machine.

Review PVE hardware guidance

SMART attributes missing

SMART attributes vary by disk and device type and by the smartctl data available. No physical disk is expected to expose every documented SMART attribute.

ZFS entity missing

ZFS entities exist only when relevant ZFS pool data is detected.

Replication entity missing

Replication entities are conditional and exist only when applicable replication jobs and data are available.

Review Cluster diagnostics

PBS entity missing

Identify whether the expected entity belongs to the PBS server, task, datastore or maintenance family, then verify the corresponding server capability and datastore discovery.

Review PBS troubleshooting

Entity is absent from the automatic Dashboard

Reference documents entities exposed by the integration. The automatic Dashboard intentionally presents a curated subset and does not display every entity.

Review Dashboard documentation

Find entities in Home Assistant

Open Settings → Devices & services → Proxmox Extended Sensors, choose the relevant device, then open its entity list. The global Entities view can also be filtered by integration, device or entity name.

↑ Back to top