Advanced Options - External Data Connector

Table of Contents

Components Created after Discovery

Components Created After Migration

Discover Based on Specific Criteria

Advanced Discovery Options

Capture Metadata Using Decoupled Install


Related Reports

Components Created after Discovery

Your first discovery and migration operations lay the foundation for protecting and recovering Veeam clients using the CommCell software. By default, all future discovery operations occur incrementally. Only new or changed Veeam information is merged into the CommCell Console. Similarly, you can run migration operations on-demand, as needed. In both cases, use the Discover and Migrate topic to perform future discovery and migration operations.

After the discovery process is complete, Veeam components, such as servers, virtual machines, and backup repositories are mapped to the appropriate CommCell entity. The following versions of Veeam are supported for these Veeam component groupings:

Veeam Grouping


Supported Veeam Versions*


Servers, virtual machines, jobs, and backup repositories.

7.0, 8.0, 9.0, 9.5


Backup job information is migrated for CommCell reporting purposes.

7.0, 8.0, 9.0, 9.5


Backup repositories and status are migrated for CommCell reporting purposes.

7.0, 8.0, 9.0, 9.5

*Only Windows platforms are supported.

Configuration Entities

The following table lists the Veeam configuration entities that are discovered and how they are mapped to CommCell entities.

Veeam Component



Servers are brought in initially as deconfigured clients and are shown under Client Computer Group in CommCell Console.

To display the discovered servers, deselect the Hide deconfigured clients option in the User Preferences dialog box.

All discovered Veeam servers are grouped into a single Client Computer Group based on the instance from which the discovery operation was run.

Veeam Virtual Server Type

  • VMware vSphere
  • Microsoft Hyper-V

CommCell Entity

  • Virtual Server Agent


Virtual Machines

During the merge, virtual machines are included as part of backup jobs. Backup jobs become subclients. Virtual machines are not merged as individual entities into the CommCell Console.


Veeam backup jobs are migrated to CommCell subclients under a single backup set for each Veeam server. The Objects in a Veeam backup job become the content of the subclient in the CommCell Console.

Also, note that when previously merged jobs are deleted from the Veeam server, the corresponding CommCell subclients are not automatically deleted from the CommCell Console during the next merge operation. Thus, you must manually remove any subclients associated with deleted jobs.

Veeam Job

  • Backup Job

CommCell Entity

  • Subclient

Policy Schedules (Frequency)

These schedule frequencies are migrated to a CommCell Schedule Policy:

  • Hourly
  • Daily
  • Monthly

Policy Schedules (Calendar)

Veeam Calendar

  • Daily
  • Monthly
  • Periodically
  • After this job

CommCell Schedule*

  • Daily
  • Yearly
  • Yearly
  • One Time

    *Veeam calendar schedules are migrated to a CommCell Schedule Policy.

Backup Repository

Veeam Backup Repositories are migrated to CommCell MediaAgents with all configured properties.

Job Entities

The following table lists the Veeam job entities that are discovered and how they are mapped to CommCell entities.

Veeam Component


Backup Jobs

Backup job information is migrated for CommCell reporting purposes.

Media Entities

The following table lists the Veeam media entities that are discovered and how they are mapped to CommCell entities.

Veeam Component


Backup Repository

Backup job schedules policies are migrated to CommCell storage policies. If the backup job has data retention settings configured, they are included in the CommCell Schedule Policy as well.

Components Created After Migration

The following table illustrates the CommCell Agents that are created for Veeam clients during the migration process:

Veeam Component Type

Corresponding CommCell Agent

CommCell Agent as Displayed in the CommCell Console

Virtual Server

Virtual Server Agent

Virtual Server

Backup Job


Backup Job Name

Discover Based on Specific Criteria

In between your regular full or incremental discovery operations, it may be necessary to perform a discovery based on a specific set of criteria. All options are available in the General tab of the EDC Subclient Property Dialog dialog box, which is accessible by right-clicking the External Data Connector subclient and clicking Properties.

Advanced Discovery Options

By default, incremental discovery operations collect only client configuration information. However, several additional options are available if you require more comprehensive information about the discovered clients. The following sections describe the options available.

To configure these settings, perform the following steps:

  1. In the CommCell Browser, right-click the default subclient for which you want to discover Veeam data, and then click Discover.

    The Discovery Options dialog box appears.

  2. On the Job Initiation tab, click Advanced.
  3. In the Advanced Discovery Options dialog box, select the options that you want to configure, and then click OK.

The following pages describe the advanced operations available on each tab:

Capture Metadata Using Decoupled Install

This method uses External Data Connector to populate Veeam Server information into an XML file, which is then applied to an existing CommServe database. This method does not require any direct connectivity between the Veeam Server and the CommServe computer, which is useful if you do not want to deploy a new CommServe database in a particular environment.

This method consists of three phases:

  1. Install External Data Connector on the Veeam Server
  2. Create XML Files Containing Veeam Server Information
  3. Populate the XML Files in a CommServe Computer

The following sections describe these phases in detail.

Install External Data Connector on the Veeam Server

External Data Connector must first be installed on the Veeam Server. If you want to perform this installation in the absence of CommServe software, create a decoupled custom package with the External Data Connector and then install the package on the Veeam Server. For instructions, see Custom Package.

Create an XML File Containing Veeam Server Information

Once External Data Connector is installed on the Veeam server, a bundle file that contains the Veeam server information must be created.

  1. On the Veeam server, from the command line, navigate to the base folder for the External Data Connector software.
  2. On Windows, execute the following command:

    CVForeignHandler -collectdata -vendor "Vendor_Type_Number" -user "External_Database_Admin_User" -password "External_Database_Admin_User_Password" -vm "Instance_Name" -cn "Client_Computer_Name" -inc -collectconfig -dir "File_Path"

    For example:

    CVForeignHandler –collectdata –vendor 15 –user "bsmith" –password "689Gmre4" -vm "Instance001" –cn "client1"

    By default, this command will populate all contents of the Veeam database into a .zip file in the JobResults folder.


The command includes several parameters that you can set, according to your needs. Parameters to gather the server information include the following:




Numeric value that represents the vendor type. Vendor types include the following:

  • 1 - NetBackup
  • 2 - NetApp
  • 8 - Tivoli Storage Manager
  • 12 - EMC Networker
  • 13 - BackupExec
  • 15 - Veeam


User name for the external database. This parameter is not applicable for EMC Networker.


Password associated with the user name for the external database in plain text. This parameter is not applicable for EMC Networker.


Instance name as it will appear in the CommCell Console.


Client name as it will appear in the CommCell Console.


Forces an incremental discovery operation.


Contacts remote clients to collect configuration information.


Specifies the directory where existing data should be read, instead of running commands.

Populate the XML File in the CommServe

Once the XML file is created, copy it to the CommServe computer and populate the information into the CommServe database.

  1. Copy the XML file into a location on the CommServe computer.
  2. From the CommCell Console, initiate a Discovery operation.
  3. From the General tab of the Advanced Discovery Options dialog box, select the following options:
    • Full Sync to populate all information in the XML file.
    • Merge from folder to identify the XML file that contains the Veeam Master Server information. You can use the Browse option to navigate to the location of the XML file.
  4. Click OK.

The Veeam server information is populated into the CommServe database.


External Data Connector (EDC) Discovery might fail with the following condition:

  • Schedules have no window defined.

    This issue can be resolved by defining a schedule window.

Related Reports

A variety of reports are available that provide detailed information on previously run Veeam jobs, as well as jobs run using the CommCell software after migration, as described below:

Reports on CommCell Console

After your first discovery, you can run reports on the CommCell Console to obtain information on all past Veeam data protection and recovery jobs.

By default, all reports display information according to CommCell entities; that is, a Veeam policy will appear as a subclient, and so on. However, several reports can be customized to display information according to the original Veeam entity. While the details of the report remain the same in either case, this option is useful as a tool for new CommCell users who may not be familiar with CommCell components.

For more information, see Classic Reports on the CommCell Console.

Last modified: 2/27/2018 8:31:15 PM