Create, rename and delete as many dashboards as needed. Each dashboard is personal and independent.
Dashboard
Customizable dashboards with widgets and metrics for centralised Proxmox VE infrastructure monitoring. Each dashboard is personal and fully customisable.
Features
Section titled “Features”Add widgets from any installed module (Resources, AutoSnap, Backup Analytics, Diagnostics, and more). You can resize and move each widget on the grid.
Multi-Cluster Filter
Turn on Allow clusters select on a dashboard to show a Clusters picker above the widgets and filter widget data by one or more clusters.
Auto Refresh
Set an automatic refresh interval (in seconds) to keep all widget data up to date without manual interaction. 0 turns automatic refresh off.
Import / Export
Export saves the current dashboard as a JSON file (dashboard-<name>.json). Upload loads a JSON file back as a new dashboard.
Why a custom dashboard when PVE has its own summary?
What you care about, not what's default
Compose the view: backup status + diagnostic alerts + cluster gauges + a Memo with the on-call rota. PVE shows the same thing to everyone.
Personal, not global
Each user has their own dashboards. Changing yours does not affect your colleagues, and they change theirs without seeing yours.
Widgets show data from Resources, AutoSnap, Backup Analytics, Replication Analytics, Diagnostics, Node Protect: every signal on one screen.
Auto-refresh + export
Set the refresh interval once. The dashboard stays current on a wall display. Export to JSON to keep a copy of a standard "ops board".
Managing dashboards
Section titled “Managing dashboards”The Dashboards drop-down at the top selects the dashboard to show (type in it to filter by name). The menu button (three dots) next to it lists the actions:
| Action | What it does |
|---|---|
| Refresh | Reloads the data of every widget of the current dashboard |
| New | Starts an empty dashboard, directly in edit mode |
| Upload | Imports a dashboard from a .json file |
| Clone | Opens a copy of the current dashboard in edit mode, with an empty name |
| Create default dashboard | Recreates the built-in dashboards (see Default Dashboard) |
| Edit | Enters edit mode on the current dashboard |
| Delete | Deletes the current dashboard, after confirmation |
| Export | Downloads the current dashboard as dashboard-<name>.json |
Upload: if a dashboard with the same name exists, the date and time are appended to the imported name.
Clone: the copy exists only in the page until it is saved. Give it a name and click Save: a new dashboard is created, and the original stays as it was.
Upload adds the imported dashboard to the dashboards of the user who uploads it, whatever owner is written in the file.
Edit Mode
Section titled “Edit Mode”Open the menu (three dots) and choose Edit to enter edit mode. The toolbar then shows:
| Control | Purpose |
|---|---|
| Name | Name of the dashboard. Save is disabled while it is empty |
| Save / Cancel | Save stores all changes in the database. Cancel discards unsaved changes |
| Refresh interval (sec.) | Automatic refresh of all widgets, in seconds. 0 = off |
| Allow clusters select | Shows the Clusters picker on the dashboard, to filter widget data by one or more clusters |
| Add widget | Menu of the widgets the user can see, grouped by module |
| Grid button | Shows or hides the layout grid |
In edit mode you can:
- Add widgets: select a widget from the Add widget menu. It is placed in the first free position on the grid. The new widget is titled
<module> - <widget>. - Move and resize: drag widgets to reposition them; drag the resize handle to change size. The grid has 24 columns and 24 rows.
- Configure: open the widget settings dialog to customize title (empty = hidden), title/body CSS styles, and widget-specific options.
- Clone: duplicate a widget with the same settings.
- Refresh: reload the data of that widget only.
- Remove: delete a widget from the dashboard.
Configure, Clone, Refresh and Remove are in the menu (three dots) on the title bar of each widget. The menu is visible only in edit mode. If you leave the page while in edit mode, the application asks for confirmation.
Widgets
Section titled “Widgets”The Dashboard has two generic widgets that are always available. Every other installed module adds its own widgets.
The list of the 32 widgets, with the module each one comes from, is in Widgets.
Widget options
Section titled “Widget options”Every widget has the common options of the Configure dialog: Title (empty = hide) and, under Style, Title CSS and Body CSS. These widgets add their own options:
| Widget | Options |
|---|---|
| Web Content | Type: Link (default; Url, Text, Icon, opens in a new tab), Iframe (Url of an embeddable page) or Html (HTML Content, rendered as is) |
| Memo | Markdown Content |
| Resources Status | Resource Type (default Vm) and, when it is Vm, VM Type (default Qemu) |
| Resources Usage | Use ProgressBar for percentage value (default on), Description as link (default on), Property Icon Status (default None), Icon Status (default IconAndText), plus the columns chosen in the widget grid |
| Check (AutoSnap, Backup Analytics, Replication Analytics) | Each has its own options in the same dialog |
Default Dashboard
Section titled “Default Dashboard”When a user has no dashboard (on first access, or after deleting the last one), cv4pve-admin creates two default dashboards from a built-in template, with only the widgets the user can see:
| Dashboard | Content | Refresh interval | Clusters picker |
|---|---|---|---|
| Home | Resource status counters, cluster map, usage grids and the check widgets of AutoSnap, Backup Analytics, Replication Analytics and Diagnostic | 10 seconds | on |
| Status | Status, size and info widgets of AutoSnap, Backup Analytics, Replication Analytics, Node Protect, Diagnostic and Update Manager | off | on |
You can recreate them at any time using the Create default dashboard action. Existing dashboards named Home or Status are not deleted: they are renamed to zzz_<name>-<date and time> and the fresh defaults take their names.
The Status default includes the Git Size widget of Node Protect, available only in the Enterprise edition EE. In the Community edition that tile stays empty and can be removed in edit mode.
Application permissions
Section titled “Application permissions”| Permission | Key | Grants |
|---|---|---|
| Dashboard | Dashboard.Link |
Access to the Dashboard page |
The built-in role Admin for module Dashboard includes it. A permission is also registered for each widget (Dashboard.Widget.Web Content, Dashboard.Widget.Memo, and <module>.Widget.<widget> for the widgets of the other modules).
A widget is shown for a cluster when the user holds the permission of the widget on that cluster, or can open the module the widget belongs to. Who can open Backup Analytics sees its widgets; the permission of a widget gives the widget alone to who cannot open the module.
- The Add widget menu lists only the widgets the user can see on at least one cluster.
- A widget reads only the clusters it is allowed on, also when no cluster is picked.
- A widget the user cannot see on any cluster stays in its place and shows You do not have permission to see this widget. It can be removed in edit mode. It appears in a dashboard made before the permissions changed, or uploaded from a file.
- The Clusters picker lists only the clusters the user can select.
- The widgets of AutoSnap, Backup Analytics, Replication Analytics, Diagnostic, Node Protect and Update Manager are shown only on the clusters where the user also holds Read on every VM, node and storage.
Roles and permissions are assigned in Admin Area → Security EE.
Proxmox VE privileges: the base (PVEAuditor) plus the following, each one only for its action.
| Privilege | Used for |
|---|---|
VM.PowerMgmt | Start, stop, shutdown, reboot, reset, suspend, resume a guest |
VM.Console | Guest console |
VM.Snapshot | Create, edit, delete a snapshot |
VM.Snapshot.Rollback | Roll back a snapshot |
VM.Replicate | Replication: Schedule Now |
VM.Backup, Datastore.AllocateSpace | Backups tab: list, configuration and deletion of backups |
Sys.Console | Node console |
Sys.PowerMgmt | Shut down, reboot a node |
The base and the rules common to all modules are in Proxmox VE Permissions.
