You are on page 1of 84

FalconStor

Snapshot Agents
USER GUIDE

FalconStor Snapshot Agents User Guide

User Guide content for individual agents may change between major product versions of FalconStor CDP/NSS
in order to reflect agent updates released via patches. In this guide and its table of contents, the heading for
changed content will be followed by (updated Month Year).
The document code at the bottom of the page shows the guide publication date.

FalconStor Software, Inc.


2 Huntington Quadrangle, Suite 2S01
Melville, NY 11747
Phone: 631-777-5188
Fax: 631-501-7633
Web site: www.falconstor.com

Copyright 2001-2013 FalconStor Software. All Rights Reserved.


FalconStor Software, IPStor, TimeView, and TimeMark are either registered trademarks or trademarks of FalconStor Software,
Inc. in the United States and other countries.
Linux is a registered trademark of Linus Torvalds.
Windows is a registered trademark of Microsoft Corporation.
All other brand and product names are trademarks or registered trademarks of their respective owners.
FalconStor Software reserves the right to make changes in the information contained in this publication without prior notice. The
reader should in all cases consult FalconStor Software to determine whether any such changes have been made.
This product is protected by United States Patents Nos. 7,093,127 B2; 6,715,098; 7,058,788 B2; 7,330,960 B2; 7,165,145 B2;
7,155,585 B2; 7.231,502 B2; 7,469,337; 7,467,259; 7,418,416 B2; 7,406,575 B2, and additional patents pending.
122313

Snapshot Agents User Guide

Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
General installation requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
Additional resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

Snapshot Agent for Microsoft VSS. . . . . . . . . . . . . . . . . . . . . . . . 4


Storage configuration guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4
Install the snapshot agent (updated November 2013) . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Silent install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Configure the snapshot agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Snapshot options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Advanced options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
Batch file options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Manage the Trace Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Snapshot process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
Writers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
History and event logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
Remove snapshot agent software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

Snapshot Agent for Microsoft Exchange . . . . . . . . . . . . . . . . . 12


Storage configuration guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
Install the snapshot agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
Silent install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
Configure snapshot agent options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
Batch file options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
Monitor tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
Manage the Trace Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
Configure service-enabled devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
Test the snapshot agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
Confirm snapshot status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
Purge log utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
Remove snapshot agent software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

Snapshot Agent for Microsoft SQL Server . . . . . . . . . . . . . . . 20


Install the snapshot agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Silent install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Configure the snapshot agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23
Database Security options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23
Database Options tab (updated October 2013) . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
Advanced Options tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
Batch Files tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
Monitor tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
Manage the Trace Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
Snapshot Agents User Guide

<databasename>.hisu file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30


Test the snapshot agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
Transaction Log Backup best practice (updated October 2013) . . . . . . . . . . . . . . . . . . .31
Recover a database manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32
Command line interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33
Diagnostic X-ray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
Remove snapshot agent software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

Snapshot Agent for Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36


Support for file systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
Install the snapshot agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
Install on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37
Silent install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37
Install on Solaris . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38
Install on Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38
Install on AIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
Install on HP-UX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
Configure the snapshot agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
Configure the snapshot agent on a Windows machine (updated October 2013) . .41
Database Security options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42
Batch file options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43
Monitor options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44
Manage the Trace Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45
Configure the snapshot agent on a Solaris machine . . . . . . . . . . . . . . . . . . . . . . . .46
Configure ASM disks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47
Configure the Oracle Listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48
Configure the snapshot agent on a Linux or AIX machine (updated October 2013) 48
Configure the snapshot agent on an HP-UX machine . . . . . . . . . . . . . . . . . . . . . . .49
(Unix only) Add root user to database groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
(Unix only) Set root users PATH and LD_LIBRARY_PATH . . . . . . . . . . . . . . . . . . . . .51
Turn on Oracle archive logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
Test the snapshot agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53
Remove snapshot agent software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53
Protect and recover Oracle databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
Database design with virtual devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
Data backup and protection scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
TimeMark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
TimeMark Copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
TimeView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
Replication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56
TimeMark rollback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56
Complete backup using a TimeView or TimeMark Copy . . . . . . . . . . . . . . . . . . .57
Recovery scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
Disk failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
User failure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
Operator failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58
Restore backed-up Oracle databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58
Automatic recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
Snapshot Agents User Guide

ii

Manual recovery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59

Snapshot Agent for FileSystems. . . . . . . . . . . . . . . . . . . . . . . . . . 61


Install the snapshot agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61
Install on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61
Silent install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62
Install on Linux and AIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62
Configure snapshot agent options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63
Batch file options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63
Monitor tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64
Manage the Trace Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64
Update registry for service-enabled devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65
Test the file system agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65
Remove snapshot agent software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65

Snapshot Agent for MySQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66


Install the snapshot agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
Silent install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
Configure the snapshot agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
Confirm snapshot status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
Remove snapshot agent software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67

Snapshot Agent for IBM DB2 Universal Database . . . . . . . . . 68


Install the snapshot agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
Install on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
Silent install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
Install on AIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70
Add root user to database groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70
Set root users PATH and LD_LIBRARY_PATH . . . . . . . . . . . . . . . . . . . . . . . . .71
Install on Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71
Test the snapshot agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72
Remove snapshot agent software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72

Snapshot Agent for Lotus Notes/Domino . . . . . . . . . . . . . . . . 73


Install the snapshot agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73
Install on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73
Silent install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74
Install on Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74
Test the snapshot agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75
Confirm snapshot status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75
Remove snapshot agent software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76

Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Snapshot Agents User Guide

iii

Introduction
Todays businesses put increasing demands on information and databases,
resulting in the need for 24x7 availability and high performance. However, evergrowing capacity presents significant challenges to meeting these requirements.
One of the most important issues identified by system administrators is the amount
of time associated with backup - and more important, recovery. Extreme downtime,
sometimes in the range of hours or days, is often experienced while recovering
corrupted or lost data.
Because it takes a significant amount of time to copy large amounts of data to tape
(or other media), the source data can change before the copying is complete.
Therefore, the data written to tape represents changes over a period of time and
does not have point-in-time referential integrity. This means that there is no
guarantee that the data written to tape can be meaningfully restored.
This is where FalconStor snapshot agents come in. Snapshot agents installed on
host machines coordinate the snapshot process for databases and messaging
applications, safely and reliably taking snapshots of data for point-in-time copy
purposes, third-party backup applications, and disaster recovery planning. Snapshot
agents ensure that the resulting copy of data not only has point-in-time consistency,
but also transactional integrity.
Snapshot agents work seamlessly with options for replication, snapshot copy,
HyperTrac, and ZeroImpact Backup Enabler, all of which are based on the built-in
snapshot engine.
Using the Replication option in conjunction with snapshot agents maintains
replicated data for off-host processing. Not only can backups be performed on the
replica, but data can be changed for testing, what if analyses, or training purposes.
Systems can be resynchronized quickly and easily with no impact to the production
server.
Snapshot agents help simplify many data management tasks, meeting the
requirements of high availability and high performance in todays workplace. The
following agents are available:
Snapshot Agent for Microsoft VSS
Snapshot Agent for Microsoft Exchange
Snapshot Agent for Microsoft SQL Server
Snapshot Agent for Oracle
Snapshot Agent for FileSystems
Snapshot Agent for MySQL
Snapshot Agent for IBM DB2 Universal Database
Snapshot Agent for Lotus Notes/Domino
FalconStor Continuous Data Protector (CDP) and Network Storage Server (NSS)
support use of snapshot agents on most major platforms. For specific support
information, refer to the Certification Matrix on the FalconStor website.

Snapshot Agents User Guide

Introduction

Each agents configuration utility includes a menu that you can display by clicking
the icon in the upper left corner of the utility window. General options include the
following:
X-ray

Log files

All Microsoft Windows-based snapshot agents include an X-ray feature that allows
you to collect technical information - such as storage server messages and a
snapshot of the servers current configuration and environment - from your storage
servers for diagnostic purposes. The X-ray function generates a .cab file that you
can send to FalconStor Technical Support for analysis.
Log file content varies with each snapshot agent. Refer to individual agent
descriptions for details.

General installation requirements


The items below apply to installation of any snapshot agent as part of an in-band
solution. Silent install is supported for all agents. Additional requirements and
Installation details are included in agent-specific sections of this guide.
Note: In this guide, storage server refers to the FalconStor Storage Server;
associated storage is managed by FalconStor CDP/NSS, using the FalconStor
Management Console. Refer to the CDP/NSS User Guide for details about SAN
Clients, SAN Resources, Snapshot Resources, and Groups.

On the client machine, you must be an administrator or have administrator


privileges in order to install the snapshot agent.
You can install a snapshot agent on any client machine that has the ability to
connect to your storage server. Install and configure an iSCSI initiator or
Fibre Channel HBA on the client machine. Launch the iSCSI initiator and
identify the storage server as the target server.
On the storage server, make sure the client machine has been added as a
SAN Client.
On the storage server, create SAN Resources (logically mapped storage
devices on the storage network) for each clients database/messaging
system files, and assign them to the related SAN Client.
Before you do this, assess the requirements of each database or messaging
system in order to determine how many resources are required. For
instance, databases typically require data files to be on a separate disk from
log files; in this case, two resources are required.
Create a Snapshot Resource on each SAN Resource.
Continuing on the storage server, create a Group (under the Logical
Resources object in the management console) for each client machines
SAN Resources. This is sometimes referred to as a snapshot group.
Doing this ensures transactional integrity for database and messaging files
that reside on multiple disks. Whenever a snapshot is triggered, a snapshot
is taken for each resource in the group.

Snapshot Agents User Guide

Introduction

Migrate the database/messaging system files you want to protect to the new
resources.
Before you install the snapshot agent, install the FalconStor Intelligent
Management Agent (IMA). IMA enables the client machine to access storage
server resources and manages notifications from the storage server.
If IMA is not detected when snapshot agent installation begins, an error
message will be displayed. You will need to cancel the procedure, install
IMA, and then repeat snapshot agent installation.
The SAN Disk Manager (SDM) user interface is provided on Windows
machines. The Intelligent Management Agent User Guide includes details
for operating IMA on Windows and Linux clients.
Install and configure the snapshot agent that corresponds to your database/
application (such as Microsoft Exchange, SQL, or Oracle).
For in-band solutions, install the Snapshot Agent for FileSystems with all
snapshot agents except the Snapshot Agent for VSS.
For information about snapshot agent installation as part of an out-of-band
solution such as FalconStor DiskSafe, refer to the user guide for that
solution.
Download software builds, patches, and other documentation related to
your FalconStor product from the FalconStor Customer Support Portal at
support.falconstor.com (account required). Click the View Builds, Patches,
& Documentation link in the GA Releases area to complete a simple search
form and display available downloads.

Additional resources
This guide supports the latest version of each snapshot agent.
Snapshot agents are designed to work with FalconStor Continuous Data Protector
(CDP) and FalconStor Network Storage Server (NSS). For more information, refer to
the CDP/NSS User Guide.
Snapshot agents are supported on various platforms. For specific version
information, refer to the Certification Matrix on the FalconStor website.
Note that the product release notes and patch descriptions can include information
that may not appear in the user guide. Be sure to review all available documents.
If you need technical support, create a support ticket on the FalconStor Customer
Support portal.

Snapshot Agents User Guide

Snapshot Agent for Microsoft VSS

The FalconStor Snapshot Agent for Microsoft Volume Shadow Copy Service
(VSS) protects VSS-aware application drives with full point-in-time consistency while
still allowing non-stop access to the data.
Microsoft VSS provides the backup infrastructure for Microsoft Windows operating
systems, using a set of extensible application programming interfaces (APIs) to
create consistent point-in-time copies of application data (shadow copies) across
multiple volumes, regardless of the snapshot technology or application, by
coordinating with business applications, filesystem services, backup applications,
fast recovery solutions, and storage hardware.
Microsoft VSS consists of four components:

Requestors - Start the VSS backup or restore operation and manage


metadata.
Writers - Prepare applications for backups and restores.
Hardware Providers - Create the snapshot shadow copies by
communicating with hardware.
VSS Service - Windows service that controls VSS operations by
coordinating the other components.

The FalconStor Snapshot Agent for VSS takes consistent point-in-time snapshots of
VSS-aware application data and communicates with FalconStor Continuous Data
Protector (CDP) and FalconStor Network Storage Server (NSS) using its own
requestor and hardware provider. The hardware provider creates snapshot volumes
and is compatible with any third-party VSS requestor.
In order to use the VSS snapshot agent inside a VMware virtual machine, you must
either assign the data LUN directly to the virtual machine from NSS, or protect local
data storage using with FalconStor DiskSafe.

Storage configuration guidelines

Microsoft VSS requires that devices are formatted in NTFS.


Microsoft VSS limits the number of volumes in a group to 64.
All devices in a snapshot group must be assigned to the client.
In the FalconStor Management Console, the TimeMark option must be
enabled on both primary and replica disks.
When Continuous Replication is enabled on a device assigned to the
client, the Create Primary TimeMark and Synchronize Replica TimeMark
options must be selected in order to ensure synchronous VSS TimeMarks
on both the primary and replica resources. This is necessary because VSS
TimeMarks contain additional VSS TimeView data that will not be replicated
unless these options are selected.
Dynamic disks are not supported.

Snapshot Agents User Guide

Snapshot Agent for Microsoft VSS

Install the snapshot agent (updated November 2013)


Complete required steps described in General installation requirements.
Installation requires the following:

The client machine must support Microsoft VSS.


The storage array used by the client must be compliant with the SCSI
commands required by Microsoft VSS, such as page 0x80 and 0x83 SCSI
inquiry commands. Contact your storage array provider to verify.

To install the snapshot agent:


1. Run the installation file.
2. When prompted, enter your license keycode.
The snapshot agent license must be activated (registered with FalconStor). If
your computer has an Internet connection, the license is activated as soon as
you enter your keycode and click Next. However, if your Internet connection is
temporarily unavailable or if your computer has no Internet connection, your
license will not be activated. You must activate your license within 30 days.
If your Internet connection is temporarily unavailable, your license will be
activated automatically the next time the snapshot agent is invoked, assuming
you have an Internet connection then. You can also add your license through
IMA.
If your computer has no Internet connection, you can perform offline activation
using IMA (refer to the Intelligent Management Agent User Guide).
3. When done, click Finish.
The snapshot agent will be installed to the same directory as IMA.
After the installation completes, the configuration utility launches automatically.

Silent install
Silent install is supported for snapshot agents. To install the agent in silent mode,
complete the following steps:
1. Download the package from the FalconStor Support Portal and extract the agent
package.
2. From the command line, navigate to the folder to which you extracted the
package.
3. Install the Intelligent Management Agent:
cd ima
setup.exe /s
cd ..

Snapshot Agents User Guide

Snapshot Agent for Microsoft VSS

4. Install the snapshot agent:


setup /s
or
setupsilent.bat
When installing the snapshot agent in silent mode on any 64-bit platform, run
setupsilent.bat from the AMD64 directory.

Snapshot Agents User Guide

Snapshot Agent for Microsoft VSS

Configure the snapshot agent


After the installation completes, a configuration utility launches.
Complete configuration as described below. When you are done, click OK to save
the changes you made in all tabs and either keep the utility open or exit. Click
Cancel to exit the utility and discard any changes.
To access this utility at a later time, select Start --> All Programs --> FalconStor -->
Configuration for Snapshot Agent for VSS, which runs vsscfg.exe.

Snapshot options

Perform a full
backup

The Snapshot tab allows you to configure or disable full and copy backups. Each
writer decides how to handle a copy backup, but tlog files are not usually truncated.

Run database
or application
verification

Always (the default) - Always perform a full backup.


Between the following times - If a snapshot notification occurs between the
times you specify, the snapshot will be a full backup.
Every Nth snapshot - Snapshots are counted, with the first snapshot
following a full backup designated as 1. When the count reaches the
number you specify, that snapshot will be a full backup. For example, if you
set the value to 5, every fifth snapshot will be a full backup.
Note that if you revise this value to a lower number and the count is currently
higher, the next backup will be a full backup, after which the count will restart.
Never - Always perform a copy backup.

You can specify when the Snapshot View should be verified during the snapshot
process. Currently, verification is compatible only with Microsoft Exchange, and
checks to see if Exchange is involved after snapshot creation is finished. You can
disable this option if the process takes too much time. For Exchange snapshots, the
snapshot agent will verify the checksum of the database and log files on the
Snapshot View, similar to IntegrityTrac.
Snapshot Agents User Guide

Snapshot Agent for Microsoft VSS

Always - Always run the verification.


After a full backup (the default)- Run the verification if the current snapshot
is a full backup.
Never - Never run the verification.

Advanced options
Use the advanced options to further refine snapshot configuration.

VSS mount point directory - the directory on which Snapshot View volumes
are mounted. Drive letters are not assigned to these volumes.
VSS metadata directory - the directory where requestor and writer metadata
is stored. You can also specify a file share in order to allow another host to
access the metadata.
CDP/SafeCache timeout - set to 180 seconds (3 minutes) by default.
Specify the number of seconds the hardware provider should wait for the
storage server to flush the CDP/SafeCache resource when asked to import
(create) a Snapshot View. Since this process is potentially time consuming,
the maximum setting is 86400 seconds (24 hours).
Exchange object verification timeout in minutes - set to 360 minutes by
default. If this timeout is exceeded before the agent has verified the
Exchange database, the agent will stop the verification process the
snapshot will fail.
Allow snapshot of mount point volumes - enabled by default, which sets a
registry value for IMA. When this option is enabled, the snapshot agent can
identify path information for volumes mounted to directories.
Storage Server for import operations - set to Automatic by default. In most
cases this option should not be changed. However, if the client is registered
to both source and target of a replication pair, specify the storage server to
which the hardware provider should send RPCs for Snapshot View
assignment when multiple storage servers are used.

Snapshot Agents User Guide

Snapshot Agent for Microsoft VSS

Batch file options


On the Batch Files tab, indicate if you want to run batch files before and/or after
each snapshot.

In order to run batch files, you must enter an administrative user name and
password for the local computer.
Click the Create/Edit button and use Notepad to generate batch files.

Manage the Trace Log


The Trace Log is a diagnostic tool used by Technical Support to help solve system
problems. Each Trace Log contains technical information about your system as well
as system messages and is updated whenever a snapshot occurs. Some of the
messages that appear in the Trace Log are also sent to the Windows Event Log.
Do not adjust Trace Log settings unless you are requested to do so by a Technical
Support representative. The configuration utility lets you maximize the level of detail
that is displayed.
1. Click the icon in the upper left corner of the configuration utility and select
Settings in the menu.

Snapshot Agents User Guide

Snapshot Agent for Microsoft VSS

2. Select Set Agent Trace On to maximize the level of detail displayed for agent
activity in the Trace Log.
The value in the text box will change to 10 and is not editable. Increasing the
level of detail will display a list of the databases that have been backed up, plus,
at higher levels, information that can be used to provide support. The log will
reflect the change after the next snapshot is taken.
Other options in this dialog are not supported.

Snapshot process
The Snapshot Agent for VSS will be triggered automatically whenever a snapshot
operation occurs on an CDP/NSS-managed disk.
You can test the snapshot agent by manually initiating a snapshot of a virtual drive
from the FalconStor Management Console. Click the TimeMark tab to verify that a
VSS snapshot has been created. You should see Yes with VSS in the Quiescent
column.
After the VSS snapshot agent creates a snapshot of application data, the snapshot
is mounted as a temporary device and assigned to the host. (A snapshot may be
referred to as a TimeMark; a mounted snapshot may be referred to as a Snapshot
View or TimeView.) The snapshot agent requestor clears read-only and hidden flags
and saves writer metadata to each volume. The hardware provider performs
additional cleanup and then tells CDP/NSS to unassign and delete the mounted
snapshot; data from the mounted snapshot is then saved.
When you select a SAN Resource in the FalconStor Management Console,
snapshots (referred to as TimeMarks in that console) created using the VSS
snapshot agent show Yes with VSS in the Quiescent column. Values in the
TimeView column can be available (data is present), none (there is no data), or in
use (the mounted snapshot is active).

Snapshot Agents User Guide

10

Snapshot Agent for Microsoft VSS

Writers
The VSS snapshot agent is designed to make backups uniform across applications.
Some writers have distinct behaviors:
Microsoft Exchange
For snapshots of Exchange databases and log files on shadow copy devices, the
snapshot agent can verify the checksum of the database and log files on the
Snapshot View, similar to the way this occurs for FalconStor IntegrityTrac.
Snapshot verification may take a long time to complete and can be disabled in the
snapshot agent configuration tool (refer to Configure the snapshot agent).
Refer to the Certification Matrix on the FalconStor website to determine supported
versions of Exchange supported by the Snapshot Agent for VSS.
Microsoft Hyper-V
In order for a virtual machine to take part in the VSS process, Hyper-V integration
tools must be installed; otherwise, the virtual machine is temporarily suspended and
saved to the disk while a snapshot is being created. When Snapshot View devices
are assigned to the host during a full backup, the Hyper-V writer will roll back each
virtual machine to the same point in time.

History and event logs


Snapshot agent events/history are recorded in the Microsoft Windows Event Log as
Snapshot Agent events.
If you are using a VSS snapshot agent build higher than 600, the hardware provider
also logs events through the snapshot agent.

Remove snapshot agent software


Remove the snapshot agent using Add/Remove Programs from the Control Panel.

Snapshot Agents User Guide

11

Snapshot Agent for


Microsoft Exchange

Note: If you are using Microsoft Exchange 2010 or Exchange 2013, you must use
the Snapshot Agent for Microsoft VSS.

The FalconStor Snapshot Agent for Microsoft Exchange enables FalconStor CDP/
NSS to protect Exchange databases with point-in-time consistency while allowing
full speed, non-stop access to databases.
Microsoft Exchange requires quiescent snapshots. In order for this to occur, the
Snapshot Notification option must be enabled on the Snapshot Resource (refer to
the CDP/NSS User Guide). When a snapshot is triggered and snapshot notification
is enabled, the FalconStor system notifies the application server running the
snapshot agent to stop writing in order for the snapshot to be taken. The snapshot
agent briefly puts the database into backup mode and notifies the FalconStor
system that the snapshot can be performed. The application server is again notified
once the snapshot has completed, and the snapshot agent takes the database out
of backup mode.
Using backup software, a backup of the snapshot image can be performed at high
speed while Microsoft Exchange operates in normal mode. While the backup
software is reading data from the snapshot image, changes that occur to the
database will not affect what gets written. Users are always able to see the database
with full access at all times while the backup software sees a stable, read-only
snapshot image of the database taken an instant before the backup began.
The snapshot agent will be triggered automatically whenever a snapshot operation
occurs on the Microsoft Exchange drive.

Storage configuration guidelines


Before you install the snapshot agent, apply Microsoft's best practice for Exchange
storage configuration.
These items should be on the same disk:
Exchange log
System path
These items should be together, on a separate disk:
Exchange database
Exchange streaming database

Snapshot Agents User Guide

12

Snapshot Agent for Microsoft Exchange

Install the snapshot agent


Complete required steps described in General installation requirements.
Installation requires the following:

Install the snapshot agent on the machine where Exchange Server is


running.
Start the Exchange Server before you install the snapshot agent.
Only one active Exchange Virtual Server per node is supported; a snapshot
group should not include multiple virtual servers on the same node.

To install the snapshot agent:


1. Run the installation file.
2. When prompted, enter your license keycode.
The snapshot agent license must be activated (registered with FalconStor). If
your computer has an Internet connection, the license is activated as soon as
you enter your keycode and click Next. However, if your Internet connection is
temporarily unavailable or if your computer has no Internet connection, your
license will not be activated. You must activate your license within 30 days so
that you can continue to use the snapshot agent.
If your Internet connection is temporarily unavailable, your license will be activated
automatically the next time the snapshot agent is invoked, assuming you have an
Internet connection then. You can also add your license through IMA.
If your computer has no Internet connection, you can perform offline activation
using IMA (refer to the Intelligent Management Agent User Guide).
3. When done, click Finish.
The snapshot agent will be installed to the same directory as IMA.

Silent install
Silent install is supported for snapshot agents. To install the agent in silent mode,
complete the following steps:
1. Download the package from the FalconStor Support Portal and extract the agent
package.
2. From the command line, navigate to the folder to which you extracted the
package.
3. Install the Intelligent Management Agent:
cd ima
setup.exe /s
cd ..

Snapshot Agents User Guide

13

Snapshot Agent for Microsoft Exchange

4. Install the snapshot agent:


setup /s
or
setupsilent.bat
When installing the snapshot agent in silent mode on any 64-bit platform, run
setupsilent.bat from the AMD64 directory.

Configure snapshot agent options


Configuration is not required. The snapshot agent includes a utility that lets you
configure optional features.
To run the utility, select Start --> All Programs --> FalconStor --> Configuration for
Snapshot Agent for Microsoft Exchange.
When you are done, click OK to save the changes you made in all tabs and either
keep the utility open or exit. Click Cancel to exit the utility and discard any changes.

Batch file options


On the Batch Files tab, indicate if you want to run batch files before and/or after
each snapshot.

In order to run batch files, you must enter an administrative user name and
password for the local computer.
You can then click the Create/Edit buttons and use Notepad to generate the batch
files.

Snapshot Agents User Guide

14

Snapshot Agent for Microsoft Exchange

Monitor tab
By default, the snapshot agent looks for databases based on information passed
from IMA. This tab allows you to identify the drives on which databases are located.

Manage the Trace Log


The Trace Log is a diagnostic tool used by Technical Support to help solve system
problems. Each Trace Log contains technical information about your system as well
as system messages and is updated whenever a snapshot occurs. Some of the
messages that appear in the Trace Log are also sent to the Windows Event Log.
Do not adjust Trace Log settings unless you are requested to do so by a Technical
Support representative. The configuration utility lets you maximize the level of detail
that is displayed.
1. Click the icon in the upper left corner of the configuration utility and select
Settings in the menu.

2. Select Set Agent Trace On to maximize the level of detail displayed for agent
activity in the Trace Log.
The value in the text box will change to 10 and is not editable. Increasing the
level of detail will display a list of the databases that have been backed up, as
well as information that can be used to provide support. The log will reflect the
change after the next snapshot is taken.
Other options in this dialog are not supported.
Snapshot Agents User Guide

15

Snapshot Agent for Microsoft Exchange

Configure service-enabled devices


If you are using a service-enabled device (SED) and you have preserved the
physical devices inquiry string (this is set when you create the SED in the
FalconStor Management Console), you need to modify the ExAgent.ini file that is
created under the directory when the snapshot agent is installed. In the ExAgent.ini
file, you must use the DriveOverride option to specify the drive letter(s) to which the
SED is mounted. For example: DriveOverride=E:; or DriveOverride=E:;F:;
Also, if you want to send snapshot results to a third-party management system, you
will have to use the Exchange configuration utility to enter the User Name and
Password of a member of the local administrators group. This user account does not
need permission from the Exchange Administrator; it is only used to run the prescript (exchpre.bat) and post-script (exchpost.bat) that are saved in the IMA
installation folder. You do not need to run these scripts unless you want to send
snapshot results to a third-party management system.

Test the snapshot agent


To test the snapshot agent, you can perform a Snapshot Copy of a virtual drive from
the FalconStor Management Console.

Confirm snapshot status


To confirm the Exchange snapshot process, you can check the Windows Event log.
The snapshot agent will send the backup command to each storage group on the
protected disk. You can find these logs after the appctrl event:
1. The snapshot agent sends the full backup command to the storage group and
then Exchange Extensible Storage Engine (ESE) starts the full backup process.
2. Exchange ESE checks the log files and the checkpoint.
3. Exchange ESE processes the log files. The snapshot agent will not request to
truncate the log to affect other Exchange backup processes.

Snapshot Agents User Guide

16

Snapshot Agent for Microsoft Exchange

4. Exchange ESE completes the backup process on a storage group. You may see
the same process on another storage group.

Snapshot Agents User Guide

17

Snapshot Agent for Microsoft Exchange

Purge log utility


If you are using the Snapshot Agent for MS Exchange to protect your Exchange
environment but do not have third-party backup software to help purge the
Exchange log files, you can use the ISPurgeExLog utility to clean up Exchange log
files.
Before you run the utility, check the Windows Application Event Log to make sure
the latest snapshot was taken successfully. You can also dump the MS Exchange
Checkpoint file using ESEUTIL.exe and check the timestamp of FullBackup Time
to view the record of the last snapshot date and time.
The Microsoft Exchange log file is generated based on each Exchange Storage
Group; run the utility on each group. In addition, you can schedule a batch job with
the following command inside the batch file:
For Microsoft Exchange 2003:
ISPurgeExLog "F:\Exchsrvr\System\E00.chk" "F:\Exchsrvr\log"

For Microsoft Exchange 2007:


ISPurgeExLog64 "F:\Exchsrvr\System\E00.chk" "F:\Exchsrvr\log"

You must specify the location of the checkpoint file and log directory.
Syntax: ISPurgeExLog "<Checkpoint File>" "<Exchange Log
directory>" [Options]]
Option

Description

-b#hour

The number of hour(s) before the recorded


checkpoint time, maximum 96 hours. For example, b04, -b16, default is -b24.

-c

Use the last checkpoint log file date/time if it is earlier


than the last full backup date/time

-hHour

From 00 to 23. For example, -h04, -h16. Execute


purge only when run within a specific hour (hh:00hh:59)

-i

Ignore the last full backup timestamp on CCR


passive node. Works with -c option.

-p

Preview the purge list without actually deleting the


log(s).

-r"reportFileName

Additional report file is generated.

s"StorageGroupName"

Storage Group Name in Report File.

-v

verbose mode.

Snapshot Agents User Guide

18

Snapshot Agent for Microsoft Exchange

It is recommended that you run the purge utility once a day, maintaining 24 hours of
log files after each log purge. After the purge, you can examine the log file directory
and make sure older log files are deleted. There is also an ISPurge.log file created
containing the history of each ISPurgeExLog execution.

Remove snapshot agent software


Remove the snapshot agent using Add/Remove Programs from the Control Panel.

Snapshot Agents User Guide

19

Snapshot Agent for Microsoft


SQL Server

The Snapshot Agent for Microsoft SQL Server protects Microsoft SQL Server
databases on protected disks with point-in-time consistency while still allowing full
speed, non-stop access to the databases. Users always have full access to the
database, while backup software sees a stable, read-only snapshot image of the
database taken an instant before backup began.
Before the snapshot process begins, a request is sent to the server running the
Snapshot Agent for Microsoft SQL Server to quiesce databases or applications. By
default, the snapshot agent performs a full backup of all databases. The configuration
utility allows you to choose different backup options for different SQL instances, and
lets you exclude less critical databases from snapshots.
Backup software can back up the snapshot image at high speed while Microsoft
SQL Server operates in normal mode. Because the contents of the snapshot image
are guaranteed never to change, the backup is consistent, ensuring transactional
integrity. When backup software reads data from the snapshot image, changes that
occur in the database do not affect what gets written.
The snapshot agent will be triggered automatically whenever a snapshot operation
occurs on the Microsoft SQL Server drive.
The snapshot agent includes a utility that allows you to recover a single database,
as well as a command line interface.
The Snapshot Agent for Microsoft SQL Server is supported for various Windows
Server platforms. For specific version information, refer to the Certification Matrix on
the FalconStor website.

Install the snapshot agent


Complete required steps described in General installation requirements.
Installation requires the following:

You need to know the database instance name.

You need to know the database administrator password if the default policy
is Windows authentication and the current Windows login account does not
have enough access rights.

Start SQL Server before you install the snapshot agent.

Install the snapshot agent on the machine on which the SQL Server
database is running.

20

Snapshot Agent for Microsoft SQL Server

The following items are required for VMware environments

If the virtual machine is not protected by DiskSafe, you must install


FalconStor Snapshot Director for VMware vSphere on the virtual host that
you want to protect.

You must configure IMA to specify override drives. These are the drives on
the virtual host that you want to protect using IMA. If you do not do this,
applications may not be quiesced correctly.
Override drives should include any other drives that contain databases or
other application data that should be quiesced before snapshots are taken.
To manage override drive settings, execute the following commands in the
command line on the virtual host:
To specify override drives:
iscmcli setoverridedrive -d "<drive_list>"
where <drive_list> is a list of drive letters separated by semi-colons.
For example:
iscmcli setoverridedrive -d "C:;E:;F:;"
To view the list of current override drives:
iscmcli getoverridedrive
If no override drives have been set, the command returns no output.
To delete current override drive settings:
iscmcli deloverridedrive

To install the snapshot agent:


1. Run the installation file.
2. When prompted, enter your license keycode.
You must activate the snapshot license (register it with FalconStor). If your
computer has an Internet connection, this will occur automatically after you enter
your keycode and click Next. However, if your Internet connection is temporarily
unavailable or if your computer has no Internet connection, automatic activation
is not possible. You must activate your license within 30 days so that you can
continue to use the snapshot agent.
If your Internet connection is temporarily unavailable, automatic activation will
occur the next time the snapshot agent is invoked, assuming you have an
Internet connection then. You can also add your license through IMA.
If your computer has no Internet connection, you can perform offline activation
using IMA.
3. When installation is complete, click Finish.
The snapshot agent will be installed to the same directory as IMA.
After the installation completes, the configuration utility launches automatically.

21

Snapshot Agent for Microsoft SQL Server

Silent install
Silent install is supported for snapshot agents. To install the agent in silent mode,
complete the following steps:
1. Download the package from the FalconStor Support Portal and extract the agent
package.
2. From the command line, navigate to the folder to which you extracted the
package.
3. Install the Intelligent Management Agent:
cd ima
setup.exe /s
cd ..
4. Install the snapshot agent:
setup /s
or
setupsilent.bat
When installing the snapshot agent in silent mode on any 64-bit platform, run
setupsilent.bat from the AMD64 directory.

22

Snapshot Agent for Microsoft SQL Server

Configure the snapshot agent


Complete configuration as described below. When you are done, click OK to save
the changes you made in all tabs and either keep the utility open or exit. Click
Cancel to exit the utility and discard any changes.
To run the utility at a later time, select Start --> All Programs --> FalconStor -->
Configuration for Snapshot Agent for Microsoft SQL Server.

Database Security options


The snapshot agent supports multiple instances of Microsoft SQL on the same
server. In order for the snapshot agent to communicate with an instance, you have
to register the instance with the snapshot agent from this utility tab.
The Database Security tab displays the databases whose snapshots will be
managed by the snapshot agents.

23

Snapshot Agent for Microsoft SQL Server

1. Click Add to add a SQL instance. The Database Login screen displays.

2. Select the virtual server or host on which the instance is located. If the SQL
server is in a cluster, select the name of the virtual server on which the SQL
instance was created. If the server is not in a cluster, select the local host name.
The drop-down list displays the virtual server name and the host name detected
in the registry.
3. In the Instance field, MSSQLSERVER will be displayed if the server uses the
default instance. If the SQL instance is not displayed, enter it here or select it in
the drop-down list.
You can use the Services console (Control Panel --> Administrative Tools -->
Services) to check instance names. In this console, the instance name will be
listed in parentheses. For example, if the service name is shown as SQL Server
(MSSQLSERVER), its instance name is MSSQLSERVER. If you have another
instance, another service, such as SQL Server (INSTANCE1), will be listed. In this
example, the SQL instance name is INSTANCE1.
4. Provide connection credentials:
For Windows Authentication mode, user name and password are not required.
Select the Trusted Connection - Windows Authentication checkbox to avoid
storing credentials in connection strings.
OR, for SQL Server authentication mode, enter the database user name and
password of an account that has access to the database.
5. When you are done, click Verify to allow the snapshot agent to attempt to
connect to the instance using the provided credentials.
If connection is successful, the Verify button changes to OK.
After you have added a SQL instance, you can change its information or remove it.
To do this, select a SQL instance in the list and then:

Click Edit to modify its information in the Database Login dialog.

Click Remove to delete it.


24

Snapshot Agent for Microsoft SQL Server

Database Options tab (updated October 2013)


Note: If the disk on which a database resides is not protected, snapshots will not
be taken.
For each database in a selected instance, the Database Options tab provides
information and lets you specify a location for the Transaction Log backup directory.

1. Select an instance from the drop-down list.


The Database count and Total values are displayed.
2. Select a database from the drop-down list.
The Database directory, Transaction log directory, and storage server ID are
displayed automatically.
If the database is not on a direct CDP/NSS device, Not on Storage Server
Device will be displayed in the Storage Server field.
3. The utility is designed to let you specify a Transaction Log Backup directory for
all databases in the selected instance, or for individual databases. It is
recommended that you store transaction log backups separately from the
transaction log and the database.
In addition, it is recommended that if you have two database instances, choose a
different backup directory for each.
Note: Ensure there is enough disk space for transaction log backups, based
on the amount of data changes to record.

25

Snapshot Agent for Microsoft SQL Server

Click the Browse button next to the Transaction Log Backup directory field and
select a backup directory location. Manually entering a directory location is not
recommended.
Note: Make sure that you have selected a database before you do this; this is
necessary in order for the selected location to be saved.
To specify this directory as the Transaction Log Backup directory for all
databases, respond Yes to the Change entry for all databases in this
instance? message.
To specify this directory as the Transaction Log Backup directory only for the
selected database, respond No to the change entry message.
If you do not see the change entry message, the directory selection will
apply only to the selected database.
Note: If you click in the Transaction log backup field but do not make a
selection, the message Change entry for all databases in this instance? may
be displayed when you continue with another action. Click No to close the
message box.
Additional options for transaction log backup are available (refer to Transaction Log
Backup best practice).

Advanced Options tab


Note: Snapshots are taken only if the disk on which a database resides is
protected.
The Advanced Options tab allows you to choose a backup option for all databases in
the selected instance and lets you exclude individual databases from that option.

26

Snapshot Agent for Microsoft SQL Server

To do this:
1. Select one backup option. Full backup is selected by default:
Full backup of all databases - The snapshot agent performs a full SQL Server
snapshot backup of selected databases, regardless of their recovery model.
Full backup, but checkpoint only on databases when recovery model set to
Simple - The snapshot agent performs a full backup on selected databases
except for those whose recovery model is set to Simple; for those, a checkpoint
is performed.
Do checkpoint only on all databases - If the instance includes a large number of
databases, choose this option to save time. Do not exclude any databases.
Copy-only, full backup of all databases - The snapshot agent performs a full
backup of selected databases but does not notify SQL that backup has occurred.
Notes for the copy-only option:

Applies only to databases configured for Full recovery.

Copy-only snapshots can be taken several times a day, providing


more frequent data protection points.

Does not interfere with third-party backup software operations.

You can perform Rollback recovery using a TimeMark or file copy


recovery from a TimeView.

You cannot choose a point-in-time recovery option between


TimeMarks.

2. Select Perform a transaction log backup for every snapshot to enable this
option. This option is disabled if you choose the checkpoint only or copy only
option.
3. The Database Selection area lists all databases discovered in the selected
instance. You can exclude specific databases from the selected backup
operation.
To do this, select a SQL instance from the drop-down list, which includes only
those instances that have been registered with the snapshot agent using this
utility.
All databases in the instance are selected by default. Uncheck any database(s)
that the snapshot agent should exclude from the selected backup operation.
If the full backup or copy-only option is selected, the snapshot agent will
perform a checkpoint flush on the excluded databases for overall snapshot
consistency.
If checkpoint only is selected, excluded databases will be ignored.
Use the Select All/Deselect All checkbox to select or deselect all databases at
the same time.

27

Snapshot Agent for Microsoft SQL Server

If you create additional databases after completing initial agent configuration and
want to exclude any of them from the selected backup option, run the
configuration utility again and deselect them here.

Batch Files tab


Use this tab to indicate if you want to run batch files before and/or after each
snapshot, and allows you to create a pre- or post-batch file in Notepad.

1. Select the checkbox if you want to run batch files before and/or after the
snapshot agent.
2. Enter an administrative user name and password for the local computer.
3. Click the appropriate Create/Edit button to open Notepad and create/save the
batch file.

28

Snapshot Agent for Microsoft SQL Server

Monitor tab
By default, the snapshot agent looks for databases based on information passed
from IMA. If the default drives (as seen in the Database Options tab) are incorrect or
if no drives are listed, this tab allows you to identify the drives on which databases
are located.

1. Select the option if you want the snapshot agent to look for databases elsewhere
than in the default drive(s).
For example, if a database is located on a SAN disk that is mounted to an NTFS
folder such as E:\database, you need to identify that drive here.
2. Type the drives on which your databases are located; separate multiple drive
names with a semicolon (for example D:;E:;F:).

Manage the Trace Log


The Trace Log is a diagnostic tool used by Technical Support to help solve system
problems. Each Trace Log contains technical information about your system as well
as system messages and is updated whenever a snapshot occurs. Some of the
messages that appear in the Trace Log are also sent to the Windows Event Log.
Do not adjust Trace Log settings unless you are requested to do so by a Technical
Support representative. The configuration utility lets you maximize the level of detail
that is displayed.
1. Launch the configuration utility.
2. Click the icon in the upper left corner of the configuration utility and select
Settings in the menu.

29

Snapshot Agent for Microsoft SQL Server

3. The Settings dialog lets you specify the level of detail to be displayed.

Click the checkbox for Specify Trace Log level. The value in the text box sets the
level of detail to be displayed. 0 is the default. Increasing the detail value will
display a list of the databases that have been backed up, plus, at higher levels
(maximum 10), information that can be used to provide support. If you change
this value, the log will adjust to the change after the next snapshot.

<databasename>.hisu file
The <databasename>.hisu file contains a list of all files since the time the application
started and resides in the transaction log directory. An example is shown below:
db1.mdf;20120703144715;0;1
db1-20120705102206.log
db1-20120705102208.log
db1-20120705102210.log
db1.mdf;20120705102213;0;1
This sample log file indicates that a full backup was done, followed by three
Transaction Log backups, and then another full backup.

* Transaction log backup, then full database backup if option to Perform a transaction log backup for every snapshot
option is checked.

30

Snapshot Agent for Microsoft SQL Server

Test the snapshot agent


To test the snapshot agent, perform a Snapshot Copy of a virtual drive from the
FalconStor Management Console for CDP/NSS.

Transaction Log Backup best practice (updated October 2013)


Transaction log backups make it possible to perform a point-in-time restore. When
you install FalconStor Database Recovery for Microsoft SQL Server, you can
configure a transaction log backup to occur immediately before a full backup (refer
to the Database Recovery for Microsoft SQL Server section in the Recovery Agents
User Guide).
Note: Transaction Log Backup can occur only after the first full backup has
occurred.
Best practice recommendations include:
1. Put the transaction log backup command in a batch file called <your file
name>.bat.
For example:
fsssrest.exe -tlb -d "*" -i "ESX40W2K8DEVHAR"
2. Schedule the snapshot agent to perform a normal full backup during a SQL
server non-peak period.
3. Use the Windows Task Scheduler to run your transaction log backup more
frequently but make sure the two processes do not execute at the same time.
For example:
If the snapshot agent is scheduled to perform a full backup at 2am every day,
use the Microsoft Task Scheduler to run the <your file name>.bat file every
hour on the half hour.
4. Make sure the directory to which transaction log backups are saved has enough
disk space, based on the amount of data changes.

31

Snapshot Agent for Microsoft SQL Server

Recover a database manually


Note: Use FalconStor Database Recovery for Microsoft SQL Server if you want
to perform automatic recovery from a point-in-time snapshot image of your SQL
database.
The snapshot agent includes a recovery utility that can either perform a Rollback
restore to the latest TimeMark snapshot or complete the recovery process after you
recover the data from a TimeView using the FalconStor Management Console.
To do this:
1. Launch the recovery utility by selecting Start --> All Programs --> FalconStor -->
Single Database Recovery for Microsoft SQL Server.
2. The Restore tab lists all databases for which snapshots have been taken.

Select the instance and database to be restored.


At any point, you can click Refresh to update all fields.
3. Click Restore.
4. In the Command Line dialog, click the Run button to begin the restore process or
copy and paste the command to a command line.

32

Snapshot Agent for Microsoft SQL Server

5. Follow the instructions displayed at the command prompt.

Note: Double-byte database names may display as question marks (????) or


spaces. This is OK.
a. Detach the database you are restoring.
b. Do one of the following:

If you want the utility to complete a TimeView restore, use IMA or the
FalconStor Management Console for CDP/NSS to perform a TimeView
restore from a Time Mark.
Find the database files *.mdf, *.meta, *.ldf (if recovery model is full) on
the TimeView.
Rename or delete the original files.
Copy the files from the TimeView to original location.
If you want the utility to perform a Rollback restore, make sure the
selected database is the only database on this device; otherwise, perform
a TimeView restore. Press Enter to continue with Rollback restore.

c. Press Enter to continue.


When the recovery process is complete, verify that the database has been restored.

Command line interface


The snapshot agent also includes a command line interface (fsssrest.exe).
Usage: fsssrest [action][options]
Actions:
-fro - Perform full restore only.
-tlb - Perform Transaction Log backup.
-fb - Perform full backup.
-cp - Perform checkpoint.
-list - List databases in instance.
-backuplist - List databases backed up in instance.
33

Snapshot Agent for Microsoft SQL Server

Options:
-t <trace path and file> - Specify a destination path and
file name for the Trace Log.
-d <databasename> - Specify the database name - applies to fb, tlb, and
cp.
-i <Server Name><Instance Name> - Specify server name and instance
name.
-dir <backup directory> - Specify the Transaction Log backup directory.
-en - Display text in English.
Note that if you do not include the -t option in the command, level 1 detail will be
saved to the Trace Log. If you include the -t option, level 10 detail (the maximum)
will be saved.
Examples:

Perform transaction log backup for a single database after a storage server
snapshot has been taken:
fsssrest -tlb -d <databasename>
This command enables you to perform additional transaction log backups
after a full backup and before the last transaction log backup. The command
records the date and time, which makes it easier to identify the transaction
logs that are needed during restore. You can run this command as needed,
based on your backup schedule. You can also use other utilities to schedule
additional transaction log backups between snapshots.

Configure Transaction Log backup for all databases in one instance:


fsssrest.exe -tlb -d * -i
"ESX40W2K8DEVHAR\SQLINSTANCE1"

Configure Transaction Log backup for all databases in all instances on the
server:
fsssrest.exe -tlb -d * -i "ESX40W2K8DEVHAR"

Configure Transaction Log backup for all databases in one instance and
generate the Trace Log:
fsssrest.exe -tlb -d * -i
"ESX40W2K8DEVHAR\SQLINSTANCE1" -t

Configure Transaction Log backup for all databases in one instance;


generate the Trace Log and save it to drive C: as test.log:
fsssrest.exe -tlb -d * -i
"ESX40W2K8DEVHAR\SQLINSTANCE1" -t C:\test.log

Transaction Log backups are recorded in history files for use by the SQL Recovery
tool. Transaction Log backups can be used by any Microsoft SQL recovery utility.
Note: If you use another utility to perform transaction log backups, you will need to
manually enter the transaction records into FalconStor Database Recovery for
Microsoft SQL Recovery.

34

Snapshot Agent for Microsoft SQL Server

Diagnostic X-ray
An X-ray feature allows you to collect technical information - such as storage server
messages and a snapshot of the servers current configuration and environment for diagnostic purposes. To capture an X-ray, launch the agents configuration utility
and select Take X-ray in the utility menu. The X-ray function generates a .cab file
that you can send to FalconStor Technical Support for analysis.

Remove snapshot agent software


Remove the snapshot agent using Add/Remove Programs from the Control Panel.

35

Snapshot Agent for Oracle

The FalconStor Snapshot Agent for Oracle enables FalconStor CDP/NSS to


protect Oracle databases with point-in-time consistency while still allowing full
speed, non-stop access to the databases.
Prior to starting the snapshot process, a request is sent to the application server
running the Snapshot Agent for Oracle. The snapshot agent places the Oracle
database in "backup" mode and notifies the server that the snapshot can be
performed. While in backup mode, the database is frozen and Oracle sends all
new incoming data to the Oracle online redo logs. Once the snapshot has
completed, the server notifies the application server and the snapshot agent places
the database back into normal mode, synchronizing all data back to the database.
Using backup software, a backup of the snapshot image can be performed at high
speed while Oracle operates in normal mode. Because the contents of the snapshot
image are guaranteed never to change, what is backed up is consistent, ensuring
transactional integrity. While the backup software is reading data from the snapshot
image, changes that occur to the database will not affect what gets written. Users
are always able to see the database with full access at all times while the backup
software sees a stable, read-only snapshot image of the database taken an instant
before the backup began.
The snapshot agent will be triggered automatically whenever a snapshot operation
occurs on the Oracle drive.

Support for file systems


The Snapshot Agent for Oracle supports the following file systems:

ASM - Automated Storage Management - the disk are raw LUNs.

OCFS - Oracle Cluster File System.

Install the snapshot agent


Complete required steps described in General installation requirements.
Installation requires the following:

You need to know the database instance name and the database
administrator password.

Start your Oracle database before you install the snapshot agent.

After the snapshot agent is installed, you must turn on Oracle archive
logging before running the snapshot agent (refer to Turn on Oracle archive
logging).

Snapshot Agents User Guide

36

Snapshot Agent for Oracle

Install on Windows
1. Run the installation file.The snapshot agent will be installed to the same
directory as IMA.
2. Select which version(s) of Oracle you are using.
You must have a separate license for each.
3. When prompted, enter your license keycode.
The snapshot agent license must be activated (registered with FalconStor). If
your computer has an Internet connection, the license is activated as soon as
you enter your keycode and click Next. However, if your Internet connection is
temporarily unavailable or if your computer has no Internet connection, your
license will not be activated. You must activate your license within 30 days so
that you can continue to use the snapshot agent.
If your Internet connection is temporarily unavailable, your license will be
activated automatically the next time the snapshot agent is invoked, assuming
you have an Internet connection then. You can also add your license through
IMA.
If your computer has no Internet connection, you can perform offline activation
using IMA (refer to the Intelligent Management Agent User Guide).
4. When done, click Finish.
After installation completes, a configuration utility launches. Refer to Configure the
snapshot agent on a Windows machine.
Silent install

Silent install is supported for snapshot agents. To install the agent in silent mode,
complete the following steps:
1. Download the package from the FalconStor Support Portal and extract the agent
package.
2. From the command line, navigate to the folder to which you extracted the
package.
3. Install the Intelligent Management Agent:
cd ima
setup.exe /s
cd ..
4. Install the snapshot agent:
For Oracle 11
Run setup /s or setupsilent.bat.
For Oracle 10
a. Copy setup10.iss to setup.iss.
b. Run setup /s or setupsilent.bat.
Snapshot Agents User Guide

37

Snapshot Agent for Oracle

For Oracle 9
a. Copy setup9.iss to setup.iss.
b. Run setup /s or setupsilent.bat.
Note: If your Oracle server is running a 64-bit operating system, perform
these steps from the AMD64 directory.

Install on Solaris
You must be root (or root equivalent) in order to install the snapshot agent.
1. Download the tar file to the local drive of your Solaris client (/tmp is used in the
example).
2. Install the snapshot agent software.
pkgadd -d /tmp/oracle8i9i10gagent-<version number>-<build number>.pkg

For example: pkgadd -d /tmp/oracle8i9i10gagent-4.50-906.pkg


3. Select the Snapshot Agent for Oracle package.
After installation completes, a configuration utility launches. Refer to Configure the
snapshot agent on a Solaris machine.

Install on Linux
You must be root (or root equivalent) in order to install the snapshot agent.
1. Download the installation file to the local drive of your Linux client.
2. Install the snapshot agent software.
rpm -i --nodeps oracleniagent-<version number>-<build number>.i386.rpm

Oracle 9i example: rpm -i --nodeps oracle9iagent-4.50898.i386.rpm


Oracle 10g example: rpm -i --nodeps oracle10gagent-4.50899.i386.rpm
3. Enter the Oracle lib directory.
The default is $ORACLE_HOME/lib
After installation completes, a configuration utility launches. Refer to Configure the
snapshot agent on a Linux or AIX machine.

Snapshot Agents User Guide

38

Snapshot Agent for Oracle

Install on AIX
You must be root (or root equivalent) in order to install the snapshot agent.
1. Download the tar file to the local drive of your AIX client.
2. Type the following command to untar the agent package:
tar -xvf oracleniagent-<version number>-<build number>.tar
Oracle 9i example: tar -xvf oracle9iagent-4.50-901.tar
Oracle 10g example: tar -xvf oracle10gagent-4.50-901.tar
3. Install the package:
installp -aFX -d IPStor.OraAgent.bff all
After installation completes, a configuration utility launches. Refer to Configure the
snapshot agent on a Linux or AIX machine.

Install on HP-UX
You must be root (or root equivalent) in order to install the snapshot agent.
1. Download the tar file to the local drive of your HP-UX client (/tmp is used in the
example).
2. Type the following command to untar the agent package:
# cd .tmp
# tar xvf oracleniagent-<version number>-<build number>.tar
Oracle 9i example: tar xvf oracle9iagent-4.50-896.tar
Oracle 10g example: tar xvf oracle10gagent-4.50-897.tar
3. Install the snapshot agent software.
# swinstall -s pwd/package oracle
4. As the Oracle User, view the .profile or type the env command to determine the
library path.
Oracle requires several environment variables, one of which is the SHLIB_PATH
(this is the same as the LD_LIBRARY_PATH on other UNIX boxes, such as
Solaris).
$ cat ~/.profile | grep SHLIB_PATH
SHLIB_PATH=$ORACLE_HOME/lib:$ORACLE_HOME/lib64:/lib:/usr/
lib:/usr/local/lib
- or $ env | grep SHLIB_PATH

Snapshot Agents User Guide

39

Snapshot Agent for Oracle

SHLIB_PATH=/oracle8/OraHome1/lib:/oracle8/OraHome1/lib64:/
lib:/usr/lib:/usr/local/lib
In these examples, there are two directories: lib and lib64. One or more of these
directories contain the library (libclntsh.sl.8.0) needed for the Oracle8i Database
Agent to work correctly.
5. As root user, issue a find command to make sure one or more of these
directories contain the necessary library path.
# find /oracle8/OraHome1/lib -name "libclntsh.sl.8.0" -print
/oracle8/OraHome1/lib/libclntsh.sl.8.0
# find /oracle8/OraHome1/lib64 -name "libclntsh.sl.8.0" print
/oracle8/OraHome1/lib64/libclntsh.sl.8.0
In this example, the file exists in both Oracle directories. If this occurs on your
machine, enter both paths when configuring the agent.
After installation completes, a configuration utility launches. Refer to Configure the
snapshot agent on an HP-UX machine.

Snapshot Agents User Guide

40

Snapshot Agent for Oracle

Configure the snapshot agent


Configuration details for each type of installation are provided below.
Additional configuration steps are required for Unix platforms (refer to (Unix only)
Add root user to database groups and (Unix only) Set root users PATH and
LD_LIBRARY_PATH).

Configure the snapshot agent on a Windows machine (updated October 2013)


Note: When you are running a backup software application on the machine
where the Snapshot Agent for Oracle is installed, you may see conflicts when the
database is set in backup or non-backup mode. In this case, you can use flag
BACKUPCHECK in configuration file snapagt.ini to indicate whether the
snapshot agent can set the database mode. The default value is 0, which
indicates the snapshot agent will always set the mode. If you set
BACKUPCHECK=1, the snapshot agent does not set the mode and will let the
backup application set the database mode.
After the installation completes, a configuration utility launches.
Complete configuration as described below. When you are done, click OK to save
the changes you made in all tabs and either keep the utility open or exit. Click
Cancel to exit the utility and discard any changes.
To access this utility at a later time, select Start --> Programs --> FalconStor -->
Configuration for Snapshot Agent for Oracle.
Select Oracle
version

To begin, select the version of Oracle you are using, then click Edit.

The Configuration screen displays.

Snapshot Agents User Guide

41

Snapshot Agent for Oracle

Database
Security
options

The Database Security tab displays the databases whose snapshots will be
managed by the snapshot agents.

Add database
To add a database whose snapshots will be managed by the snapshot agent, click
Add Login. The Database Login dialog is displayed.

1. Enter the login credentials for the database you are adding:
Database SID - Enter the Oracle instance name.
User Name and Password - Enter the user name and password of an Oracle
account with the DBA role (system, for example). This is the user and password
that the storage server needs to access your database. When the Oracle
database is set up initially, the default system user password is usually manager.
Do not use the user name sys.
Note: If you ever need to change the Database SID, User Name, or
Password, click Remove to remove the existing SID and then re-add it.

Snapshot Agents User Guide

42

Snapshot Agent for Oracle

2. Verify that the credentials you entered are correct:


Click Verify to allow the agent to verify the SID by attempting to connect to the
database with the provided information. If connection is successful, the database
will be added to the list.
Edit database credentials
Use this function to validate the security credentials for the selected database.
1. Select a database in the list and click Edit. Login credentials are displayed.
2. Click Verify to allow the agent to attempt to connect to the database with the
current information.
Verify bin path
Use this function to enter or verify the Oracle bin path for the selected database.
1. Select a database in the list and click Bin Path.
2. Enter the Oracle bin path, typically %ORACLE_HOME%/bin.
You can either click the button next to the field to have the agent search for the
path or you can manually enter the path. If you click the button and the SID is
correct, the path will be discovered automatically. If the SID is incorrect, the path
will not be found. You should then either enter the correct SID or, if the database
is not running, start the specified database.
Remove database
Use this function to remove a database from the list.
1. Select a database in the list.
2. Click Remove.
Batch file
options

On the Batch Files tab, indicate if you want to run batch files before and/or after
each snapshot.

Snapshot Agents User Guide

43

Snapshot Agent for Oracle

1. Select the checkbox if you want to run batch files before and/or after the
snapshot agent.
2. Enter an administrative user name and password for the local computer.
3. Click the appropriate Create/Edit button to open Notepad and create/save the
batch file.
Monitor options

By default, the snapshot agent looks for databases based on information passed from
IMA. The Monitor tab allows you to identify the drives on which databases are located.
Use the Monitor tab to override the default drives and then specify the drive(s) on
which you want the agent to look for databases.

1. The snapshot agent assumes a default location for databases on the client
machine. If your Oracle database(s) are located on any other drive(s), you need
to tell the agent to monitor those drives as well. To do this, select the Override
the default drives option.
2. Type the drive letter(s) on which your database(s) is/are located, separated by
semicolons: for example, D;E;.
Click OK to save the changes you made in all tabs and either keep the utility open or
exit. Click Cancel to exit the utility and discard any changes.

Snapshot Agents User Guide

44

Snapshot Agent for Oracle

Manage the
Trace Log

The Trace Log is a diagnostic tool used by Technical Support to help solve system
problems. Each Trace Log contains technical information about your system as well
as system messages and is updated whenever a snapshot occurs. Some of the
messages that appear in the Trace Log are also sent to the Windows Event Log.
In the Trace log, you can see the connection to Oracle system and the ALTER
tablespace begin backup and ALTER tablespace end backup command to all
tablespaces on the protected disk. For Linux installations, trace log messages are
logged to the system message file.

Do not adjust Trace Log settings unless you are requested to do so by a Technical
Support representative. The configuration utility lets you maximize the level of detail
that is displayed.

Snapshot Agents User Guide

45

Snapshot Agent for Oracle

1. Click the icon in the upper left corner of the configuration utility and select
Settings in the menu.

2. Select Set Agent Trace On to maximize the level of detail displayed for agent
activity in the Trace Log.
The value in the text box will change to 10 and is not editable. Increasing the
level of detail will display a list of the databases that have been backed up, as
well as information that can be used to provide support. The log will reflect the
change after the next snapshot is taken.
Other options in this dialog are not supported.

Configure the snapshot agent on a Solaris machine


If you have more than one Oracle SID, make sure all database instances are
running before you configure the agent.
1. Run /usr/local/ipstorclient/agents/oracle/bin/ora_setup.sh.
2. Select the version of the Oracle agent you are setting up.
Select 1 for the Oracle 8 agent, 2 for the Oracle 9 agent, or 3 for the Oracle 10
agent.
3. Enter the Oracle library path.
Note: If you are using the 64-bit version of Oracle, enter the path of the 32-bit
version of the Oracle libraries. [Should 32-bit be 64-bit here?]
Oracle 9i example: /export/home/ora9i/OraHome1/lib32
Oracle 10g example: /export/home/ora10g/OraHome1/lib32
4. Answer the questions that are asked by the setup program:
Is Oracle started? -- Since the setup program needs to verify the Oracle
user ID and password, the Oracle database must be started before the
ora_setup program continues.
What is the Oracle SID? -- In order to turn on Oracle archive logging, the
setup program needs to know the Oracle instance name.
What is the Oracle home path for SID xxx? -- This is the ORACLE_HOME
environment variable. Type the path in the format /oracle/OraHome1.

Snapshot Agents User Guide

46

Snapshot Agent for Oracle

What is the Oracle admin user id for SID xxx? (system) -- Type the admin
user name needed to access the database. The user name should not be
sys.
What is the Oracle admin password for SID xxx? (manager) -- Type the
password needed to access the database. The setup program will attempt
to verify that the user ID and password are valid.
What is the login name of the UNIX user account that owns Oracle
software? (ora10) -- Type the name of the Oracle user.
Would you like to enter another Oracle SID? -- Indicate if you want to
configure more Oracle instances.
5. Shut down the client (ipstorclient) and log out.
6. Log in again as root and restart ipstorclient.
Note: If you ever add another Oracle instance and need to configure it for the
snapshot agent, you can run ora_setup.sh add. Conversely, if you ever
need to remove an Oracle instance from your snapshot agent configuration,
you can run ora_setup.sh remove.
Configure ASM
disks

The snapshot agent includes a utility that helps you configure Oracle Automatic
Storage Management (ASM) disks. The utility is /asm10config and its usage is as
follows:
asm10config -a | -d | -m | -l | -D
-a : add an ASM disk group
-d : delete an ASM disk group
-m : modify an ASM disk group
-l : list ASM disk groups
-D : delete all ASM disk groups
To add an ASM disk group:
1. Run /asm10config -a .
2. Indicate if Oracle is started.
3. Enter the IP address of the storage server.
4. Enter the password for the root user on the storage server.
5. Enter the Oracle SID.
6. Set ORACLE_HOME.
A list of virtual devices will be displayed.
7. Select the virtual device(s) for your disk group by entering the appropriate line
numbers.

Snapshot Agents User Guide

47

Snapshot Agent for Oracle

For multiple virtual devices, separate numbers with semicolons. For example:
1;2;5.
8. If you have multiple disk groups, select the virtual device(s) for each group.
9. Indicate if you want to save the displayed VGList information.
It will be saved to /usr/local/ipstorclient/agents/oracle10/etc/agt.ini.
Configure the
Oracle Listener

The snapshot agent needs the Oracle Listener, which should be configured to use
the TCP/IP protocol and port number 1521.
Each version of Oracle has its own Listener. If you have more than one version of
Oracle running on the same machine, do the following:
1. Determine which version was installed first; for example, you have 9i and 10g
installed on the same machine and 10g was installed first.
2. Run the Listener that came with the version that was installed first.
For the purposes of our example, run the Listener that came with 10g.
3. Configure the other Oracle versions to use this Listener.
For the purposes of our example, configure the 9i version of Oracle to use the
10g Listener.
Refer to your Oracle documentation for information about how to use and configure
the Oracle Listener.

Configure the snapshot agent on a Linux or AIX machine (updated October 2013)
Note for Linux only: When you are running a backup software application on the
machine where the Snapshot Agent for Oracle is installed, you may see conflicts
when the database is set in backup or non-backup mode. In this case, you can
use flag BACKUPCHECK in configuration file snapagt.ini to indicate whether
the snapshot agent can set the database mode. The default value is 0, which
indicates the snapshot agent will always set the mode. If you set
BACKUPCHECK=1, the snapshot agent does not set the mode and will let the
backup application set the database mode.
1. Once the package is installed, re-login as root.
su -

2. Run the setup program.


/usr/local/ipstorclient/agents/oracle/bin/ora_setup.sh

3. Answer the questions that are asked by the setup program:


Is Oracle started? (y/n) -- Since the setup program needs to verify the
Oracle user ID and password, the Oracle database must be started before
the ora_setup program continues.
Snapshot Agents User Guide

48

Snapshot Agent for Oracle

What is the Oracle home path? -- Type the path in the format /oracle/
OraHome1.
Enter the Oracle SID: -- In order to turn Oracle archive logging on, the setup
program needs to know the Oracle instance name.
What is the Oracle admin user id for SID xxx? (system) -- Type the admin user
name needed to access the database. The user name should not be sys.
What is the Oracle admin password for SID xxx? (manager) -- Type the
password needed to access the database. The setup program will attempt
to verify that the user ID and password are valid.
Once the Snapshot Agent for Oracle is set up successfully, the configuration file /
usr/local/ipstorclient/agents/oracle/etc/oracle.conf will be created and the following
file will be updated: /usr/local/ipstorclient/etc/isdb.conf

Configure the snapshot agent on an HP-UX machine


1. Once the package is installed and the Oracle database has been restarted, relog in as root and run the setup program:
/usr/local/ipstorclient/agents/oracle/bin/ora_setup.sh
2. Answer the questions that are asked by the setup program:
Please enter the Oracle lib path: -- Type the Oracle lib directory
SHLIB_PATH. Use a colon to separate multiple paths. An example for
Oracle 8i would be: /oracle8/OraHome1/lib:/oracle8/OraHome1/lib64
Is Oracle started? -- Oracle MUST be started.
What is the Oracle home path? -- This is the ORACLE_HOME environment
variable. Type the path in the format /oracle/OraHome1.
Enter the Oracle SID: -- In order to turn on Oracle archive logging, the setup
program needs to know the Oracle instance name (ORACLE_SID
environment variable).
What is the Oracle admin user id for SID xxx? (system) -- Type the admin user
name needed to access the database. The user name should not be sys.
What is the Oracle admin password for SID xxx? (manager) -- Type the
password needed to access the database. The setup program will attempt
to verify that the user ID and password are valid.
What is the login name of the UNIX user account that owns Oracle
software? (oracle) -- Type the name of the Oracle user.
Would you like to enter user id and password for another Oracle SID? -Indicate if you want to configure more Oracle instances.
Once the Snapshot Agent for Oracle is set up successfully, the configuration file /
usr/local/ipstorclient/agents/oracle/etc/oracle.conf will be created and the following
file will be updated: /usr/local/ipstorclient/etc/isdb.conf
Note: If you make a mistake when entering the Oracle lib path(s), remove the
wrong entries in the /etc/.is.sh file and re-run the Oracle setup program.
Snapshot Agents User Guide

49

Snapshot Agent for Oracle

(Unix only) Add root user to database groups


The storage server uses the root user to trigger the agent and run agent commands.
To make this possible, add the root user to your database groups.
1. Use an editor to edit the /etc/group file.
2. Add root to each database group.
When you are done, your file should look something like this:
system:!:0:root
sys:!:3:root,bin,sys
...
...
oinstall:!:206:root
dba:!:207:oracle,root
(Oracle 805 on Solaris ONLY) The default group for the root user should be set to
the dba group, which owns the Oracle805 installation.
1. Use an editor to edit the /etc/passwd file.
2. The group ID for the root user should be the group ID of the dba group.
In this example, 101 is the group id for the dba group:
root:x:0:101:Super-User:/:/sbin/sh
daemon:x:1:1::/:
bin:x:2:2::/usr/bin:
sys:x:3:3::/:
adm:x:4:4:Admin:/var/adm:
lp:x:71:8:Line Printer Admin:/usr/spool/lp:
uucp:x:5:5:uucp Admin:/usr/lib/uucp:
nuucp:x:9:9:uucp Admin:/var/spool/uucppublic:/usr/lib/uucp/uucico
listen:x:37:4:Network Admin:/usr/net/nls:
nobody:x:60001:60001:Nobody:/:
noaccess:x:60002:60002:No Access User:/:
nobody4:x:65534:65534:SunOS 4.x Nobody:/:
ora8i:x:1001:101::/export/home/ora8i:/bin/sh
oracle8:x:1002:101::/export/home/oracle8:/bin/sh
sange:x:1003:10::/export/home/sange:/bin/sh
3. Verify the gid of the root user with the ID command:
# id
uid=0(root) gid=101(dba)

Snapshot Agents User Guide

50

Snapshot Agent for Oracle

(Unix only) Set root users PATH and LD_LIBRARY_PATH


You need to set the root users PATH and LD_LIBRARY_PATH to include the
database users PATH and LD_LIBRARY_PATH variables.
Example:
root users PATH is:

/home/bin:/usr:/usr/bin:/usr/local/bin

root users LD_LIBRARY_PATH is: /home/lib:/usr/lib:/usr/local/lib

Oracle users PATH is: /export/home/oracle/OraHome1/bin


Oracle users LD_LIBRARY_PATH is: /export/home/oracle/OraHome1/lib
Note: Be sure to enter the 32-bit version of the Oracle library path for
LD_LIBRARY_PATH.
You have to add the Oracle users environment variables to the roots variables.
1. Log in as the root user and edit the /.profile file.
2. Add the Oracle paths to the end of the root paths.
Using the example above:
PATH=/home/bin:/usr:/usr/bin:/usr/local/bin:/export/home/oracle/OraHome1/bin ; export
PATH
LD_LIBRARY_PATH=/home/lib:/usr/lib:/usr/local/lib:/export/home/oracle/OraHome1/lib ;
export LD_LIBRARY_PATH

Snapshot Agents User Guide

51

Snapshot Agent for Oracle

Turn on Oracle archive logging


After the snapshot agent is installed, you must turn on Oracle archive logging before
running the snapshot agent:
1. Include the following three lines in your initSID.ora:
log_archive_start

= true

log_archive_dest

= /mount_point/oradata/SID/ARCHIVE/

log_archive_format = _%s.arc

log_archive_start -- This parameter specifies whether archiving should be


started automatically when the database is started.
log_archive_dest -- This value specifies the default location of the file to be
used when archiving redo log files.
log_archive_format -- This parameter is used to specify the default file
name format for the archive log files. This value is appended to the
log_archive_dest value (%s is the log sequence number).
Therefore, when a redo log is archived, Oracle will use a combination of
log_archive_dest and log_archive_format to produce the location and
file name of the archive log.
For example: /mount_point/oradata/SID/ARCHIVE/arch_1234.arc
Before restarting the database, ensure that you have created the
/mount_point/oradata/SID/ARCHIVE directory.
Note that the trailing arc in log_archive_dest is part of the archive log file
name, not the directory.
Also, these changes will not take effect until you restart the database.
2. With the database shut down, use one of the many DBA tools available (such as
sqlplus) to manually start the database and execute the following commands:
startup mount exclusive pfile=<path to pfile>
connect internal
alter database archivelog;
archive log start;
alter database open;

Snapshot Agents User Guide

52

Snapshot Agent for Oracle

Test the snapshot agent


To test the snapshot agent, perform a Snapshot Copy of a virtual drive from the
FalconStor Management Console.
Note: Use a group if your Oracle database uses multiple virtual devices.

Remove snapshot agent software


Do the following to remove snapshot agent software:
Operating System

Command/Instructions

Windows

Use Add/Remove Programs from the Control Panel.

Linux

Log on to the system as root and execute the following command:

rpm -e oracleniagent-<version number>-<build


number>
Oracle 9i example: rpm -e oracle9iagent-4.50-896
Solaris

Log on to the system as root and execute the following command:

pkgrm isora
HP-UX

Log on to the system as root and execute the following command:

swremove oracleniagent-<version number>-<build


number>
Oracle 9i example: swremove oracle9iagent-4.50-896.
Oracle 10g example: swremove oracle10gagent-4.50-896.
AIX

Log on to the system as root and execute the following command:

installp -u IPStor.OraAgent.rte

Snapshot Agents User Guide

53

Snapshot Agent for Oracle

Protect and recover Oracle databases


Database design with virtual devices
Physical
location of the
tablespaces

We recommend that you create each tablespace on a separate virtual disk. If there
are sufficient resources, the virtual disk should be created on a dedicated physical
device. It this is not possible, the virtual disks should be created such that disk
access is balanced across the available physical resources.

Fault tolerance
and
performance
considerations

For fault tolerance, mirroring can be done at the operating system level or you can
use the Mirroring feature. Other fault-tolerance configurations can be implemented
at the operating system level. When creating virtual devices, keep in mind that the
operating system might configure the virtual disks in a RAID configuration. For RAID
configurations, you should make sure the disks are from different physical disks.

Free disk space


considerations

If the database is very active and changes are made randomly, the Snapshot
Resource should be created with sufficient size, and the storage server should have
enough free disk space to allow the snapshot resource to grow when needed. It is
better to define which physical disk should be used when expanding the snapshot
resource.

Using groups

Most Oracle databases use more than one virtual disk. In order to guarantee
database integrity, use the FalconStor Management Console to create a group on
the storage server (refer to the CDP/NSS User Guide for details):
1. Create a group; be sure to select the option to enable TimeMark (snapshots) for
the group; you can also enable CDP Journal option.
2. Select the SAN resources (virtual disks) that are used by the Oracle database to
join the group.
3. Assign the group to the client that runs the Oracle database.
4. Perform all snapshot-related functions using the group.

Oracle control
file

If a raw device is used for the Oracle database, you must store the Oracle control file
on another virtual disk, which should be in the same group as the raw devices
virtual disk. Otherwise, snapshots of the raw device database may be inconsistent.

Data backup and protection scenarios


TimeMark

The FalconStor TimeMark option is an effective way to protect your Oracle


database by creating point-in-time snapshot copies TimeMarks of the database.
You can use these TimeMarks to recover your database to the time at which the
TimeMark was triggered. To create a TimeMark:
1. In the FalconStor Management Console, connect to the server that is serving the
virtual disks for the Oracle database.

Snapshot Agents User Guide

54

Snapshot Agent for Oracle

2. Expand Logical Resources --> Groups.


3. Right-click the group that was created for the Oracle database and select
TimeMark --> Create.
4. Enter a descriptive name for the TimeMark.
5. Ensure that the snapshot agent has completed taking a snapshot of the disks.
The Database Alert log should display messages showing that all tablespaces
have been in and out of backup mode.
6. Expand the group and select one of the virtual disks.
7. In the right pane for the virtual disk, select the TimeMark tab. A list of TimeMarks
will appear, with the latest TimeMark listed at the end.
TimeMark Copy

Use TimeMark Copy to create a physical copy of the disks that are used by the
Oracle database. The set of TimeMark Copy disks should be created with the same
TimeMark. The set of TimeMark Copy disks is exactly what the online Oracle disks
looked like at the moment you created the TimeMark. This set of disks can be
mounted on the Oracle Server and the Oracle database instance can be started with
minimal recovery steps. Make sure there is enough free physical space for creating
the TimeMark Copy.
To create a TimeMark Copy:
1. Launch the FalconStor Management Console.
2. Connect to the server that is serving the virtual disks for the Oracle database.
3. Expand Logical Resources --> SAN Resources.
4. Right-click on the first virtual device of the group.
5. Select TimeMark --> Copy.
6. Select the desired TimeMark to be copied.
7. Repeat the last two steps for all virtual devices in the group.
The TimeMark Copy disks can be assigned and mounted by the client using the
Oracle database. When you start the Oracle database using the TimeMark Copy
disks, the tablespaces are still in backup mode. Refer to the Disk failure section for
information about how to recover a database with TimeMark Copy disks.

TimeView

Instead of recreating the Oracle disks with physical storage, you can create a
TimeView that is mountable and works exactly like the TimeMark, except that the
original set of disks for the production database have to be working. You can use
TimeView to retrieve lost data without rolling back changes on the product database.
TimeView does not require physical storage.
To create a TimeView of the database disks:

Snapshot Agents User Guide

55

Snapshot Agent for Oracle

1. Launch the Console.


2. Connect to the server that is serving the virtual disks for the Oracle database.
3. Expand Logical Resources --> SAN Resources.
4. Right-click on the first virtual device of the group.
5. Select TimeMark --> TimeView.
6. Select the desired TimeMark to be viewed.
7. Repeat the last two steps for all virtual devices in the group.
You will see a new virtual disk for the TimeView you created for each disk in the
group. You can assign TimeView virtual disks to a client and mount them just as you
can any other virtual disks. You can copy files from the TimeView disks. You can
start the Oracle database on the TimeView disks and export tables from that
instance of the Oracle database. The tablespaces are set to backup mode when the
snapshot occurs. When you first start your database using the TimeView disks you
need to recover database to set the tablespaces back to normal mode.
Replication

TimeMark
rollback

You can set up replication of the Oracle database disks to protect the database in
case of site failure. In the event that the primary site fails, the replica disks on the
secondary site can be promoted, assigned to the Oracle server, mounted, and the
database will be back and running with minimal down time. The database will be at
the state of the last complete replication.
This feature rolls back a disk back to the point in time at which you took the
TimeMark. This is useful if you need to roll back changes to the disks to a known
good stage, such as before a major update to the table that contains customer
information.
To perform a rollback:
1. Stop the Oracle database.
2. Stop the client on the Oracle database server.
3. Launch the Console.
4. In IMA, unassign the device(s) that the Oracle database resides on.
5. Connect to the server that is serving the virtual disks for the Oracle database.
6. Expand Logical Resources --> Groups.
7. Right-click on the group that was created for the Oracle database.
8. Select TimeMark --> Rollback.
9. Select the TimeMark that you want to roll back to.

Snapshot Agents User Guide

56

Snapshot Agent for Oracle

10. Follow the wizard to complete the rollback procedure.


11. Start the client on the Oracle database server.
12. Start the Oracle database.
13. In IMA, reassign the device(s) on which the Oracle database resides.
14. Perform the Database recovery, if necessary, by typing recover database in
SQL Plus or a command window.
Complete
backup using a
TimeView or
TimeMark Copy

You can perform a complete tape backup of your database using a TimeView or
TimeMark Copy. The TimeView or the TimeMark Copy disks contains the Oracle
database files as regular files and can be backed up with your normal backup
software.

Recovery scenarios
Disk failure

You can quickly recover from disk failure by using a TimeMark Copy you created.
The database can be brought back online in a matter of minutes. However, the data
entered after the TimeMark was created cannot be restored.
To recover using a TimeMark Copy:
1. Stop the client on the Oracle database.
2. Launch the Console.
3. Unassign all of the disks used for the Oracle database from the client.
4. Assign the set of TimeMark Copy disks for the Oracle database to the client.
5. Restart the client on the Oracle database server.
6. Start the Oracle database.
7. Recover the database, if necessary.
8. Open the database for normal access.

User failure

User failure can occur when users executes DDL commands, such as drop table,
that they need to undo. The TimeMark option and the snapshot agent provide a
quick and painless way to recover tables and records that were accidentally
dropped.
To recover from user failure:
1. Create a TimeView of the database disk using the desired TimeMark.
2. Assign the TimeView virtual disks to a backup Oracle database server. This
could be the on same server as the production database server.

Snapshot Agents User Guide

57

Snapshot Agent for Oracle

3. Rescan the client to discover the disks.


4. Start the Oracle database instance using the TimeView disks.
5. Export the object (such as a table) from this database instance to a dump file.
6. On the production database, drop the object that was altered by the user.
7. Import the object to the production database using the dump file.
Operator failure

If the system administrator or DBA accidentally deleted some files that are important
to the Oracle database, you can quickly retrieve the files from a TimeView.
To recover files from a TimeView:
1. Create a TimeView of the database disk using the desired TimeMark.
2. Assign the TimeView virtual disks to the Oracle database server.
3. Rescan the client to discover the new disks.
4. Mount the new disks and copy the files from the TimeView disks.
If a disk for the database is accidentally formatted, you can recover it using rollback.
Follow the steps inTimeMark rollback.

Restore backed-up Oracle databases


The backed up version of an Oracle database cannot be mounted until an Oracle
end backup command is issued.
If you issue the startup open pfile=... command without the end backup command
being issued, you will get a message telling you that the database needs media
recovery. For example:
SQL> connect sys/password as sysdba
Connected to an idle instance.
SQL> startup open pfile=/oracle/pfile/init.ora
ORACLE instance started.
Total System Global Area 403473660 bytes
Fixed Size
279804 bytes
Variable Size
201326592 bytes
Database Buffers
201326592 bytes
Redo Buffers
540672 bytes
Database mounted.
ORA-01113: file 1 needs media recovery
ORA-01110: data file 1: '/oracle/system/SYSTEM.dbf'
Note that it says "file 1" needs recovery. While there may be multiple files, it stops
after seeing the first error and does not try to continue to the other data files.

Snapshot Agents User Guide

58

Snapshot Agent for Oracle

Automatic
recovery

1. When you see this message, you can run the recover database command
which will find all tablespaces and take each out of backup mode.
SQL> recover database;
Media recovery complete.
2. Afterwards, you can open the database.
SQL> alter database open;
Database altered.

Manual
recovery

You can also manually issue the Oracle commands to find each tablespace and then
end the backup:
1. Instead of issuing the recover database command, check to see if the
tablespaces are in the backup mode by issuing the following command.
SQL> select * from v$backup;

FILE# STATUS
CHANGE# TIME
-------- ------------------ ---------- --------1
ACTIVE
107569 23-AUG-00
2
ACTIVE
107573 23-AUG-00
3
ACTIVE
107577 23-AUG-00
4
ACTIVE
107581 23-AUG-00
5
ACTIVE
107585 23-AUG-00
6
ACTIVE
107589 23-AUG-00
6 rows selected.

Since the file status is active, the tablespaces are still in the backup mode.
2. Find out what the names of the tablespaces are.
SQL> select * from v$tablespace;

TS#
NAME
INC
-------- ------------------------------ --0
SYSTEM
YES
1
UNDOTBS
YES
2
DRSYS
YES
3
INDX
YES
4
TEMP
YES
5
TOOLS
YES
6
USERS
YES
7 rows selected.

3. Manually take each out of backup mode.


SQL> ALTER TABLESPACE SYSTEM END BACKUP;
Tablespace altered.
SQL> ALTER TABLESPACE UNDOTBS END BACKUP;
Tablespace altered.

Snapshot Agents User Guide

59

Snapshot Agent for Oracle

SQL> ALTER TABLESPACE DRSYS END BACKUP;


Tablespace altered.
SQL> ALTER TABLESPACE INDX END BACKUP;
Tablespace altered.
SQL> ALTER TABLESPACE TOOLS END BACKUP;
Tablespace altered.
SQL> ALTER TABLESPACE USERS END BACKUP;
Tablespace altered.
4. Open the database.
SQL> ALTER DATABASE open;
Database altered.

Snapshot Agents User Guide

60

Snapshot Agent for FileSystems


The FalconStor Snapshot Agent for FileSystems protects data with full point-intime consistency while still allowing full speed, almost non-stop access to the data.
Prior to starting the snapshot process, all disk cache and buffers are flushed to disk.
Using backup software, a back up of the snapshot image can be performed at high
speed while the file system operates in normal mode. Because the contents of the
snapshot image are guaranteed never to change, what is backed up is consistent,
ensuring transactional integrity. While the backup software is reading data from the
snapshot image, changes that occur to the data will not affect what gets written. Users
are always able to fully access the data while the backup software sees a stable, readonly snapshot image of the data taken an instant before the backup began.
The snapshot agent will be triggered automatically whenever a snapshot operation
occurs.

Install the snapshot agent


Complete required steps described in General installation requirements.

Install on Windows
1. Run the installation file.
2. When prompted, enter your license keycode.
For Windows installations, the snapshot agent license must be activated
(registered with FalconStor). If your computer has an Internet connection, the
license is activated as soon as you enter your keycode and click Next. However,
if your Internet connection is temporarily unavailable or if your computer has no
Internet connection, your license will not be activated. You must activate your
license within 30 days so that you can continue to use the snapshot agent.
If your Internet connection is temporarily unavailable, your license will be
activated automatically the next time the snapshot agent is invoked, assuming
you have an Internet connection then. You can also add your license through
IMA.
If your computer has no Internet connection, you can perform offline activation
using IMA (refer to the Intelligent Management Agent User Guide).
3. When done, click Finish.
The snapshot agent will be installed into the same directory as the IMA.
4. When done, click Finish.
The snapshot agent will be installed to the same directory as IMA.
After the installation completes, the configuration utility launches automatically.
The snapshot agent will start automatically each time the client is started.

Snapshot Agents User Guide

61

Snapshot Agent for FileSystems

Silent install

Silent install is supported for snapshot agents. To install the agent in silent mode,
complete the following steps:
1. Download the package from the FalconStor Support Portal and extract the agent
package.
2. From the command line, navigate to the folder to which you extracted the
package.
3. Install the Intelligent Management Agent:
cd ima
setup.exe /s
cd ..
4. Install the snapshot agent:
setup /s
or
setupsilent.bat
When installing the snapshot agent in silent mode on any 64-bit platform, run
setupsilent.bat from the AMD64 directory.

Install on Linux and AIX


You must be root or root equivalent in order to install the agent.
1. Copy the installation package to the local drive of your client.
We will be using /tmp as an example.
2. Install the snapshot agent software.
Linux

Execute the following command on Linux:


rpm -i filesystemagent-<version number>-<build
number>.i386.rpm

For example: rpm -i filesystemagent-4.50-904.i386.rpm


AIX

Execute the following command on AIX:


installp -ad jfsagent-<version number>-<build number>.rte all

Snapshot Agents User Guide

62

Snapshot Agent for FileSystems

Configure snapshot agent options


Configuration is not required. The snapshot agent includes a utility that lets you
configure optional features.
To run the utility, select Start --> All Programs --> FalconStor --> Configuration for
Snapshot Agent for FileSystems.
When you are done, click OK to save the changes you made in all tabs and either
keep the utility open or exit. Click Cancel to exit the utility and discard any changes.

Batch file options


On the Batch Files tab, indicate if you want to run batch files before and/or after
each snapshot.

In order to run batch files, you must enter an administrative user name and
password for the local computer.
You can then click the Create/Edit buttons and use Notepad to generate the batch
files.

Snapshot Agents User Guide

63

Snapshot Agent for FileSystems

Monitor tab
By default, the snapshot agent looks for databases based on information passed
from IMA. This tab allows you to identify the drives on which databases are located.

Manage the Trace Log


The Trace Log is a diagnostic tool used by Technical Support to help solve system
problems. Each Trace Log contains technical information about your system as well
as system messages and is updated whenever a snapshot occurs. Some of the
messages that appear in the Trace Log are also sent to the Windows Event Log.
For Linux installations, trace log messages are logged to the system message file.
Do not adjust Trace Log settings unless you are requested to do so by a Technical
Support representative. The configuration utility lets you maximize the level of detail
that is displayed.
1. Click the icon in the upper left corner of the configuration utility and select
Settings in the menu.

2. Select Set Agent Trace On to maximize the level of detail displayed for agent
activity in the Trace Log.
The value in the text box will change to 10 and is not editable. Increasing the
level of detail will display a list of the databases that have been backed up, as

Snapshot Agents User Guide

64

Snapshot Agent for FileSystems

well as information that can be used to provide support. The log will reflect the
change after the next snapshot is taken.
Other options in this dialog are not supported.

Update registry for service-enabled devices


If you are using a service-enabled device (SED) and you have preserved the
physical devices inquiry string (this is set when you create the SED in the Console),
you need to make a change in the registry.
1. In the registry, locate the following key:
HKEY_LOCAL_MACHINE\SOFTWARE\FalconStor\IPStor\CurrentVersion\
Agents\Agent n
Agent n is the agent number (e.g. Agent 1).
If you have multiple agents installed on the machine, highlight each and check
the Name field for the one that says Windows.
2. Under the correct agent key, add a string (REG_SZ) named OverRideDrives
and specify the drive letter(s) to which the SED is mounted.
For example: the value might be E:;F:;

Test the file system agent


To test the file system agent, you can perform a Snapshot Copy of a virtual drive
from the FalconStor Management Console.

Remove snapshot agent software


Do the following to remove the snapshot agent software:
Operating System

Command/Instructions

Windows

Use Add/Remove Programs from the Control Panel.

Linux

Log on to the system as root and execute the following command:


rpm -e filesystemagent-<version>-<build>
For example: rpm -e filesystemagent-4.50-904

AIX

Log on to the system as root and execute the following command:


installp -u jfsagt

Snapshot Agents User Guide

65

Snapshot Agent for MySQL


FalconStor provides a Snapshot Agent for MySQL, an RDBMS (Relational Database
Management System) in which data is stored in the form of tables and the
relationships among the data are also stored in the form of tables. MySQL runs as a
server providing multi-user access to a number of databases. MySQL is a key part
of LAMP (Linux, Apache, MySQL, PHP / Perl / Python), an open source enterprise
software stack. The Snapshot Agent for MySQL ensures the MySQL database is in
sync and stable before taking snapshots. It protects MySQL databases with full
point-in-time consistency while still allowing full speed, non-stop access to the
databases.
The snapshot agent will be triggered automatically any time a snapshot operation
occurs on the MySQL database files or drive.

Install the snapshot agent


Complete required steps described in General installation requirements.
Installation requires the following:

Install the snapshot agent on the same machine where the MySQL
database is running.
Start MySQL server before installing the agent.

To install:
1. Run the installation file.
2. When prompted, enter your license keycode.
The snapshot agent license must be registered with FalconStor and activated. If
your computer has an Internet connection, the license is activated as soon as
you enter your keycode and click Next. However, if your Internet connection is
temporarily down or if your computer has no Internet connection, your license
will not be activated. You must activate your license within 30 days so that you
can continue to use the snapshot agent.
If your Internet connection is temporarily down, your license will be activated
automatically the next time the snapshot agent is invoked, assuming you have
an Internet connection then. You can also add your license through IMA.
If your computer has no Internet connection, you can perform offline activation
using IMA (refer to the Intelligent Management Agent User Guide).
3. When done, click Finish.

66

Snapshot Agent for MySQL

Silent install
Silent install is supported for snapshot agents. To install the agent in silent mode,
complete the following steps:
1. Download the package from the FalconStor Support Portal and extract the agent
package.
2. From the command line, navigate to the folder to which you extracted the
package.
3. Install the Intelligent Management Agent:
cd ima
setup.exe /s
cd ..
4. Install the snapshot agent:
setup /s
or
setupsilent.bat
When installing the snapshot agent in silent mode on any 64-bit platform, run
setupsilent.bat from the AMD64 directory.

Configure the snapshot agent


After installation completes, execute the following command to configure the agent:
/usr/local/ipstorclient/agents/mysql/bin/ismysql_setup

Confirm snapshot status


The Trace Log is a diagnostic tool used by Technical Support to help solve system
problems. Each Trace Log contains technical information about your system as well
as system messages and is updated whenever a snapshot occurs. Trace log
messages are logged to the system message file.

Remove snapshot agent software


Execute the following command to uninstall the snapshot agent:
rpm -e ismysql-4.50-0.906
Note: In this case, the mysql agent is build 906 and the package name is mysql4.50-0.906.i386.rpm. if you are using a different build, you will need to modify the
command as appropriate.

67

Snapshot Agent for IBM DB2


Universal Database

The FalconStor Snapshot Agent for DB2 protects DB2 databases with full point-intime consistency while still allowing full speed, non-stop access to the databases.
Prior to starting the snapshot process, a request is sent to the application server
running the Snapshot Agent for DB2. The snapshot agent suspends all DB2
database writes and notifies the server that the snapshot can be performed. Once
the snapshot has completed, the agent resumes all database writes.
Using backup software, a back up of the snapshot image can be performed at high
speed while DB2 operates in normal mode. Because the contents of the snapshot
image are guaranteed never to change, what is backed up is consistent, ensuring
transactional integrity. While the backup software is reading data from the snapshot
image, changes that occur to the database will not affect what gets written. Users
are always able to see the database with full access at all times while the backup
software sees a stable, read-only snapshot image of the database taken an instant
before the backup began.
The snapshot agent will be triggered automatically any time a snapshot operation
occurs on the DB2 drive.

Install the snapshot agent


Complete required steps described in General installation requirements.
Installation requires the following :

You need to know the database instance name and the database
administrator password.
Start the DB2 database before installing the agent.

Install on Windows
1. Run the installation file.
2. When prompted, enter your license keycode.
The snapshot agent license must be activated (registered with FalconStor). If
your computer has an Internet connection, the license is activated as soon as
you enter your keycode and click Next. However, if your Internet connection is
temporarily down or if your computer has no Internet connection, your license
will not be activated. You must activate your license within 30 days so that you
can continue to use the snapshot agent.
If your Internet connection is temporarily down, your license will be activated
automatically the next time the snapshot agent is invoked, assuming you have
an Internet connection then. You can also add your license through IMA.

Snapshot Agents User Guide

68

Snapshot Agent for IBM DB2 Universal Database

If your computer has no Internet connection, you can perform offline activation
using IMA (refer to the Intelligent Management Agent User Guide).
3. When prompted, enter the user ID and password of the DB2 administrator.
This is the system user and password that the storage server needs to access
your database. When the DB2 database is set up initially, the default system
user password is usually DB2adm.
4. Enter the home path where DB2 is installed.
5. Enter the database instance.
Separate multiple instances with a space.
The snapshot agent will be installed to the same directory as IMA.
Silent install

Silent install is supported for snapshot agents. To install the agent in silent mode,
complete the following steps:
1. Download the package from the FalconStor Support Portal and extract the agent
package.
2. From the command line, navigate to the folder to which you extracted the
package.
3. Install the Intelligent Management Agent:
cd ima
setup.exe /s
cd ..
4. Install the snapshot agent:
setup /s
or
setupsilent.bat
When installing the snapshot agent in silent mode on any 64-bit platform, run
setupsilent.bat from the AMD64 directory.

Snapshot Agents User Guide

69

Snapshot Agent for IBM DB2 Universal Database

Install on AIX
You must be root (or root equivalent) in order to install the snapshot agent.
1. Make sure that your DB2 database is up and running.
2. Copy the tar file to the local drive of your AIX client.
3. Type the following command to untar the agent package.
tar xvf db2agent-<version number>-<build number>.tar

For example: tar xvf db2agent-4.50-896.tar


4. install the agent package.
installp -aFX -d IPStor.DB2Agent.bff all
5. Run the setup program.
/usr/local/ipstorclient/agents/db2/bin/db2_setup

6. When prompted, answer the following questions:


What is the DB2 bin path?
What is the DB2 admin user id? ()
What is the DB2 admin password? ()
What is the current db2 instance name?
If there is more than one db2 instance, enter all the db2 instance names
and separate them by a space.
Add root user to
database
groups

The root user is the user that the storage server uses to trigger the agent and run
agent commands. Therefore, in order for the storage server to be able to execute
database commands, you need to add the root user to your database groups.
1. Use an editor to edit the /etc/group file.
2. Add root to each database group.
When you are done, your file should look something like this:
system:!:0:root
sys:!:3:root,bin,sys
...
...
db2iadm1:!:999:db2inst1,db2as,root
db2fadm1:!:998:db2inst1,db2fenc1,db2as,root
db2asgrp:!:997:db2inst1,db2as,db2fenc1,root

Snapshot Agents User Guide

70

Snapshot Agent for IBM DB2 Universal Database

Set root users


PATH and
LD_LIBRARY_
PATH

You need to set the root users PATH and LD_LIBRARY_PATH to include the
database users PATH and LD_LIBRARY_PATH variables.
Example:
root users PATH is:

/home/bin:/usr:/usr/bin:/usr/local/bin

root users LD_LIBRARY_PATH is: /home/lib:/usr/lib:/usr/local/lib

DB2 users PATH is: /home/db2inst1/bin


DB2 users LD_LIBRARY_PATH is: /home/db2inst1/lib
where db2inst1 is the database name.

You have to add the DB2 users environment variables to the roots variables.
1. Log in as the root user and edit the /.profile file.
2. Add the DB2 paths to the end of the root paths.
Using the example above:
PATH=/home/bin:/usr:/usr/bin:/usr/local/bin:/home/
db2inst1/bin ; export PATH
LD_LIBRARY_PATH=/home/lib:/usr/lib:/usr/local/lib:/home/
db2inst1/lib ; export LD_LIBRARY_PATH

Install on Linux
You must be root (or root equivalent) in order to install the snapshot agent.
1. Copy the installation file to the local drive of your Linux client.
2. Install the snapshot agent software.
rpm -ivh db2agent-<version number>-<build number>.i386.rpm
For example: rpm -ivh db2agent-4.50-0.900.i386.rpm
3. Shut down the client and log out.
4. Run the setup program.
/usr/local/ipstorclient/agents/db2/bin/isdb2_setup
5. When prompted, answer the following questions:
What is the DB2 bin path?
What is the current db2 instance name?
If there is more than one db2 instance, enter all the db2 instance names and
separate them by a space.

Snapshot Agents User Guide

71

Snapshot Agent for IBM DB2 Universal Database

6. Add the root user to the db2 group.


The following is an example of the group file:
/etc/group
root:x:0:
bin:x:1:daemon
daemon:x:2:
sys:x:3:

dasadm1:!:101:db2inst2,root
db2grp1:!:102:root

Test the snapshot agent


To test the snapshot agent, perform a Snapshot Copy of a virtual drive from the
FalconStor Management Console.

Remove snapshot agent software


Do the following to uninstall the snapshot agent software:
Operating System

Command/Instructions

Windows

Use Add/Remove Programs from the Control Panel.

Linux

Log on to the system as root and execute the following


command:
rpm -e db2agent-<version number>-<build
number>
For example: rpm -e db2agent-4.50-0.900

AIX

Log on to the system as root and execute the following


command:
installp -ug db2agent-<version number><build number>
For example: installp -ug db2agent-4.50-896

Snapshot Agents User Guide

72

Snapshot Agent for Lotus Notes /


Domino

The FalconStor Snapshot Agent for Lotus Notes/Domino protects databases with
full point-in-time consistency while still allowing full speed, almost non-stop access
to the databases.
Prior to starting the snapshot process, a request is sent to the application server
running the Snapshot Agent for Lotus Notes/Domino. The snapshot agent syncs the
database while the server takes a snapshot of the database.
Using backup software, a back up of the snapshot image can be performed at high
speed while Lotus Notes/Domino operates in normal mode. Because the contents of
the snapshot image are guaranteed never to change, what is backed up is
consistent, ensuring transactional integrity. While the backup software is reading
data from the snapshot image, changes that occur to the database will not affect
what gets written. Users are always able to see the database with full access at all
times while the backup software sees a stable, read-only snapshot image of the
database taken an instant before the backup began.
The snapshot agent will be triggered automatically any time a snapshot operation
occurs on the Lotus Notes drive.

Install the snapshot agent


Complete required steps described in General installation requirements.

Install on Windows
Installation requires the following:

Your Lotus Notes database must be properly installed and functioning


before installing the agent.

To install:
1. Verify that the Lotus Notes path is set in the PATH environment variable.
If it is not set, add the path (such as C:\Lotus\Notes) to the PATH environment
variable and then reboot the machine.
2. Shut down the Domino server and stop IMA.
3. Run the installation file.
4. When prompted, enter your license keycode.
The snapshot agent license must be activated (registered with FalconStor). If
your computer has an Internet connection, the license is activated as soon as
you enter your keycode and click Next. However, if your Internet connection is
temporarily down or if your computer has no Internet connection, your license

Snapshot Agents User Guide

73

Snapshot Agent for Lotus Notes/Domino

will not be activated. You must activate your license within 30 days so that you
can continue to use the snapshot agent.
If your Internet connection is temporarily down, your license will be activated
automatically the next time the snapshot agent is invoked, assuming you have
an Internet connection then. You can also add your license through IMA.
If your computer has no Internet connection, you can perform offline activation
using IMA (refer to the Intelligent Management Agent User Guide).
5. When done, click Finish.
The snapshot agent will be installed to the same directory as IMA.
6. Start the client and your Domino Server.
Silent install

Silent install is supported for snapshot agents. To install the agent in silent mode,
complete the following steps:
1. Download the package from the FalconStor Support Portal and extract the agent
package.
2. From the command line, navigate to the folder to which you extracted the
package.
3. Install the Intelligent Management Agent:
cd ima
setup.exe /s
cd ..
4. Install the snapshot agent:
setup /s
or
setupsilent.bat
When installing the snapshot agent in silent mode on any 64-bit platform, run
setupsilent.bat from the AMD64 directory.

Install on Linux
Installation of the snapshot agent has the following requirements:

You must be root (or root equivalent) in order to install.


Your Lotus Notes database must be properly installed and functioning
before installing the agent.

To install:
1. Install the snapshot agent software.
rpm -i notesagent-<version number>-<build number>.i386.rpm
For example: rpm -i notesagent-4.50-896.i386.rpm
Snapshot Agents User Guide

74

Snapshot Agent for Lotus Notes/Domino

2. Type the following command:


# cd /usr/local/ipstorclient/agents/notes/bin
3. Type the following command:
# isnotes_setup

Test the snapshot agent


To test the snapshot agent, perform a Snapshot Copy of a virtual drive from the
FalconStor Management Console.

Confirm snapshot status


You can get detailed information from the agent trace log.The Trace Log is a
diagnostic tool used by Technical Support to help solve system problems. Each
Trace Log contains technical information about your system as well as system
messages and is updated whenever a snapshot occurs. Some of the messages that
appear in the Trace Log are also sent to the Windows Event Log.
In the Trace Log, you can see the connection to the Domino system and the backup
command to all NFS databases on the protected disks.

For Linux installations, trace log messages are logged to the system message file.
On the Domino server, you can check the snapshot agent communication from the
system log.

Snapshot Agents User Guide

75

Snapshot Agent for Lotus Notes/Domino

Remove snapshot agent software


Do the following to uninstall the snapshot agent software:
Operating System

Command/Instructions

Windows

Use Add/Remove Programs from the Control Panel.

Linux

Log on to the system as root and execute the following


command:
rpm -e notesagent-<version number>-<build
number>
For example: rpm -e antecedent-4.50-896

Snapshot Agents User Guide

76

snapshot Agents User Guide

Index
D

DB2
Install
AIX 70
Linux 71
Requirements 68
Windows 68
Silent install 69
Silent install l 69
Licensing 68
Remove 72
Root user
Database groups 70
PATHs 71
Downloads 3

Lotus Notes
Install
Windows
Silent install 74
Lotus Notes/Domino
Agent trace log 75
Install
Linux 74
Windows 73
Licensing 73
Remove 76

E
Exchange
Batch file options 14
Exchange and VSS 12
Install 13
Silent install 13, 22, 37, 62
Licensing 13
Options 14
Override efault drives 15, 44, 64
Purge Log utility 18
Remove 19
Service-enabled devices 16
Status 16
Trace Log 15

F
FileSystems
Batch file options 63
Install
HP-UX 62
Linux 62
Solaris 62
Windows 61
Licensing 61
Remove 65
Service-enabled devices 65
Trace log 64

H
HyperTrac 1

M
MySQL
Configure 67
Install 66
Windows
Silent install 67
Licensing 66
Remove 67
Trace log 67

O
Oracle
Archive logging 52
Configure
AIX 48
Batch file options 43
Database security 42
HP-UX 49
Linux 48
Override drives 44
Solaris 46
ASM disk utility 47
Listener 48
Windows 41
Data backup and protection scenarios 54
Complete tape backup 57
Replication 56
TimeMark 54
TimeMark Copy 55
TimeMark rollback 56
TimeView 55
Database design-virtual devices 54
Database mode conflicts
Linux 48
Snapshot Agents User Guide

77

Windows 41
File system support 36
Install 36
AIX 39
HP-UX 39
Linux 38
Requirements 36
Solaris 38
Windows 37
License 37
License 37
Protect and recover databases 54
Protect databases 54
Recover databases 54
Recovery scenarios 57
Disk failure 57
Manual recovery 59
Operator failure 58
User failure 57
Remove software 53
Restore backed-up database 58
Restore databases 58
Automatic recovery 59
Snapshot Copy 53
Test
Snapshot Copy 53
Trace Log
Windows 45
Unix
Add root user 50
Database groups 50
PATHs 51
Solaris 50
Oracle Listener
Solaris 48

P
Patches 3

R
Release Notes 3
Replication 1

S
Snapshot agents
and DiskSafe 3
In-band solutions 2
Installation overview 2
Out-of-band solutions 3

SQL Server 20
Command line interface 33
Configure 23
Add instance 24
Advanced options 26
Backup options 26
Batch files 28
Change instance information 24
Checkpoint only 27
Copy only 27
Database options 25
Database security 23
Database selection/exclusion 27
Default drives 29
Full backup 27
Full backup plus checkpoint 27
Remove instance 24
Snapshot Copy test 31
Transaction log backup 27
Transaction Log Backup directory 25
Windows authentication 24
Diagnostic X-ray 35
Install 20, 21
Licensing 21
Offline activation 21
Manual recovery 32
Remove 35
Status
.hisu file 30
Transaction Log Backup best practice 31
VMware 21
VMware environment 21
Support Portal 3

V
VSS
Advanced options 8
batch file options 9
Configure 7
Events 11
Install 2, 5
Silent install 5
Licensing 5
Remove 11
Run 10
Snapshot options 7
Snapshot View/TimeView 10
Snapshots/TimeMarks 10
Storage guidelines 4

Snapshot Agents User Guide

78

Trace log 9
VMware 4
Writers 11

Z
ZeroImpact Backup Enabler 1

Snapshot Agents User Guide

79

You might also like