backup_storage_ranking
Rank protected objects by backup storage consumed, largest first, to identify which machines cost the most to protect. Handles owner attribution and scoping by backup or repository.
Instructions
[READ] Protected objects ranked by backup storage consumed, largest first.
Answers "which machines are the most expensive to protect". Each backup file
is charged to its single owner and one machine is merged across backups
(vCenter path / moref, agent BIOS UUID), each row carrying an explicit rank.
Shared and unattributable files are totals, never charged to anyone, split
into ownerlessStoredBytes (per-job chain files naming no owner — ordinary,
often large) and unmatchedOwnerStoredBytes (a file naming an owner its own
backup does not list and the server cannot resolve). An owner id missing
from its backup's listing is looked up once through /backupObjects/{id};
when found (a machine moved to another job) its bytes are charged and also
counted in recoveredOwnerStoredBytes, and unmatchedOwners says how each
id resolved (largest ids first; at most 50 entries, unmatchedOwnersTotal
and unmatchedOwnersTruncated say when there are more). Judge whether these
numbers can be billed on
unmatchedOwnerFiles being 0, never on the unresolved* sum.
A complete scan of a large estate is slow (a 123-backup VBR 13.1 estate took
21 minutes): scope it with backups or repository when the question is
about part of the estate. scoped true or backupsTruncated true means the
ranking covers only the selection or the scanned subset and must not be
reported as an estate-wide ranking. An entry in unreadableBackups with
timedOut true is fixed by raising the target's timeout in config.yaml,
not by retrying. Needs VBR 12.3+.
Args: limit: Rows to return, 1-500 (default 20). max_backups: Backups to scan within the scope, 1-1000 (default 100); raise for full coverage. backups: Only these backups, by id or name (a backup is named after its job; see backup_list). Omit for all. repository: Only backups stored in this repository, by id or name. concurrency: Backups read in parallel, 1-8 (default 1, sequential). Unmeasured on a real VBR: parallel reads load the same server and can push reads past the timeout; lower it if backups time out. target: Veeam target name from config; omit to use the default.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| target | No | ||
| backups | No | ||
| repository | No | ||
| concurrency | No | ||
| max_backups | No |