Veeam VDC Storage Vault - Version 1.0

Overview

The Veeam VDC Storage Vault - Version 1.0 collector retrieves storage vault consumption data from a Veeam Service Provider Console (VSPC) environment using the VSPC REST API v3, specifically the VDC Vault storage vaults endpoint.

This collector provides visibility into how much storage each tenant is consuming across their Veeam Data Cloud (VDC) storage vaults, enabling service providers to track storage usage and allocate costs within Varibill.

The collector retrieves unrated allocation data, meaning no monetary values are supplied by the source system. Pricing and billing calculations are applied within Varibill based on configured contracts and pricing rules.

This is a point-in-time collector, meaning each execution retrieves the current state of storage vault consumption at the time of collection.

For general instructions on creating and running Source Collectors, see: Configuring a New Cloud Source Collector

Collector Summary

About Veeam Service Provider Console

Veeam is a provider of data protection, backup, and disaster recovery solutions for virtual, physical, and cloud-based workloads.

Veeam Service Provider Console (VSPC) is a management and monitoring platform designed for service providers and managed service providers (MSPs). It enables centralized oversight of Veeam-protected environments across multiple customer tenants, including backup infrastructure, storage resources, and license usage.

Veeam Data Cloud (VDC) storage vaults are cloud-based storage targets provisioned within the VSPC environment. Each storage vault is associated with a tenant and a data centre region, and stores backup data consumed by that tenant’s protected workloads.

Data Collected

The Veeam VDC Storage Vault - Version 1.0 collector retrieves unrated storage consumption data from Veeam Service Provider Console. For each storage vault, the collector submits one record representing the consumed storage space.

The quantity for each record is the consumed space in terabytes (TB), converted from the raw byte value reported by the API.

Each record includes the tenant name and storage vault name.

The Product Identifier is constructed as {Product Identifier Prefix}{data centre region}, where the data centre region is the identifier reported by the VSPC API for the storage vault’s location (for example, southafricanorth or uksouth). Examples: VDC#southafricanorth, VDC#uksouth.

The Client Identifier submitted to Varibill is constructed as {tenant UID}#{storage vault UID}, using the GUIDs assigned by the VSPC environment.

The Record Identifier for each record takes the form Usage on storage vault {vault name} for tenant {tenant name}.

The Unique Identifier is the same as the Client Identifier: {tenant UID}#{storage vault UID}.

Ensure your Varibill product configuration accounts for these formats.

Prerequisites

Before configuring this collector, ensure that:

• You have administrator access to the Veeam Service Provider Console
• You have generated a REST API key in the VSPC portal with appropriate permissions
• You have noted the URL of your VSPC environment (including the port number)
• You have access to the Varibill Source Collector configuration screen

Configuration Parameters

The parameters below are entered when configuring the collector in Varibill. They are grouped by function.

Connection Parameters

These parameters identify and authenticate against your Veeam Service Provider Console environment.

Billing Parameters

Operational Parameters

These parameters control file management behavior.

Configuration Steps

Step 1: Prepare Veeam Service Provider Console

1. Log in to the Veeam Service Provider Console as an administrator.
2. Navigate to the API key management section.
3. Generate a new REST API key or locate an existing key with appropriate permissions.
4. Copy the API Key value.
5. Note the VSPC URL from your browser’s address bar, including the port number (for example, https://your-vspc-host:1280).

Step 2: Configure the Collector in Varibill

1. In the Varibill User Interface, open the Source Collector configuration screen.

2. Enter the required field values under the Details tab:

   • Hosting Provider: Select Varibill Cloud
   • Source Collector Name: Select Veeam VDC Storage Vault - Version 1.0

3. Enter the connection parameters:

   • Veeam Host: The base URL of your VSPC environment, including the port number (for example, https://your-vspc-host:1280)
   • Veeam API Key: The REST API key from the VSPC portal

4. Enter the billing parameters:

   • Product Identifier Prefix: The prefix to apply to Product Identifiers (for example, VDC#)

5. Save the collector configuration.

Step 3: Run the Collector

Run or schedule the collector according to your standard Source Collector execution process.

For detailed instructions, see: Configuring a New Cloud Source Collector

Troubleshooting

If the collector fails to connect to Veeam Service Provider Console, verify that:

• The Veeam Host URL is correct, includes https://, and specifies the correct port number.
• The Veeam API Key is valid and has not been revoked or regenerated since it was last configured.
• The API Key has sufficient permissions to query VDC Vault storage vault data.
• No firewall or IP restriction rules are blocking the Varibill collector’s IP address from reaching the VSPC port.

If the collector connects successfully but returns no data, verify that:

• There are active tenants with VDC storage vaults provisioned in your VSPC environment.
• The storage vaults have consumed storage space (vaults with zero consumption will still be reported).
• The VSPC environment is running and reporting data correctly.

Veeam References

The following resources may assist with locating values or configuring your Veeam API access.

Veeam Documentation (External)

• Veeam Website
• Veeam Service Provider Console REST API Reference