Bocada Guide

Bocada® Enterprise 5Plug-in Guide

forSymantec 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

ConventionsThe following typographic conventions are used in this manual.

Convention Meaning Example

Italic Provide emphasis Select times that are an hour or two before backup activities are expected to start.

Computer Text or items on the computer screen

If the test is successful, a Con-nected successfully message dis-plays.

Computer Bold

Commands to be performed Click Tools > Options.

[ ] Square brackets enclose vari-ables. Replace the square brack-ets and their text with text that applies to a user’s situation.

~:[path names]

Replace the brackets and their text with the path names used on the user’s computer.

Table of Contents

Conventions - - - - - - - - - - - - - - - - - - 2

Introduction - - - - - - - - - - - - - - 5Welcome - - - - - - - - - - - - - - - - - - - - 5

How this Manual is Organized - - - - - - - - - 5Overview - - - - - - - - - - - - - - - - - - - - - - 5

Setup- - - - - - - - - - - - - - - - - - - - - - - - 5

Metrics - - - - - - - - - - - - - - - - - - - - - - - 5

Errors - - - - - - - - - - - - - - - - - - - - - - - 5

Glossary - - - - - - - - - - - - - - - - - - - - - - 5

Overview - - - - - - - - - - - - - - - 7Supported Versions - - - - - - - - - - - - - - - 7

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

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

Requirements - - - - - - - - - - - - - - - - - 8NetBackup Host Properties- - - - - - - - - - - - - - 8

Collection Protocols - - - - - - - - - - - - - - - - - 8

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

Setup - - - - - - - - - - - - - - - - - 11Server Properties - - - - - - - - - - - - - - - 11

NetBackup Tab - - - - - - - - - - - - - - - - - - 12

Test Connection - - - - - - - - - - - - - - - - - - 14

Metrics - - - - - - - - - - - - - - - - 15Start Time - - - - - - - - - - - - - - - - - - - - 15

Job Group Start Time- - - - - - - - - - - - - - - - - - - - 15Backup Job Start Time - - - - - - - - - - - - - - - - - - - 15

Elapsed Time - - - - - - - - - - - - - - - - - - - 15Group Duration - - - - - - - - - - - - - - - - - - - - - - - 15Job Duration - - - - - - - - - - - - - - - - - - - - - - - - - 15Media Duration - - - - - - - - - - - - - - - - - - - - - - - 15

Backup Scope - - - - - - - - - - - - - - - - - - - 16Backup Server- - - - - - - - - - - - - - - - - - - - - - - - - 16Backup Client- - - - - - - - - - - - - - - - - - - - - - - - - 16Media Server - - - - - - - - - - - - - - - - - - - - - - - - - 16Group Name - - - - - - - - - - - - - - - - - - - - - - - - - 16Group Session- - - - - - - - - - - - - - - - - - - - - - - - - 16Level - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 16Target - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 16

Job Type - - - - - - - - - - - - - - - - - - - - - 16Backup - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 16Duplication - - - - - - - - - - - - - - - - - - - - - - - - - - 16

Backup Size- - - - - - - - - - - - - - - - - - - - 17Bytes - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 17Bytes on Media - - - - - - - - - - - - - - - - - - - - - - - - 17

Bocada Enterprise 5 Plug-in Guide: 3

Files - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 17

Media Resources - - - - - - - - - - - - - - - - - 17Media Library - - - - - - - - - - - - - - - - - - - - - - - - 17Media Device - - - - - - - - - - - - - - - - - - - - - - - - - 17Media Volume - - - - - - - - - - - - - - - - - - - - - - - - 17Media Expiration - - - - - - - - - - - - - - - - - - - - - - 17Restore - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 17

Occupancy - - - - - - - - - - - - - - - - - - - - 18Media Group - - - - - - - - - - - - - - - - - - - - - - - - - 18Media Pool - - - - - - - - - - - - - - - - - - - - - - - - - - 18Byte Count - - - - - - - - - - - - - - - - - - - - - - - - - - 18File Count - - - - - - - - - - - - - - - - - - - - - - - - - - - 18

Media Inventory - - - - - - - - - - - - - - - - - 18Media Library - - - - - - - - - - - - - - - - - - - - - - - - 18Media Device - - - - - - - - - - - - - - - - - - - - - - - - - 18Media Volume - - - - - - - - - - - - - - - - - - - - - - - - 18Media Pool - - - - - - - - - - - - - - - - - - - - - - - - - - 18Allocation Date- - - - - - - - - - - - - - - - - - - - - - - - 18Volume Status - - - - - - - - - - - - - - - - - - - - - - - - 18Online - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 18

Library Operations - - - - - - - - - - - - - - - - 18Mount / Dismount - - - - - - - - - - - - - - - - - - - - - 18

Errors - - - - - - - - - - - - - - - - - - - - - - 19Error Count - - - - - - - - - - - - - - - - - - - - - - - - - - 19Error Set - - - - - - - - - - - - - - - - - - - - - - - - - - - - 19

Messages - - - - - - - - - - - - - - - - - - - - - 19Messages - - - - - - - - - - - - - - - - - - - - - - - - - - - - 19

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

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

Bocada Enterprise 5 Plug-in Guide: 4

1: Introduction

WelcomeThe 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

OverviewThis 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 Net-Backup configurations currently supported by the plug-in.

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

MetricsThis section provides a description of the metrics collected by the plug–in and any conversions that are made.

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

GlossaryThis 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


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 VersionsThe 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 TypesThe plug-in currently supports the following collection types from NetBackup servers:

Collection Type Supported Description

Backup ✓ Collects transactional details about backup, duplication and restore jobs. Example metrics include, start times, durations, bytes, files, errors etc.

Media ✓

Collects transactional details about media operations. Example metrics include media mounts and dismounts.

Occupancy ✓ Collects point and time inventory information. Example metrics include, total recoverable gigabytes (occupancy), media volume count, media volume status, etc.


Overview Data Sources

Data SourcesThe plug-in collects data off the NetBackup server using a variety of different commu-nication 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 PropertiesFor 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 Net-Backup 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 server’s list of allowed computers.

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


Overview Communications

❒ Access to commands via one of the following protocols:

Windows

❒ MsTelnet

UNIX

❒ bprsh

❒ Authentication Method:

❒ Username\Password

CommunicationsPorts

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

NetBackup Version 4.5Vnetd 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.

Daemon Default Port Direction Notes

vnetd 13724/TCP/IP inbound If vnetd is enabled on the NetBackup up server, this port is required.

MSTelnet 23/TCP inbound Windows Only

vmd 13701/TCP inbound 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.

bpdbm 13721/TCP inbound

bpjobd 13723/TCP inbound

bpcd 13782/TCP inbound (UNIX)

Outbound if connecting directly to bpcd service.


Overview Communications


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 PropertiesBackup 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).


Setup Server Properties

NetBackup TabUsername

Enter a user name the Bocada® Enterprise 5 application will use to contact the Net-Backup server. The user name should be in the form [domain]\[user name].

PasswordEnter password the Bocada® Enterprise 5 application will use to contact the Net-Backup server.

Note: The Username and Password properties are only used for Windows servers.

Media Access ProtocolSelect 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 ser-viced by the bpcd daemon on the NetBackup master server. The plug-in imple-ments 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 result-ing 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 PathSpecify 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 VersionSelect Auto-detect, 6.0, 5.1, or 5.0The 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 ver-sion. The possible options are described as follows:

Auto-Detect - The Bocada® Enterprise 5 application queries the backup server to determine its product version.



6.0 - The Bocada® Enterprise 5 application considers the backup server as if it were running version 6.0.



Note: If the backup server is running NetBackup version 4.5, you must select Auto-Detect.

NetBackup Install PathEnter the path where the Netbackup is installed. This should be the same directory that contains both the Netbackup and Volmgr directories.

BPCDEnter 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.

BPDBMEnter the port number used by the NetBackup bpdbm daemon.

By default the NetBackup software assigns port number 13721 to the bpdbm dae-mon. However, verify this number using the previously listed steps.

BPJOBDEnter the port number used by the NetBackup bpjobd daemon.

By default the NetBackup software assigns port number 13723 to the bpjobd dae-mon. However, verify this number using the previously listed steps.

TELNETEnter 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.



VNETDEnter 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 zoneSelect 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 ConnectionWhen 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 authenti-cated server. If the DUS server is not in the approved servers list on the Net-Backup server, the connection will fail.

❒ If the MsTelnet service is specified by the Media Access Protocol server prop-erty, the plug-in will attempt to connect to the MsTelnet server.

If the plug-in settings pass the connectivity test, a Connection Successful message dis-plays. 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.


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 conven-tions. 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 conver-sions that are made.

Start Time

Elapsed Time

Metric Name Supported Definition

Job Group Start Time ✓ 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.

Backup Job Start Time ✓ The date and start time of a given job.


Group Duration ✓ Duration of a given group session.

Job Duration ✓ Duration of a given job.

Media Duration ✓ The length of time during which a given job is written/read to/from a given media volume.


Metrics Backup Scope

Backup Scope

Job Type


Backup Server ✓ The name of the backup server associated with a given job.

Only NetBackup master servers can be added to Bocada® Enterprise 5.

Backup Client ✓ The backup client associated with a given backup job.

Media Server ✓ The media server associated with a given job.

Group Name ✓ The configuration or policy associated with a given job. A Group typically defines what clients and targets are backed up.

Group Session X The identifier assigned to a an individual run of a given Group.

Level ✓ 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

Target ✓ 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 moni-tor.


Backup ✓ Data is copied from a backup client to one or more backup media volumes.

Duplication ✓ 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 orig-inal image.


Metrics Backup Size

Backup Size

Media Resources

Restore ✓ Selected data is copied from a backup image to a target sys-tem. Typically restores are performed to recover damaged or destroyed data, or in order to test the effectiveness of backups.


Bytes ✓ 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

Bytes on Media ✓ The number of bytes transferred to/from a given media vol-ume 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

Files ✓ The number of files transferred by a given job.

Metric Name Supported Notes

Media Library ✓ The media library associated with a given job.

Media Device ✓ The media device (e.g. tape drive) associated with a given job.

Media Volume ✓ The media volumes associated with a given job.

Media Expiration ✓ The date the media image associated with a given job expires.



Metrics Occupancy

Occupancy

Media Inventory

Library Operations


Media Group ✓ 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.

Media Pool ✓ The Media Pool associated with a given set of unexpired data in the estate.

Byte Count ✓ The amount of unexpired data in the estate.

File Count ✓ The number of files associated with the unexpired data in the estate.


Media Library ✓ The media libraries in the estate on a given day.

Media Device ✓ The media devices (e.g. tape drives) in the estate on a given day.

Media Volume ✓ The media volumes in the estate on a given day.

Media Pool ✓ The media pools in the estate on a given day.

Allocation Date ✓ The date a given media volume was made available for use.

Volume Status ✓ 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.

Online ✓ 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)


Mount / Dismount ✓ The data and time when a a given media volume was mounted or dismounted from a drive.


Metrics Errors

Errors

Messages


Error Count ✓ Error count is the number of recognized errors associated with a given job.

Error Set ✓ The unique error categories associated with a given job.

Metric Name Supported Description

Messages ✓ Any details such as error messages and event logs associated with a job.


Metrics Messages


5: Errors

Error Codes and CategoriesThe Bocada® Enterprise 5 application collects each error message and code (if applica-ble) 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 InterfaceEach 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 tim-eout errors are represented by error number 14. The resulting error set is 6,14.

Error Set in the DatabaseEach 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 repre-sentation of both these bits.


Errors Error Codes and Categories


6: Glossary

The following table defines terms used by the Bocada® Enterprise 5 application and lists the corresponding NetBackup terms.

Bocada® Enterprise 5 Term Definition

Equivalent NetBackup Term

Backup Client A computer that is eligible to be backed up by a backup server

Client

Backup Job 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’.

Backup job

Backup Server A computer that transmits data from one or more backup clients to a storage device. Backup servers also keep metadata describing backup activities.

Master Server

Group Session A single execution of a job group. For example, the job group that ran last Monday.

[no equivalent term]

Job Group An aggregate of one or more backup jobs that are scheduled to start at the same date/time.

Policy

Level 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.

Backup Type

Media Device A hardware unit that reads and writes backed up data to and from media volumes

Drive Name

Media Library 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.

Storage Unit

Media Server A remote computer used by a backup server to process backup and restore activities to and from media vol-umes. Media servers are physically attached to one or more storage devices.

Media Server

Media Volume A hardware unit used for long-term storage of backed up data. Media volumes typically take the form of mag-netic tapes, optical disks, CD ROMs, or hard disks.

Media


Glossary


Bocada Guide

Documents

Transcript of Bocada Guide