Bocada Enterprise 5 Plug-in Guide

for Symantec NetBackup

Copyright 2007 Bocada, Inc. All Rights Reserved. Protected by U.S patents 6,640,217; 6,708,188; 6,745,210. The material in this manual is for information only and is subject to change without notice. While efforts have been made to ensure accuracy, Bocada, Inc. assumes no liability resulting from errors or omissions in this document, or from the use of information contained herein. Bocada, Inc. reserves the right to make changes in the product design and documentation without reservation and without notification to its users. Trademark Notices: BackupReport, Bocada and the Bocada logo are registered trademarks of Bocada, Inc. Symantec NetBackup is a registered trademark of Symantec. Other product names mentioned herein may be trademarks or registered trademarks of their respective companies. Version: 20071211 RA 5.0.0

Conventions
The following typographic conventions are used in this manual. Convention Italic Meaning Provide emphasis Example Select times that are an hour or two before backup activities are expected to start. If the test is successful, a Connected successfully message displays. Click Tools > Options. ~:[path names] Replace the brackets and their text with the path names used on the users computer.

Computer

Text or items on the computer screen Commands to be performed Square brackets enclose variables. Replace the square brackets and their text with text that applies to a users situation.

Computer Bold []

Table of Contents
Conventions - - - - - - - - - - - - - - - - - - 2

Introduction - - - - - - - - - - - - - - 5
Welcome - - - - - - - - - - - - - - - - - - - - 5 How this Manual is Organized - - - - - - - - - 5
Overview Setup- - Metrics - Errors - Glossary -5 -5 -5 -5 -5

Overview - - - - - - - - - - - - - - - 7
Supported Versions - - - - - - - - - - - - - - - 7 Supported Collection Types - - - - - - - - - - - 7
Backup - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 7 Media- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 7 Occupancy- - - - - - - - - - - - - - - - - - - - - - - - - - - 7

Data Sources - - - - - - - - - - - - - - - - - - 8 Requirements - - - - - - - - - - - - - - - - - 8

NetBackup Host Properties- - - - - - - - - - - - - - 8 Collection Protocols - - - - - - - - - - - - - - - - - 8

Communications - - - - - - - - - - - - - - - - 9

Setup - - - - - - - - - - - - - - - - - 11
Server Properties - - - - - - - - - - - - - - - 11
NetBackup Tab - - - - - - - - - - - - - - - - - - 12 Test Connection - - - - - - - - - - - - - - - - - - 14

Metrics - - - - - - - - - - - - - - - - 15
Start Time - - - - - - - - - - - - - - - - - - - Job Group Start Time- - - - - - - - - - - - - - - - - - - Backup Job Start Time - - - - - - - - - - - - - - - - - - Elapsed Time - - - - - - - - - - - - - - - - - - Group Duration - - - - - - - - - - - - - - - - - - - - - - Job Duration - - - - - - - - - - - - - - - - - - - - - - - - Media Duration - - - - - - - - - - - - - - - - - - - - - - Backup Scope - - - - - - - - - - - - - - - - - - Backup Server- - - - - - - - - - - - - - - - - - - - - - - - Backup Client- - - - - - - - - - - - - - - - - - - - - - - - Media Server - - - - - - - - - - - - - - - - - - - - - - - - Group Name - - - - - - - - - - - - - - - - - - - - - - - - Group Session- - - - - - - - - - - - - - - - - - - - - - - - Level - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Target - - - - - - - - - - - - - - - - - - - - - - - - - - - - Job Type - - - - - - - - - - - - - - - - - - - - Backup - - - - - - - - - - - - - - - - - - - - - - - - - - - - Duplication - - - - - - - - - - - - - - - - - - - - - - - - - Backup Size- - - - - - - - - - - - - - - - - - - Bytes - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Bytes on Media - - - - - - - - - - - - - - - - - - - - - - - 15 15 15 15 15 15 15 16 16 16 16 16 16 16 16 16 16 16 17 17 17

Bocada Enterprise 5 Plug-in Guide: 3

Files - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Media Resources - - - - - - - - - - - - - - - - Media Library - - - - - - - - - - - - - - - - - - - - - - - Media Device - - - - - - - - - - - - - - - - - - - - - - - - Media Volume - - - - - - - - - - - - - - - - - - - - - - - Media Expiration - - - - - - - - - - - - - - - - - - - - - Restore - - - - - - - - - - - - - - - - - - - - - - - - - - - - Occupancy - - - - - - - - - - - - - - - - - - - Media Group - - - - - - - - - - - - - - - - - - - - - - - - Media Pool - - - - - - - - - - - - - - - - - - - - - - - - - Byte Count - - - - - - - - - - - - - - - - - - - - - - - - - File Count - - - - - - - - - - - - - - - - - - - - - - - - - - Media Inventory - - - - - - - - - - - - - - - - Media Library - - - - - - - - - - - - - - - - - - - - - - - Media Device - - - - - - - - - - - - - - - - - - - - - - - - Media Volume - - - - - - - - - - - - - - - - - - - - - - - Media Pool - - - - - - - - - - - - - - - - - - - - - - - - - Allocation Date- - - - - - - - - - - - - - - - - - - - - - - Volume Status - - - - - - - - - - - - - - - - - - - - - - - Online - - - - - - - - - - - - - - - - - - - - - - - - - - - - Library Operations - - - - - - - - - - - - - - - Mount / Dismount - - - - - - - - - - - - - - - - - - - - Errors - - - - - - - - - - - - - - - - - - - - - Error Count - - - - - - - - - - - - - - - - - - - - - - - - - Error Set - - - - - - - - - - - - - - - - - - - - - - - - - - - Messages - - - - - - - - - - - - - - - - - - - - Messages - - - - - - - - - - - - - - - - - - - - - - - - - - - -

17 17 17 17 17 17 17 18 18 18 18 18 18 18 18 18 18 18 18 18 18 18 19 19 19 19 19

Errors - - - - - - - - - - - - - - - - - 21
Error Codes and Categories - - - - - - - - - - 21

Glossary - - - - - - - - - - - - - - - 23

Bocada Enterprise 5 Plug-in Guide: 4

1: Introduction

Welcome
The Bocada Enterprise 5 application offers advanced, standardized reporting for a number of backup products. Use this guide to see how the application integrates with the Symantec NetBackup software.

How this Manual is Organized

Overview
This section lists any requirements that must be met prior to collecting data with the Bocada Enterprise 5 plug-in for NetBackup. In addition, this section lists the NetBackup configurations currently supported by the plug-in.

Setup
This section gives an overview of the general procedure and detailed instructions for adding a NetBackup server to the Bocada Enterprise 5 application.

Metrics
This section provides a description of the metrics collected by the plugin and any conversions that are made.

Errors
This section describes the errors that are collected from NetBackup servers and how they are mapped to Bocada Enterprise 5 error categories.

Glossary
This section defines terms used by the Bocada Enterprise 5 application and lists the corresponding NetBackup terms.

Bocada Enterprise 5 Plug-in Guide: 5

Introduction

How this Manual is Organized

Bocada Enterprise 5 Plug-in Guide: 6

2: Overview

This section lists any requirements that must be met prior to collecting data with the Bocada Enterprise 5 plug-in for Symantec NetBackup. In addition, this section lists the NetBackup configurations currently supported by the plug-in.

Supported Versions
The Bocada Enterprise 5 application currently supports the following NetBackup configurations: NetBackup Version 6 5.1 5.0 4.5 NetBackup Server Operating System Windows Any variant of UNIX that the vendor supports The Bocada Enterprise 5 application may work with NetBackup servers using other product versions or platforms. However, configurations other than those listed above have not been tested fully and may yield unexpected results.

Supported Collection Types

The plug-in currently supports the following collection types from NetBackup servers:
Collection Type Backup Supported Description Collects transactional details about backup, duplication and restore jobs. Example metrics include, start times, durations, bytes, files, errors etc. Collects transactional details about media operations. Example metrics include media mounts and dismounts. Collects point and time inventory information. Example metrics include, total recoverable gigabytes (occupancy), media volume count, media volume status, etc.

Media

Occupancy

Bocada Enterprise 5 Plug-in Guide: 7

Overview

Data Sources

Data Sources
The plug-in collects data off the NetBackup server using a variety of different communication protocols.The plug-in relies on the following NetBackup data sources:

Activity Monitor Error Log Image List Policy/Schedule Storage Unit List (bpstulist) Media List (medialist) Volume Pools (vmpool) Volume Query (vmquery) Volume Operation Commands (vmoprcmd)

Requirements
NetBackup Host Properties
For the plug-in to communicate with the backup server, an entry for the Bocada Enterprise 5 Database Update Service (DUS) server must be made in: server list (Windows) bp.conf file (UNIX) The NetBackup server will refuse a connection to the Bocada Enterprise 5 master server or secondary DUS unless two conditions are met. Meeting these conditions is necessary prior to configuring NetBackup within the Bocada Enterprise 5 application.

Forward and reverse name resolution must be available from the NetBackup server to the Bocada Enterprise 5 DUS. If forward and reverse name resolution is not possible due to security restrictions, implement a hosts file. The computer requesting the connection must be in the NetBackup servers list of allowed computers.

Collection Protocols
To communicate with a NetBackup server, the Bocada Enterprise 5 user must have the following:

Bocada Enterprise 5 Plug-in Guide: 8

Overview

Communications

Access to commands via one of the following protocols: Windows

MsTelnet UNIX bprsh Authentication Method: Username\Password

Communications
Ports Default ports are specified by NetBackup for internal communication within a firewall. When using NetBackup through a firewall, certain ports need to be opened.
Daemon
vnetd

Default Port
13724/TCP/IP

Direction
inbound

Notes
If vnetd is enabled on the NetBackup up server, this port is required. Windows Only Open port 13701 if drive name labels are to be included in Bocada Enterprise 5 updates. This port does not need to be opened if drive naming is not enabled in NetBackup.

MSTelnet vmd

23/TCP 13701/TCP

inbound inbound

bpdbm bpjobd bpcd

13721/TCP 13723/TCP 13782/TCP

inbound inbound inbound (UNIX) Outbound if connecting directly to bpcd service.

NetBackup Version 4.5 Vnetd is the primary default daemon that communicates with the bpcd daemon on the NetBackup server. In NetBackup version 4.5 environments where a firewall is required, the bpcd daemon is unable to connect through the vnetd daemon. In this enviornment, you must connect directly to the bpcd daemon and open a range of ports from 512-1024. The port is then randomly generated.

Bocada Enterprise 5 Plug-in Guide: 9

Overview

Communications

Bocada Enterprise 5 Plug-in Guide: 10

3: Setup

This section gives an overview of the general procedure and detailed instructions for adding an NetBackup server to the Bocada Enterprise 5 application.

Server Properties
Backup Server Properties determine how the Bocada Enterprise 5 application will interact with a NetBackup server. Backup Server Properties are set in either the Backup Servers window or the Database Operations Monitor (DOM).

Bocada Enterprise 5 Plug-in Guide: 11

Setup

Server Properties

NetBackup Tab
Username Enter a user name the Bocada Enterprise 5 application will use to contact the NetBackup server. The user name should be in the form [domain]\[user name]. Password Enter password the Bocada Enterprise 5 application will use to contact the NetBackup server. Note: The Username and Password properties are only used for Windows servers. Media Access Protocol Select the service protocol used by the plug-in. This setting determines the service the plug-in will use, such as: BpRsh (UNIX) This protocol is used when the NetBackup master server is UNIX based. It is serviced by the bpcd daemon on the NetBackup master server. The plug-in implements the proprietary client side communication protocol for bprsh. Bprsh allows the remote execution of NetBackup binaries on the master server. MsTelnet (Windows) This protocol is used when the NetBackup master server is Windows. The plug-in establishes an MsTelnet session authenticating itself via NTLM authentication which encrypts the password. Once the connection is established the plug-in can remotely execute any of the needed NetBackup media related binaries. The resulting output of the remote NetBackup binary execution is piped to a temporary file on the NetBackup master server. The plug-in then accesses these files using the SMB protocol. Media Data Temp Path Specify the location where the temporary output data is to be stored on the backup server. This property is only used with MsTelnet and the default value is C:\tmp NetBackup Version Select Auto-detect, 6.0, 5.1, or 5.0 The plug-in uses the auto-detect setting to determine the product version of the NetBackup server. The recommended setting is to manually select the product version. The possible options are described as follows: Auto-Detect - The Bocada Enterprise 5 application queries the backup server to determine its product version.

Bocada Enterprise 5 Plug-in Guide: 12

Setup

Server Properties

6.0 - The Bocada Enterprise 5 application considers the backup server as if it were running version 6.0. 5.1 - The Bocada Enterprise 5 application considers the backup server as if it were running version 5.1. 5.0 - The Bocada Enterprise 5 application considers the backup server as if it were running version 5.0. Note: If the backup server is running NetBackup version 4.5, you must select Auto-Detect. NetBackup Install Path Enter the path where the Netbackup is installed. This should be the same directory that contains both the Netbackup and Volmgr directories. BPCD Enter the port number used by the NetBackup bpcd daemon. If the default settings were selected during NetBackup installation, bpcd was assigned port number 13782. However, verify that the port numbers have not been changed. To view the port numbers used by NetBackup (Windows platforms) 1. Open Windows Explorer. 2. Expand [system root]\system32\drivers\etc. For example, C:\WINNT\system32\drivers\etc. 3. Double-click on Services in the right hand pane. Depending on the software on the system, it may be necessary to select a text editor (such as notepad) to view the file. To view the port numbers used by NetBackup (UNIX platforms) Look in the /etc/services file. BPDBM Enter the port number used by the NetBackup bpdbm daemon. By default the NetBackup software assigns port number 13721 to the bpdbm daemon. However, verify this number using the previously listed steps. BPJOBD Enter the port number used by the NetBackup bpjobd daemon. By default the NetBackup software assigns port number 13723 to the bpjobd daemon. However, verify this number using the previously listed steps. TELNET Enter the port number used by the Netbackup plug-in. By default, the NetBackup software assigns port number 23. However, verify this number using the previously listed steps.

Bocada Enterprise 5 Plug-in Guide: 13

Setup

Server Properties

VNETD Enter the port number used by the NetBackup vnetd daemon. By default the NetBackup software assigns port number 13724 to the vmd daemon. However, verify this number using the previously listed steps. Time zone Select the time zone, relative to GMT, where this NetBackup server resides. This setting ensures times are displayed consistently in environments that span multiple time zones. When data is extracted from the NetBackup servers, times are converted to Coordinated Universal Time (UTC). When reports are generated, times are converted on a per report bases to the time zone configured for that report.

Test Connection
When the plug-in is configured, select the Test Connection button. This button tests the connectivity as follows:

The plug-in will ping the NetBackup vnetd port. If the MsTelnet media access protocol is enabled, it will then ping the MsTelnet port. If the plug-in fails to gain access to either of these ports, the connection will fail. The plug-in then attempts to request access to the bpdbm, bpjobd, and bpcd daemons via vnetd. If the plug-in fails to gain access to any of these daemons, an error message displays Could not service [service name]. If the previous steps are successful, the plug-in will send an authentication request to the bpcd daemon to determine whether or not it is an authenticated server. If the DUS server is not in the approved servers list on the NetBackup server, the connection will fail. If the MsTelnet service is specified by the Media Access Protocol server property, the plug-in will attempt to connect to the MsTelnet server. If the plug-in settings pass the connectivity test, a Connection Successful message displays. If connectivity testing fails, a Connection Failed message is received. In this instance, check the settings against the backup server information and the backup product help information. If these actions do not solve the problem, contact Bocada Support.

Bocada Enterprise 5 Plug-in Guide: 14

4: Metrics

A powerful feature of the Bocada Enterprise 5 application is its ability to provide true cross-vendor reporting. To do this, it uses a standardized format to report backup information. Regardless of the backup product, reports will follow uniform conventions. However, this categorization also means that data formats may differ between the Bocada Enterprise 5 application and the original source. The following is a description of the metrics collected by the plug-in and any conversions that are made.

Start Time
Metric Name Job Group Start Time Supported Definition The date and start time of the group session associated with a given job. A group session is created each time a NetBackup policy is run. The date and start time of a given job.

Backup Job Start Time

Elapsed Time
Metric Name Group Duration Job Duration Media Duration Supported Definition Duration of a given group session. Duration of a given job. The length of time during which a given job is written/read to/from a given media volume.

Bocada Enterprise 5 Plug-in Guide: 15

Metrics

Backup Scope

Backup Scope
Metric Name Backup Server Supported Definition The name of the backup server associated with a given job. Only NetBackup master servers can be added to Bocada Enterprise 5. The backup client associated with a given backup job. The media server associated with a given job. The configuration or policy associated with a given job. A Group typically defines what clients and targets are backed up. The identifier assigned to a an individual run of a given Group. The level associated with a given job. Since each backup product has its own proprietary name level terminology, the Bocada Enterprise 5 application assigns standardized (canonical) levels. Conversion Full assigned to level Full Differential Incremental assigned to level Full Cumulative Incremental assigned to level Differential User Backup assigned to level Manual User Archive assigned to level Archival Restore assigned to level Restore Duplication assigned to level Duplication The name or identifier for the smallest configured unit in a job. Target data is primarily pulled from the policy data source. If a job is executed, which contains a policy with no target information, the target data is pulled from the activity monitor.

Backup Client Media Server Group Name

Group Session

Level

Target

Job Type
Metric Name Backup Supported Definition Data is copied from a backup client to one or more backup media volumes. The image on media for a given backup job is copied to a second set of media volumes. Typically the duplicated image is stored in a separate physical location than the original image.

Duplication

Bocada Enterprise 5 Plug-in Guide: 16

Metrics

Backup Size

Metric Name Restore

Supported

Definition Selected data is copied from a backup image to a target system. Typically restores are performed to recover damaged or destroyed data, or in order to test the effectiveness of backups.

Backup Size
Metric Name Bytes Supported Definition The number of bytes transferred up by a given job. Conversion 1 KB = 1024 Bytes 1 MB = 1024 KB 1 GB = 1024 MB 1 TB = 1024 GB 1 PB = 1024 TB The number of bytes transferred to/from a given media volume by a given job. Conversion 1 KB = 1024 Bytes 1 MB = 1024 KB 1 GB = 1024 MB 1 TB = 1024 GB 1 PB = 1024 TB The number of files transferred by a given job.

Bytes on Media

Files

Media Resources
Metric Name Media Library Media Device Supported Notes The media library associated with a given job. The media device (e.g. tape drive) associated with a given job. The media volumes associated with a given job. The date the media image associated with a given job expires.

Media Volume Media Expiration

Bocada Enterprise 5 Plug-in Guide: 17

Metrics

Occupancy

Occupancy
Metric Name Media Group Supported Definition The configuration or policy associated with a given set of unexpired data in the estate. A media group typically defines data storage location and retention policies. The Media Pool associated with a given set of unexpired data in the estate. The amount of unexpired data in the estate. The number of files associated with the unexpired data in the estate.

Media Pool

Byte Count File Count

Media Inventory
Metric Name Media Library Media Device Supported Definition The media libraries in the estate on a given day. The media devices (e.g. tape drives) in the estate on a given day. The media volumes in the estate on a given day. The media pools in the estate on a given day. The date a given media volume was made available for use. The status of a given media volume on a given day. Since each backup product has its own proprietary media volume status terminology, the Bocada Enterprise 5 application assigns standardized (canonical) statuses. Identifier for whether a given media volume resides in a media library on a given day. Volumes that are not online require human intervention before they are available to the media library (i.e. an administrator must insert the tape into the library)

Media Volume Media Pool Allocation Date Volume Status

Online

Library Operations
Metric Name Mount / Dismount Supported Definition The data and time when a a given media volume was mounted or dismounted from a drive.

Bocada Enterprise 5 Plug-in Guide: 18

Metrics

Errors

Errors
Metric Name Error Count Supported Definition Error count is the number of recognized errors associated with a given job. The unique error categories associated with a given job.

Error Set

Messages
Metric Name Messages Supported Description Any details such as error messages and event logs associated with a job.

Bocada Enterprise 5 Plug-in Guide: 19

Metrics

Messages

Bocada Enterprise 5 Plug-in Guide: 20

5: Errors

Error Codes and Categories

The Bocada Enterprise 5 application collects each error message and code (if applicable) generated by the backup server. For reporting purposes, these error messages are associated with Bocada Enterprise 5 error categories (e.g. Media Unavailable Error). This categorization ensures the standardized reporting of errors even in heterogeneous environments. The mapping of NetBackup error codes to the corresponding Bocada error category is described in the document: NBU_ErrorCodes_ErrorCategories Error Set in the User Interface Each error category is associated with a unique error number. The collection of unique error numbers comprise the error set. This error set is represented in the format N1,N2,Nn+1. For example, a backup job is associated with two file locked errors and one backup timeout error. File locked errors are represented by error number 6 while backup timeout errors are represented by error number 14. The resulting error set is 6,14. Error Set in the Database Each error category is associated with a unique error bit. The number of unique error bits comprise the error set. This error set is represented in the database by a decimal number. For example, a backup job is associated with two file locked errors and one backup window error. File locked errors are represented by the 25 bit while backup timeout errors are represented by the 213 bit. The resulting error set is 8224, the decimal representation of both these bits.

Bocada Enterprise 5 Plug-in Guide: 21

Errors

Error Codes and Categories

Bocada Enterprise 5 Plug-in Guide: 22

6: Glossary

The following table defines terms used by the Bocada Enterprise 5 application and lists the corresponding NetBackup terms.
Bocada Enterprise 5 Term Backup Client Backup Job

Definition
A computer that is eligible to be backed up by a backup server The backup of a single target. For example, a job group ran last Monday. As a result, a backup job occurred that backed up target C:\Finance on client BEOWULF. A computer that transmits data from one or more backup clients to a storage device. Backup servers also keep metadata describing backup activities. A single execution of a job group. For example, the job group that ran last Monday. An aggregate of one or more backup jobs that are scheduled to start at the same date/time. The criteria used by a backup product to determine which files in a backup selection will be saved to media. Levels usually discriminate between files that have and have not changed since the last backup. A hardware unit that reads and writes backed up data to and from media volumes A hardware unit that automatically manipulates two or more media volumes. Media libraries contain one or more media devices and a robotic device to manipulate media volumes. A remote computer used by a backup server to process backup and restore activities to and from media volumes. Media servers are physically attached to one or more storage devices. A hardware unit used for long-term storage of backed up data. Media volumes typically take the form of magnetic tapes, optical disks, CD ROMs, or hard disks.

Equivalent NetBackup Term

Client

Backup job

Backup Server

Master Server

Group Session Job Group Level

[no equivalent term]

Policy

Backup Type

Media Device Media Library

Drive Name

Storage Unit

Media Server

Media Server

Media Volume

Media

Bocada Enterprise 5 Plug-in Guide: 23

Glossary

Bocada Enterprise 5 Plug-in Guide: 24