Avamar-Datacollector-Sheet

• Introduction
• Compatibility
  • Supported System Versions
• Configuration notes for the Data Collection Management
  • Configuration with and without separate Backup Hardware
    • Case 1: Stand-alone-Mode (no separate backup hardware)
    • Case 2: Avamar with a separate backup hardware (e.g. datadomain)
  • Creating an asset in the CIO Cockpit Web Frontend:
  • Creating an Asset in the Data Collection Management
  • System Access: Oauth users and permissions
    • Oauth Client ID and Secret
    • Shellscript
      • Using the manufacturer's instructions
  • Fields in Data Collection Management
• System Access
  • Network and firewall
• KPI scope of the Data Collection
  • BackupSoftwareJob
    • List of backup jobs
  • List of backup clients
  • BackupHardwareJob (only for installations without external backup hardware)

Introduction

The integration of hardware/software - hereinafter referred to as "system" - into the CIO Cockpit not only requires the registration of the systems themselves but also the configuration of the data collection. Data collection is set up centrally via the Data Collection Management (DCM).

Compatibility

Supported System Versions

Avamar is supported from version 18.2. onwards.

Configuration notes for the Data Collection Management

To set up the data collection, the system must first be created in the CIO Cockpit (see FAQs). You can create the system either in the CIO Cockpit Web Frontend or in Data Collection Management (recommended).

Configuration with and without separate Backup Hardware

Avamar is used as backup software in the CIO Cockpit. On one hand Avamar uses storage capacities of the VM on which the software runs and on the other hand an external backup hardware, e.g. datadomain is used. External backup hardware is represented by a separate asset in the CIO Cockpit and the data is collected by a separate data collector. A backup hardware asset can be created to map the memory used internally. Its deduplication factor is always one. This backup hardware asset may only be created if no separate backup hardware is used.

Case 1: Stand-alone-Mode (no separate backup hardware)

A separate backup hardware can be created (optional). It depicts the memory of the VM or server on which Avamar is running.

Case 2: Avamar with a separate backup hardware (e.g. datadomain)

No backup hardware asset is created in Avamar's Data Collection Management configuration. Instead, a separate data collector job must be created for the backup hardware asset (e.g. datadomain). Creating an Asset in the CIO Cockpit Web Frontend

Creating an asset in the CIO Cockpit Web Frontend:

1. Select "Configuration" -> "Assets” in the left bar
2. Select in the main window: "Add", fill in (at least) the mandatory fields and under "Manufacturer, Asset Type, Product" select "Dell EMC" -> "Backup Software" -> "Avamar”

Creating an Asset in the Data Collection Management

Navigation: "Data collectors & Assets" -> "Add Data collector system" -> Select vendor: Dell EMC and Product: Avamar If the system has been created at an earlier time, the existing asset can be selected by clicking on "Use existing element".

System Access: Oauth users and permissions

To access the Avamar REST API, an Oauth client must be created using the REST API of the Avamar backup software. Requirements for the configuration of the data collector are:

CIO Cockpit User (Avamar Administrator role, see guide)

• Username
• Password

corresponding Oauth Login

• Client-ID
• Secret

Oauth Client ID and Secret

The generation of an oauth-user with the credentials Client ID and Secret, required for the data collection, can be done either via a shell script (recommended) or "manually" following the manufacturer's instructions.

Shellscript

The script can be downloaded hier (right click - "save link as").

It must be on a Linux host and executable:

sudo chomd +x avamar-oauth.sh

It is executed via

./avamar-oauth.sh oauthClientId oauthClientName oauthSecret avamarUser avamarPassword

The script must be executed with the following parameters:

• oauthClientId: ID selected by user (e.g. “cockpit_svc_id”)
• oauthClientName: Name for the Oauth client chosen by the user (e.g. “cockpit_svc_client”)
• oauthSecret: Secret chosen by the user
• avamarUser: User name of the CIO Cockpit user for whom the Oauth login is set up
• avamarPassword: Password of the CIO Cockpit user for whom the Oauth login is set up

Using the manufacturer's instructions

The generation is described in the Avamar-REST-API-Guide (https://www.emc.com/collateral/TechnicalDocument/docu92032.pdf) starting on page 15 (chapter "Authorizing third party clients to use Avamar APIs"). Only the first step has to be done.

Fields in Data Collection Management

System Access

Network and firewall

The following communication paths are required for the data collector to communicate with the system:

KPI scope of the Data Collection

BackupSoftwareJob

List of backup jobs

List of backup clients

BackupHardwareJob (only for installations without external backup hardware)