Snap Creator Framework 3 3 0 Installation

NetApp® Snap Creator Framework 3.3.0

Installation and Administration Guide

NetApp, Inc. 495 East Java Drive Sunnyvale, CA 94089 USA Telephone: +1 (408) 822-6000 Fax: +1 (408) 822-4501 Support telephone: +1 (888) 4-NETAPP Documentation comments: [email protected] Information Web: www.netapp.com

Part Number: 215-05625_A0 December 2010

mailto:[email protected]

Copyright and Trademark Information

Copyright Information

Copyright © 1994-2011 NetApp, Inc. All rights reserved. Printed in the U.S.A.

Portions copyright © 2011 IBM Corporation. All rights reserved. Printed in the U.S.A.

U.S. Government Users Restricted Rights—Use, duplication, or disclosure restricted by GSA ADP Schedule Contract with IBM Corporation.

No part of this document covered by copyright may be reproduced in any form or by any means— graphic, electronic, or mechanical, including photocopying, recording, taping, or storage in an electronic retrieval system—without prior written permission of the copyright owner.

References in this documentation to IBM products, programs, or services do not imply that IBM intends to make these available in all countries in which IBM operates. Any reference to an IBM product, program, or service is not intended to state or imply that only IBM’s product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any of IBM’s or NetApp’s intellectual property rights may be used instead of the IBM or NetApp product, program, or service. Evaluation and verification of operation in conjunction with other products, except those expressly designated by IBM and NetApp, are the user’s responsibility.

No part of this document covered by copyright may be reproduced in any form or by any means— graphic, electronic, or mechanical, including photocopying, recording, taping, or storage in an electronic retrieval system—without prior written permission of the copyright owner.

Software derived from copyrighted NetApp material is subject to the following license and disclaimer:

THIS SOFTWARE IS PROVIDED BY NETAPP ―AS IS‖ AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL NETAPP BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

NetApp reserves the right to change any products described herein at any time, and without notice. NetApp assumes no responsibility or liability arising from the use of products described herein, except as expressly agreed to in writing by NetApp. The use or purchase of this product does not convey a license under any patent rights, trademark rights, or any other intellectual property rights of NetApp.

The product described in this manual may be protected by one or more U.S.A. patents, foreign patents, or pending applications.

RESTRICTED RIGHTS LEGEND: Use, duplication, or disclosure by the government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.277-7103 (October 1988) and FAR 52-227-19 (June 1987).

Trademark Information

NetApp, the NetApp logo, Network Appliance, the Network Appliance logo, ApplianceWatch, ASUP, AutoSupport, Bycast, Campaign Express, ComplianceClock, Cryptainer, CryptoShred, Data ONTAP, DataFabric, DataFort, Decru, Decru DataFort, FAServer, FilerView, FlexCache, FlexClone, FlexScale, FlexShare, FlexSuite, FlexVol, FPolicy, GetSuccessful, gFiler, Go further, faster, Imagine Virtually Anything, Lifetime Key Management, LockVault, Manage ONTAP, MetroCluster, MultiStore, NearStore, NetCache, NOW (NetApp on the Web), ONTAPI, OpenKey, RAID-DP, SANscreen, SecureAdmin, SecureShare, Select, Shadow Tape, Simulate ONTAP, SnapCopy, SnapDirector, SnapDrive, SnapFilter, SnapLock, SnapManager, SnapMigrator, SnapMirror, SnapMover, SnapRestore, Snapshot, SnapSuite, SnapValidator, SnapVault, StorageGRID, StoreVault, the StoreVault logo, SyncMirror, Tech OnTap, The evolution of storage, Topio, vFiler, VFM, Virtual File Manager, WAFL, and Web Filer are trademarks or registered trademarks of NetApp, Inc. in the United States, other countries, or both.

IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. A complete and current list of other IBM trademarks is available on the Web at www.ibm.com/legal/copytrade.shtml.

Apple is a registered trademark and QuickTime is a trademark of Apple, Inc. in the U.S.A. and/or other countries. Microsoft is a registered trademark and Windows Media is a trademark of Microsoft Corporation in the U.S.A. and/or other countries. RealAudio, RealNetworks, RealPlayer, RealSystem, RealText, and RealVideo are registered trademarks and RealMedia, RealProxy, and SureStream are trademarks of RealNetworks, Inc. in the U.S.A. and/or other countries.

All other brands or products are trademarks or registered trademarks of their respective holders and should be treated as such.

NetApp, Inc. is a licensee of the CompactFlash and CF Logo trademarks. NetApp, Inc. NetCache is certified RealSystem compatible.

NetApp Snap Creator Framework 3.3.0 Installation and Administration Guide 4 of 60

Table of Contents

1 NETAPP SNAP CREATOR FRAMEWORK OVERVIEW ......................................................................................... 8 1.1 Snap Creator architecture .................................................................................................................................. 8 1.2 Snap Creator features ......................................................................................................................................... 8 1.3 Snap Creator functions ...................................................................................................................................... 9 1.4 Snap Creator integration .................................................................................................................................... 9 1.5 Limitations of Snap Creator ............................................................................................................................... 9 1.6 Snap Creator backup process ......................................................................................................................... 10 1.6.1 Application plug-ins ......................................................................................................................................... 10 1.6.2 Application quiesce and unquiesce commands .............................................................................................. 10 1.6.3 Archive commands ......................................................................................................................................... 10 1.6.4 PRE commands .............................................................................................................................................. 10 1.6.5 POST commands ........................................................................................................................................... 11 1.6.6 Connecting to NetApp storage ........................................................................................................................ 11 1.6.7 NetApp storage Data ONTAP API calls .......................................................................................................... 11 1.7 Security features ............................................................................................................................................... 12 1.7.1 Storage controller security .............................................................................................................................. 12 1.7.2 Snap Creator agent security ........................................................................................................................... 12 1.8 Snap Creator policies ....................................................................................................................................... 13 1.9 Snap Creator agent ........................................................................................................................................... 13 2 INSTALLING SNAP CREATOR ............................................................................................................................. 15 2.1 Snap Creator server installation ...................................................................................................................... 15 2.2 Snap Creator agent installation ....................................................................................................................... 16 2.3 Upgrading from SnapCreator 3.2 ..................................................................................................................... 17 3 CONFIGURING SNAP CREATOR ......................................................................................................................... 18 3.1 Snap Creator server configuration .................................................................................................................. 18 3.1.1 Creating a configuration file (CLI) ................................................................................................................... 18 3.1.2 Creating a configuration file (GUI) .................................................................................................................. 18 3.1.3 Creating a schedule ........................................................................................................................................ 26 3.1.4 Managing volumes and Snapshot copies ....................................................................................................... 28 3.1.5 Referencing .................................................................................................................................................... 29 3.1.6 Required options ............................................................................................................................................. 29 3.1.7 Connection options ......................................................................................................................................... 30 3.1.8 Snapshot copy options.................................................................................................................................... 30 3.1.9 SnapVault options ........................................................................................................................................... 31 3.1.10 SnapMirror options ......................................................................................................................................... 32 3.1.11 Cloning options ............................................................................................................................................... 33 3.1.12 Protection Manager options ............................................................................................................................ 33 3.1.13 OSSV options ................................................................................................................................................. 34 3.1.14 Operations Manager settings .......................................................................................................................... 34 3.1.15 APP commands .............................................................................................................................................. 34 3.1.16 PRE commands .............................................................................................................................................. 35 3.1.17 POST commands ........................................................................................................................................... 35 3.1.18 Event management options ............................................................................................................................ 36 3.1.19 Client/server configuration .............................................................................................................................. 36 3.1.20 Plug-ins ........................................................................................................................................................... 37 3.2 Snap Creator agent configuration ................................................................................................................... 40 3.3 Creating Windows services for Snap Creator ................................................................................................ 40 3.3.1 Windows service for Snap Creator agent........................................................................................................ 40 3.3.2 Windows service for Snap Creator server ....................................................................................................... 41 4 RUNNING SNAP CREATOR .................................................................................................................................. 42 4.1 Running Snap Creator server .......................................................................................................................... 42 4.1.1 Optional parameters ....................................................................................................................................... 44 4.2 Running Snap Creator agent............................................................................................................................ 45 5 PLUG-IN FRAMEWORK ........................................................................................................................................ 46 A. APPENDIX: SNAP CREATOR EXAMPLES .......................................................................................................... 47 A.1 NetApp Snapshot copy (always required) ...................................................................................................... 47 A.2 NetApp application-consistent backup ........................................................................................................... 47 A.3 NetApp Snapshot copy and backup to tape ................................................................................................... 47 A.4 NetApp backup to disk (OSSV) ........................................................................................................................ 48 A.5 NetApp Snapshot copy and backup to disk (SnapVault) .............................................................................. 48 A.6 NetApp Snapshot copy and backup to disk (SnapMirror) ............................................................................. 49 A.7 NetApp Snapshot copy and database refresh (primary) ............................................................................... 49 A.8 NetApp Snapshot copy and database refresh (secondary)........................................................................... 49 A.9 NetApp Snapshot copy and Protection Manager update .............................................................................. 50 B. APPENDIX: TROUBLESHOOTING ....................................................................................................................... 51 B.1 Logs ................................................................................................................................................................... 51 B.1.1 Out log ............................................................................................................................................................ 51


B.1.2 Debug log ....................................................................................................................................................... 51 B.1.3 Error log .......................................................................................................................................................... 51 B.1.4 Snap Creator agent ........................................................................................................................................ 51 B.2 SCDUMP ............................................................................................................................................................ 51 B.3 Networking......................................................................................................................................................... 52 B.3.1 IP/Hostname ................................................................................................................................................... 52 B.3.2 Protection Manager ........................................................................................................................................ 52 B.3.3 Firewall ........................................................................................................................................................... 52 B.3.4 NAT................................................................................................................................................................. 52 B.3.5 HTTPS ............................................................................................................................................................ 52 B.4 Exit codes .......................................................................................................................................................... 53 B.5 Error messages ................................................................................................................................................. 53 B.5.1 CLI error messages ........................................................................................................................................ 53 B.5.2 GUI error messages........................................................................................................................................ 59

List of Tables

Table 1 - Referencing variables .................................................................................................................................... 29 Table 2 - Basic configuration ........................................................................................................................................ 30 Table 3 - Connection options ........................................................................................................................................ 30 Table 4 - Snapshot copy options................................................................................................................................... 31 Table 5 - SnapVault options .......................................................................................................................................... 31 Table 6 - SnapMirror options ........................................................................................................................................ 32 Table 7 - Cloning options .............................................................................................................................................. 33 Table 8 - Protection Manager options ........................................................................................................................... 33 Table 9 - OSSV options ................................................................................................................................................ 34 Table 10 - Operations Manager settings ......................................................................................................................... 34 Table 11 - APP commands ............................................................................................................................................. 34 Table 12 - PRE commands ............................................................................................................................................. 35 Table 13 - Post commands ............................................................................................................................................. 35 Table 14 - Event Management options ........................................................................................................................... 36 Table 15 - Client/server configuration ............................................................................................................................. 36 Table 16 - Plug-ins .......................................................................................................................................................... 37 Table 17 - Oracle options ................................................................................................................................................ 38 Table 18 - MySQL options .............................................................................................................................................. 38 Table 19 - DB2 options ................................................................................................................................................... 38 Table 20 - Optional cloning for DB2 (UNIX) .................................................................................................................... 39 Table 21 - Archive log options ........................................................................................................................................ 39 Table 22 - Snap Creator server parameters ................................................................................................................... 42 Table 23 - Optional parameters ...................................................................................................................................... 44 Table 24 - Snapshot copy configuration .......................................................................................................................... 47 Table 25 - Application-consistent backup configuration .................................................................................................. 47 Table 26 - Snapshot copy and backup to tape configuration .......................................................................................... 48 Table 27 - OSSV configuration ....................................................................................................................................... 48 Table 28 - Snapshot copy and backup to disk configuration ........................................................................................... 48 Table 29 - Snapshot copy and backup to disk configuration ........................................................................................... 49 Table 30 - Snapshot copy and database refresh configuration ....................................................................................... 49 Table 31 - Snapshot copy and database refresh configuration ....................................................................................... 49 Table 32 - Snapshot copy and Protection Manager configuration .................................................................................. 50 Table 33 - Exit codes ...................................................................................................................................................... 53 Table 34 - CLI error messages ....................................................................................................................................... 53 Table 35 - GUI error messages....................................................................................................................................... 60

List of Figures

Figure 1 - Snap Creator architecture ................................................................................................................................ 8 Figure 2 - Snap Creator agent architecture .................................................................................................................... 13


Preface

This document describes how to install, configure, and run NetApp Snap Creator Framework on NetApp storage systems.

AUDIENCE

The primary audience for this document is technical personnel such as systems administrators, engineers, and professional service engineers.

TERMINOLOGY

To understand the concepts in this document, you might need to know the terms defined here.

Controller or storage controller - The component of a storage system that runs the Data ONTAP®

operating system and controls its disk subsystem. Controllers or storage controllers are also

sometimes called storage appliances, appliances, storage engines, heads, CPU modules, or

controller modules.

Storage system - The hardware device running Data ONTAP that receives data from and sends

data to native disk shelves, third-party storage, or both. Storage systems that run Data ONTAP

are sometimes referred to as filers, appliances, storage appliances, V-Series systems, or

systems.

KEYBOARD AND FORMATTING CONVENTIONS

You can use your product more effectively when you understand how this document uses keyboard and formatting conventions to present information.

Keyboard conventions

Convention What it means

Enter, enter Used to refer to the key that generates a carriage return; the key is named Return on some keyboards.

Used to mean pressing one or more keys on the keyboard and then pressing the Enter key, or clicking in a field in a graphical interface and then typing information into the field.

Formatting conventions

Convention What it means

Italic font Words or characters that require special attention.

Placeholders for information that you must supply.

For example, if the guide says to enter the arp -d hostname command, you

enter the characters "arp -d" followed by the actual name of the host.

Monospaced

font

Command names, option names, and daemon names.

Information displayed on the system console or other computer monitors.

Contents of files.

File, path, and directory names.

Bold

monospaced font Words or characters you type. What you type is always shown in lowercase letters; unless your program is case-sensitive and uppercase letters are necessary for it to work properly.

SPECIAL MESSAGES

This document might contain the following types of messages to alert you to conditions you need to be aware of.

Note: A note contains important information that helps you install or operate the system efficiently.

HOW TO SEND YOUR COMMENTS

You can help us to improve the quality of our documentation by sending us your feedback.


Your feedback is important in helping us provide the most accurate and high-quality information.

If you have suggestions for improving this document, send us your comments by e-mail to [email protected]. To help us direct your comments to the correct division, include the name of your product in the subject line.



1 NetApp Snap Creator Framework overview

NetApp Snap Creator Framework (Snap Creator) is a central backup framework to integrate NetApp Snapshot™ technology with any application that is not supported by SnapManager® products. Normally, this requires a customized script that would interface with the application and the NetApp storage system. These customized scripts are written repetitively every day and are not usually reused. Snap Creator allows you to perform backup, recovery, and disaster recovery faster and more productively.

As the integration for most applications is unique and challenging, backup products support only a few applications. In contrast, Snap Creator provides application integration through plug-ins that enables it to support any application anywhere. With Snap Creator, you can integrate application consistency (backup) scripts or use the built-in Snap Creator plug-ins.

Currently, Snap Creator supports and provides application plug-ins for Oracle®, DB2, and MySQL®. In addition, other application plug-ins are available through the Snap Creator community. Snap Creator handles communication with NetApp storage and performs various tasks that include policy-based Snapshot management (using API or SnapDrive®), an optional LUN or volume clone, seamless integration with SnapMirror® or SnapVault®, and integration with Operations Manager or Protection Manager (PM). Snap Creator is not a replacement for SnapManager and SnapDrive products; in fact, it integrates with both products.

1.1 Snap Creator architecture

Snap Creator consists of a server and agent layer. The server is where the GUI, configuration, and CLI reside. The agent is a lightweight daemon which runs remotely or locally and allows the Snap Creator server to send quiesce or unquiesce operations to a given database. The communication layer from agent to server is Simple Object Access Protocol (SOAP) over HTTP.

The following figure shows the Snap Creator architecture:

Figure 1 - Snap Creator architecture

1.2 Snap Creator features

Snap Creator has the following features:

Brower-based GUI on NetApp Web Framework (NWF)


GUI backup scheduler

A dynamic configuration file in which users can pass their own user-defined values

Agent for central backup management

Global configuration files

1.3 Snap Creator functions

Snap Creator performs the following functions:

Configures multiple Snapshot or SnapVault policies with different retentions

Manages both Snapshot and SnapVault policies

Creates and manages Snapshot copies and SnapVault retentions across multiple volumes and

storage controllers

Supports volume and qtree SnapMirror

Supports FAS and vFiler™

units

Supports consistency groups (consistent Snapshot copies across multiple volumes or appliances)

Supports one-to-one, fan-in, and fan-out SnapMirror or SnapVault relationships

Supports cascading SnapMirror

Performs granular error logging and sends error messages through e-mail or other tools

Supports password encryption. Clear text passwords are not saved in the configuration file

Supports SnapVault restore but without direct application integration

1.4 Snap Creator integration

Snap Creator integrates either fully or optionally with the following software products:

Optionally integrates with both SnapDrive for UNIX (SDU) and SnapDrive for windows. If

SnapDrive is used instead of sending a ZAPI call to the storage controller for the Snapshot, Snap

Creator runs SnapDrive

Optionally uses SnapVault directly instead of PM to transfer Snapshot copies to secondary

NetApp technologies such as Snapshot, SnapVault, SnapMirror, LUN cloning, volume cloning,

and igroup mapping using Data ONTAP® API.

Plug-ins for Oracle, DB2, and MySQL.

With any application or database that runs in an open systems environment (you can write the

application backup script or plug-in if one does not exist)

NetBackup™

, CommVault®, or any backup software with CLI commands.

Optionally integrates with Operations Manager for monitoring (the ability to create events in

Operations Manager)

Optionally integrates with Protection Manager to perform secondary backup (Snap Creator

backup copies can be registered in Protection Manager)

Optionally integrates with Open Systems SnapVault®

1.5 Limitations of Snap Creator

Snap Creator does not perform the following operations:

Replacing SnapManager products.


Handling the mounting of cloned LUNs; mount commands or SnapDrive is required to mount

clones LUNs.

Creating or managing SnapVault and SnapMirror relationships.

1.6 Snap Creator backup process

The backup process is same for all the applications and consists of the following steps:

1. Achieve application consistency

2. Achieve file system consistency (optional)

3. Create a NetApp Snapshot copy

4. Return the application to normal mode

5. Clone the LUN or volume (optional)

6. Perform various SnapMirror or SnapVault functions (optional)

7. Delete old NetApp Snapshot copies, thus managing retention policies on both primary and

secondary storage devices in the case of SnapVault or SnapMirror

Each of the preceding steps involves running optional scripts, commands, or using the plug-in interfaces. The scripts or commands are triggered by using PRE and POST command parameters in the configuration file. All the PRE and POST commands can be run remotely by using the Snap Creator agent. For the application quiesce and unquiesce, use the Snap Creator application plug-ins or issue commands and scripts.

1.6.1 Application plug-ins

Snap Creator offers built-in application support for Oracle, DB2, and MySQL. All these plug-ins provide application quiesce, unquiesce, and other functionalities. Additional application plug-ins might be available; please contact your NetApp sales representative or NetApp authorized partners sales representative.

1.6.2 Application quiesce and unquiesce commands

The quiesce and unquiesce commands are used to achieve application consistency when not using

Snap Creator application plug-ins. Snapshot copies of volumes without application consistency are only crash consistent.

1.6.3 Archive commands

Archive commands are user-defined commands or scripts that are run before the NetApp POST commands (last command that runs). The purpose of the archive commands is to provide the ability to interface with archiving tools after a backup is performed.

1.6.4 PRE commands

PRE commands are user-defined commands or scripts that are run before the following operations:

The application quiesce commands or application integration plug-ins

The Data ONTAP API or SnapDrive calls

The application unquiesce command or application integration plug-ins

The volume or LUN clone delete commands are run

Following are the different types of PRE commands:

PRE app quiesce

PRE NetApp


PRE app unquiesce

PRE clone create

PRE app clone create

PRE NetApp clone delete

PRE exit

PRE restore (in the case of interactive restore)

A PRE command can be used for a file system synchronization or consistency check before calls using Data ONTAP API or SnapDrive are made. For example, run the file system command or script as a PRE NetApp command.

Note: PRE commands or scripts that do not exit with status 0 will be handled as an error within Snap Creator.

1.6.5 POST commands

POST commands are user-defined commands or scripts that are run after the application quiesce

command, the Data ONTAP API calls, and the application unquiesce command.

Following are the different types of POST commands:

POST application quiesce

POST NetApp

POST application unquiesce

POST data transfer

POST clone create

POST app clone create

POST restore (in the case of interactive restore)

A POST command can be used after the application unquiesce command is run to make sure that the

database is running in normal mode. For example, run the database check command or script as a POST application unquiesce command.

Note: POST commands or scripts that do not exit with status of 0 will be handled as an error within Snap Creator.

1.6.6 Connecting to NetApp storage

Connections to a specified primary or secondary NetApp storage controller are made using Data ONTAP API over HTTP or HTTPS. The connections are made by using a user account that exists on the NetApp storage controller. The user is only granted HTTP login and API roles, which means that the user has no permissions to perform anything outside of Data ONTAP API. The root user account also works but NetApp does not recommend using it.

1.6.7 NetApp storage Data ONTAP API calls

Snap Creator requires Data ONTAP API calls. Following are some examples of these Data ONTAP API calls:

One or more volumes (primary)

LUN or volume clone of a Snapshot copy

Map igroups to cloned LUNs

SnapMirror update of one or more volumes (secondary)

SnapVault update of one or more volumes (secondary)


Renaming the recent Snapshot copy (SnapVault secondary only)

Snapshot delete of one or more Snapshot copies based on retention policy (SnapVault secondary

only)

Renaming the recent Snapshot copy (primary)

Snapshot delete of one or more Snapshot copies based on retention policy (primary)

Deleting volume or LUN clones

For example, if you have three volumes: vol1, vol2, and vol3, Snap Creator can create regular Snapshot copies of vol1, vol2, and vol3 (primary) and perform a SnapVault update on vol2 as well as a SnapMirror update on vol3. Since SnapVault retentions (secondary) are different from normal Snapshot copy retentions (primary), Snap Creator can handle a different retention policy for primary and secondary storage as well as various policies. This prevents backup scripts from being out of sync with SnapVault schedules on the NetApp storage controller. It is not necessary to configure SnapVault schedules with Snap Creator. This provides an end-to-end process dependent on a single schedule for any application.

1.7 Security features

1.7.1 Storage controller security

A user name and password is required to communicate with NetApp storage controllers. Passwords can be encrypted so they are not saved in clear text. Snap Creator uses and supports NetApp Role-based access control (RBAC). This is storage controller RBAC; following are the minimum roles that Snap Creator might require:

login-* (for all login access) or login-http-admin (to only allow API login)

api-snapshot-* (always required)

api-system-* (always required)

api-ems-* (always required)

api-snapvault-* (required only for SnapVault management)

api-snapmirror-* (required only for SnapMirror management)

api-volume-* (required for volume clones)

api-lun-* (required for volume and LUN clones)

api-cg-* (required for Consistency Group Snapshot copies)

api-nfs-* (required for exporting cloned volumes by using NFS)

Note: NetApp recommends creating a backup user with only the necessary API permissions and does not recommend using the root user.

Network communications are done through HTTP (80) or HTTPS (443), so you must have one or both of these ports open between the host where Snap Creator runs and the NetApp storage controllers. A user must be created on the NetApp storage controllers for authentication purposes. In the case of HTTPS, make sure the user is enabled and configured on the NetApp storage controllers.

1.7.2 Snap Creator agent security

Snap Creator can run centrally and use an agent to communicate with database servers. The agent is a daemon that runs on any port; by default it runs on port 9090. This port must be open between the Snap Creator server to the server running the agent. The communication between the agent and the Snap Creator server is done through SOAP over the HTTP protocol.


1.8 Snap Creator policies

A policy is the number of Snapshot copies that you want to keep and/or the snapshot copy age. Snap Creator policies are user-defined Snapshot copy retentions that apply to Snapshot copies on primary storage and also to SnapVault Snapshot copies on secondary storage. You must define at least one

policy in the NTAP_SNAPSHOT_RETENTIONS configuration parameter. In the case of SnapVault, you

can associate the same policy with different SnapVault retentions.

For example, if you want to create daily Snapshot copies and retain them for seven days on primary storage and one month on secondary storage, use the following commands:

NTAP_SNAPSHOT_RETENTIONS=daily:7

NTAP_SNAPVAULT_RETENTIONS=daily:28

You can also specify the minimum age of a Snapshot copy (in days) to ensure that Snapshot copies are deleted only if they are older than the minimum age, regardless of how many Snapshot copies exist in a given volume. Using the above example of seven days for Snapshot copies and one month for SnapVault Snapshot copies, use the following commands:

NTAP_SNAPSHOT_RETENTION_AGE=7

NTAP_SNAPVAULT_RETENTION_AGE=28

You can define as many policies as desired, but Snap Creator can run only one policy at a time. The maximum age value is global, so it applies to all policies. For an additional weekly policy, configure it and then call Snap Creator once a week using Cron or task manager with the Snap type set to ―Weekly‖.

1.9 Snap Creator agent

The Snap Creator agent remotely handles operations on application through the plug-ins. All the Snap Creator configurations are stored centrally on the Snap Creator server and all backup jobs can be scheduled from the same host. This provides a single pane of glass (SPOG) for backup and restore.

The following figure shows the Snap Creator agent architecture:

Figure 2 - Snap Creator agent architecture

Snap Creator uses its agent, which runs as a daemon, to quiesce the application. The default port used is 9090, but any other port can also be used.

SOAP protocol is used over the HTTP protocol for communication. The supported application plug-ins are built into the agent and other community plug-ins are available as source code and can be added to

the /plug-ins directory. In addition to the application plug-ins, all PRE commands, POST commands,

and APP commands can be executed remotely through the agent. This provides the ability to mount file systems or to perform additional application processing remotely. The agent has an access file under

/path/so/scAgent_v<#>/config/agent.conf where certain commands are allowed to run. By

default, all commands are denied; this means that only the built-in or community plug-ins can execute


commands through the agent. PRE or POST scripting commands or scripts must be allowed in the

agent.conf.

The agent also provides a watchdog process that automatically unquiesces an application after its configurable timeout is reached if communication from the server is lost. The watchdog can be enabled or disabled and has a configurable timeout.


2 Installing Snap Creator

This chapter describes how to install Snap Creator server and Snap Creator agent.

2.1 Snap Creator server installation

The Snap Creator server is designed to run on any open systems platform. Perform the following steps to install Snap Creator server:

1. Download the Snap Creator executable file from http://now.netapp.com

2. Extract the .tgz file to /usr/local for UNIX® or .zip file to C:\ for Windows®. On Windows,

NetApp recommends that you do not have spaces in the install path. Change directory to the

Snap Creator server root directory /path/to/scServer_v<#>.

3. Run Snap Creator setup by entering the following command.

./snapcreator -—profile setup

Snap Creator setup configures an admin user for the GUI and sets up the GUI parameters.

Note: Snap Creator is a non serialized product but it prompts for a serial number. This value is optional. The user can hit return to continue or enter a numeric value. The intent is to add the NetApp controller serial number applicable to the Snap Creator application. The Snap Creator application archives this information for later use. The user can run —version command using the Snap Creator

Command Line Interface to retrieve this serial number information when contacting NetApp Global Support (NGS) to open a Snap Creator case.

Syntax to add serial number is as follows:

c:\SnapCreator\scServer_v3.3.0>snapcreator --profile setup

Welcome to the NetApp Snap Creator Framework!

Setup NetApp Snap Creator Framework Server (y|n): y

Enter serial number: ________ (Serial Number must be numeric)

4. Create a Data ONTAP API user

Because Snap Creator uses Data ONTAP API, create a user with the required access on the NetApp storage controller. You should create a new role, group, and user so that you can control access and lock the Snap Creator user. A user must be created on all NetApp storage systems involved (primary and secondary, in the case of SnapMirror or SnapVault), but depending on the storage controller’s function, not all roles are needed. Following are the possible roles that Snap Creator might require:

login-* (for all login access) or login-http-admin (to only allow API login)

api-snapshot-* (always required)

api-system-* (always required)

api-ems-* (always required)

api-snapvault-* (required only for SnapVault management)

api-snapmirror-* (required only for SnapMirror management)

api-volume-* (required for volume clones)

api-lun-* (required for volume and LUN clones)

api-cg-* (required for Consistency Group Snapshot copies)

api-nfs-* (required for exporting cloned volumes by using NFS)

http://now.netapp.com/


5. Install Snap Creator GUI

The Snap Creator GUI is based on Java™

and uses the NetApp Web Framework (NWF). NetApp recommends using Internet Explorer or Mozilla browsers. The GUI uses Jetty, which is an embedded Java application server. The GUI is a complementary tool that helps to build, manage, and run Snap Creator configuration profiles. GUI requirements Java Runtime Environment (JRE) 1.6 or higher must be installed on the system running Snap Creator. Download the Java JRE from http://www.java.com/en/download/manual.jsp.

On UNIX, the bash shell must be installed under /bin/bash. If the bash shell is installed in a

different location, then make a soft symbolic link pointing /bin/bash to the location where bash

shell is installed. GUI setup

On UNIX, set the following parameters in snapcreatorgui.conf located at:

/path/to/scServer_v<#>/gui/etc/snapcreatorgui.conf: SNAPCREATOR_PATH=/path/to/scServer_v<#>

SNAPCREATOR_EXEC=/path/to/scServer_v<#>/snapcreator

SNAPCREATOR_USER=<username>

SNAPCREATOR_PASS=<encrypted password>

SNAPCREATOR_SERIAL=<serial number>

Note: The snapcreatorgui.conf settings should be automatically set after running

the./snapcreator—profile setup command.

After the parameters are configured, start the GUI by using the following commands: cd /path/to/scServer_v<#>/gui

/path/to/java -jar snapcreator.jar

or /path/to/java -jar snapcreator.jar -db_password <db_password> -db_port

<db_port> -db_username <db_username> -gui_port <gui_port>

Note: Change the directory to /path/to/scServer_v<#>/gui to start the GUI.

Once Jetty is running, you can access the Snap Creator GUI over HTTP as follows: http://myserver.mydomain.com:8080

The log setting for NetApp Snap Creator Framework GUI is present in

gui/etc/log4j.properties file. The default setting is as follows.

Log file: gui/logs/snapcreator.log

Max file size: 10MB

Max number of backup files: 4

Logging level: INFO

These settings can be changed as per the user requirements.

2.2 Snap Creator agent installation

The Snap Creator agent is designed to run on any open systems platform. If the agent is not required, you can choose to run the Snap Creator server on the application server locally. Perform the following steps to install Snap Creator agent:

1. Download the Snap Creator executable file from http://now.netapp.com

http://www.java.com/en/download/manual.jsp

http://myserver.mydomain.com:8080/

http://now.netapp.com/


2. Extract the .tgz file to /usr/local for UNIX or .zip file to C:\ for Windows. On Windows,

NetApp recommends that you do not have spaces in the install path. Change directory to the

Snap Creator server root directory /path/to/scAgent_v<#>.

3. Run Snap Creator setup by entering the following command.

./snapcreator -—profile setup

Snap Creator agent setup on UNIX configures the /path/to/scAgent_v<#>/bin/scAgent

start script and prints usage information. On Windows, it simply prints usage information.

4. Install the agent.

For Windows

The agent does not run as a service. To start the agent across reboots, click Start>Program Files>Accessories>System Tools.

To run a task, create a .bat with /path/to/scAgent_v<#>/snapcreator –start-agent

<port> in it and use the .bat file as your task.

For UNIX

The Snap Creator agent has the ability to run as a daemon under UNIX. The agent uses either the default port 9090 or a user-specified port. To set a non-default port number, configure the

following environment variable: SC_AGENT_PORT.

If the SC_AGENT_PORT environment variable is not set, then the agent defaults to port 9090.

To make sure the agent starts when rebooting, a start script must be set up under

/path/to/rc2.d. Start scripts must begin with S9x (S99scagent). The start script should

contain the following:

/path/to/scAgent_v<#>/bin/scAgent start

This command is run to start the agent manually

/path/to/scAgent_v<#>/bin/scAgent stop

This command is run to stop the agent manually

/path/to/scAgent_v<#>/bin/scAgent status

This command is run to query the agent status

2.3 Upgrading from SnapCreator 3.2

For Snap Creator 3.3.0 to use the configuration file from version 3.2, add the following parameters: SNAPDRIVE_DISCOVERY

NTAP_SNAPSHOT_DELETE_BY_AGE_ONLY

NTAP_SNAPSHOT_DEPENDENCY_IGNORE

NTAP_SNAPVAULT_SNAPSHOT

NTAP_SNAPVAULT_RESTORE_WAIT

NTAP_NFS_EXPORT_HOST

NTAP_NFS_EXPORT_ACCESS

NTAP_NFS_EXPORT_PERSISTENT

NTAP_PM_RUN_BACKUP

NTAP_OSSV_FS_SNAPSHOT

NTAP_OSSV_FS_SNAPSHOT_CREATE_CMD0<##>

APP_DEFINED_RESTORE

APP_AUTO_DISCOVERY

APP_CONF_PERSISTENCE

SC_AGENT_UNQUIESCE_TIMEOUT

SC_AGENT_WATCHDOG_ENABLE

Note: To upgrade from versions prior to SnapCreator 3.2, please contact your Professional Services representative.


3 Configuring Snap Creator

This chapter describes how to configure Snap Creator server and Snap Creator agent.

3.1 Snap Creator server configuration

The configuration file is located in

/path/to/scServer_v<#>/configs/<profile>/<config>.conf. You can create multiple

configurations, but Snap Creator server runs only one configuration at a time. Snap Creator server should be scheduled through Cron (UNIX), task manager (Windows), or the Snap Creator scheduler in GUI. You can edit this file by using Visual Interactive (VI) (UNIX) or any text editor in Windows. Additionally, you can use the Snap Creator GUI to edit and manage configuration files. The configuration file is divided into four sections: Basic Configuration, NetApp Options, Other Options, and Additional Plug-ins.

3.1.1 Creating a configuration file (CLI)

You can create a new directory or profile for your configuration under

/path/to/scServer_v<#>/configs. It is a best practice is to name it after the host or application

being backed up. This example uses the name oraprod01.

The default template is located in /path/to/scServer_v<#>/configs/default/default.conf.

To create a configuration file, perform the following steps:

1. Create the directory:

mkdir /path/to/scServer_v<#>/configs/oraprod01

2. Copy or rename the default template to your new configuration directory:

cp /path/to/scServer_v<#>/configs/default/default.conf

/path/to/scServer_v<#>/configs/oraprod01/oraprod01.conf

3. Edit your configuration file by using VI (UNIX) or any text editor in Windows.

3.1.2 Creating a configuration file (GUI)

Perform the following steps to create the configuration file using GUI.

1. Open a web browser to the following URL: http://myserver.mydomain.com:8080 and login.

2. In the Management Configurations screen, click the Add backup profile icon and enter the new

profile name.

http://myserver.mydomain.com:8080/


The profile name should relate to the application being backed up. Adding a profile creates a

directory under the /path/to/scServer_v<#>/configs directory.

The new backup profile is created.

3. Right-click the backup profile and select New Configuration.

4. In the New Configuration Welcome window, click Next.


5. In the Filer Login Credentials window, enter the details. For the Transport type, select any value

from the drop down list and the Filer port is picked automatically.

6. Check the Password Protection checkbox to enable password encryption, and then click Next.

7. From the Volumes window, select and drag the desired volumes to the panel on the right to be

used for the new configuration.


8. In the Snapshot Action window, enter the Snapshot information.

Note: The Snapshot naming convention must be unique. Snapshot copies are deleted according to this naming convention.

The policy retention setting determines the number of Snapshot copies to be retained for a given policy.

The Policy retention age defines the retention age for Snapshot copies.

Consistency group consists of Snapshot copies that are consistent across multiple volumes within a storage controller.

9. In the Data protection window, select SnapMirror or SnapVault or leave both unchecked, and click

Next.


10. In the Applications window, select the desired application and click Next.

Note: Snap Creator currently supports only Oracle, MySQL, and DB2. If an unsupported application is selected, the following message is displayed.


If you select Oracle, enter the parameters for Oracle and click Next:

If you select MySQL, enter the parameters for MySQL and click Next:


If you select DB2, enter the parameters for DB2 and click Next:

11. In the Agent Configuration window, enter the agent configuration details or leave the field blank

and click Next.

Note: Click the Test icon to test the connection


12. In the Operations Manager window, complete the parameters to enable Operations Manager

Alerting or leave the field blank and click Next.

13. In the Summary window, review the settings and click Finish to complete.


Note: You can also rename and delete a configuration by right-clicking and selecting Delete or Rename. The GUI creates the same configuration files you would create by using the CLI. You can update and edit configuration files created by the GUI from the CLI or from the CLI to the GUI.

3.1.3 Creating a schedule

Perform the following steps to create a schedule by using the GUI:

1. Click the Schedules tab on the left to load the Management Schedules screen.

2. Click the Add new task icon to create a new schedule.


3. Enter the details in the New Task window to create a new schedule and click Save.

The new schedule is created and the schedule details are displayed under configuration details.


3.1.4 Managing volumes and Snapshot copies

The volumes and Snapshot copies for each configuration are listed under the Data tab.

Click the Volumes tab under Data to view the volume details like Total size, size available, state, and so on.

Click the Snapshots tab to view the Snapshot copy details like Snapshot copy name, access time, dependency, and so on.

The Snapshot copies can be renamed or deleted by clicking the rename and delete icons.

Click the Backup Logs tab under Reports and select the Backup profile and log to view the Backup log details


3.1.5 Referencing

The configuration file is dynamic, which means that you can create and set variables within the configuration itself. Referencing is the ability to define variables within the configuration file. This is done by using the ―%‖ character. For example, use of SnapDrive instead of Data ONTAP API to create the Snapshot copies. As the Snapshot copy names need to be unique, you must set a dynamic variable. Following is an example from a Windows SnapDrive configuration.

NTAP_SNAPSHOT_CREATE_CMD1=‖c:/Program Files/NetApp/SnapDrive/sdcli‖ snap

create -m fx1b4 -s %SNAME-%SNAP_TYPE-%SNAP_TIME_recent -D E:

The following table lists the built-in variables that can be referenced:

Table 1 - Referencing variables

Variables Description

%SNAP_TYPE This is given when you run Snap Creator and it is your retention policy, that is, daily, weekly, monthly.

%SNAP_TIME This is a timestamp (YYYYMMDDhhmmss) used in the naming of Snapshot copies to create a guaranteed unique name for every Snapshot copy. It is also used to name the backup reports and Sybase transaction logs.

%ACTION This is the given action when you run Snap Creator: (snap|clone_vol|clone_lun|arch|restore|delete|snaplist|clonelist|

pmsetup|ossv)

%MSG This is used to send an error message to another program such as e-mail or Tivoli. It can only be used with the SENDTRAP function.

%USER_DEFINED This passes a user-defined argument to the Snap Creator configuration file. For example, when you want to integrate with a backup application like NetBackup, you might have to pass the desired NetBackup schedule into the configuration file when you have multiple schedules and want to call NetBackup with a certain schedule. You could also achieve this by having multiple configuration files for the different scenarios.

Note: When combining variables in the Snap Creator configuration file (%SNAME-%SNAP_TYPE-%SNAP_TIME_recent), always use the ―-― as a separator between the variables, just like in the preceding SnapDrive example.

3.1.6 Required options

The following table lists the options required in a basic configuration:


Table 2 - Basic configuration

Variables Setting Description

SNAME (REQUIRED) Snapshot copy naming convention should be unique. Snapshot copies on NetApp are deleted according to the naming convention and retention policy used.

SNAP_TIMESTAMP_ ONLY (REQUIRED)

Y/N If set to Y, Snapshot copies end with YYYYMMDDHHMMSS. Otherwise, new Snapshot copies are recent and they are renamed to end with YYYYMMDDHHMMSS.

VOLUMES (REQUIRED) This is the list of source appliances and volumes you want to create a Snapshot copy of, that is, filer1:vol1,vol2,vol3; filer2:vol1;filer3:vol2,vol3.

NTAP_SNAPSHOT_ RETENTIONS (REQUIRED)

Determines the number of NetApp Snapshot copies you want to retain for a given policy, that is, daily:7,weekly:4,monthly:1.

NTAP_USERS (REQUIRED)

This is the list of appliances and their corresponding user names/passwords, that is, filer1:joe/password1;filer2:bob/password2;filer3:ken/password3.

Note: If you want to use protected passwords, first run

./snapcreator—cryptpasswd and then save the scrambled

password in the config file.

NTAP_PWD_PROTECTION (REQUIRED)

Y/N Enables password protection. You must encrypt passwords and save encrypted passwords in config when this option is set to ―Y.‖

TRANSPORT (REQUIRED)

HTTP/ HTTPS

This allows you to choose the protocol for API communications.

Note: HTTPS may require openssl-devel libraries

PORT (REQUIRED) This is the port you want to use to communicate with the NetApp storage controller(s), normally (80/443).

LOG_NUM (REQUIRED) This is the number of .debug and .out reports that Snap Creator has

to retain.

3.1.7 Connection options

The following table lists the options required to connect to vFiler units and interfaces:

Table 3 - Connection options


VFILERS This is the list of vFiler™ units and their hosting appliances or volumes, that is, vFiler1@filer1:vol1,vol2,vol3;vFiler2@filer2:vol1;vFiler3@filer3:vol2,vol3.

MANAGEMENT_ INTERFACES

This is an interface that you can specify for every physical appliance. All Data ONTAP API communications between Snap Creator and the controller occur through this interface.

For example:

MANAGEMENT_INTERFACES=filer1:filer1-

mgmt;filer2:filer2-mgmt

SECONDARY_ INTERFACES

For every appliance or vFiler unit, you can specify a secondary interface source/destination pair (name or IP). It is used for SnapMirror and SnapVault updates.

For example, filer1:filer1-backup/filer2-backup.

Where:

filer1 – Storage controller or VFiler unit name

filer1-backup – Secondary interface for filer1/vFiler1

filer2-backup – Secondary interface for filer1/vFiler1’s SnapMirror or SnapVault destination

Note: The SnapVault/SnapMirror relationships must be configured to

use this secondary interface. Snap Creator does not manage SnapMirror/SnapVault relationships.

3.1.8 Snapshot copy options

The following table lists the options required to setup Snapshot copy:


Table 4 - Snapshot copy options


NTAP_SNAPSHOT_ RETENTION_AGE

Allows you to define a retention age (in days) for Snapshot copies. If configured, Snapshot copies are deleted only if they exceed the number defined in NTAP_SNAPSHOT_ RETENTIONS and if they are older than the retention age (in days).

SNAPDRIVE Y/N Allows you to use SnapDrive instead of Data ONTAP API for creating a Snapshot copy.

SNAPDRIVE_DISCOVERY

Y/N Enables use of SnapDrive for the discovery feature. Requires SnapDrive to be configured and working on host where discovery is performed.

NTAP_SNAPSHOT_ DISABLE

Y/N Disables the Snap Creator from creating a Snapshot copy So that Snap Creator can handle SnapVault or SnapMirror for SnapManager.

For this setting to work, the SnapManager Snapshot copies need to follow this naming convention: <snapshot copy name>-

<policy>_recent.

NTAP_SNAPSHOT_ NODELETE

Y/N Overrides NTAP_SNAPSHOT_RETENTIONS and prevents Snapshot copies from being deleted. Leaving this on can make the volume full.

NTAP_SNAPSHOT_DELETE_BY_AGE_ONLY

Y/N Requires NTAP_SNAPSHOT_RETENTION_AGE and forces deletion based on Snapshot copy age rather than the number of Snapshot copies.

NTAP_SNAPSHOT_DEPENDENCY_IGNORE

Y/N Applies only to snapshot deletion menu ―—action delete‖. Manually deleting Snapshot copies with a dependency is not permitted.

NTAP_SNAPSHOT_ CREATE_CMD<#>

This SnapDrive command creates a Snapshot copy and flushes the file system buffers. < #> is a number from 01-99.

Note: This is required if you enable the SNAPDRIVE option. Data

ONTAP API is still used to perform everything else, but the SNAPDRIVE

option creates Snapshot copies.

NTAP_CONSISTENCY_ GROUP_SNAPSHOT

Y/N Enables use of consistency groups. By using this setting, you can take a consistent (I/O fencing) Snapshot copy across more than one volume and multiple storage controllers.

Note: Enabling this option requires

NTAP_CONSISTENCY_GROUP_TIMEOUT

NTAP_CONSISTENCY_ GROUP_TIMEOUT

urgent

medium

relaxed

Specifies the wait time for I/O fencing between volumes. Before we can create a Snapshot consistency group, all volumes must be quiesced (I/O fencing). The default setting and recommendation is medium (7 seconds); however, this depends on the number of volumes you have and the number of appliances that are involved.

Urgent is 2 seconds

Medium is 7 seconds

Relaxed is 20 seconds

3.1.9 SnapVault options

The following table lists the options required to set up SnapVault:

Table 5 - SnapVault options


NTAP_SNAPVAULT_ UPDATE

Y/N Allows you to turn off and on the SnapVault update function.

SNAPVAULT_ VOLUMES

This is the list of source appliances and volumes on which you want to perform a SnapVault update, that is, filer1:vol1,vol2,vol3;filer2:vol1;filer3:vol2,vol3.

Note: For SnapVault and SnapMirror updates to work, the relationships

need to exist. Snap Creator does not create the relationships.

Note: The host name(s) in the SnapMirror or SnapVault relationship

must be the same as specified in the VOLUMES, SNAPMIRROR_VOLUMES, and SNAPVAULT_VOLUMES options. Also, the host where Snap Creator runs must be able to resolve the hostname(s).

Note: Host names should be the short host name (name that appears

on storage controller command prompt), not the FQDN.



SNAPVAULT_QTREE_ INCLUDE

This is the list of source appliances and qtree paths that should be included in the SnapVault update. Without this option, all qtrees under a volume are vaulted by SnapVault if a relationship exists. Qtrees listed in the following example are vaulted by SnapVault and the rest are ignored by SnapVault: filer1:/vol/qtree/qtree1,/vol/volume/qtree2;filer2:/vol/volume/qtree1.

NTAP_SNAPVAULT_ RETENTIONS

Determines the number of NetApp Snapshot copies on the SnapVault secondary that you want to retain for a given policy, that is, daily:21,weekly:12,monthly:3.

NTAP_SNAPVAULT_ RETENTION_AGE

Allows you to define a retention age (in days) for SnapVault Snapshot copies. If configured, SnapVault Snapshot copies are deleted only if they exceed the number defined in NTAP_SNAPVAULT_ RETENTIONS and if they are older than the retention age (in days).

NTAP_SNAPVAULT_SNAPSHOT

Y/N Enables use of SnapVault Snapshot copies; that is, Snapshot copies that are compatible with the Storage Controller SnapVault scheduler. When using this option, Snapshot delete is handled by the Storage controller and not the Snap Creator.

Additionally, Snapshot copies are named as follows: sv_<POLICY>.<##>. The policy name comes from the NTAP_SNAPSHOT_RETENTIONS parameter and the retention set is also applied to the Storage Controller SnapVault schedule.

NTAP_SNAPVAULT_ NODELETE

Y/N Overrides NTAP_SNAPVAULT_RETENTIONS and prevents Snapshot copies from being deleted. Leaving this on can cause your NetApp volume to fill up.

NTAP_SNAPVAULT_RESTORE_WAIT

Y/N In the case of SnapVault restore, forces Snap Creator to wait for the operation to complete. This is recommended because after the SnapVault restore completes, Snap Creator prompts the user to delete the restore Snapshot copies that get created on primary storage and are no longer needed.

NTAP_SNAPVAULT_ WAIT

This is the wait time (in minutes) for the SnapVault update process to complete before taking a Snapshot copy on the SnapVault secondary.

NTAP_SNAPVAULT_MAX_TRANSFER

This is the maximum bandwidth SnapVault is allowed to use in kbps. If it is not set, SnapVault uses the maximum available bandwidth.

3.1.10 SnapMirror options

The following table lists the options required to set SnapMirror:

Table 6 - SnapMirror options


NTAP_SNAPMIRROR_ UPDATE

Y/N Allows you to turn off and on the SnapMirror update function.

NTAP_SNAPMIRROR_ CASCADING_UPDATE

Y/N Allows you to turn off and on the cascading SnapMirror update function. This is a SnapMirror update using a SnapVault destination volume.

SNAPMIRROR_ VOLUMES

This is the list of source appliances and volumes on which you want to perform a SnapMirror update, that is, filer1:vol1,vol2,vol3;filer2:vol1;filer3:vol2,vol3.

SNAPMIRROR_ CASCADING_VOLUMES

This is the list of SnapVault destination appliances and volumes where, after a SnapVault update, you want to perform a SnapMirror update, that is, sec-filer1:vol1-sec,vol2-sec.

NTAP_SNAPMIRROR_ WAIT

This is the wait time (in minutes) for the SnapMirror update process to complete before creating a clone on the SnapMirror destination. If NTAP_CLONE_SECONDARY=Y, Snap Creator waits until the SnapMirror update is complete before proceeding.

Note: This can only be used with NTAP_CLONE_SECONDARY and

ACTION clone_vol (only volume clones are currently supported).

NTAP_SNAPMIRROR_ USE_SNAPSHOT

Y/N If enabled, the SnapMirror update uses the newly created Snapshot copy, thus creating a Snapshot copy on the SnapMirror destination.

Note: This is required for NTAP_CLONE_SECONDARY because a

Snapshot copy is needed in order to create a clone on the SnapMirror destination.

NTAP_SNAPMIRROR_MAX_TRANSFER

This is the maximum bandwidth SnapMirror is allowed to use in kbps. If it is not set, SnapMirror uses the maximum available bandwidth.


3.1.11 Cloning options

The following table lists the options required to set up cloning.

Table 7 - Cloning options


NTAP_VOL_CLONE_ RESERVE

none

file

volume

This is the space guarantee for a cloned volume.

NTAP_LUN_CLONE_ RESERVATION

true

false

If set to true, space is reserved for the cloned LUNs if the clone_lun Action is selected. Otherwise, space is not reserved.

NTAP_CLONE_IGROUP_ MAP

Specify the appliance, source volume, and an IGROUP. The IGROUP is then mapped to cloned LUNs that reside in the source volume or cloned LUNs that reside in the volume clone, that is, filer1:src_volume1/igroup1;filer2:src_volume2/igroup2.

Note: LUN clones assume the same name as their parent volume or

LUN and end with _CLONE, that is, if the volume is called myvol, its clone would be myvol_CLONE.

Note: Volume clones start with ―cl_‖ and end with ―-

YYYYMMDDHHMMSS.‖

NTAP_CLONE_FOR_ BACKUP

Y/N If enabled, clones (volume and LUN) are created and then deleted after the other NetApp operations are complete. Otherwise, clones are deleted before NetApp operations complete.

Note: If you are backing up clones to tape, this should be set to Y. If you

are doing database refreshes, then you will most likely want to set it to N.

NTAP_CLONE_ SECONDARY

Y/N If enabled, clones are created on the SnapMirror destination after the SnapMirror update is complete.

Note: This setting should be used with

NTAP_SNAPMIRROR_USE_SNAPSHOT, NTAP_SNAPMIRROR_WAIT, NTAP_CLONE_SECONDARY_VOLUMES , and ACTION clone_vol.

NTAP_CLONE_ SECONDARY_VOLUMES

This is a mapping of primary/secondary appliances and the secondary volumes. This is required so that Snap Creator can find the secondary volumes, that is, filer1:filer1-sec/vol1,vol2,vol3;filer2:filer2-sec/vol1;filer3:filer3-sec/vol2,vol3.

NTAP_NUM_VOL_CLONES

This is the number of volume clones you want to retain. This works in a similar way to the snapshot retention policy.

Note: This only works for volume clones that require a FlexClone®

license on the NetApp storage controller.

NTAP_NFS_EXPORT_HOST

Host

IP

The hostname or IP address where the clone should be exported. This is the host where the user wants to mount the clone volume by using NFS.

NTAP_NFS_EXPORT_ACCESS

root

read-write

read-only

The host specified in NTAP_NFS_EXPORT_HOST receives access or permission to the clone volume.

root – Root access is granted

read-only – Read-only access is granted

read-write – Read/Write access is granted

NTAP_NFS_EXPORT_PERSISTENT

true

false

Determines if NFS export is persistent. If true is selected, the clone volume is exported and the /etc/exports file on the Storage Controller is updated.

3.1.12 Protection Manager options

The following table lists the options required to set up Protection Manager:

Table 8 - Protection Manager options


NTAP_PM_UPDATE Y/N Allows you to turn off and on the Protection Manager update that registers Snap Creator Snapshot copies in Protection Manager.

Note: If NTAP_PM_UPDATE is enabled, you must configure

NTAP_DFM_DATA_SET.



NTAP_DFM_DATA_SET This is a list of appliances and Protection Manager data sets to volume correlations, that is, filer1:dataset1/vol1,vol2;filer1:dataset2/vol3.

NTAP_PM_RUN_BACKUP

Y{N Starts the Protection Manager backup, checks the progress and status, and waits for it to complete.

3.1.13 OSSV options

The following table lists the options required to set up OSSV:

Table 9 - OSSV options


NTAP_OSSV_ENABLE Y/N Enables the Open Systems SnapVault (OSSV) integration. This option must be used in combination with the NTAP_OSSV_HOMEDIR parameter. OSSV is also required on the host running Snap Creator.

Note: When OSSV option is enabled, the path is specified as volumes.

When specifying paths in windows for OSSV ':' should not be used. For example, if the path is E:\DB then it should used as E\DB.

NTAP_OSSV_HOMEDIR /usr/s

napvau

lt

The path to the OSSV home directory, that is, /usr/snapvault

NTAP_OSSV_FS_SNAPSHOT

Y/N This setting also requires the NTAP_OSSV_FS_SNAPSHOT_CREATE_CMD<##> and allows creating a file system snapshot copy using OS / Filesystem command. The File system Snapshot copy is then transferred to NetApp storage using SnapVault.

NTAP_OSSV_FS_SNAPSHOT_CREATE_CMD<##>

These are scripts or commands to be executed during or before the OSSV backup process, where ―##‖ is a number from 01–99.

This can be used to perform backup file system Snapshot copies by using OSSV.

3.1.14 Operations Manager settings

The following table describes the Operations Manager settings:

Table 10 - Operations Manager settings


OM_HOST The name or IP address of the Operations Manager host.

OM_USER The user name of an Operations Manager user who has permission to create events.

OM_PWD The password for the Operations Manager user.

OM_PORT The port to use for communications with Operations Manager; 8080 is the default http port that the Operations Manager uses.

OM_EVENT_GENERATE Y/N Enables or disables event creation in Operations Manager.

3.1.15 APP commands

The following table describes the different APP commands:

Table 11 - APP commands


APP_CLONE_FOLLOW_ UP_ CMD<##>

These are scripts or commands to be executed after the database is cloned, where ―##‖ is a number between 01–99.

This can be used to perform application-specific follow-up activities on SAP systems, such as, installing a SAP license, adjusting database tables, deleting or updating content, and starting up the application.

APP_QUIESCE_CMD<##>

These are scripts or commands that put your application into backup mode where, ―##‖ is a number between 01–99.

Note: This is ignored if you use APP_NAME because it is handled

internally in Snap Creator.



APP_UNQUIESCE_ CMD<##>

These are scripts or commands that take your application out of backup mode, where ―##‖ is a number from 01–99.



ARCHIVE_CMD<##> Handles database archiving. It can also be used as a wrapper to run other scripts.

The archive command, where ―##‖ is a number from 01–99.

3.1.16 PRE commands

The following table lists the PRE commands:

Table 12 - PRE commands


PRE_APP_QUIESCE_ CMD<##>

This is the pre application backup start command, where ―##‖ is a number from 01–99.

PRE_NTAP_CMD<##> This is the pre NetApp Snapshot command, where ―##‖ is a number from 01–99; it runs before all NetApp operations.

PRE_APP_QUIESCE_ CMD<##>

This is the pre application backup stop command, where ―##‖ is a number from 01–99.

PRE_NTAP_CLONE_ DELETE_CMD<##>

This is the pre NetApp clone delete command, where ―##‖ is a number from 01–99.

Note: The purpose of NetApp clone delete command(s) is to call a

mount script or commands so that cloned LUNs can be mounted for the purpose of backing up (probably to tape).

PRE_EXIT_CMD<##> This is an optional command that is run after a fatal error occurs but before Snap Creator exits. This is useful to revert to the state it was before Snap Creator ran.

Note: This command returns an application into normal operation mode

before Snap Creator exits due to an error.



PRE_RESTORE_CMD<##>

This is an optional command that can be run before you enter an interactive restore. This allows you to interact with the application being restored. For example, you might want to shut down the application before performing a restore.

PRE_CLONE_CREATE _ CMD<##>

This is an optional command that can be run before Data ONTAP API cloning operations occur, where ―##‖ is a number from 01–99.

3.1.17 POST commands

The following table lists the POST commands:

Table 13 - Post commands


POST_APP_ QUIESCECMD<##>

This is a post application backup start command, where ―##‖ is a number from 01–99

POST_NTAP_CMD<##> This is a post NetApp command, where ―#‖ is a number from 01–99. This runs after all NetApp operations are complete.

POST_APP_UNQUIESCE _CMD<##>

This is a post application backup stop command, where ―##‖ is a number from 01–99.

POST_NTAP_DATA_ TRANSFER_CMD<##>

This is a post data transfer command that runs after SnapVault or SnapMirror transfer, where ―##‖ is a number from 01–99.

POST_RESTORE_ CMD<##>

This is an optional command that can be run after you complete an interactive restore. It allows you to interact with the application being restored. After your restore is complete, you might want to start the application.

POST_CLONE_CREATE_ CMD<##>

This is an optional command that can be run after Data ONTAP API cloning operations occur, where ―##‖ is a number from 01–99. The commands are used to perform operations such as mounting cloned file systems.


3.1.18 Event management options

The following table lists the options required to set up event management:

Table 14 - Event Management options


NTAP_ASUP_ERROR_ ENABLE

Y/N Enables Snap Creator error messages to also log an auto support message on the NetApp storage controller. Snap Creator always creates an info auto support message when the backup has started and is complete.

SENDTRAP This command interfaces with your monitoring software or e-mail allowing you to pass alerts generated from Snap Creator into your own monitoring infrastructure. The %MSG variable is the message sent from Snap Creator. Following is an example of how to send an email on a UNIX system:

SENDTRAP=/usr/bin/mailx –s %MSG [email protected] </dev/null

SUCCESS_TRAP This command interfaces with your monitoring software or e-mail allowing you to pass the success message generated from Snap Creator into your own monitoring infrastructure. The %SUCCESS_MSG variable is the success message for Snap Creator. Following is an example of how to send an email on UNIX system:

SUCCESS_TRAP=/usr/bin/mailx –s %SUCCESS_MSG [email protected] </dev/null

SUCCESS_MSG After a successful Snap Creator backup, this setting logs the message defined and also sends it to SUCCESS_TRAP, if defined, or to SENDTRAP, if SENDTRAP is defined.

3.1.19 Client/server configuration

The following table lists the options for client/server configuration:

Table 15 - Client/server configuration


SC_AGENT <hostname or IP >:<port>

Snap Creator has the capability to perform tasks on remote hosts. A task is either a defined plug-in (parameter APP_NAME) or a command specified with the parameters _CMD, for example,

NTAP_SNAPSHOT_CREATE_CMD01. To specify a remote host, enter its name or IP address followed by a colon and the port the Snap Creator agent is listening on. On the remote host, start the Snap Creator agent by running the command:

<path to scAgent_v<#>>/snapcreator—start-agent <port>

SC_CLONE_ TARGET

<hostname or IP of the clone target>:<port>

Snap Creator has the capability to perform clone operations. Using the

action clone_vol in combination with

{PRE|POST}_CLONE_CREATE_CMDxx, you can handle the storage objects on the remote side. For example, mounting/unmounting file systems. To specify a clone target, enter its name or IP address followed by a colon and the port the Snap Creator agent is listening on.

SC_AGENT_ TIMEOUT

Time in seconds

Specifies the timeout in seconds. The implemented client/server architecture uses a timeout mechanism. This means that if the client does not respond in the specified interval, the server fails with a timeout message. However, the task on the client is not aborted and requires further investigation. On a server with high load or known long-running tasks like own scripts or complex SnapDrive operations, it might be necessary to extend the timeout and adapt this value to your own requirements. By default, a timeout of 300 seconds is used.

SC_AGENT_WATCHDOG_ENABLE

Y/N Enables or disables the agent watchdog process. When the agent receives a quiesce request, the watchdog process starts. The watchdog process waits for the SC_AGENT_UNQUIESCE_TIMEOUT and unquiesces the application. If an unquiesce request is received by the agent, the watchdog process is terminated.





SC_AGENT_UNQUIESCE_TIMEOUT

Time in seconds

This optional setting specifies the timeout in seconds. If the communication with the agent is not possible and an application is in the quiesce state, the agent automatically returns the application into its normal mode of operation without communication from the server. If this setting is not set, then the unquiesce timeout is set to whatever the SC_AGENT_TIMEOUT is plus 5 seconds.

SC_TMP_DIR Y/N Allows you to use a user-defined, alternate temporary directory to store the Snap Creator related files. The user creates the directory and manages the user access. The plug-ins use temporary files to interact with the database. The temp files are created in the host’s default temp directory, which has write access to all the users. If the directory is full, Snap Creator displays an error while creating the temp files.

3.1.20 Plug-ins

Currently, Snap Creator supports the following applications: Oracle, DB2, and MySQL.

Table 16 - Plug-ins


APP_NAME oracle

db2

mysql

<plug-in>

Determines which application is being backed up. Snap Creator has built-in support for the listed applications. You can either use APP_NAME or configure APP_QUIESCE_CMDXX, APP_UNQUIESCE_CMDXX, and PRE_EXIT_CMDXX.

If the application is not directly supported in Snap Creator, you can use a plug-in or run your own application quiesce/unquiesce commands or scripts.

<PLUG-IN>:

Copy the plug-in to the /path/to/scServer|scAgent/plug-ins

directory and specify your plug-in in the APP_NAME parameter.

Commands or Scripts:

APP_QUIESCE_CMD01=/path/to/quiesceCMD

APP_UNQUIESCE_CMD01=/path/to/unquiesceCMD

PRE_EXIT_CMD01=/path/to/unquiesceCMD

APP_IGNORE_ERROR

Y/N Determines if Snap Creator should ignore errors from application plug-ins. This might be useful in a scenario where the user wants to back up multiple databases and does not want to stop the backup based on quiesce or unquiesce of single database failing.

APP_DEFINED_RESTORE

Y/N This setting enables application based restores. Snap Creator, in the event of a restore, sends a request to the application plug-in and the plug-in handles the request.

APP_AUTO_DISCOVERY

Y/N Enables application auto discovery. Snap Creator sends discover request to application plug-in and the plug-in is then responsible for the discovery of the storage configuration. This can be done dynamically or persistent with the APP_CONF_PERSISTENCE parameter if information is to be saved to the config file.

This parameter is similar to VALIDATE_VOLUMES but allows one through plug-in framework to add discover functionality to any application plug-in.

APP_CONF_PERSISTENCE

Y/N Enables auto discovery to be persistent, which means changes are dynamically updated in config file.

VALIDATE_ VOLUMES

DATA Snap Creator validates that all volumes where the database resides are part of the backup. Currently, there are some limitations. Only NFS is supported.

Currently, this option checks data files only for the supported databases.

Oracle plug-in

Oracle database is an enterprise database. The Oracle plug-in supports both Windows and UNIX systems. The Oracle plug-in only supports Oracle database10g™ or higher. The entire database is put into backup mode and that is only supported starting with Oracle10g. The Oracle plug-in uses SQL*Plus to communicate with the database.


Table 17 - Oracle options

Parameter Settings Description

APP_NAME oracle The application name.

ORACLE_DATABASES A list of Oracle Databases and the user name, that is, db1:user1;db2:user2.

SQLPLUS_CMD The path to the sqlplus command.

CNTL_FILE_BACKUP_DIR The path to the directory where the user should store backup control files (Oracle user must have permissions).

ORA_TEMP The path to a directory for storing temp file, that is, /tmp

(Oracle user must have permissions).

ARCHIVE_LOG_ONLY Y/N Informs Oracle Plug-in to only perform a switch log. This setting is useful if you are handling archive logs separate from data backup.

ORACLE_HOME The path to the oracle home directory

ORACLE_EXPORT_PARAMETERS

Y/N This parameter allows you to add export statement for assigning values to environment.

This is applicable only in UNIX or Linux based environment.

MySQL plug-in

MySQL is a popular database alternative to Oracle and SQL Server®. The MySQL plug-in supports both Windows and UNIX systems running MySQL 5.x. The MySQL plug-in uses Net-MySQL to communicate with the database.

Table 18 - MySQL options


APP_NAME mysql The application name.

MYSQL_DATABASES A list of MySQL database(s) and the username/password that is, db1:user1/pwd1;db2:user2/pwd2

HOST Name of the host where the databases are located, that is, localhost

PORTS Y/N A list of database(s) and the ports they are listening on, that is, db1:3307;db2:3308

MASTER_SLAVE Specifies the database(s) to be part of the MASTER/SLAVE environment.

DB2 plug-in

DB2 is a high-end database alternative to Oracle and SQL Server. The DB2 plug-in supports both Windows and UNIX systems running DB2 9.x. The DB2 plug-in uses the db2 command to

communicate with the database.

Table 19 - DB2 options


APP_NAME db2 The application name.

DB2_DATABASES A list of db2 database(s) and the username, that is, db1:user1;db2:user2

DB2_CMD The path used by the db2 command to interact with the database.

Note: For Windows, you must first give a path to db2cmd.exe

For example,

UNIX:

DB2_CMD=/opt/ibm/sqllib/bin/db2

Windows:

DB2_CMD=X:\IBM\SQLLIB\BIN\db2cmd.exe /c /w /i

X:\IBM\SQLLIB\BIN\db2.exe

Optional cloning for DB2 (UNIX)


Table 20 - Optional cloning for DB2 (UNIX)

Parameter Description

DB2INIDB_CMD Path to the db2inidb command. If not specified, sqllib/adm/db2inidb is

used.

DB2RELOCATEDB_CMD

Path to the db2relocatedb command. If not specified,

sqllib/bin/db2relocatedb is used.

DB2_CLONE_META source_sid: Database SID used on the source side

target_sid: Database SID used on the target side

target_db_path: Database path on the target side

target_os_user: DB2 instance owner on the target side

target_os_passwd: Group of DB2 instance owner

For example:

DB2_CLONE_META=PRD:QAS,/db2/QAS,db2qas/dbqasadm

DB2_CLONE_RELOCxx Relocation information for the db2relocatedb command, for example, cloning PRD to QAS

target_sid: Name of the target database

entry: Entry of the file containing the relocation information

For example:

DB2_CLONE_RELOC01=QAS:DB_NAME=PRD:QAS

DB2_CLONE_RELOC02=QAS:DB_PATH=/db2/PRD:/db2/QAS

DB2_CLONE_RELOC03=QAS:DB_INSTANCE=db2prd:db2qas

DB2_CLONE_RELOC04=QAS:LOG_DIR=/db2/PRD/log_dir,/db2/QAS/log_d

ir

DB2_CLONE_RELOC05=QAS:CONT_PATH=/db2/PRD/sap*,/db2/QAS/sap*

DB2_CLONE_RELOC_ FILE

Relocation information for the db2relocatedb command in an external file on the clone target


fqdn: Fully qualified file name containing the relocation information

Multiple target databases (and their relocation information) can be either specified with the DB2_CLONE_RELOC_FILE parameter, separated by a semicolon or by extending this parameter with a number (e. g. DB2_CLONE_RELOC_FILE01). A combination of both is allowed.

Note: If DB2_CLONE_RELOC_FILE and DB2_CLONE_RELOC## is specified for

the same database, DB2_CLONE_RELOC_FILE is used and DB2_CLONE_RELOC## is ignored.

DB2_CLONE_PARAMxx Target database specific configuration parameters


parameter=value: Parameter and value pair to be set on target side. Multiple pairs can be specified, separated by a comma.

For example:

DB2_CLONE_PARAM01=QAS:LOGARCHMETH1=DISK:/db2/QAS/logarch1,LOG

ARCHMETH2=DISK:/db2/QAS/logarch2

Archive log plug-in

The Archive log plug-in works for any database and is database independent. This plug-in does not communicate with the database. Its purpose is to delete archive logs that are older than the configured threshold value (in days).

Table 21 - Archive log options

Parameter Setting Description

ARCHIVE_LOG_ENABLE Y/N Enables archive log management (deletion of old archive logs).

ARCHIVE_LOG_RETENTION Numbers of days the archive logs are retained. Epoch time is used and is precise to the second.

ARCHIVE_LOG_DIR Path to the directory that contains the archive logs. Optionally, for multiple archive log directories, ARCHIVE_LOG_DIR<##> can be used.

ARCHIVE_LOG_EXT File extension of the archive logs, that is, if the archive logs are 10192091019.log, you would set this to ―log‖; the search pattern used is: <something>.<extension>


3.2 Snap Creator agent configuration

Snap Creator server access is the only parameter to be configured on the agent. By default, the Snap Creator server is not allowed to execute any commands or scripts on the agent. It has access only to the built-in application plug-ins. If PRE or POST commands or APP commands are required for mounting or any other operations, then those commands or scripts must be added to the

/path/to/scAgent_v<#>/config/agent.conf file. Regular expressions can be used to be more

restrictive. Each command or script should be added to the file as follows:

echo

/bin/mount

/path/to/myscript

In this example, the agent allows the Snap Creator server to run echo,/bin/mount, or

/path/to/myscript in addition to the application plug-ins. If the application plug-ins are not used

and the agent is required, run the application quiesce and unquiesce commands for application consistency.

^/bin/mount.*filer:/vol/cl_.* /mnt/

Additionally, the wildcard ―*‖ can be used to allow all commands but NetApp does not recommend it for security reasons.

3.3 Creating Windows services for Snap Creator

In Windows environment, daemons are typically controlled by services. You can configure a service to start, stop, or restart automatically or manually. Snap Creator can take advantage of a service for both the agent and server. This simplifies administration in a Windows environment. Because Snap Creator does not provide Windows services for these two components out-of-the-box, the Windows Resource Tool kit is required. For more information, see Microsoft KB article: http://support.microsoft.com/kb/137890.

3.3.1 Windows service for Snap Creator agent

Perform the following steps to create a Windows service for Snap Creator agent:

1. Install the Windows Resource Toolkit.

http://www.microsoft.com/downloads/en/details.aspx?FamilyID=9d467a69-57ff-4ae7-96ee-b18c4790cffd&displaylang=en

2. Run the instsrv command to create service.

instsrv "Snap Creator Agent"

"c:\ProgramFiles\WindowsResourceKits\Tools\srvany.exe"

3. Open registry and add a new key called ―Parameters‖ under

HKEY_LOCAL_MACHINE\SYSTEM\Services\Snap Creator Agent

4. Under the newly added parameters key, add a new string value type REG_SZ called

―Application‖. Modify the new Application string value and add the path to start the Snap Creator

agent ―C:\scAgent3.3.0\snapcreator.exe –start-agent 9090‖.

http://support.microsoft.com/kb/137890




5. Start the Snap Creator agent service.

Note: To remove Snap Creator agent service, run instsrv ―Snap Creator Agent‖ remove

command

3.3.2 Windows service for Snap Creator server

The Snap Creator server runs the GUI and backend derby database. This is optional but using the GUI adds value to manage Snap Creator configurations. Follow these steps to create a windows service for the Snap Creator server:

1. Install Windows Resource Toolkit.


2. Run the instsrv command to create service

instsrv "Snap Creator Server "

"c:\ProgramFiles\WindowsResourceKits\Tools\srvany.exe"

3. Open registry and add a new key called ―Parameters‖ under

HKEY_LOCAL_MACHINE\SYSTEM\Services\Snap Creator Server


―Application‖. Modify the new Application string value and add the path to start the Snap Creator

server ―java–jarsnapcreator.jar‖.


―AppDirectory‖. Modify the new AppDirectory string value and add the path to where the

snapcreator.jar file is located ―C:\scServer3.3.0\gui‖.

6. Start the Snap Creator Server service.

Note: To remove Snap Creator server service, run instsrv ―Snap Creator Server‖ remove

command




4 Running Snap Creator

This chapter explains how to run Snap Creator server and Snap Creator agent and the associated parameters.

4.1 Running Snap Creator server

NetApp recommends scheduling the Snap Creator server from the UNIX Cron, the Windows task manager, or the Snap Creator built-in GUI scheduler. The binary for the Snap Creator server and agent are the same; only the packaging is different.

Note: When scheduling through the Windows task manager, create a .bat file.

./snapcreator—profile <Config> --action <Action> --policy <Policy> <Optional

Arguments>

The following table lists the Snap Creator server parameters:

Table 22 - Snap Creator server parameters


--profile <Profile> The name of the profile should be the name you gave to the directory/file without the

.conf suffix. To create alternate config files under the same profile, use the —config

option.

list Displays all configs known to Snap Creator. Do not use ―list‖ as a profile name as it only displays configs.

For example:

./snapcreator—profile list

setup Runs the Snap Creator setup that configures both the GUI and Snap Creator itself.

For example:

./snapcreator—profile setup

--action <Action> (snap|clone_vol|clone_lun|clone_del|arch|quiesce|unquiesce|discover|restore|delete|snaplist|clonelist|pmsetup|ossv)

There are currently ten possible actions: create a Snapshot copy (snap), perform an OSSV backup (ossv), take a Snapshot copy as well as a volume clone (clone_vol), take a Snapshot copy as well as a LUN clone (clone_lun), handle only archiving for an application (arch),perform an interactive restore (restore), perform an interactive delete (delete), list Snapshot copies for a given policy (snaplist), list volume clones (clonelist), configure a Protection Manager data set (pmsetup).

snap Takes a Snapshot copy.

For example:

./snapcreator—profile <Profile> --action snap—policy <Policy>

<Optional Arguments>

ossv Uses OSSV to perform the backup; no Snapshot copy is created.

For example:

./snapcreator—profile <Profile> --action ossv—policy <Policy>


clone_vol Takes a Snapshot copy plus whatever else is configured and then uses that Snapshot copy to make a volume clone. This requires a FlexClone license. Once the volume is cloned, an IGROUP is mapped to all the LUNs that reside in the cloned volume using

the NTAP_CLONE_IGROUP_MAP option in the configuration file.

Note: The format of the volume clone names are as follows:

cl_<source volume>_YYYYMMDDhhmmss

./snapcreator—profile <Profile> clone_vol—policy <Policy>


If the SC_CLONE_TARGET parameter and the options necessary for the database clone

handling are set after cloning the volume, the database cloning is complete.



clone_lun Creates a Snapshot copy plus whatever else is configured and then uses that Snapshot copy to make a LUN clone of all LUNs that reside in the source volume. Once the LUNs are cloned, an IGROUP is mapped to all the cloned LUNs that reside in the source volume using the NTAP_CLONE_IGROUP_MAP option in the configuration file.

Note: Because there is a possibility that Snapshot copies can get locked by cloned LUNs, this is not a recommended method. However, this depends on whether the customer owns a FlexClone license. If the customer owns a FlexClone license, clone_vol, which uses FlexClone, should be used.

./snapcreator—profile <Profile> --action clone_lun—policy

<Policy> <Optional Arguments>

clone_del Deletes a volume clone(s) created by Snap Creator according to the volume clone settings defined in the configuration file. You can use this option to separate the clone delete workflow from that of clone create. Some third party integrations, such as BRTools by SAP, require separate clone create and delete workflows.

arch Provides archive log management functionality as a separate workflow based on application plug-in settings as defined by the config file. Snap Creator performs archive log management for a given application. The purpose of this action is to provide granularity allowing other tools to better integrate with Snap Creator. Additionally, this functionality allows for multiple application backup workflows that are required in certain virtualized environments.

For example:

./snapcreator—profile <Profile> --action arch <Optional

Arguments>

quiesce Provides quiesce functionality as a separate workflow based on application plug-in settings as defined by the config file. Snap Creator quiesces a given application. The purpose of this action is to provide granularity allowing other tools to better integrate with Snap Creator. Additionally, this functionality allows for multiple application backup workflows that are required in certain virtualized environments.

For example:

./snapcreator—profile <Profile> --action quiesce <Optional

Arguments>

unquiesce Provides unquiesce functionality as a separate workflow based on application plug-in settings as defined by the config file. Snap Creator unquiesces a given application. The purpose of this action is to provide granularity allowing other tools to better integrate with Snap Creator. Additionally, this functionality allows for multiple application backup workflows that are required in certain virtualized environments.

For example:

./snapcreator—profile <Profile> --action unquiesce <Optional

Arguments>

discover Provides discover functionality as a separate workflow based on application plug-in settings as defined by the config file. Snap Creator performs discovery for a given application. The purpose of this action is to provide granularity allowing other tools to better integrate with Snap Creator.

For example:

./snapcreator—profile <Profile> --action discover <Optional

Arguments>

scdump Collects all support information for NGS and places everything into a .zip file located under the root Snap Creator directory. Collected information consists of logs, config files, storage controller, OS, database (if applicable), and SnapDrive (if applicable) information.

For example:

./snapcreator—profile <Profile> --action scdump <Optional

Arguments>

restore Provides an interactive restore. You can perform a volume, file, or SnapVault restore. File restore is for LUNs. A volume restore is only recommended in case of a disaster. Otherwise, you should always recover files. For NAS, you can recover files by simply copying files out of the ~snapshot directory so that there is no need to handle NAS file restore with Snap Creator. A SnapVault restore restores a qtree on secondary storage back to primary storage either on its original or alternate location.

For example:

./snapcreator—profile <Profile> --action restore—policy <Policy>




delete Guides you through an interactive Snapshot delete menu for a given Snap Creator policy.

For example:

./snapcreator—profile <Profile> --action delete—policy <Policy>


snaplist Lists all Snapshot copies that are being managed by Snap Creator. It displays Snapshot copies on primary as well as secondary storage.

For example:

./snapcreator—profile <Profile> --action snaplist <Optional

Arguments>

clonelist Lists all volume clones that are being managed by Snap Creator. It shows volume clones on primary as well as secondary storage.

For example:

./snapcreator—profile <Profile> --action clonelist <Optional

Arguments>

dpstatus Shows detailed information about SnapVault or SnapMirror relationships.

For example:

./snapcreator—profile <profile> --action dpstatus

pmsetup Creates a Protection Manager Dataset for given config.

For example:

./snapcreator—profile <Profile> --action pmsetup <Optional

Arguments>

Note: After creating the Protection Manager (PM) dataset, you need to go into PM to

configure it. The configuration involves adding relationships and defining the protection policy.

--policy <Policy> The name of the Snapshot policy defined in NTAP_SNAPSHOT_RETENTIONS and possibly NTAP_SNAPVAULT_RETENTIONS. You can name the Snapshot policy whatever you want but it is important that the name you pass Snap Creator as—policy be exactly the same as defined in NTAP_SNAPSHOT_RETENTIONS as well

as possibly NTAP_SNAPVAULT_RETENTIONS if you are using SnapVault. You can also have as many of these as you want all with different retentions.

Note: If you use SnapDrive to create the Snapshot copies, use lowercase. SnapDrive

(at least Windows) cannot differentiate between uppercase and lowercase.

4.1.1 Optional parameters

The following table lists the optional parameters:

Table 23 - Optional parameters


--config Allows you to specify an alternate config file located under the

/path/to/scServer_v<#>/<Config> directory.

For example:

./snapcreator—profile <Profile> --action <Action> --policy

<Policy> --config <Alternate Config>

Note: This option is required when the profile

/path/to/scServer_v<#>/configs/<profile> and the config does not match

/path/to/scServer_v<#>/configs/<profile>/<config>.conf

--global Allows you to use a global config file. There are two possible global config files you can have.

Environment Global Config: configs/global.conf

Profile Global Config: configs/<profile>/global.conf

Parameters are loaded first from environment global, then the profile global, and finally your actual config file. Any duplicate parameters are overwritten by your actual config file.

For example:


<Policy> --config <Alternate Config> --global



--verbose Displays all logging information to STDOUT. This is an optional setting and is used mostly for testing and running Snap Creator manually.

For example:


<Policy> --config <Alternate Config> --verbose

--debug Displays all logging information to STDOUT and the log file. This is an optional setting and is for debugging problems.

For example:


<Policy> --config <Alternate Config> --verbose—debug

--version Prints the Snap Creator version.

For example:

./snapcreator –version

--cryptpasswd Encrypts a password for storing it in a config file.

For example:

./snapcreator—cryptpasswd

4.2 Running Snap Creator agent

The Snap Creator agent runs as a daemon on UNIX and Windows. The binary for the Snap Creator server and agent are the same; however the packaging is different.

The arguments are as follows:

./snapcreator –start-agent <port> <Optional Arguments>

Where:

start-agent <port>: Starts the Snap Creator agent daemon on the specified port. If no port is

specified, port 9090 is used.

<Optional arguments> are:

- --debug: Displays all logging information to STDOUT and the log file. This is an optional setting

and is for debugging problems.

Following is an example of the argument:

./snapcreator –start-agent <9090> --debug

Note: On UNIX, to start the agent automatically, use the /path/to/scAgent_v<#>/bin/scAgent

script. Windows does not have a start script.


5 Plug-in framework

The plug-in framework allows the user to create a new plug-in for Snap Creator or reuse existing plug-ins. The purpose of a plug-in is to provide Snap Creator with the steps for handling backup and recovery of a given application. The plug-in framework defines the following methods:

quiesce – Method for handling quiesce for a given application plug-in

unquiesce - Method for handling unquiesce for a given application plug-in

discover - Method for handling discovery of storage objects for a given application plug-in

scdump – Method for handling collection of support information, database, OS, and SnapDrive

restore - Method for handling restore for a given application plug-in (Cannot use build-in restore

CLI of Snap Creator)

restore_pre - Method for handling pre-restore operations for a given application plug-in (can use

built-in restore CLI of Snap Creator)

restore_post - Method for handling post-restore operations for a given application plug-in (can use

built-in restore CLI of Snap Creator)

clone_pre - Method for handling pre-clone operations for a given application plug-in

clone_post - Method for handling post-clone operations for a given application plug-in

The plug-in framework supports Perl as the programming.

The plug-in framework allows the user to implement objects and functions that exist within the

Snap Creator. For example, error handling is available, which means the plug-in can use the

standard implementation Snap Creator uses. This reduces the work required in order to create a

plug-in.

All plug-ins must be installed under /path/to/scServer|scAgent/plugins/<Plug-in>

and must be called <Plug-in>.pm. The plug-in must be installed where it is supposed to run. This

could be the Snap Creator server or Snap Creator agent depending on the setup of Snap Creator.

For more information about the plug-in framework, plug-ins, and a plug-in user guide, see the Snap Creator plug-ins community:

http://communities.netapp.com/community/products_and_solutions/databases_and_enterprise_apps/snapcreator/plug-ins

http://communities.netapp.com/community/products_and_solutions/databases_and_enterprise_apps/snapcreator/plugins

http://communities.netapp.com/community/products_and_solutions/databases_and_enterprise_apps/snapcreator/plugins


A. Appendix: Snap Creator examples

Snap Creator offers the flexibility to perform simple procedures such as creating a Snapshot copy as well as complex procedures such as SnapMirror destination volume. This section lists the examples of supported Snap Creator configurations.

A.1 NetApp Snapshot copy (always required)

This example uses Snap Creator to create a consistent Snapshot copy. As a Snapshot copy is the basis for all operations, all examples require the following settings.

Table 24 - Snapshot copy configuration

Configuration option Setting

SNAME Snapshot copy name

VOLUMES filer1:vol1,vol2,vol3

NTAP_USERS filer1:snapadm/mypassword

TRANSPORT HTTP

PORT 80

LOG_NUM 10

NTAP_PWD_PROTECTION N

NTAP_SNAPSHOT_RETENTIONS daily:7

Run Snap Creator with the following options:

./snapcreator—profile <Profile Name> --action snap --policy daily <Optional

Arguments>

These settings are always required. In this example, we have only created one retention policy set to daily, which retains seven Snapshot copies.

A.2 NetApp application-consistent backup

This example combines an application quiesce and unquiesce with a NetApp Snapshot copy.

Table 25 - Application-consistent backup configuration


APP_NAME oracle|db2|mysql|<plug-in>

APP_IGNORE_ERROR N

APP_DEFINED_RESTORE N

APP_AUTO_DISCOVERY N

APP_CONF_PERSISTENCE Y


./snapcreator—profile <Profile Name> --action snap --policy <Policy Name>


A.3 NetApp Snapshot copy and backup to tape

This example uses Snap Creator to create and clone a Snapshot copy, mount this clone, and then back up the mountpoint to tape using third-party backup software.


Table 26 - Snapshot copy and backup to tape configuration


NTAP_CLONE_FOR_BACKUP Y

NTAP_CLONE_SECONDARY N

NTAP_CLONE_IGROUP_MAP filer1:src_volume1/igroup1

NTAP_VOL_CLONE_RESERVE none

NTAP_NUM_VOL_CLONES 1

NTAP_LUN_CLONE_RESERVATION false

PRE_NTAP_CLONE_DELETE_CMD1 Mount script or SnapDrive command

PRE_NTAP_CLONE_DELETE_CMD2 CLI command to start backup of mountpoint

To clone a volume, run Snap Creator with the following options:

./snapcreator—profile <Profile Name> --action clone_vol --policy <Policy

Name> <Optional Arguments>

To clone a LUN, run Snap Creator with the following options:

./snapcreator—profile <Profile Name> --action clone_lun --policy <Policy


A.4 NetApp backup to disk (OSSV)

This example uses the OSSV client to perform a SnapVault update or create a Snapshot copy on the secondary storage.

Table 27 - OSSV configuration


NTAP_OSSV_ENABLE Y

NTAP_OSSV_HOMEDIR /usr/snapvault

NTAP_OSSV_FS_SNAPSHOT N


./snapcreator –profile <Profile Name> --action ossv --policy <Policy Name>


A.5 NetApp Snapshot copy and backup to disk (SnapVault)

This example uses Snap Creator to create a Snapshot copy, perform a SnapVault update, and create a Snapshot copy of the SnapVault secondary.

Table 28 - Snapshot copy and backup to disk configuration


SNAPVAULT_VOLUMES filer1:vol1,vol2,vol3

NTAP_SNAPVAULT_RETENTIONS Daily:30

NTAP_SNAPVAULT_RETENTION_AGE 30

NTAP_SNAPVAULT_MAX_TRANSFER kbps or blank

NTAP_SNAPVAULT_UPDATE Y

NTAP_SNAPVAULT_WAIT minutes

NTAP_SNAPVAULT_NODELETE N





A.6 NetApp Snapshot copy and backup to disk (SnapMirror)

This example uses Snap Creator to create a Snapshot copy and perform a SnapMirror update.

Table 29 - Snapshot copy and backup to disk configuration


SNAPMIROR_VOLUMES filer1:vol1,vol2,vol3

NTAP_SNAPMIRROR_USE_SNAPSHOT Y

NTAP_SNAPMIRROR_MAX_TRANSFER kbps or blank

NTAP_SNAPMIRROR_UPDATE Y




A.7 NetApp Snapshot copy and database refresh (primary)

This example uses Snap Creator to create and clone a Snapshot copy.

Table 30 - Snapshot copy and database refresh configuration



NTAP_CLONE_IGROUP_MAP filer1:src_volume1/igroup1


NTAP_LUN_CLONE_RESERVATION false

NTAP_NFS_EXPORT_HOST hostname

NTAP_NFS_EXPORT_ACCESS root

NTAP_NFS_EXPORT_PERSISTENT true

POST_NTAP_CMD1 Mount Script or SnapDrive command to mount clone

POST_NTAP_CMD2 CLI command or script to start cloned database

To clone a volume, run Snap Creator with the following options:



To clone a LUN, call Snap Creator with the following options:

./snapcreator—profile <Profile Name> --action clone_lun --policy <Policy


A.8 NetApp Snapshot copy and database refresh (secondary)

This example uses Snap Creator to create a Snapshot copy, perform a SnapMirror update, and clone the SnapMirror destination volume.

Table 31 - Snapshot copy and database refresh configuration


SNAPMIROR_VOLUMES filer1:vol1,vol2,vol3

NTAP_SNAPMIRROR_USE_SNAPSHOT Y

NTAP_SNAPMIRROR_MAX_TRANSFER kbps or blank

NTAP_SNAPMIRROR_UPDATE Y

NTAP_CLONE_SECONDARY_VOLUMES filer1:filer1-sec/vol1,vol2,vol3

NTAP_CLONE_SECONDARY Y



NTAP_NUM_VOL_CLONES 1



NTAP_NFS_EXPORT_HOST hostname

NTAP_NFS_EXPORT_ACCESS root

NTAP_NFS_EXPORT_PERSISTENT true

POST_NTAP_CMD1 Mount script or SnapDrive command to mount cloned

POST_NTAP_CMD2 CLI command or script to start cloned database

For volume clone, run Snap Creator with the following options:



A.9 NetApp Snapshot copy and Protection Manager update

When using Snap Creator to create a Snapshot copy, register the Snapshot copy with Protection Manager and then use Protection Manager to manage SnapVault or SnapMirror.

Table 32 - Snapshot copy and Protection Manager configuration


NTAP_PM_UPDATE Y

NTAP_DFM_DATA_SET filer1:dataset1/vol1,vol2;filer1:dataset2/vol3

NTAP_SNAPSHOT_NODELETE Y

NTAP_PM_RUN_BACKUP Y


./snapcreator –profile <Profile Name> --action snap --policy <Policy Name>


Note: Both Operations Manager and Protection Manager are required. Additionally, you must configure a dataset created by Snap Creator within Protection Manager and create a schedule for that dataset (secondary). Snap Creator or PM can delete primary Snapshot copies. Protection Manager manages all secondary Snapshot copies and their retentions.


B. Appendix: Troubleshooting

This appendix provides basic troubleshooting information and a description of error messages in Snap Creator.

B.1 Logs

Snap Creator writes to several logs. The three logs for every profile and configuration are as follows:

Out

Debug

Error

The out and debug logs are retained as defined by the LUG_NUM value in the configuration file while the

error log is always appended. All logs are written to the

/path/to/scServer_v<#>/logs/<profile> directory.

B.1.1 Out log

The out or output log contains information about everything Snap Creator does. Messages can be INFO, CMD, OUTPUT, DEBUG, WARN, or ERROR. Anything with INFO is considered to be a standard, normally occurring operation. Anything with CMD is an external command or script that Snap Creator runs (according to configuration) and the return code from the command or script is logged. Typically, these are PRE, POST, or APP Quiesce/Unquiesce commands. Anything with OUTPUT is a Data ONTAP API call. Anything with DEBUG is debug information. Anything with WARN is considered to draw your attention, but, again under normal circumstances, it is considered to be normal activity and should require no action (an example is when we delete Snapshot copies). Anything with ERROR is a problem and most likely requires manual action to fix the error. Snap Creator exits on any ERROR, so it is important to fix whatever problem occurred before it runs again. Snap Creator does not automatically

fix problems but you can specify Creator what to do before exiting by using the PRE_EXIT_CMD

defined in the configuration file.

B.1.2 Debug log

The debug log contains the output from any external commands or scripts run by Snap Creator, for example, SnapDrive. If you call other scripts through Snap Creator, it is important that you properly set up exit codes and output for those scripts. You should never exit with status 0 if a problem occurs.

B.1.3 Error log

The error log contains a history of all the ERROR events for a given configuration. The error log helps in viewing information about of errors that occurred in the past so you can correlate things better and get a historical perspective. You can also monitor this log file and use it as a means to integrate Snap Creator with your monitoring application.

B.1.4 Snap Creator agent

The Snap Creator agent does not create any log files. If problems occur while running in the

client/server mode, start the agent in the debug mode to print debug messages on stdout.

The debug can be enabled by specifying the additional --debug option:

/path/to/scAgent_v<#>/bin/scAgent --debug

B.2 SCDUMP

Snap Creator collects all support information using scdump and places it into a .zip file located under

the root Snap Creator directory. This information is useful for troubleshooting. The .zip file consists of the following items:

Snap Creator version (build info, date, and so on)


Host OS and architecture

Database and version

SnapDrive version

Other environment variables

The syntax for SCDUMP is as follows:

./snapcreator.pl --profile <profile> [--config <config>] --action scdump --

verbose

B.3 Networking

When authorization failures occur with Snap Creator, verify the configuration, firewall permissions, and network address translation (NAT).

B.3.1 IP/Hostname

Unless you use host equiv, the storage system name returned from the hostname command on

the controller should be the same as the one entered in the Snap Creator config file.

Do not use an FQDN when the hostname of a storage system is abbreviated.

Make sure that the IP resolution matches the name you specified. If there is a mismatch, correct it by

using host equiv on the storage system.

To enable host equiv, perform the following steps:

1. Enter the following command:

options httpd.admin.hostsequiv.enable on

2. Edit the /etc/hostsequiv file and add the following:

<IP/Name of host in SnapCreator config> <SnapCreator user>‖

B.3.2 Protection Manager

The storage controller name defined in the Snap Creator config parameter VOLUMES must match 1:1 with the storage controller name in Protection Manager. If they do not match, you can use the operating systems host file to force things to match 1:1.

B.3.3 Firewall

If there is a firewall between the host running Snap Creator and your NetApp storage system, make sure you have ACLs (bidirectional) open for 80, 443, or both.

80: Used to communicate with NetApp storage system if http is selected.

443: Used to communicate with NetApp storage system if https is selected.

If the agent is running, the port on which the agent is running must be open. Make sure the return traffic from the storage system is allowed to go to the system running Snap Creator on at least non-privileged ports.

B.3.4 NAT

If you use NAT, make sure the source/destination IP addresses are not changed in the TCP packet. The host and storage systems need to know who they are talking to. Presenting a firewall IP instead of the actual host or controller IP might cause problems.

B.3.5 HTTPS

To use HTTPS (443) for Linux, Solaris, or AIX, install the openssl-devel RPM. This RPM contains

the openssl libraries, which are required to use SSL.


B.4 Exit codes

The Snap Creator Server does not receive any requests except from a server, instead the CLI interface (Snap Creator) is executed. This can be executed from CLI or through GUI, the GUI simply runs the CLI in the background. The Snap Creator Server will either produce a success message or a failure message based on an action. It will return the following exit codes:

The following table lists the exit codes with their description:

Table 33 - Exit codes

Exit code Description

0 Success

1 Error in Framework (Snap Creator Server)

2 Error in Plug-in (Snap Creator Agent)

B.5 Error messages

This section lists the error messages that occur in Snap Creator. A description of the error message and resolution is also provided.

B.5.1 CLI error messages

The following table describes the Snap Creator CLI error messages and possible resolutions:

Table 34 - CLI error messages

Error message Explanation Resolution

ERROR: Could not Create directory <DIR> Snap Creator error.

Unable to create directory due to lack of sufficient permissions.

Check the directory permissions and ensure that they are read/write.

ERROR: Application environment set for plug-in <Plug-in> encountered errors

Plug-in error.

Only Oracle, DB2 or MySQL plug-ins are supported.

If the <Plug-in> is not Oracle, DB2, or MySQL, then it is not supported by NetApp Support.

ERROR: Could not redirect STDERR to <debug log file> Snap Creator error.

Unable to create the Snap Creator debug log file.

Make sure the logs/<profile> directory has write permission for the Snap Creator to create the debug log.

ERROR: The action <Action> is not supported with OSSV, Exiting!

Snap Creator error.

This action is not supported with OSSV.

OSSV integration does not support specified <Action>



ERROR: This type of restore requires SNAP_TIMESTAMP_ONLY=Y and

NTAP_CONSISTENCY_GROUP_SNAPSHOT=Y

Snap Creator error.

The action –restore_alt requires both the parameters to be set for the Snap Creator to perform restore operation. The Consistency Group Snapshot copies must have the same timestamp. When we rename Snapshot copies for _recent, the timestamps might be off. The SNAP_TIMESTAMP_ONLY=Y ensures that _recent snapshot names are not used and therefore renaming Snapshot copies is avoided.

Set the parameters SNAP_TIMESTAMP_ONLY=Y and

NTAP_CONSISTENCY_GROUP_SNAPSHOT=Y for future backups. Current backups can only be manually restored directly from the storage controller.

ERROR: NetApp Cloned LUN igroup Map of <lun clone> to igroup <igroup> on <filer> failed! Exiting

Snap Creator error.

Snap Creator could not map LUN clone to an igroup.

Ensure that igroup exists and that the NTAP_CLONE_IGROUP_MAP is configured correctly in the config file.

ERROR: NetApp PM backup list is not defined; no Backups for dataset <dataset> exist! Exiting

Snap Creator error.

No dataset exists in Protection Manager.

Ensure dataset is configured correctly in Protection Manager (―snapcreator –profile <profile> --action pmsetup‖ to create dataset), it must have primary/secondary resources assigned. Make sure NTAP_DFM_DATA_SET is configured correctly in config file.

ERROR: NetApp PM backup list end for dataset <dataset> failed! Exiting

Snap Creator error.

Could not complete the process of listing datasets. This could be due to an API error or a communication error while talking to Operations Manager.

This indicates a configuration issue in Protection Manager dataset. Check to make sure the dataset is conformant and has an associated protection policy. Re-run the backup after the dataset is displayed as conformant.

ERROR: Protection Manager dataset List for dataset <dataset> is undefined, check you dataset in Protection Manager! Exiting

Snap Creator error.

Unable to find the dataset.

Ensure that the dataset exists in Protection Manager and was created by Snap Creator.

ERROR: Protection Manager dataset <dataset> was not created by Snap Creator, please create dataset from within Snap Creator!

Snap Creator error.

Dataset not supported as it is not created by Snap Creator.

Only datasets created by Snap Creator are supported.



ERROR: Protection Manager dataset <dataset> is <conformant status>, Exiting!

Snap Creator error. Protection manager issue. The dataset is not conformant and Snap Creator does not allow backup to proceed until it is conformant.

Check to make sure the dataset is conformant and has an associated protection policy. Re-run the backup after the dataset is displayed as conformant.

ERROR: No NetApp Volumes on <filer> found! Exiting Snap Creator error.

No volumes exist on the storage system.

Verify and ensure that the VOLUMES and NTAP_USERS parameters are configured correctly in config file.

ERROR: NetApp SnapMirror Source VFiler <vFiler> and VFiler specified in config <vFiler> do not match! Exiting

Snap Creator error.

The VFiler specified in the config file and the SnapMirror source VFiler does not match.

Ensure that the correct vFiler entry is configured for vFilers in config file. The VFilers parameter is required only for enabling VFiler tunneling. Do not use this parameter for Data ONTAP 7.3 and later versions. Add vFiler name to VOLUMES and NTAP_USERS parameters for the vFiler to be treated as a normal physical storage system by the Snap Creator.

ERROR: NetApp Snapmirror Source Filer <filer or vFiler> and filer specified in config <filer or vFiler> don't match! Exiting

Snap Creator error.

The storage system specified in the config file and the SnapMirror source storage system do not match.

To use SnapMirror in Snap Creator, set the SNAPMIRROR_VOLUMES, verify the correct storage system, and configure the volumes. Ensure that the primary storage and volumes are added to SNAPMIRROR_VOLUMES and not the secondary storage.

ERROR: SnapMirror for <filer> is not enabled; please enable SnapMirror on <filer>! Exiting

Snap Creator error.

SnapMirror not enabled.

Ensure that SnapMirror is enabled on storage system through Data ONTAP and that SNAPMIRROR_VOLUMES as well as NTAP_SNAPMIRROR_UPDATE=Y are configured in config file.

ERROR: No SnapMirror relationship for <filer:volume> exist! Exiting

Snap Creator error. SnapMirror relationship not found for the given source volume. Snap Creator does not create or manage SnapMirror relationships.

Verify and create the SnapMirror relationship if it does not exist.



ERROR: NetApp SnapVault Source Filer <filer or vFiler>and filer specified in config <filer or vFiler> don't match! Exiting

Snap Creator error. SNAPVAULT_VOLUMES must be set to use SnapVault in Snap Creator.

Verify the storage system in the config file and check if the volumes are configured. Primary storage and volumes must be added to SNAPVAULT_VOLUMES and not the secondary storage.

ERROR: NetApp SnapVault Source VFiler <vFiler> and vFiler specified in config <vFiler> don't match! Exiting

Snap Creator error. SNAPVAULT_VOLUMES must be set to use SnapVault in Snap Creator.

Verify the storage system in the config file and check if the volumes are configured. Primary storage and volumes must be added to SNAPVAULT_VOLUMES and not the secondary storage. As vFiler tunneling is in use, the VFilers parameter in the config file must be configured to map vFiler/volume to the physical storage system.

ERROR: No SnapVault relationship for <filer:volume> exist! Exiting

Snap Creator error.

No SnapVault relationships are found for the given storage system and volume.

Ensure that VOLUMES and SNAPVAULT_VOLUMES are configured correctly in the config file. As Snap Creator does not manage or create SnapVault relationships, ensure that the correct relationship exists.

ERROR: NetApp SnapVault Status is undefined; check your configuration for <filer>! Exiting

Snap Creator error.

Unable to retrieve SnapVault status. No SnapVault relationships are found on the storage system.

Snap Creator does not create or manage SnapVault relationships; ensure that the correct relationship exists.

ERROR: NetApp SnapMirror Update on source <filer:volume> failed to complete in <minutes as defined in config> minutes, Exiting!

Snap Creator error.

The SnapMirror update started but failed to complete in the time specified as NTAP_SNAPMIRROR_WAIT in the config file.

Increase the timeout value in the config file or identify the reason why the SnapMirror update takes a long time.

ERROR: SnapMirror transfer Error detected - <xfer error>! Exiting

Snap Creator error. SnapMirror transfer failed due to a transfer error.

This could be a network issue. Check the storage system to identify the reason and continue troubleshooting.

ERROR: NetApp SnapVault Update on source <filer:volume> failed to complete in NTAP_SNAPVAULT_WAIT' minutes, Exiting

Snap Creator error.

The SnapVault update started but failed to complete in the time specified as NTAP_SNAPVAULT_WAIT in config file.

Increase the timeout value in the config file or identify the reason why the SnapVault update takes a long time.



ERROR: SnapVault transfer Error detected - <xfer error>! Exiting

Snap Creator error. SnapVault transfer failed due to a transfer error.

Could be a network issue. Check the storage system to identify the reason and continue troubleshooting.

ERROR: You have selected snapshot <snapshot> for deletion but it has a dependency <dependency>, Exiting!

Snap Creator error.

This can occur if NTAP_SNAPSHOT_DEPENDENCY_IGNORE=N is set in the config file. Snapshot copies with dependency can be deleted only when this parameter is set to ―Y‖.

If you want to delete a snapshot copy, even though it has a dependency, then set NTAP_SNAPSHOT_DEPENDENCY_IGNORE=Y in the config file and try deleting it.

ERROR: Couldn't open directory <dir> Snap Creator error. Unable to open directory.

Check the directory permissions and ensure that it has write permission.

ERROR: Couldn't access the directory <dir>

Snap Creator error

Unable to access directory.

Check the directory permissions and ensure that it has write permission.

ERROR: Missing Required option –profile Snap Creator error.

This is a user error. --profile option is required.

Add the –profile CLI parameter.

ERROR: Missing Required option –action Snap Creator error.

This is a user error. --action option is required.

Add the –action CLI parameter.

ERROR: Invalid option for --action, use snap|ossv|clone_lun|clone_vol|clone_del|restore|delete|snaplist|clonelist|dpstatus|pmsetup|arch|quiesce|unquiesce|discover|scdump

Snap Creator error. The option given for –action is invalid.

Use an action that is valid.

ERROR: Missing Required option –policy Snap Creator error.

This is a user error. --policy is required for this operation.

Add the –policy CLI parameter.

ERROR: Config File <config file> not found Snap Creator error.

Config file not found as it does not exist or the permissions are not set properly.

Ensure that the config file exists and the read/write permissions are set properly.

ERROR: Couldn't open FileHandle for <filer>

Snap Creator error.

Unable to open file.

Ensure that the read/write permissions are set properly.

ERROR: PORT is a required parameter and was not defined, please check your configuration file!

Snap Creator error.

PORT parameter is not defined in the config file.

Specify the value for PORT parameter in the config file.

ERROR: TRANSPORT is a required parameter and was not defined; please check your configuration file!

Snap Creator error. TRANSPORT parameter not defined in the config file.

Specify the value for TRANSPORT parameter in the config file.



ERROR: LOG_NUM is a required parameter and was not defined; please check your configuration file!

Snap Creator error. LOG_NUM parameter not defined in the config file.

Specify the value for LOG_NUM parameter in the config file.

ERROR: NTAP_PWD_PROTECTION is a required parameter and was not defined; please check your configuration file!

Snap Creator error. NTAP_PWD_PROTECTION parameter not defined in the config file.

Specify the value for NTAP_PWD_PROTECTION parameter in the config file.

ERROR: NTAP_USERS is a required parameter and was not defined; please check your configuration file!

Snap Creator error. NTAP_USERS parameter not defined in the config file.

Specify the value for NTAP_USERS parameter in the config file.

ERROR: VOLUMES is a required parameter and was not defined, please check your configuration file!

Snap Creator error. VOLUMES parameter not defined in the config file.

Specify the value for VOLUMES parameter in the config file.

ERROR: SNAME is a required parameter and was not defined; please check your configuration file!

Snap Creator error. SNAME parameter not defined in the config file.

Specify the value for SNAME parameter in the config file.

ERROR: Invalid application plug-in (<plug-in>supported applications are oracle|db2|mysql

Plug-in error.

Invalid Plug-in. The plug-in is not an Oracle, DB2 or MySQL plug-in.

Also, the plug-in is not found in /plug-ins/<plug-in>/<plug-in>.pm.

Check the APP_NAME parameter in the config file. Ensure that there is no typo error and the plug-in exists. The App_Name parameter is case sensitive.

ERROR: Discovering for <plug-in> failed with return code <return> and message <message>

Plug-in error. Discovery of the plug-in failed.

If the plug-in is not an Oracle, DB2 or MySQL plug-in, then the discovery might fail. Discovery can fail due to many reasons. To disable discovery set APP_AUTO_DISCOVERY=N and set VALIDATE_VOLUMES= or comment out VALIDATE_VOLUMES.

For NFS (UNIX), as df –k is used; therefore check the debug output to identify the cause. It could be a SnapDrive issue for LUNs as it is managed using SnapDrive.

ERROR: Application quiesce for plug-in <plug-in>encountered errors

Plug-in error. quiesce failed.

If the plug-in is not an Oracle, DB2, or MySQL plug-in, then it is not supported by NetApp Support. Check the debug logs to identify why quiesce fails.

ERROR: Application unquiesce for plug-in <plug-in> encountered errors

Plug-in error. unquiesce failed.

If the plug-in is not an Oracle, DB2, or MySQL plug-in, then it is not supported by NetApp Support. Check the debug logs to identify why unquiesce fails.



ERROR: Could not write to file <file>

Unable to create the file.

Ensure that the file has the correct permissions or the directory has read/write permissions.

ERROR: Password does not match Snap Creator error.

Occurs during the ―—profile setup‖.

Password entered for GUI does not match.

Re-enter the password.

ERROR: Application quiesce for plug-in FOO failed with exit code 100, Exiting

Plug-in error.

Configuration file locked

Unlock configuration file manually by running the following command:

--action

unquiesce

ERROR: Another quiesce operation or watchdog is already running on this config

Snap Creator error

This error means that a quiesce operation is in progress or that it is complete but no unquiesce requests was received

Run an unquiesce. This can be done manually using the following command: snapcreator --

profile <profile>

--action

unquiesce –

verbose

ERROR: Either no quiesce operation performed or forced unquiesce operation already triggered from watchdog, backup might not be useable

This error means that no quiesce operation was received before performing unquiesce. This can be result of a forced unquiesce being triggered from agent or by never running a quiesce first. If we do not have an running quiesce operation, there is no need to try the unquiesce

The application is not in a quiesced state or in backup mode. This could indicate a forced unquiesce. If a forced unquiesce occurred, determine the reason why and re-run the backup.

ERROR: Forced unquiesced possibly triggered from watchdog

This error means that the watchdog process might have done a force unquiesce. This can happen when the SC_AGENT_UNQUIESCE_TIMEOUT is reached before the server sends a normal unquiesce. It can also be caused by running Back-to-back unquiesce requests.

If this occurs within a backup, then determine why the forced unquiesce is being triggered and re-run the backup.

B.5.2 GUI error messages

The following table describes the error messages that occur in the GUI and possible resolutions:


Table 35 - GUI error messages


Unable to decrypt password Unable to decrypt the storage system password due to an unsupported cipher usage.

Indicates an error in the Snap Creator backend. Check gui/etc/snapcreatorgui.conf

or re-run snapcreator –profile

setup to configure the GUI

correctly.

Unable to encrypt password Unable to encrypt the Storage system password.

Indicates an error in the Snap Creator backend. Check /etc/snapcreatorgui.conf or

re-run snapcreator –profile

setup to configure the GUI

correctly. You can also manually encrypt as password using the following CLI command: snapcreator –cryptpasswd.

Unable to get a list of log files Unable to retrieve the log files list as the log or corresponding profile folder does not exist.

Could be a permission issue. Check permissions in the Snap Creator root directory and logs directory.

Unable to find profiles path Unable to find <Snap creator home>/logs/<profilename>

This could indicate that a backup was never run. The profile directory gets created upon the first run of a backup. Retry after running a backup.

Unable to load configuration file Configuration file for this profile does not exist

This is most likely a permission issue. Check permissions for the Snap Creator root directory and configs directory.

snapcreator.conf file not found snapcreatorgui.conf file not found

under <Snap creator home>/gui/etc

This is most likely a permission issue. Check permissions for the

Snap Creator gui/etc directory.

Unable to update configuration file

Unable to update this configuration file as it was either deleted or renamed.

This is most likely a permission issue. Check permissions for the Snap Creator root directory and configs directory.

Invalid username or password Login failed either due to an incorrect user name/password or the --profile setup is not completed.

Verify the GUI password is correct in the /gui/etc/snapcreatorgui.conf

file and the storage controller username/password in the NTAP_USERS parameter in the config file.

Unable to delete file Unable to delete profile folder or config file. File does not exist or does not have the permission to perform the operation.

This is most likely a permission issue. Check permissions for the Snap Creator root directory.

Unable to rename file Unable to rename profile folder or config file. File does not exist or does not have the permission to perform the operation.


Directory exists - Cannot create a new profile

The profile with the same name already exists.

The profile already exists; profile names must be unique.

Unable to find configs directory containing the profiles

Unable to find <Snap Creator home>/configs folder


Unknown failure. Check service logs for more details

Unexpected error or Runtime Exception. Check the log for details.

Check the GUI log file snapcreatorgui.log in the

gui/logs/ directory.

Snap Creator Framework 3 3 0 Installation

Documents

Transcript of Snap Creator Framework 3 3 0 Installation