Multiple Formats
Export as Xlsx (single workbook with one sheet per section), Html (browsable static site) or Json (multi-file, one per section). Every report is downloaded as a single .zip.
System Report
Saves the state of a Proxmox VE cluster (configuration, resources, audit data) at a point in time in a single file to download. Use it for compliance audits, customer hand-over, change tracking and capacity planning. It is built on the cv4pve-report library.
Features
Section titled “Features”Presets & Fine-grained Settings
Pick a preset, or toggle every individual section yourself.
- Fast: structure only, no heavy data. Default for a new report
- Standard: the defaults. Everything except guest RRD data, audit log, syslog, S.M.A.R.T. and capacity planning
- Full: RRD on week timeframe, guest RRD, audit log, syslog, firewall log of the last 3 days, S.M.A.R.T., capacity planning
What's Included
- Cluster: overview, audit log, tasks
- Nodes: detail, APT updates, replication, RRD, syslog, S.M.A.R.T.
- Guests: snapshots, disks, partitions, QEMU agent, RRD
- Storage: content, backups, RRD
- Firewall: rules, aliases, ipsets, log
- Capacity Planning: average and peak usage of guests and nodes, storage growth and days to full. It needs the RRD data of each section
Resource Filters
Limit by node names (@all, comma-separated, wildcards) and by guest IDs.
Generate reports manually from the Reports page. Each report is saved with the format and settings you chose. In the history grid you can download or delete any past report and view the settings it was generated with.
Parallel Fetching
Max Parallel Requests (default 5) speeds up data collection on large clusters. Set it to 1 for sequential mode.
Why automate reports when PVE already shows everything in its UI?
One file you can hand off
Auditors, customers and capacity planners want a self-contained file. Pick the format that fits the receiver: Xlsx, Html or Json.
Reports are saved with the settings you chose. Open a report from six months ago and see what the cluster looked like then.
Heavy data on demand
S.M.A.R.T., syslog, firewall log, RRD over a week: include them only when you need them. The Fast preset stays light and quick.
Compliance ready
PVE shows the live state. A System Report has a date and can be archived. It answers the question that auditors ask: "what was running, where, when?". The mapping of checks to standards (ISO 27001, NIS2 and others) is in Diagnostics EE.
Sections
Section titled “Sections”- Overview: introduction to the module
- Reports: history of the generated reports with id, start, duration and format. See Reports
Reports
Section titled “Reports”| Action | What it does |
|---|---|
| New | Opens the New Report panel: choose the format and the content (see Report options), then save to start the generation in the background |
| Download | Downloads the selected report as a .zip file. Disabled until the report has ended |
| Delete | After confirmation, deletes the selected report and its file |
| Refresh | Reloads the grid |
The grid has no status column. A failed report has an end too: Download is active, and answers File not available for this report. The error is in the log of the task.
Click the Id of a row to open, read-only, the options the report was generated with. Progress and log of a running report are in the global Task Tracker.
Reports are generated on demand only: the module has no schedule and no retention, so old reports stay until you delete them.
Report options
Section titled “Report options”The Fast, Standard and Full buttons at the top of the panel load a ready-made set of values. The tables below show the Standard values. A new report starts with Fast.
General
Section titled “General”| Option | Standard | Purpose |
|---|---|---|
| Format | Xlsx | Xlsx, Html or Json |
| Max Parallel Requests | 5 | Max parallel requests when fetching data (1 = sequential) |
| API timeout (seconds) | 0 | API timeout in seconds (0 = use the default) |
Cluster
Section titled “Cluster”| Option | Standard | Purpose |
|---|---|---|
| Include | on | Cluster overview |
| Tasks | on | Cluster tasks |
| Audit Log | off | Cluster log, with Max Count (0 = unlimited) |
| Option | Standard | Purpose |
|---|---|---|
| Names | @all |
Nodes to include |
| RRD Data | on | Node metrics, with Time frame (Hour, Day, Week, Month or Year; default Day) and Consolidation (default Average) |
| Syslog | off | Node syslog, with Max Count (default 500, ignored when the period has a start date) and Period (a single date range field) |
| Replication | on | Replication jobs |
| Node Detail | on | Enables the options below |
| APT | on | Available APT updates |
| Disk Detail | on | Disk details |
| S.M.A.R.T. Data | off | S.M.A.R.T. attributes of the disks |
| Firewall Log | on | Node firewall log |
| Tasks | on | Node tasks, with Only Errors (off), Max Count (0 = unlimited) and Source (all, local or active; default all) |
Guest (VM / CT)
Section titled “Guest (VM / CT)”| Option | Standard | Purpose |
|---|---|---|
| IDs | @all |
Guests to include |
| RRD Data | off | Guest metrics, with Time frame and Consolidation |
| Snapshots | on | Snapshots of each guest |
| Disks | on | Disks of each guest |
| Partitions | on | Partitions of each guest |
| QEMU Agent | on | Data read through the QEMU Guest Agent, with Agent Timeout sec. (default 3) |
| Guest Detail | on | Enables Firewall Log (on) and Tasks (on, same options as the node tasks) |
The @all button of Names and IDs is shown only to a user who can read every VM, node and storage of the cluster. For the other users, the picker of IDs suggests only the guests they can read, without @all, pools, tags and nodes.
Storage
Section titled “Storage”| Option | Standard | Purpose |
|---|---|---|
| Content | on | Storage content |
| Backups | on | Backups on the storage |
| RRD Data | on | Storage metrics, with Time frame and Consolidation |
Firewall
Section titled “Firewall”| Option | Standard | Purpose |
|---|---|---|
| Firewall | on | Firewall rules, aliases, ipsets and log, with Max Count (0 = unlimited) and Period (a single date range field) for the log |
Capacity Planning
Section titled “Capacity Planning”| Option | Standard | Purpose |
|---|---|---|
| Capacity Planning | off | Average and peak usage of guests and nodes, storage growth and days to full. Each table needs the RRD Data of its section (Node, Guest, Storage) and uses its time frame |
Settings
Section titled “Settings”The module has no settings at module level: everything is chosen per report in Report options.
Widgets
Section titled “Widgets”| Widget | Content |
|---|---|
| Daily Status EE | Successful and failed reports per day (last 14 days) |
Permissions
Section titled “Permissions”Assign these to a role under Security.
| Permission | Allows |
|---|---|
| System Report | Open the module and its Overview page |
| Reports | Open the page with that name (one permission per page) |
| Report: Create / Delete | Start a New report, delete a report |
| Report: Download | Download a report |
| Daily Status EE | Use the dashboard widget |
The built-in role of the module includes all of them. A custom role has to be given them explicitly: without the permission the button is hidden.
Proxmox VE privileges: the base (PVEAuditor) plus the following.
| Privilege | Used for | Without it |
|---|---|---|
Sys.Modify | Updates available on each node, Standard and Full presets | A warning for each node |
Sys.Syslog | Node firewall log (Standard and Full presets) and syslog (Full preset) | A warning for each node |
VM.Console | Firewall log of the guests, Standard and Full presets | A warning for each guest |
VM.Backup, Datastore.AllocateSpace | Backups, Standard and Full presets | The backups are missing from the report |
VM.Config.Disk | Disk images in the storage content, Standard and Full presets | The disk images are missing from the report |
The Fast preset needs the base only. All these privileges except Sys.Syslog are more than read-only: Proxmox VE asks for them also to read these data.
The base and the rules common to all modules are in Proxmox VE Permissions.
