(click to expand table of contents)

• License Usage Reporting
  • Monthly License Usage Report
  • Mid-month License Usage
• Storage Usage Reporting
  • Backup Resources
  • Replication Resources
• IaaS Usage Reporting
  • IaaS License Usage
  • IaaS Storage Usage
    • Option 1: Protected Workloads API
    • Option 2: Dedicated Repositories

Note: Please take heed of the following items, as highlighted in Veeam documentation, as they’ll most likely require additional configuration in your custom integration or in your Veeam environment:

• Asynchronous Processing
• Throttling

License Usage Reporting

Monthly License Usage Report

Generated once a month at the beginning of the month. It can also be accessed using the web UI and should be used for reporting your monthly license usage to Veeam as defined in the Veeam Rental Licensing and Usage Reporting reference guide.

• /v3/licensing/reports/latest: Returns the most recent usage report
• /v3/licensing/reports/{date}: Returns the usage report for the specified date. Useful for pulling usage reports older than the previous month.

Mid-month License Usage

Returns point-in-time license usage for the current calendar month. This is beneficial for those customers with a billing cycle ending in the middle of the month.

• /v3/licensing/sites/usage/companies: Returns Veeam Cloud Connect licenses usage by companies
• /v3/licensing/backupServers/usage/companies: Returns Veeam Backup & Replication rental licenses usage by companies. This is any VBR server managed by VSPC that is using your company’s Veeam rental license.
• /v3/licensing/console/usage/companies: Returns usage by companies for all agents (VAW/VAL/VAM) managed directly by VSPC
• /v3/licensing/voneServers/usage/companies: Returns Veeam ONE (11a) licenses usage by companies
• /v3/licensing/vbm365Servers/usage/companies: Returns Veeam Backup for Microsoft 365 (v6) licenses usage by companies

Storage Usage Reporting

Backup Resources

• /v3/organizations/companies/sites/backupResources/usage: Returns current Cloud Connect backup resource usage by companies

Replication Resources

• /v3/organizations/companies/sites/replicationResources/usage: Returns current Cloud Connect replication (VMware vCenter) resource usage by companies
• /api/v3/organizations/companies/sites/vcdReplicationResources/usage: Returns current Cloud Connect replication (VMware Cloud Director) resource usage by companies

IaaS Usage Reporting

This section describes common methods used by service providers to pull chargeback usage for their IaaS customers.

Tip: Use Filter query string to limit results

IaaS License Usage

1. /v3/infrastructure/backupServers/jobs: Retrieve IaaS customer backup jobs
   • Uniquely naming the backup job so you can identify the IaaS customer is key.
   • Filter by backup job name
2. /v3/protectedWorkloads/virtualMachines: Retrieve VMs protected by IaaS customer backup jobs
   • Filter by backup job ID (jobUid)
   • You can further filter the results to show only VMs with the latestRestorePointDate within the previous 30 days if you want to mimic Veeam Rental License and Usage Reporting guidelines.
3. The total VM count of all VMs identified in the previous step is the IaaS customer license usage.

IaaS Storage Usage

Option 1: Protected Workloads API

This method is more granular than option 2 and is discussed in further detail in the IaaS License Usage section. High-level…you identify all VMs protected by the backup jobs and take the sum of the totalRestorePointSize parameter for those VMs.

1. /v3/infrastructure/backupServers/jobs: Retrieve IaaS customer backup jobs
2. /v3/protectedWorkloads/virtualMachines: Retrieve VMs protected by IaaS customer backup jobs
3. The sum of the totalRestorePointSize parameter for all VMs identified in the previous step is the IaaS customer storage usage.

Option 2: Dedicated Repositories

If you can dedicate a repository for each IaaS customer, then you can pull storage usage at the repository-level either using Veeam APIs (or direct from the storage).