Veeam Backup & Replication Dashboard

An auto-generating Home Assistant dashboard for the Veeam Backup & Replication integration. It reads the device and entity registries at render time and builds views from whatever the integration has created — so jobs and repositories appear and disappear on their own, with no dashboard YAML to maintain.

This project is an independent, open source project. It is not affiliated with, endorsed by, or sponsored by Veeam Software.

Requirements

• Home Assistant 2026.1 or newer
• The ha-veeam-br integration, set up and producing entities

Installation

HACS (recommended)

Have HACS installed, then use this button:

Click Download, then reload your browser.

Note

This is not in the default HACS store yet. If the button above doesn't work, add https://github.com/Cenvora/ha-veeam-br-dashboard as a custom repository of type Dashboard in HACS → ⋮ → Custom repositories, then download it from there.

The type is called Dashboard in the HACS interface but plugin everywhere machine readable — the install button above, hacs.json, and the CI workflow all use plugin. HACS maps the two (common.type.plugin = "Dashboard"); they are not different categories.

HACS registers the dashboard resource for you, so there is nothing to add by hand.

Manual install

1. Copy veeam-br-dashboard.js from the latest release into <config>/www/
2. Add it under Settings → Dashboards → ⋮ → Resources as /local/veeam-br-dashboard.js, type JavaScript module
3. Reload your browser

Usage

A whole dashboard

Settings → Dashboards → Add dashboard → New dashboard from scratch, then ⋮ → Raw configuration editor, and replace the contents with:

strategy:
  type: custom:veeam-br

That's the entire configuration. You get four views:

View	Contents
Overview	A live headline, server/cluster/licence badges, and one tile per job, repository, proxy and accelerator
Jobs	A section per backup job with its sensors and start/stop/retry buttons
Repositories	A section per repository and scale-out repository, with used space as a gauge
Infrastructure	HA cluster, backup proxies, WAN accelerators, server details and licensing

Views with nothing to show are left out, so a server with no scale-out repositories does not get an empty tab.

A single view in an existing dashboard

Two editors take two different shapes, and pasting one into the other is the usual cause of an empty view.

Dashboard ⋮ → Raw configuration editor — the whole dashboard, so views are a list:

views:
  - strategy:
      type: custom:veeam-br
      group: jobs
      title: Backups
      icon: mdi:shield-check
      theme: midnight
  - title: Something else of your own
    cards: []

A single view → Edit view → ⋮ → Edit in YAML — one view, so there is no views: key and no type:/sections: of your own:

strategy:
  type: custom:veeam-br
  group: jobs
  title: Backups
  icon: mdi:shield-check
  theme: midnight

group accepts overview, jobs, repositories or infrastructure.

Important

Set the view's name, icon and theme inside the strategy: block, as above — not beside it, and not in the visual editor.

Home Assistant applies a strategy's generated configuration over the view's own keys, so a title: next to strategy: is ignored and the tab reads Unnamed view. And using the visual editor to rename or restyle the view replaces the strategy with a static copy of the cards it happened to generate that moment — the dashboard stops updating itself. That is how strategies work in Home Assistant generally, not something specific to this one.

title, path, icon, theme, background, subview and visible are accepted directly. Anything else Home Assistant supports on a view goes under view:, which is passed through untouched:

strategy:
  type: custom:veeam-br
  view:
    theme: midnight
    top_margin: true

Options

All optional, and valid on either the dashboard or a view strategy:

Option	Default	What it does
title, icon, path	per view	Name a generated view. The whole-dashboard strategy names its own four views, so it ignores these
theme, background, subview, visible	—	Standard view settings. On the dashboard strategy they apply to every view
view	—	Any other view setting, passed through verbatim
summary	true	The live headline counting failed jobs and full repositories
badges	true	Show server, cluster and licence state as badges instead of tiles
columns	3	Maximum section columns
include_diagnostics	false	Include diagnostic entities — build numbers, IDs, timelines
include_config	true	Include config entities. The job start/stop buttons live here
include_hidden	false	Include entities you have hidden
repository_warn_at	85	Used-space percentage treated as a warning, in the headline and on the gauges

strategy:
  type: custom:veeam-br
  include_diagnostics: true
  repository_warn_at: 75
  columns: 2

Multiple Veeam servers

Each server is its own config entry, and all of them are picked up. When more than one is configured, section titles are suffixed with the server name — so two jobs both called Nightly VMs on different servers stay distinguishable.

How it works

The strategy asks Home Assistant for the device and entity registries, keeps entities whose platform is veeam_br, and groups their devices by model — Backup Job, Backup Repository, Scale-Out Backup Repository, Backup Proxy, WAN Accelerator, Backup & Replication Server, License, High Availability Cluster.

Working from the registry rather than matching entity IDs means renaming an entity or a device does not break the dashboard, and disabled entities are never given a tile that would render broken.

A few deliberate choices in the layout:

• One tile per device on the overview, named for the device — a proxy contributing three tiles that all read veeam-worker-01 tells you nothing about which is which. The rest of a device's entities are on its own section in the Jobs, Repositories or Infrastructure view.
• Short names inside a device section. In a section already titled Nightly VMs, the tiles read Status, Last Result, Start — not the full friendly name repeated four times.
• Jobs lead with Last Result, not Status. Status reports what a job is doing (Running, Inactive, Disabled) and never reports failure; the pass/fail outcome of the last run is on Last Result.
• Used space is a gauge, coloured at repository_warn_at. A tile reading 0.2% is a number you have to think about; a gauge is not.
• Server, cluster and licence state are badges, because they are one-per-server facts that belong along the top rather than in a section competing with your jobs.
• The headline is a template, not a count baked in at render time. A strategy runs once per page load, so anything computed from live states would be a stale snapshot minutes later — that also applies to card order and colour, which is why neither depends on state.

Development

Plain ES module, no build step, no dependencies. The file you edit is the file Home Assistant loads.

node --test        # or: npm test

The tests import the module directly and feed it registry fixtures, asserting on the generated dashboard configuration — grouping, filtering, multi-server labelling and the empty state.

Related

• ha-veeam-br — the integration that produces the entities, including automation blueprints
• veeam-br — the Python REST API library underneath

License

MIT — see LICENSE.