Overview
The Veeam Cloud Connect V3.6 collector retrieves tenant license usage, backup resource storage, and replication resource storage data from a Veeam Service Provider Console (VSPC) environment using the VSPC REST API v3.
This collector provides visibility into managed tenant workloads, backup storage consumption, and replication storage quotas, enabling service providers to validate subscriptions, reconcile 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 tenant usage and resource allocations at the time of collection.
For general instructions on creating and running Source Collectors, see: Configuring a New Cloud Source Collector
Collector Summary
| Field | Value |
|---|---|
| Source Collector Name | Veeam Cloud Connect V3.6 - Version 11.0 |
| Collection Behavior | Point in Time |
| Rating Model | Unrated |
| Vendor Name | Veeam |
| Product | Veeam Service Provider Console |
| Purpose | Retrieves tenant license usage, backup storage, and replication storage data from Veeam Service Provider Console for billing and validation within Varibill |
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, replication resources, and license usage.
Service providers use VSPC to manage tenant organizations, monitor backup and replication workloads, track license consumption across product types and editions, and provision cloud-connected infrastructure for their customers.
Data Collected
The Veeam Cloud Connect V3.6 - Version 11.0 collector retrieves unrated tenant allocation data from Veeam Service Provider Console across three data categories:
- License usage — workload counts per tenant organization, broken down by product type (such as BackupAndReplication, CloudConnect, VSPC, VONE, VB365, or VDP), license edition, and workload type. Usage is aggregated per organization and submitted as individual allocation records.
- Backup resource storage — storage consumption for each tenant’s backup resources, reported by resource type.
- Replication resource storage — storage quota allocations for each tenant’s replication resources, derived from hardware plan and storage configurations.
Note: Storage values measured in bytes are automatically converted to gigabytes (GB) before submission to Varibill.
Note: The Veeam Cloud Connect V3.6 - Version 11.0 collector reflects the state of the VSPC environment at the time it runs. More frequent execution improves billing accuracy for environments with frequent workload or storage changes.
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
Tip: The VSPC URL includes the port number used by the REST API
service. Confirm the correct port with your VSPC administrator. The
format is typically https://your-vspc-host:1280.
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.
| Parameter | What it is | Where to find it |
|---|---|---|
| Veeam URL | The base URL of your VSPC environment, including the port number | Your VSPC administrator. Format:
https://your-vspc-host:1280 (include https://
and the port number, no trailing slash) |
| Veeam API Key | The REST API key used to authenticate against the VSPC API | Veeam Service Provider Console → API key management |
Warning! The Veeam API Key grants API access to your VSPC environment. Store it securely and do not share it. If the key is compromised, revoke and regenerate it immediately in the VSPC portal.
Billing Parameters
| Parameter | What it is | Example |
|---|---|---|
| Veeam Code | A prefix applied to the beginning of each Product Identifier submitted to Varibill for license usage and backup resource records. Must be between 2 and 10 characters. | VCC# |
| Replication Code | A code appended to the Veeam Code to form the Product Identifier for replication storage records. Must be between 1 and 15 characters. | Replica |
Note: Product Identifiers are constructed differently depending on the data type:
- License usage records:
{Veeam Code}#{product type}#{license edition}#{workload type} - Backup resource records:
{Veeam Code}{resource type} - Replication storage records:
{Veeam Code}{Replication Code}
Ensure your Varibill product configuration accounts for all three formats.
Operational Parameters
These parameters control collection and file management behavior.
| Parameter | What it is | Default |
|---|---|---|
| Delete data files older than | The number of days after which locally stored collection files are automatically deleted | 62 |
| Maximum number of records per file | The maximum number of records written to a single output file before a new file is started. Must be between 1,000 and 50,000. | 10000 |
Veeam References
The following resources may assist with locating values or configuring your Veeam API access.
Veeam Documentation (External)
Note: Veeam documentation is provided for reference. Steps and interface labels may vary depending on your VSPC version and account permissions.
Configuration Steps
Step 1: Prepare Veeam Service Provider Console
- Log in to the Veeam Service Provider Console as an administrator.
- Navigate to the API key management section.
- Generate a new REST API key or locate an existing key with appropriate permissions.
- Copy the API Key value.
- 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
In the Varibill User Interface, open the Source Collector configuration screen.
Enter the required field values under the Details tab:
- Hosting Provider: Select Varibill Cloud
- Source Collector Name: Select Veeam Cloud Connect V3.6 - Version 11.0
Enter the connection parameters:
- Veeam URL: 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
- Veeam URL: The base URL of your VSPC environment,
including the port number (for example,
Enter the billing parameters:
- Veeam Code: The prefix to apply to Product
Identifiers (for example,
VCC#) - Replication Code: The code for replication storage
Product Identifiers (for example,
Replica)
- Veeam Code: The prefix to apply to Product
Identifiers (for example,
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 URL is correct, includes
https://, and specifies the correct port number. - The API Key is valid and has not been revoked or regenerated since it was last configured.
- The API Key has sufficient permissions to query organization, infrastructure, and licensing data.
- No firewall or IP restriction rules are blocking the Varibill collector’s IP address from reaching the VSPC port.
If no data is returned despite a successful connection, verify that:
- There are active tenant organizations with managed workloads in your VSPC environment.
- Tenants have backup resources, replication resources, or license usage associated with them.
- The VSPC environment is running and reporting data correctly.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article