Page Comparison

...

To run this collector, there are some configurations detailed below that you need to consider.

Configuration	Details
System requirements	OS 64-bit versions. OS - Microsoft Windows Server 2022. Local or remote installation of the Microsoft SQL Server 2019.

Info

More information

Refer to the Vendor setup section to know more about these configurations.

...

Veeam Backup & Replication is a comprehensive data protection and disaster recovery solution. With Veeam Backup & Replication, you can create image-level backups of virtual, physical, and cloud machines and restore from them.

Devo collector features

Feature	Details
Allow parallel downloading (`multipod`)	`Not allowed`
Running environments	`Collector server` `On-premise`
Populated Devo events	`Table`
Flattening preprocessing	`No`

Data sources

Data source	Description	API endpoint	Collector service name	Devo table	Available from release
BackUp Server Data	Returns a resource representation of a collection of backup servers connected to Veeam Backup Enterprise Manager.	`/query?type=BackupServer`	`backup_server_data`	`backup.veeam.backup_replication.backupserverdata`	`v1.0.0-beta1`

Vendor setup

Anchor

	Vendor-setup
	Vendor-setup

...

Info
This minimum configuration refers exclusively to those specific parameters of this integration. There are more required parameters related to the generic behavior of the collector. Check setting sections for details.

Setting	Details
`<api_base_url_value>`	This parameter is the URL of the Veeam instance.
`<username_value>`	The Veeam username.
`<password_value>`	The Veeam password.

Info
See the Accepted authentication methods section to verify what settings are required based on the desired authentication method.

Accepted authentication methods

Authentication method

Username

Password

Username/Password

Status

colour	Green
title	REQUIRED

Status

colour	Green
title	REQUIRED

Run the collector

Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).

Rw ui tabs macro

Rw tab

title	On-premise collector

This data collector can be run in any machine that has the Docker service available because it should be executed as a docker container. The following sections explain how to prepare all the required setup for having the data collector running.

Structure

The following directory structure should be created for being used when running the collector:

Code Block

<any_directory>
└── devo-collectors/
    └── <product_name>/
        ├── certs/
        │   ├── chain.crt
        │   ├── <your_domain>.key
        │   └── <your_domain>.crt
        ├── state/
        └── config/ 
            └── config.yaml

Note
Replace `<product_name>` with the proper value.

Devo credentials

In Devo, go to Administration → Credentials → X.509 Certificates, download the Certificate, Private key and Chain CA and save them in <product_name>/certs/. Learn more about security credentials in Devo here.

Note
Replace `<product_name>` with the proper value.

Editing the config.yaml file

Code Block

globals:
  debug: <enable_debug_logs>
  id: not_used
  name: veeam_backup_manager_collector
  persistence:
    type: filesystem
    config:
      directory_name: state
outputs:
  devo_1:
    type: devo_platform
    config:
      address: <your-ingestion-endpoint>
      port: 443
      type: SSL
      chain: <chain_filename>
      cert: <cert_filename>
      key: <key_filename>
inputs:
  veeam_backup_manager_collector_input:
    id: <short_unique_id>
    enabled: True
    requests_per_second: <requests_per_second>
    api_base_url: <api_base_url_value>
    credentials:
      username: <username_value>
      password: <password_value>
    services:
      backup_server_data:
        request_period_in_seconds: <request_period_in_seconds_value>
        devo_tag: <override_devo_tag>
        filter_by_uid: <optional_uid_filter>
        filter_by_description: <optional_description_filter>
        filter_by_port:  <optional_port_filter>
        filter_by_version: <optional_version_filter>

Info
All defined service entities will be executed by the collector. If you do not want to run any of them, just remove the entity from the `services` object.

Replace the placeholders with your required values following the description table below:

Parameter

Data type

Type

Value range / Format

Details

<enable_debug_logs>

bool

Mandatory

false / true

This will make the collector generate (or not) log messages with the DEBUG level.

<your-ingestion-endpoint>

str

Mandatory

collector-us.devo.io
collector-eu.devo.io

Use this param to identify the Devo Cloud where the events will be sent.

<chain_filename>

str

Mandatory

Minimum length: 4
Maximum length: 20

Use this param to identify the chain.cert file downloaded from your Devo domain. Usually this file's name is: chain.crt

<cert_filename>

str

Mandatory

Minimum length: 4
Maximum length: 20

Use this param to identify the file.cert downloaded from your Devo domain.

<key_filename>

str

Mandatory

Minimum length: 4
Maximum length: 20

Use this param to identify the file.key downloaded from your Devo domain.

<short_unique_id>

int

Mandatory

YMMDD

Use this param to give a unique id to this input service.

Note
This parameter is used to build the persistence address, do not use the same value for multiple collectors. It could cause a collision.

<requests_per_second>

int

Optional

Minimum value: 1

Customize the maximum number of API requests per second. If not used, the default setting will be used: 100000 requests/sec.

Info
This parameter should be removed if it is not used.

<api_base_url_value>

str

Mandatory

Valid URL

This parameter is the URL of the Veeam instance.

<username_value>

str

Mandatory

Minimum length: 1

The Veeam username.

<password_value>

str

Mandatory

Minimum length: 1

The Veeam password.

<request_period_in_seconds_value>

int

Optional

Minimum value: 1

Period in seconds used between each data pulling, this value will overwrite the default value (60 seconds).

Info
This parameter can be removed or commented.

<override_devo_tag>

str

Optional

A Devo Tag. For more information see Devo Tags.

This parameter allows to define a custom devo tag.

Info
This parameter should be removed if it is not used.

<optional_uid_filter>

str

Optional

Minimum length: 1

This parameter allows you to filter the results by UID.

Info
This parameter should be removed if it is not used.

<optional_description_filter>

str

Optional

Minimum length: 1

This parameter allows you to filter the results by description.

Info
This parameter should be removed if it is not used.

<optional_port_filter>

str

Optional

Minimum length: 1

This parameter allows you to filter the results by port number.

Info
This parameter should be removed if it is not used.

<optional_version_filter>

str

Optional

Minimum length: 1

This parameter allows you to filter the results by version.

Info
This parameter should be removed if it is not used.

Download the Docker image

The collector should be deployed as a Docker container. Download the Docker image of the collector as a .tgz file by clicking the link in the following table:

Collector Docker image	SHA-256 hash
collector-veeam_if-docker-image-1.0.0	`5f2cf7b281f2d0539a97bce40f05c8102975f70de0ee3d0528406f2145257911`

Use the following command to add the Docker image to the system:

Code Block
gunzip -c <image_file>-<version>.tgz \| docker load

Note
Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace `<image_file>` and `<version>` with a proper value.

The Docker image can be deployed on the following services:

Docker

Execute the following command on the root directory <any_directory>/devo-collectors/<product_name>/

Code Block

docker run 
--name collector-<product_name> 
--volume $PWD/certs:/devo-collector/certs 
--volume $PWD/config:/devo-collector/config 
--volume $PWD/state:/devo-collector/state 
--env CONFIG_FILE=config.yaml 
--rm 
--interactive 
--tty 
<image_name>:<version>

Note
Replace `<product_name>`, `<image_name>` and `<version>` with the proper values.

Docker Compose

The following Docker Compose file can be used to execute the Docker container. It must be created in the <any_directory>/devo-collectors/<product_name>/ directory.

Code Block

version: '3'
services:
  collector-<product_name>:
    image: <image_name>:${IMAGE_VERSION:-latest}
    container_name: collector-<product_name>
    volumes:
      - ./certs:/devo-collector/certs
      - ./config:/devo-collector/config
      - ./credentials:/devo-collector/credentials
      - ./state:/devo-collector/state
    environment:
      - CONFIG_FILE=${CONFIG_FILE:-config.yaml}

To run the container using docker-compose, execute the following command from the <any_directory>/devo-collectors/<product_name>/ directory:

Code Block
IMAGE_VERSION=<version> docker-compose up -d

Note
Replace `<product_name>`, `<image_name>` and `<version>` with the proper values.

Rw tab

title	Cloud collector

We use a piece of software called Collector Server to host and manage all our available collectors. If you want us to host this collector for you, get in touch with us and we will guide you through the configuration.

To enable the collector for a customer:

In the Collector Server GUI, access the domain in which you want this instance to be created
Click Add Collector and find the one you wish to add.
In the Version field, select the latest value.
In the Collector Name field, set the value you prefer (this name must be unique inside the same Collector Server domain).
In the sending method select Direct Send. Direct Send configuration is optional for collectors that create Table events, but mandatory for those that create Lookups.
In the Parameters section, establish the Collector Parameters as follows below:

Editing the JSON configuration

Code Block

{
  "global_overrides": {
    "debug": <debug_status>
  },
  "inputs": {
    "veeam_backup_manager_collector_input": {
      "id": "<short_unique_id>",
      "enabled": True,
      "requests_per_second": <requests_per_second>,
      "api_base_url": "<api_base_url_value>"
      "credentials": {
        "username": "<username_value>",
        "password": "<password_value>"
      },
      "services": {
        "backup_server_data": {
          "request_period_in_seconds": <request_period_in_seconds_value>,
          "devo_tag": "<override_devo_tag>",
          "filter_by_uid": "<optional_uid_filter>",
          "filter_by_description": "<optional_description_filter>",
          "filter_by_port":  "<optional_port_filter>",
          "filter_by_version": "<optional_version_filter>"
        }
      }
    }
  }
}

Info
All defined service entities will be executed by the collector. If you do not want to run any of them, just remove the entity from the `services` object.

Please replace the placeholders with real world values following the description table below:

Parameter

Data Type

Type

Value Range / Format

Details

<debug_status>

bool

Mandatory

false / true

This will make the collector generate (or not) log messages with the DEBUG level.

<short_unique_id>

int

Mandatory

YMMDD

Use this param to give a unique id to this input service.

Note
This parameter is used to build the persistence address, do not use the same value for multiple collectors. It could cause a collision.

<requests_per_second>

int

Optional

Minimum value: 1

Customize the maximum number of API requests per second. If not used, the default setting will be used: 100000 requests/sec.

Info
This parameter should be removed if it is not used.

<api_base_url_value>

str

Mandatory

Valid URL

This parameter is the URL of the Veeam instance.

<username_value>

str

Mandatory

Minimum length: 1

The Veeam username.

<password_value>

str

Mandatory

Minimum length: 1

The Veeam password.

<request_period_in_seconds_value>

int

Optional

Minimum value: 1

Period in seconds used between each data pulling, this value will overwrite the default value (60 seconds).

Info
This parameter can be removed or commented.

<override_devo_tag>

str

Optional

A Devo Tag. For more information see Devo Tags.

This parameter allows to define a custom devo tag.

Info
This parameter should be removed if it is not used.

<optional_uid_filter>

str

Optional

Minimum length: 1

This parameter allows you to filter the results by UID.

Info
This parameter should be removed if it is not used.

<optional_description_filter>

str

Optional

Minimum length: 1

This parameter allows you to filter the results by description.

Info
This parameter should be removed if it is not used.

<optional_port_filter>

str

Optional

Minimum length: 1

This parameter allows you to filter the results by port number.

Info
This parameter should be removed if it is not used.

<optional_version_filter>

str

Optional

Minimum length: 1

This parameter allows you to filter the results by version.

Info
This parameter should be removed if it is not used.

Image Added

Collector services detail

...

Expand

title	Enable/disable the logging debug mode

Sometimes it is necessary to activate the debug mode of the collector's logging. This debug mode increases the verbosity of the log and allows you to print execution traces that are very helpful in resolving incidents or detecting bottlenecks in heavy download processes.

To enable this option you just need to edit the configuration file and change the debug_status parameter from false to true and restart the collector.
To disable this option, you just need to update the configuration file and change the debug_status parameter from true to false and restart the collector.

For more information, visit the configuration and parameterization section corresponding to the chosen deployment mode.

Change log for v1.x.x

Release

Released on

Release type

Details

Recommendations

v1.0.0-beta1

30 Nov 2022

Status

colour	Purple
title	NEW FEATURE

New Features

Released the first BETA version of the Veeam collector with the following service:

BackUp Server Data: Returns a resource representation of a collection of backup servers connected to Veeam Backup Enterprise Manager.

Recommended version

Versions Compared

Old Version 12

New Version Current

Key

Devo collector features

Data sources

Vendor setup

Accepted authentication methods

Run the collector

Structure

Devo credentials

Editing the config.yaml file

Download the Docker image

Docker

Docker Compose

Editing the JSON configuration

Collector services detail

Change log for v1.x.x

New Features