Home Assistant Supervisor
The Home Assistant Supervisor integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows you to monitor and control Supervisor add-ons and operating system from Home Assistant.
This integration is already installed if you run Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports add-ons. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.. Please note that this integration
cannot be installed on Home Assistant ContainerHome Assistant Container is a standalone container-based installation of Home Assistant Core. Any OCI
Sensor entities
For each installed add-on, the following sensors are available:
| Sensor | Enabled by default | Description |
|---|---|---|
| Version | no | Current version of the add-on |
| Newest Version | no | Latest version of the add-on currently available |
| CPU Percent | no | The CPU Percent usage of the add-on |
| Memory Percent | no | The Memory (RAM) Percent usage of the add-on |
For Home Assistant OS, the following sensors are available:
| Sensor | Enabled by default | Description |
|---|---|---|
| Version | no | Current version of the Home Assistant OS |
| Newest Version | no | Latest version of the Home Assistant OS currently available |
For Home Assistant Core, the following sensors are available:
| Sensor | Enabled by default | Description |
|---|---|---|
| CPU Percent | no | The CPU Percent usage of the core |
| Memory Percent | no | The Memory (RAM) Percent usage of the core |
For Home Assistant Supervisor, the following sensors are available:
| Sensor | Enabled by default | Description |
|---|---|---|
| CPU Percent | no | The CPU Percent usage of the supervisor |
| Memory Percent | no | The Memory (RAM) Percent usage of the supervisor |
For Home Assistant Host, the following sensors are available:
| Sensor | Enabled by default | Description |
|---|---|---|
| OS Agent Version | no | The version of the installed OS Agent |
| Apparmor Version | no | The version of apparmor |
| Disk Free | no | Free space (in GB) left on the device |
| Disk Total | no | Total space (in GB) on the device |
| Disk Used | no | Used space (in GB) on the device |
Binary sensor entities
For each installed add-on Supervisor provides following binary sensors:
(These entities are disabled by default and must be re-enabled to appear)
| Sensor | Enabled by default | Description |
|---|---|---|
| Update Available | no | Whether there is an update available for this add-on (This is deprecated, use the Update entities instead.) |
| Running | no | Whether the add-on is running or not. |
For each network storage Supervisor provides following binary sensors:
| Sensor | Enabled by default | Description |
|---|---|---|
| Connected | no | Whether the network storage is connected and working properly. |
For Home Assistant OS Supervisor provides following binary sensors:
| Sensor | Enabled by default | Description |
|---|---|---|
| Update Available | no | Whether there is an update available for OS |
Switch entities
For each installed add-on, the following switch is available:
| Switch | Enabled by default | Description |
|---|---|---|
| Running | no | Shows whether the add-on is running or not, and allows you to start or stop the add-on depending on its current state. |
Update entities
For all your installed add-ons, Home Assistant Core, Home Assistant Supervisor, and for the Home Assistant Operating System (if you are running that), this integration will provide update entities that provide information about pending updates, and will allow you to update to them.
Actions
Action: Start add-on
The hassio.addon_start action starts an add-on.
| Data attribute | Optional | Description |
|---|---|---|
addon |
no | Add-on slug |
Action: Stop add-on
The hassio.addon_stop action stops an add-on.
| Data attribute | Optional | Description |
|---|---|---|
addon |
no | Add-on slug |
Action: Restart add-on
The hassio.addon_restart action restarts an add-on.
| Data attribute | Optional | Description |
|---|---|---|
addon |
no | Add-on slug |
Action: Write to add-on stdin
The hassio.addon_stdin action writes data to add-on stdin.
| Data attribute | Optional | Description |
|---|---|---|
addon |
no | Add-on slug |
Action: Reboot host
The hassio.host_reboot action reboots the host system.
Action: Shut down host
The hassio.host_shutdown action shuts down the host system.
Action: Create full backup
The hassio.backup_full action creates a full backup.
| Data attribute | Optional | Description |
|---|---|---|
name |
yes | By default, the current date and time are used in your local time, which you have set in your general settings. |
password |
yes | Optional password for backup |
compressed |
yes |
false to create uncompressed backups |
location |
yes | Alternate backup location instead of using the default location for backups |
homeassistant_exclude_database |
yes | Exclude the Home Assistant database file from backup |
Action: Create partial backup
The hassio.backup_partial action creates a partial backup.
| Data attribute | Optional | Description |
|---|---|---|
addons |
yes | List of add-on slugs to backup |
folders |
yes | List of directories to backup |
name |
yes | Name of the backup file. Default is the current date and time in the user’s local time |
password |
yes | Optional password for backup |
compressed |
yes |
false to create uncompressed backups |
location |
yes | Alternate backup location instead of using the default location for backups |
homeassistant |
yes | Include Home Assistant and associated config in backup |
homeassistant_exclude_database |
yes | Exclude the Home Assistant database file from backup |
Action: Restore from full backup
The hassio.restore_full action restores from a full backup.
| Data attribute | Optional | Description |
|---|---|---|
slug |
no | Slug of backup to restore from |
password |
yes | Optional password for backup |
Action: Restore from partial backup
The hassio.restore_partial action restores from a partial backup.
| Data attribute | Optional | Description |
|---|---|---|
slug |
no | Slug of backup to restore from |
homeassistant |
yes | Whether to restore Home Assistant, true or false
|
addons |
yes | List of add-on slugs to restore |
folders |
yes | List of directories to restore |
password |
yes | Optional password for backup |