Veeam Service Provider Console (SPC)

This document provides the steps required to configure the Veeam Service Provider Console (SPC) Integration with Synthesize.

Overview

Our integration with the Veeam Service Provider Console (SPC) seamlessly synchronizes service usage data by company directly from Veeam Service Provider Console. To deploy and configure Veeam Service Provider Console, please review the following documentation: Veeam Service Provider Console Deployment Guide.

Authentication Details

To begin, it is essential to collect the API URL and generate an API Key that will be used to establish a connection with the Veeam Service Provider Console.

API URL

Whitelisting IPs on Host Server

Due to the random IPs utilized by our Veeam SPC integration, whitelisting IPs on your Veeam SPC host server is currently not feasible. We're devising a plan to enable whitelisting for static IPs on your host server. However, if you prefer not to expose your host server to the internet at the moment, you can implement a custom "self-hosted" integration with Veeam SPC. For more details, reach out to support@meetgradient.com.

Certificate Requirement on Host Server

Note that a SSL certificate is mandatory for the server hosting the console. This certificate is crucial for authentication and establishing connections with the host server. Failure to have a valid SSL certificate in place can result in Synthesize being unable to authenticate or establish a connection with the host server.

Certificate Verification

Utilizing a reliable third-party certificate check tool like www.sslshopper.com/ssl-check.html can help identify any missing certificates. In instances where a certificate is not recognized as trusted, it may be necessary to install an intermediate/chain certificate or associate the URL with a trusted root certificate.

To establish a connection with our integration, you'll require the API URL tailored to your specific setup. The API URL adheres to the following format:

  • If you're accessing the Veeam Service Provider Console Web UI via HTTPS without a designated port number:

    API URL: https://<hostname>

  • In case you're connecting to the Veeam Service Provider Console Web UI using HTTPS with a customized port number:

    API URL (with port): https://<hostname>:<port>

    • Please note that the default port number is 1280.

For more comprehensive information on Resource URLs, please consult the following documentation: Veeam Service Provider Console REST API Resource URLs.

API Key

When configuring our Veeam integration, we employ the "Simple API Key" method for authentication. This method generates a single Private Key that serves as your authentication token for seamless access to our integration.

For guidance on creating a Simple API Key, refer to the following guide: Configuring a Simple API Key.

Connect Veeam SPC

  1. Login to Synthesize by Gradient MSP. If you don't already have an account, you can easily register an account by entering your email address or SSO credentials.
  2. Navigate to the Integrations tab.
  3. Select the Veeam SPC integration and click Connect.
  4. Select Billing Only and click Continue.
  5. Enter the API URL and API Key generated from Veeam Service Provider Console in the previous steps.
  6. Click Authenticate.
  7. Once successfully authenticated, accounts and services will be generated, and the integration will be updated to a pending status. You can click the status refresh button or simply refresh your browser if you are unable to proceed to the next step.
  8. Click Next.

Map Accounts and Services

  1. Map your accounts and services by dragging the card from Synthesize on the left to Veeam SPC on the right.
    1. We offer options to map to product and retention types.  This is to accommodate the different ways that MSP resell these services. You only need to map to the relevant service for your use case. 
  2. Review service mappings, and when you are ready, click Finish to start syncing information into Synthesize.

Usage Breakdown for Managed Services

This comprehensive breakdown outlines the various services integrated into Synthesize. We aggregate usage data from these services based on Managed services counters from the Veeam Service Provider Console REST API. This breakdown serves as a reference for mapping services when configuring the integration in Synthesize.

To access a more extensive catalog of billable services within the Veeam Service Provider Console, please consult the following documentation: Veeam Service Provider Console - Services.

Service Description
AgentCloudBackupDataTransferIn Agent cloud backup data transfer (incoming).
AgentCloudBackupDataTransferOut Agent cloud backup data transfer (outgoing).
BackedupVms Backed up virtual machines.
CloudArchiveTierBackupSize Cloud archive tier backup size.
CloudCapacityTierBackupSize Cloud capacity tier backup size.
CloudInsiderProtectionBackupSize Cloud insider protection backup size.
CloudObjectStorageUsage Object cloud storage usage.
CloudPerfomanceTierBackupSize Cloud performance tier backup size.
CloudRegularStorageUsage Regular cloud storage usage.
CloudRepositoryUsageByServerAgent Cloud repository usage by server agents.
CloudRepositoryUsageByVm Cloud repository usage by virtual machines.
CloudRepositoryUsageByWorkstationAgent Cloud repository usage by workstation agents.
CloudTotalUsage Total cloud storage usage.
FileShareArchiveSize File share archive size.
FileShareBackupSize File share backup size.
FileShareSourceSize File share source size.
ManagedAgentsLinuxOS Managed agents for Linux OS.
ManagedAgentsMacOS Managed agents for macOS.
ManagedAgentsWindowsDesktopOS Managed agents for Windows desktop OS.
ManagedAgentsWindowsServerOS Managed agents for Windows server OS.
ManagedCloudVms Managed cloud virtual machines.
ManagedServerAgents Managed server agents.
ManagedUsers Managed users.
ManagedVms Charged by the number of managed VMs.

A managed VM is a VM that has a backup or replica restore point.
ManagedWorkstationAgents Managed workstation agents.
ReplicatedVms Replicated virtual machines.
Vb365ArchiveSize Veeam 365 archive size.
Vb365BackupSize Veeam 365 backup size.
Vb365ProtectedGroups Veeam 365 protected groups.
Vb365ProtectedSites Veeam 365 protected sites.
Vb365ProtectedTeams Veeam 365 protected teams.
Vb365ProtectedUsers Veeam 365 protected users.
VbrCloudBackupDataTransferIn Veeam Backup & Replication cloud backup data transfer (incoming).
VbrCloudBackupDataTransferOut Veeam Backup & Replication cloud backup data transfer (outgoing).
VbrCloudReplicaDataTransferIn Veeam Backup & Replication cloud replica data transfer (incoming).
VbrCloudReplicaDataTransferOut Veeam Backup & Replication cloud replica data transfer (outgoing).
VmCloudBackups Virtual machine cloud backups.
VmCloudReplicaComputeTime Compute time for virtual machine cloud replicas.
VmCloudReplicaStorageUsage Storage usage for virtual machine cloud replicas.
VmCloudReplicas Virtual machine cloud replicas.
WorkstationCloudBackups Workstation cloud backups.