snap creator

Upload: hemarao2250

Post on 30-Oct-2015

316 views

Category:

Documents


0 download

TRANSCRIPT

  • NetApp Snap Creator Framework 3.5.0 Installation and Administration Guide

    NetApp, Inc.495 East Java DriveSunnyvale, CA 94089 USATelephone: +1 (408) 822-6000Fax: +1 (408) 822-4501Support telephone: +1 (888) 4-NETAPPDocumentation comments: [email protected] Web: http://www.netapp.com

    Part number: 215-06466_A012 January 2012

  • Contents

    Snap Creator overview ................................................................................ 7Architecture of Snap Creator ....................................................................................... 7

    New features of Snap Creator ..................................................................... 9Security features of Snap Creator ............................................................ 11Snap Creator Integration .......................................................................... 15Snap Creator Policies ................................................................................. 17What Snap Creator Agent is ..................................................................... 19Snap Creator Agent Multithreading ........................................................ 21Preparing to install Snap Creator ............................................................. 23

    Downloading Snap Creator software ........................................................................ 23Creating a Data ONTAP user .................................................................................... 23Installing Java on Snap Creator Server ..................................................................... 24Pre-installation steps for Domino plug-in ................................................................. 24

    Linux/Solaris/AIX specific settings .............................................................. 25Pre-installation steps for Domino plug-in on Windows ................................ 25

    Installing Snap Creator on Windows ....................................................... 27Installing Snap Creator on UNIX ............................................................. 29

    Installing Snap Creator Server .................................................................................. 29Installing Snap Creator Agent ................................................................................... 30

    Uninstalling Snap Creator from Windows .............................................. 31Upgrading Snap Creator ........................................................................... 33

    Upgrading from Snap Creator 3.4.0 .......................................................................... 33Upgrading from Snap Creator 3.3.0 .......................................................................... 34Upgrading Snap Creator GUI .................................................................................... 35

    Information required to configure Snap Creator ................................... 37Oracle plug-in ............................................................................................................ 41MySQL plug-in ......................................................................................................... 42DB2 plug-in ............................................................................................................... 42VMware (VIBE) plug-in ........................................................................................... 43

    vCloud vApp backup and restore using VMware plug-in ............................. 45VM backup and restore using VMware plug-in ............................................ 46

    Sybase plug-in ........................................................................................................... 46

    Table of Contents | 3

  • MaxDB plug-in ......................................................................................................... 49Lotus Domino plug-in ............................................................................................... 51SnapManager for Microsoft Exchange plug-in ......................................................... 53SnapManager for Microsoft SQL Server plug-in ...................................................... 54Archive log plug-in ................................................................................................... 55

    Configuring Snap Creator Server ............................................................. 57Creating a configuration file using CLI .................................................................... 57Creating a configuration file using GUI .................................................................... 57Referencing ............................................................................................................... 58

    Snap Creator Agent configuration ........................................................... 85Snap Creator Backup process ................................................................... 87

    List of commands ...................................................................................................... 87Running Snap Creator Server using CLI ................................................ 89Running Snap Creator Agent using CLI ................................................. 99Running Snap Creator using GUI .......................................................... 101

    Creating a schedule ................................................................................................. 101Creating multiple users ............................................................................................ 102Job monitoring ......................................................................................................... 103Viewing data and log details ................................................................................... 103

    Performing restore using Snap Creator ................................................. 105Performing Volume restore ..................................................................................... 105Performing Single file restore ................................................................................. 106Performing VMware restore .................................................................................... 106Performing restore with Domino plug-in ................................................................ 107

    Performing Volume restore for Domino using CLI .................................... 108Performing Volume restore for Domino using GUI ................................... 109Performing Single file restore for Domino using CLI ................................ 109Performing Single file restore for Domino using GUI ................................ 111

    Using the Plug-in Framework to create custom plug-ins ..................... 113Troubleshooting Snap Creator issues ..................................................... 115

    Logs ......................................................................................................................... 115Troubleshooting Snap Creator GUI error ................................................................ 117Troubleshooting Network issues ............................................................................. 118Error messages ........................................................................................................ 119

    Snap Creator examples ............................................................................ 189Copyright information ............................................................................. 195

    4 | Snap Creator 3.5.0 Installation and Administration Guide

  • Trademark information ........................................................................... 197How to send your comments .................................................................... 199

    Table of Contents | 5

  • 6 | Snap Creator 3.5.0 Installation and Administration Guide

  • Snap Creator overview

    Snap Creator is a backup and recovery software solution that enables you to integrate Snapshottechnology with any application that is not supported by SnapManager products.

    Snap Creator is platform and operating system independent. It provides application integrationthrough plug-ins that enable it to support any application on a storage system. Snap Creator uses theplug-ins to handle quiesce and unquiesce actions for a given application or database.

    Snap Creator supports application plug-ins for Oracle, DB2, MySQL, Sybase ASE (Sybase), LotusDomino (Domino), SnapManager for Microsoft SQL Server, SnapManager for Microsoft Exchange,MaxDB, and VMware (vSphere and vCloud Director). Additional application plug-ins are availablethrough the Snap Creator Community.

    Snap Creator provides a management interface for Snapshot technology, SnapVault, Open SystemsSnapVault, SnapMirror, Protection Manager, Operations Manager, and FlexClone technology.

    Architecture of Snap CreatorSnap Creator consists of a server and agent layer. The GUI, configuration, and CLI reside in theserver layer. The agent runs remotely or locally and allows the Snap Creator Server to send quiesceor unquiesce operations to a given database.

    The communication layer from the agent to the server is Simple Object Access Protocol (SOAP) overHTTP.

    The following illustration shows the Snap Creator architecture:

    7

  • 8 | Snap Creator 3.5.0 Installation and Administration Guide

  • New features of Snap Creator

    Snap Creator 3.5.0 introduces new features such as support for MaxDB plug-in, GUI support formultiple users.

    The following are the new features:

    Compatibility with Data ONTAP 8.1 Cluster-Mode and 7-Mode Data ONTAP 8.1 Cluster-Mode support for the following plug-ins:

    Oracle DB2 Domino Sybase MaxDB MySQL VMware

    Enhancements to Domino plug-in

    Support for IBM-AIX (64-bit) Ability to disable replication Up to the minute restore No log option

    Open Systems SnapVault support with Snap Creator Agent Support for recursive archive log deletion within subdirectories DataFabric Manager server proxy through GUI GUI support for job monitoring Ability to set all configuration parameters through GUI UNIX services GUI support for Data ONTAP 8.1 Cluster-Mode

    GUI prompts the user to enter cluster credentials if it discovers that the storage system detailsentered are of a Cluster-Mode Vserver.

    GUI detects SnapMirror relationships and prompts the user to enter destination Vserver andcluster authentication details.

    Users can see volume, volume clone, and Snapshot data for Cluster-Mode configurations.

    EMS logging for ASUP data mining Cluster-Mode EMS logging for ASUP data mining Operating system or File System plug-in

    9

  • 10 | Snap Creator 3.5.0 Installation and Administration Guide

  • Security features of Snap Creator

    Snap Creator provides security features, such as RBAC for Storage controller, Host security for SnapCreator Agent, and RBAC for Snap Creator users through GUI.

    RBAC for Storage controllerIf you are not using DataFabric Manager server proxy, you need a user name and password tocommunicate with storage controllers. Passwords can be encrypted so that they are not saved in cleartext.

    The following are the minimum permissions 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) api-file-* (required for listing the files during single file restore) api-license-* (required for retrieving license information) api-net-* (required for the VMware plug-in)

    Note: Do not use the root user. You should create a backup user with only the necessary APIpermissions.

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

    Snap Creator Agent securitySnap Creator uses host security to allow only authorized hosts to access the agent. Additionally, itchecks the user name or password if you are not using a Snap Creator Server to communicate withthe agent. This feature allows you to specify multiple host lines. To restrict access for third partyapplications through SOAP, the agent offers a user/password authentication.

    If a command contains the path of the Snap Creator installation directory, it is blocked.

    RBAC for Snap Creator users through GUIYou can create and manage multiple user accounts within Snap Creator GUI. The existing user in theGUI (which is created during installation or profile setup) acts as a super user and has access to the

    11

  • complete system. The ability to assign a set of profiles restricts a user to operate in a defined area.This is useful in a multi-tenant environment.

    There are four types of users:

    Super user: Has access to everyone's work space and is the only user that can create users andprofiles. The super user can perform actions, such as the following:

    Adding new user by providing user name and password Changing password for a user Assigning a set of GUI actions to the user Reviewing the list of users and the profiles and actions that they can perform

    Admin user: Has access only to a set of profiles and can perform all actions without anyrestrictions only on those profiles.

    Read-only user: Has access to a set of profiles but can only perform a set of read-onlyoperations. This user cannot perform write or execute operations like creating a Snapshot copy orcreating a configuration.

    Custom user: Has access to a set of profiles and a set of actions.

    The user can be assigned the following list of GUI actions:

    Add Schedule Administrator Archive Log Create Configuration Delete Configuration Delete Schedule Delete Snapshot Discover Download Configuration LUN Clone Quiesce Read Only Rename Configuration Rename Snapshot Restore Run Schedule Scdump Snapshot Unquiesce Update Configuration Update Schedule Upload Configuration Volume Clone

    12 | Snap Creator 3.5.0 Installation and Administration Guide

  • Note: Multiple users can simultaneously sign in to the GUI and perform operations but it isrecommended that not more than 10 users are signed in at the same time.

    Security features of Snap Creator | 13

  • 14 | Snap Creator 3.5.0 Installation and Administration Guide

  • Snap Creator Integration

    Snap Creator integrates either fully or optionally with other software products and technologies.

    Optionally integrates with both SnapDrive for UNIX (SDU) and SnapDrive for WindowsIf SnapDrive is used instead of Manage ONTAP Solution, which sends a call to the storagecontroller for the Snapshot copy, Snap Creator runs SnapDrive.

    Optionally uses SnapVault directly instead of Protection Manager to transfer Snapshot copies tosecondary

    Snapshot, SnapVault, SnapMirror, LUN cloning, volume cloning, and igroup mapping using DataONTAP API.

    Any application or database that runs in an open systems environment (you can write theapplication 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

    Note: Snap Creator 3.5.0 does not support SnapVault, Operations Manager, Protection Manager,and Open Systems SnapVault on Data ONTAP 8.1 Cluster-Mode.

    15

  • 16 | Snap Creator 3.5.0 Installation and Administration Guide

  • Snap Creator Policies

    A policy defines the number of Snapshot copies that you want to keep and the Snapshot copy age.Snap Creator policies are user-defined Snapshot copy retentions that apply to Snapshot copies onprimary storage and SnapVault Snapshot copies on secondary storage.

    You must define at least one policy in the NTAP_SNAPSHOT_RETENTIONS configurationparameter. For SnapVault, you can associate the same policy with different SnapVault retention.

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

    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 copiesare deleted only if they are older than the minimum age, regardless of how many Snapshot copiesexist in a given volume. Using the preceding example of seven days for Snapshot copies and onemonth for SnapVault Snapshot copies, use the following options:

    NTAP_SNAPSHOT_RETENTION_AGE=7

    NTAP_SNAPVAULT_RETENTION_AGE=28

    Additionally, you can specify the Snapshot copy deletion by age only using the following option:

    NTAP_SNAPSHOT_DELETE_BY_AGE_ONLY=Y

    Note: Although you can define multiple policies, Snap Creator can run only one policy at a time.

    The maximum age value is a global parameter and it applies to all the policies. To configure anadditional weekly policy, define it and then call it in Snap Creator once a week using Cron or taskmanager with SNAP_TYPE set to Weekly.

    17

  • 18 | Snap Creator 3.5.0 Installation and Administration Guide

  • What Snap Creator Agent is

    The Snap Creator Agent is a lightweight daemon which runs remotely or locally and allows the SnapCreator Server to send quiesce or unquiesce operations to a given database.

    The Snap Creator Agent remotely handles operations on application through the plug-ins. All SnapCreator configurations are stored centrally on the Snap Creator Server and all backup jobs can bescheduled from the same host. This provides a single pane of glass (SPOG) for backup and restore.The following illustration shows the Snap Creator Agent architecture:

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

    SOAP is used over the HTTP for communication. Based on a WSDL, any SOAP client can interactwith the agent. Currently, Apache CXF (for Java) and PowerShell (for Windows) can be used. Thesupported application plug-ins are built into the agent.

    Other community plug-ins are available as source codes and can be added to the /plug-insdirectory. In addition to the application plug-ins, all PRE commands, POST commands, and APPcommands can be executed remotely through the agent. This provides the ability to mount filesystems or to perform additional application processing remotely. The agent has an access fileunder /path/so/scAgent_v/config/agent.conf where certain commands are allowed torun. By default, all commands are denied. This means that only the built-in or community plug-ins

    19

  • can execute commands through the agent. PRE or POST scripting commands or scripts must beallowed in the agent.conf.

    Note: Snap Creator 3.5.0 does not support Snap Creator 3.3.0 agent.

    The following illustration shows the Snap Creator Agent communication:

    20 | Snap Creator 3.5.0 Installation and Administration Guide

  • Snap Creator Agent Multithreading

    The Snap Creator Agent can handle parallel requests by allowing the Snap Creator Agent todistribute requests coming from the agent itself.

    The following illustration shows the different types of deployment:

    Simple deployment

    In simple deployment, Snap Creator Server opens a connection to the Snap Creator Agent and sendsthe requests. Unless Snap Creator Server stops, the connection is open and the agent is blocked fromaccepting further requests.

    Deployment using a Watchdog

    After accepting the Snap Creator request to quiesce the database, Snap Creator Agent creates aseparate process (watchdog). This watchdog inherits the environment and all the settings of theparent process and unquiesces the database after a configured timeout.

    In this scenario, the agent is blocked until the Snap Creator Server stops or explicitly closes theconnection.

    Multithreaded deployment using Watchdog

    21

  • In the intended multithreaded deployment, the Snap Creator Agent immediately creates an additionalprocess (SC-A') and passes the "communication responsibility" (req') to this process. This newlycreated process inherits the basic Snap Creator Agent settings. Snap Creator Server communicateswith this process. If configured, this process creates a watchdog when the quiesce operation is called.

    After the additional process is created, the Snap Creator Agent is able to accept additional requests.

    Note: Multi-threaded agent is not supported on Windows platform

    22 | Snap Creator 3.5.0 Installation and Administration Guide

  • Preparing to install Snap Creator

    Before installing Snap Creator, you must perform certain tasks, such as downloading the SnapCreator software, creating a Data ONTAP user, and installing Java on Snap Creator.

    Downloading Snap Creator softwareYou can download the Snap Creator software from the NetApp Support Site. Snap Creator is listed inthe Software Download section under Snap Creator Framework.

    Steps

    1. Select the version of Snap Creator to download by selecting View & Download.

    2. At the bottom of the page under the Software download instructions, click CONTINUE.

    3. Read and accept the End User License Agreement by clicking Accept.

    4. Select the operating system and bit level of the software package(s) to download.

    Related information

    The NetApp Support Site-support.netapp.com

    Creating a Data ONTAP userSnap Creator uses the Data ONTAP API to communicate with the storage system. Therefore, it isrequired to create a new role, group, and user. The role is assigned to the group and the groupcontains the user.

    About this task

    These tasks must be completed using the Data ONTAP CLI (SSH, console connection, or telnet).Note: Copy and paste the given commands into a text editor and verify before pasting it in the CLIconsole.

    Steps

    1. Create a role defining the rights required for Snap Creator on the storage system by entering thefollowing command:

    23

  • useradmin role add rolename -a login-*,api-snapshot-*, api-system-*,api-ems-*,api-snapvault-*,api-snapmirror-*, api-volume-*,api-lun-*,api-cg-*,api-nfs-*,api-file-*, api-license-*, api-net-*

    2. Create a new group on the storage system and assign the previously created role to the group byentering the following command:useradmin group add groupname -r rolename

    3. Create a user account in the previously created group that will be used for Snap Creator byentering the following command:useradmin user add username -g groupname

    4. Enter the password for the account.

    Note: These steps must be performed once for each controller where Snap Creator is used.

    Installing Java on Snap Creator ServerFor the Snap Creator GUI to function, Java must be installed on the Snap Creator Server. The SnapCreator GUI is Java based and uses the NetApp Web Framework (NWF). Java Runtime Environment(JRE) 1.6 or higher must be installed on the Snap Creator Server.

    Steps

    1. Download Java from the Java website.

    Note: The version of Java installed must match the version of Snap Creator installed.

    2. Verify the version of java by entering the following command: java -versionExample

    C:\Documents and Settings\Administrator>java -versionjava version "1.7.0_04-ea"Java(TM) SE Runtime Environment (build 1.7.0_04-ea-b01)Java HotSpot(TM) Client VM (build 23.0-b03, mixed mode, sharing)

    The output of the command lists the installed version of Java. If the Java installation is 64-bit thatwill be listed. If there is no mention of the bit-level then the installation is 32-bit.

    Pre-installation steps for Domino plug-inThe Domino plug-in is included as part of the Snap Creator installation. There are a few pre-installation steps to be performed depending on the operating system used.

    24 | Snap Creator 3.5.0 Installation and Administration Guide

  • Linux/Solaris/AIX specific settingsLotus Domino for Linux is available only as a 32-bit application, so regardless of the server bit-levelthe 32-bit version of Snap Creator must be used to support Lotus Domino.

    Domino on Linux and Solaris cannot be run as root. As a result Snap Creator, Snap Creator Server,Agent, and GUI cannot be run as root. It is recommended that Snap Creator is run using the sameaccount that was used to install Domino.

    For the Domino plug-in to work properly, there are a series of symbolic links that must be created.These three symbolic links (symlinks) must be made to Domino's shared object files for the plug-into work properly. After installing Domino to the default location, you can copy and paste thefollowing commands into the environment:

    ln -s /opt/ibm/lotus/notes/latest/linux/libxmlproc.so /usr/lib/libxmlproc.so

    ln -s /opt/ibm/lotus/notes/latest/linux/libndgts.so /usr/lib/libndgts.so

    ln -s /opt/ibm/lotus/notes/latest/linux/libnotes.so /usr/lib/libnotes.so

    Pre-installation steps for Domino plug-in on WindowsThe path to the Domino binary files must be added into the Environmental Variables for Windows.This should be the same path as the Notes_ExecDirectory listed in the Domino options table.

    About this task

    Note: If you perform these steps after Snap Creator is installed you must restart the Snap Creatorservice(s).

    Steps

    1. Right-click My Computer and select Properties (If My Computer is not on the Desktop it canusually be found in the Start menu).

    2. Click the Advanced tab in Windows 2003 or the Advanced system settings task in Windows2008.

    3. Click Environmental Variables.

    4. Use a system variable. There are two sections: User variables and System variables. With a uservariable the Snap Creator service must be run as that particular user.

    5. Locate and select PATH, then click Edit.

    6. Append ; after the last value then add the Domino path.

    7. Click Ok on each window until you exit to the Desktop.

    Preparing to install Snap Creator | 25

  • 26 | Snap Creator 3.5.0 Installation and Administration Guide

  • Installing Snap Creator on Windows

    You can install Snap Creator Server and Snap Creator Agent on Windows using the Windowsinstaller.

    Steps

    1. Extract the .exe file to C:\.

    2. Run the install package executable and proceed through the installation wizard.

    If you want to enable job monitoring, select the Enable Job monitor checkbox. The Job monitorsize should be between 1 and 1000.

    Note: Do not close any window until the installation is complete.

    Related tasks

    Downloading Snap Creator software on page 23Installing Java on Snap Creator Server on page 24Creating a Data ONTAP user on page 23

    27

  • 28 | Snap Creator 3.5.0 Installation and Administration Guide

  • Installing Snap Creator on UNIX

    Snap Creator installation for UNIX differs from Windows in that the software package is anexecutable that when extracted contains both the Snap Creator Server and the Snap Creator Agent.

    UNIX Services (agent/server) feature offers a start script for the Snap Creator Agent and SnapCreator Server. The start scripts are written in UNIX shell script (bourne shell) and are designed torun on all UNIX environments supported by Snap Creator.

    Installing Snap Creator ServerYou can install Snap Creator Server on UNIX. The Snap Creator Server is designed to run on anyopen systems platform.

    Steps

    1. Extract the .tgz file to /usr/local. Change directory to the Snap Creator Server rootdirectory/path/to/scServer_v.

    2. Run Snap Creator setup by entering the following command:./snapcreator --profile setup.

    Note: The Snap Creator executable should already be configured upon extraction with theproper permissions to be executed. If profile setup command does not work, the permissionsmust be added by running following command:chmod 755 snapcreator

    3. Accept the EULA license agreement.

    4. Optional: Enter the serial number of the storage system that will be used with Snap Creator.

    Note: The intent is to add the controller serial number applicable to the Snap Creatorapplication. The Snap Creator application archives this information for later use. The user canrun -version command to retrieve this serial number information when contacting technicalsupport to open a Snap Creator case.

    5. To enable GUI job monitoring, entery

    6. Enter the job monitor size.Note: The Job monitor size should be between 1 and 1000.

    7. Enter the user name and password for the administrative user for the GUI.

    8. Start the Snap Creator GUI by following the instructions provided on the screen.

    29

  • 9. To start Snap Creator GUI, type the following URL in the web browser: http://: where:

    HostName is the host name or IP address of the Snap Creator Server Port is the port number where the Snap Creator Server is running. By default this is port 8080.

    Related tasks

    Downloading Snap Creator software on page 23Installing Java on Snap Creator Server on page 24Creating a Data ONTAP user on page 23

    Installing Snap Creator AgentThe 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.

    Steps

    1. Extract the .tgz file to /usr/local.

    2. 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/xscript andprints usage information.

    4. Install the agent.

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

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

    To ensure that 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 thefollowing:

    /path/to/scAgent_v/bin/scAgent startThis command is run to start the agent manually.

    /path/to/scAgent_v/bin/scAgent stopThis command is run to stop the agent manually.

    /path/to/scAgent_v/bin/scAgent statusThis command is run to query the agent status.

    30 | Snap Creator 3.5.0 Installation and Administration Guide

  • Uninstalling Snap Creator from Windows

    You can uninstall Snap Creator from the Windows start menu.

    Before you begin

    You must have backed up the log and config files to retain the existing configuration. If the server is manually started from the console, you must have stopped it.

    Step

    1. Select All programs > Snap Creator > Uninstall NetApp Snap Creator Framework.

    31

  • 32 | Snap Creator 3.5.0 Installation and Administration Guide

  • Upgrading Snap Creator

    You can upgrade to Snap Creator 3.5.0 by adding parameters to the Snap Creator configuration file.You can also upgrade the Snap Creator GUI after installing Snap Creator 3.5.0.

    Upgrading from Snap Creator 3.4.0You can upgrade to Snap Creator 3.5.0 by adding parameters to the Snap Creator 3.4.0 configurationfile.

    Step

    1. Add the following parameters to the Snap Creator 3.4.0 configuration file:

    LOG_TRACE_ENABLE=Y

    ALLOW_IP_ADDR=N

    CMODE_CLUSTER_USERS=

    CMODE_CLUSTER_NAME

    CMODE_SNAPSHOT_FORCE_DELETE=Y

    FS_NAME=

    META_DATA_VOLUME=

    JAVA_HOME=

    JVM_ARGS=

    JAVA_CLASSPATH=

    PERL_HOME=

    PERL_OPTS=

    PYTHON_HOME=

    PYTHON_OPTS=

    ARCHIVE_LOG_RECURSIVE_SEARCH

    33

  • Upgrading from Snap Creator 3.3.0You can upgrade to Snap Creator 3.5.0 by adding parameters to the Snap Creator 3.3.0 configurationfile.

    Step

    1. Add the following parameters to the Snap Creator 3.3.0 configuration file:

    CONFIG_TYPE - PLUGIN|STANDARDUSE_PROXY - (Y|N)NTAP_CONSISTENCY_GROUP_WAFL_SYNC - (Y|N)NTAP_SNAPSHOT_RESTORE_AUTO_DETECT - (Y|N)MOUNT_CMD

    UMOUNT_CMD

    APP_DEFINED_CLONE - (Y|N)LOG_TRACE_ENABLE=Y

    ALLOW_IP_ADDR=N

    CMODE_CLUSTER_USERS=

    CMODE_CLUSTER_NAME=

    CMODE_SNAPSHOT_FORCE_DELETE=Y

    FS_NAME=

    META_DATA_VOLUME=

    JAVA_HOME=

    JVM_ARGS=

    JAVA_CLASSPATH=

    PERL_HOME=

    PERL_OPTS=

    PYTHON_HOME=

    PYTHON_OPTS=

    ARCHIVE_LOG_RECURSIVE_SEARCH

    Note: To upgrade from versions prior to Snap Creator 3.3.0, contact technical support.

    34 | Snap Creator 3.5.0 Installation and Administration Guide

  • Upgrading Snap Creator GUIYou can upgrade the Snap Creator GUI by running the upgrade command.

    Before you begin

    You must have stopped Snap Creator Server . You must have backed up the profiles in the scServerX.Xx/configs folder. You must have backed up the Snap Creator database folder scServerX.Xx/gui/

    snapcreator.

    If using Windows, you must have uninstalled the current Snap Creator version.

    Steps

    1. Install new Snap Creator version.

    2. Stop the Snap Creator Server service on Windows.

    3. Copy the backed up profiles to the new scServerX.Xx/configs folder.

    4. Delete the newly created Snap Creator database folder scServerX.Xx/gui/snapcreator.

    5. Copy and paste the backed up Snap Creator database folder to scServerX.Xx/gui directory.

    6. Open CLI and change to directory scServerX.Xx/gui.

    7. Run the upgrade command java -jar snapcreator.jar -upgrade.

    8. Start Snap Creator Server.

    Upgrading Snap Creator | 35

  • 36 | Snap Creator 3.5.0 Installation and Administration Guide

  • Information required to configure Snap Creator

    Snap Creator 3.5.0 supports Oracle, MySQL, DB2, VMware, Sybase ASE, Domino, MaxDB,SnapManager for SQL Server, and SnapManager for Exchange plug-ins. Community plug-ins are notincluded in the package and must be downloaded separately.

    The following table lists the plug-in parameters, settings, and the description:

    Parameters Setting Description

    APP_NAME oracle, db2, mysql, vibe,sybase, domino, smsql, sme,maxdb

    Determines which applicationis being backed up. SnapCreator has built-in support forthe listed applications. You caneither use APP_NAME orconfigureAPP_QUIESCE_CMDXX,APP_UNQUIESCE_CMDXX,and PRE_EXIT_CMDXX. Ifthe application is not directlysupported in Snap Creator, youcan use a plug-in or run yourown application quiesce/unquiesce commands or scripts.: Copy the plug-into the /path/to/scServer|scAgent/plug-ins directoryand specify your plug-in in theAPP_NAME parameter.Commands or Scripts:APP_QUIESCE_CMD01=/path/to/quiesceCMDAPP_UNQUIESCE_CMD01=/path/to/unquiesceCMDPRE_EXIT_CMD01=/path/to/unquiesceCMD

    37

  • Parameters Setting Description

    APP_IGNORE_ERROR (Y|N) Determines if Snap Creatorshould ignore errors fromapplication plug-ins. This isuseful when the user wants toback up multiple databases anddoes not want to stop thebackup based on quiesce orunquiesce of single databasefailing.

    APP_DEFINED_RESTORE (Y|N) Enables application basedrestores. In the event of arestore, Snap Creator sends arequest to the application plug-in and the plug-in handles therequest.

    APP_AUTO_DISCOVERY (Y|N) Enables application autodiscovery. Snap Creator sendsdiscover request to applicationplug-in and the plug-in is thenresponsible for the discovery ofthe storage configuration. Thiscan be done dynamically orpersistent with theAPP_CONF_PERSISTENCEparameter if information is tobe saved to the config file. Thisparameter is similar toVALIDATE_VOLUMES butallows one through plug-inframework to add discoverfunctionality to any applicationplug-in.

    APP_CONF_PERSISTENCY (Y|N) Enables auto discovery to bepersistent, which meanschanges are dynamicallyupdated in config file.

    38 | Snap Creator 3.5.0 Installation and Administration Guide

  • Parameters Setting Description

    VALIDATE_ VOLUMES DATA Snap Creator validates that allvolumes where the databaseresides are part of the backup.Currently, there are somelimitations. Only NFS issupported. Currently, thisoption checks data files only forthe supported databases.

    FS_NAME Determines which plug-in isbeing used for file systemoperations.

    META_DATA_VOLUME Allows for Snapshot copy ofspecified volume to occur afterunquiesce. This can be valuablefor certain plug-ins whereSnapshot copy of data must betaken at different times. Themeta data volume must not beonly volume specified:controller1:volume1

    APP_DEFINED_CLONE (Y|N) The built-in cloning abilities ofSnap Creator will be ignored.Instead the plug-in isresponsible for handling allclone activities including vol orLUN clone creation anddeletion. The built-in plug-insdo not this type of clone.

    JAVA_HOME Text Setting which points to the JavaVirtual Machine which shouldbe used for executing .classand .jar files. If set,$JAVA_HOME/bin/java willbe used, otherwise just java torun the .class/.jar file #

    Information required to configure Snap Creator | 39

  • Parameters Setting Description

    JVM_ARGS Text Setting to control the JavaVirtual Machine whenexecuting native Java .classor .jar files. The defaultsetting is -Xms32M -Xmx128M

    JAVA_CLASSPATH Text Setting which defines the Javaclasspath. Per default,plugins/native isconfigured and can becompleted with thisenvironment variable, whichwill be appended to the default.

    PERL_HOME Text Setting which points to the Perlinterpreter which should beused for executing .pl files. Ifset, $PERL_HOME/bin/perlwill be used, otherwise just perlto run the .pl file

    PERL_OPTS Text Setting to control the Perlinterpreter when executingnative Perl files. Options forsettings additional includedirectories (-I) etc. can bepassed to the Perl interpreter.

    PYTHON_HOME Text Setting which points to thePython interpreter which shouldbe used for executing .py files.If set, $PYTHON_HOME/pythonwill be used, otherwise justpython to run the .py file

    PYTHON_OPTS Text Setting to control the Pythoninterpreter when executingnative Python files.

    40 | Snap Creator 3.5.0 Installation and Administration Guide

  • Oracle plug-inThe Oracle plug-in supports only Oracle 10g database or higher. The Oracle plug-in uses SQL*Plusto communicate with the database.

    The following table lists the Oracle plug-in parameters, the settings, and the description:

    Parameter Settings Description

    APP_NAME oracle The application name

    ORACLE_DATABASES A list of Oracle databases andthe user name, that is,db1:user1;db2:user2.

    SQLPLUS_CMD The path to the sqlpluscommand.

    CNTL_FILE_BACKUP_DIR The path to the directory wherethe user should store backupcontrol files (Oracle user musthave permissions).

    ORA_TEMP The path to a directory to storetemp file, that is, /tmp (Oracleuser must have permissions).

    ARCHIVE_LOG_ONLY (Y|N ) Informs Oracle Plug-in to onlyperform a switch log. Thissetting is useful if you arehandling archive logs separatefrom data backup.

    ORACLE_HOME The path to the oracle homedirectory

    ORACLE_HOME_ PATH to Oracle homedirectory for a given SID.When backing up multipledatabases it might be importantto specify more than one Oraclehome.

    Information required to configure Snap Creator | 41

  • Parameter Settings Description

    ORACLE_EXPORT_PARAMETERS

    (Y|N ) The ORACLE_HOME andORACLE_SID environmentparameters are exported usingthe export command. This isapplicable only in UNIX orLinux based environment.

    MySQL plug-inThe MySQL plug-in supports MySQL 5.x. The MySQL plug-in uses Net-MySQL to communicatewith the database.

    The following table lists the MySQL plug-in parameters, the settings, and the description:Parameter Settings Description

    APP_NAME mysql The application name

    MYSQL_DATABASES A list of MySQL database(s)and the user name/passwordthat is, db1:user1/pwd1;db2:user2/pwd2

    HOST Name of the host where thedatabases are located: localhost

    PORTS (Y|N) A list of database(s) and theports they are listening on, thatis, db1:3307;db2:3308

    MASTER_SLAVE Specifies the database(s) to bepart of the MASTER/SLAVEenvironment.

    DB2 plug-inThe DB2 plug-in supports DB2 9.x. The DB2 plug-in uses the db2 command to communicate withthe database.

    The following table lists the DB2 plug-in parameters, the settings, and the description:

    Parameter Settings Description

    APP_NAME db2 The application name

    42 | Snap Creator 3.5.0 Installation and Administration Guide

  • Parameter Settings Description

    DB2_DATABASES A list of db2 database(s) andthe user name, that is,db1:user1;db2:user2

    DB2_CMD The path used by the db2command to interact with thedatabase.

    Note: For Windows, youmust first give a path todb2cmd.exe For exampleUNIX:DB2_CMD=/ibm/sqllib/bin/db2Windows: DB2_CMD= Z:\IBM\SQLLIB\BIN\db2cmd.exe -c -w -iZ:\IBM\SQLLIB\BIN\db2.exe

    VMware (VIBE) plug-inSnap Creator supports back up of VMware VMs and vApps through VMware plug-in. VMware plug-in is an integrated plug-in for both VMs with vSphere and vApps with vCloud.

    Snap Creator 3.5.0 supports VMware vSphere 4.x, 5 and VMware vCloud Director 1.0, 1.5.

    You should be aware of the following considerations when using VMware plug-in:

    The VMware plug-in is supported only on Windows and Linux. If the user is using a non-Windows or non-Linux Snap Creator Server, they need a Snap Creator Windows/Linux agent torun the VMware plug-in.

    VMware HA with VMware plug-in is not tested and is not supported. Consistency group Snapshot copies with VMware plug-in is not tested and is not supported. VMware plug-in does not support Raw Device Mapping. After restore operations are complete, user must run a Snap Creator backup of the restored VMs

    and vApps to ensure the new environment is cleaned up appropriately and all VMware Snapshotcopies are removed.

    If the plug-in is not able to clean up VMware Snapshot copies and displays an error, user mustremove the VMware Snapshot copies manually. Plug-in cannot guarantee 100% VMwareSnapshot copy removal and it is a known VMware issue.

    VMware plug-in supports only 32-bit Snap Creator with 32-bit Linux system and 64-bit SnapCreator with 64-bit Linux system.

    Information required to configure Snap Creator | 43

  • The following table lists the VMware plug-in parameters, the settings, and the description:

    Parameter Description

    VIBE_VCLOUD_IPADDR IP addresses or hostname(s) of the vCloudDirector to log into (vCloud ONLY)

    VIBE_VCLOUD_USER User name to log in to the vCloud Director(vCloud ONLY). You must set @ or@system (top level vCloud database) Example:VIBE_VCLOUD_USER=administrator@system

    Note: vCloud Director system administratoruser name must be used to perform backup orrestore. Backup or restore fails if the user isan organization admin or any other user.

    VIBE_VCLOUD_PASSWD Password associated to the VCLOUD_USERspecified (vCloud ONLY)

    VIBE_VCENTER_USER User name to use toog in to vCenter

    VIBE_VCENTER_PASSWD Password associated to the VCENTER_USERspecified

    VIBE_VCLOUD_NAMES List of Organization, vDC and vApp objectnames to backup (vCloud ONLY)Example:VIBE_VCLOUD_NAMES=ORG:VDC1,VDC2:VAPP1,VAPP2;ORG2:VDC3:;ORG3::VAPP6

    VIBE_VSPHERE_NAMES List of Datastores and VMs to backup pervCenter (vSphere ONLY) Example:VIBE_VSPHERE_NAMES=VCENTER1:DS1:VM1;VCENTER2;DS2,DS3:;VCENTER3::VM4

    VIBE_TRIM_VSPHERE_NAMES List of VMs to remove from backup per vCenter(vSphere ONLY) Example:VIBE_TRIM_VSPHERE_NAMES=VCENTER1:VM99;VCENTER2:VM5,VM12

    VIBE_RESTORE_INTERVAL Time between each restore check (default: 30seconds)

    VIBE_RESTORE_TIME Total time to wait for complete restore (default:3600 seconds)

    44 | Snap Creator 3.5.0 Installation and Administration Guide

  • Parameter Description

    VIBE_VMWARE_SNAPSHOT Take a VMware Snapshot copy during backup(default: Y)

    VIBE_NOPING Do not ICMP ping VMware or storagecontrollers (default: N)

    VIBE_DYNAMIC_VOLUMES_UPDATE If set to 'N', does not perform dynamic volumeupdate, which you have to set VOLUMES,SNAPVAULT_VOLUMES,SNAPMIRROR_VOLUMES andNTAP_DFM_DATA_SET manually (default:not set)

    vCloud vApp backup and restore using VMware plug-inSnap Creator 3.5.0 supports backup of vCloud vApps through VMware plug-in. vApp / VM backupsare taken by this plug-in through the vCloud Director (vCD) API and vSphere API which areinvoked on the VMware vCloud Director and VMware vCenter server respectively.

    For vApp backup or restore, the user must provide the following details in the configuration file:

    vCloud IP and credentials vCloud Organizations, vDCs and vApp names

    Note: If more than one vCenter is attached to vCloud, then the password for the all vCentersshould be same.

    The following are important data points regarding vCloud backup and restore processes:

    The backup and restore processes for both VMware and vCloud are very similar except thediscovery process, where vCloud backups require additional discovery of the vCloud Director(vCD) metadata using REST APIs.

    You should provide with details of the vCloud with the organizations, vDCs or vApps to bebacked up.

    If a vDC is listed, all the vApps in the vDC are backed up. The vCloud module discovers VMs associated to any vApp that need to be backed up and puts

    them on a backup list. If a vApp selected for backup is contained within an Organization or vDC also selected for

    backup, it will be backed up only once.

    Note: For Virtual Machine File System(VMFS) restore operations through the VMware plug-in,there must be enough space in the volume to create a LUN clone that is equal to the size of theLUN.

    Note: User must close and reopen the config file in the GUI before running restore on a VMwareconfiguration because volumes discovered are not updated automatically.

    Information required to configure Snap Creator | 45

  • VM backup and restore using VMware plug-inSnap Creator supports backup of VMware VMs through VMware plug-in. VM backups are takenthrough the vSphere API which are invoked on the VMware vCenter server.

    For VM backup, the user must provide the following details in the configuration file:

    vCenter IP/hostname and credentials vSphere VM(s) and datastore namesFor restore operations, you should provide the backup parameters and the Snapshot copy name to beused for the restore.

    You should keep the following points in mind when performing VMware backup and restoreprocesses:

    If a VM is listed and is not available, the plug-in displays an error message. It will not be able torestore a lost VM even if it is backed up.

    If a Datastore is listed, all the VMs in the Datastore will be backed up. Only the listed VMs or VMs located on the Datastores specified will be backed up. If a VM selected for backup is contained within a Datastore that is also selected for backup, it

    will be backed up only once. This plug-in supports both NFS and VMFS Datastores. VM restores on an NFS Datastore use a Single File SnapRestore (SFSR) on the storage system,

    which avoids host copies. To restore VM on a VMFS Datastore, perform the following steps:

    1. Use FlexClone or LUN clone of the LUN contained in a specific restore Snapshot copy.

    2. Map that to the cluster.

    3. Use vCenter API calls to copy contents from the Snapshot VMFS datastore to the originalVMFS datastore.

    Sybase plug-inThe Sybase plug-in uses the isql command to interact with the Sybase database. The Sybase plug-incan quiesce one or more databases. The Sybase ASE plug-in supports Sybase ASE 12.5.x, SybaseASE 15.0.x, and Sybase ASE 15.5.

    The following table lists the Sybase plug-in parameters, the settings, and the description:

    Parameter Setting Description

    SYBASE_SERVER The Sybase data server name (-S option on isql) Example:SYBASE_SERVER=p_test

    46 | Snap Creator 3.5.0 Installation and Administration Guide

  • Parameter Setting Description

    SYBASE_DATABASES The list of databases within theinstance to back up. Format isDB1:USER:PASSWD;DB2:USER:PASSWD. The masterdatabase is added. If a databasenamed"+ALL" is used, thendatabase autodiscovery is usedand the sybsyntax,sybsystemdb, sybsystemprocsand tempdb databases areexcluded. Encrypted passwordsare supported ifNTAP_PWD_PROTECTIONis set.Example:SYBASE_DATABASES=DBAtest2:sa/53616c7465645f5f76881b465ca8ce3745c239b60e04351eExample:SYBASE_DATABASES=+ALL:sa/53616c7465645f5f76881b465ca8ce3745c239b60e04351e

    SYBASE_DATABASES_EXCLUDE

    (Y|N ) Allows databases to beexcluded if the +ALL constructis used, use ';' to allow multipledatabases. Example:SYBASE_DATABASES_EXCLUDE=pubs2;test_db1.

    SYBASE_TRAN_DUMP Allows post Snapshot Sybasetransaction dump to beperformed. Each databaserequiring a txn dump needs tobe specified. Format is"DB1:PATH;DB2:PATH"where path is a directory.Example:SYBASE_TRAN_DUMP=pubs2:/sybasedumps/pubs2

    Information required to configure Snap Creator | 47

  • Parameter Setting Description

    SYBASE_TRAN_DUMP_FORMAT

    Allows the user to specify thedump naming convention.Three "keys" can be specified,%S = Instance name fromSYBASE_SERVER %D isdatabase fromSYBASE_DATABASES and%T is a unique timestamp.Default format is %S_%D_%T.cmn Example:SYBASE_TRAN_DUMP_FORMAT=%S_%D_%T.log

    SYBASE_TRAN_DUMP_COMPRESS

    Allows native Sybasetransaction dump compressionto be enabled. Example:SYBASE_TRAN_DUMP_COMPRESS=Y

    SYBASE_ISQL_CMD Defines the path to the "isql"command to be used. Example:SYBASE_ISQL_CMD=/opt/sybase/OCS-15_0/bin/isql

    SYBASE The location of the Sybaseinstall. Example: SYBASE=/sybase

    SYBASE_LOGDIR Defines the directory whereSnap Creator logs are placed.Example:SYBASE_LOGDIR=/usr/local/ntap/scServer3.3.0/logs

    SYBASE_MANIFEST Specifies the databases forwhich the manifest file shouldbe created along with thelocation where the manifest fileshould be placed. Example:SYBASE_MANIFEST=DBAtest2:/t_inf_nzl_devs/

    48 | Snap Creator 3.5.0 Installation and Administration Guide

  • Parameter Setting Description

    SYBASE_MANIFEST_FORMAT

    Allows the user to specify themanifest file namingconvention. Three "keys" canbe specified: %S = Instancename fromSYBASE_SERVER, %D isdatabase fromSYBASE_DATABASES, and%T is a unique timestampwhich is the same as used forSnapshot naming. Defaultformat is %S_%D_%T.manifest Example:SYBASE_MANIFEST_FORMAT=%S_%D_%T.manifest

    SYBASE_MANIFEST_DELETE

    (Y|N ) Allows the manifest to bedeleted once the Snapshot hasbeen performed. The manifestfile should be captured withinthe Snapshot so it is alwaysavailable with the backup.Example:SYBASE_MANIFEST_DELETE=Y

    MaxDB plug-inThe MaxDB plug-in supports MaxDB 7.8.

    The following table lists the MaxDB plug-in parameters, the settings, and the description:

    Parameter Setting Description

    APP_NAME maxdb The application name

    XUSER_ENABLE (Y|N) Enables the use of an xuser formaxdb so password is notrequired for db user

    HANDLE_LOGWRITER (Y|N) Executes suspend logwriter/resume logwriter if set to Y

    Information required to configure Snap Creator | 49

  • Parameter Setting Description

    DBMCLICMD The path to the MaxDB dbmclicommand, if not set dbmcli onthe search path is used

    SQLCLICMD The path to the MaxDB sqlclicommand, if not set sqlcli onthe search path is used

    MAXDB_UPDATE_HIST_LOG

    (Y|N) Tells the maxdb backupprogram if it should updatemaxdb history log

    MAXDB_DATABASES List of database(s) and theirusername/password separatedby a comma of which you wantto backup Example:MAXDB_DATABASES=db1:user1/password;db2:user2/password

    MAXDB_CHECK_SNAPSHOT_DIR

    Setting to check, if a SnapCreator Snapshot copyoperation was successful andthe Snapshot copy has beentaken. NFS only. Directorymust point to the directorywhich contains the .snapshotdirectory. Multiple directoriescan be specified as a commaseparated list Multipledatabases can be specified as asemicolon separated list In caseof MaxDB 7.8 and newer, thedatabase backup request will bemarked as Failed in the backuphistory. The shown error codeidentifies the number ofmissing snapshots. Example:MAXDB_CHECK_SNAPSHOT_DIR=SID:directory[,directory...][SID2:directory[,directory...]

    50 | Snap Creator 3.5.0 Installation and Administration Guide

  • Lotus Domino plug-inThe Lotus Domino plug-in supports Lotus Domino 8.0, Lotus Domino 8.0.x, Lotus Domino 8.5, andLotus Domino 8.5.x.

    The IBM Lotus Domino application consistency feature ensures application consistency byinterfacing with the Domino APIs through the Domino plug-in. This plug-in is supported onWindows, Linux, AIX, and Solaris.

    The Domino plug-in collects a list of all databases, templates, and mailboxes in the Dominoenvironment. Each file is then placed in a quiesced state. When the databases are quiesced, allchanges to the databases are stored in a temporary area known as change info. When the Snapshotcopy is taken, the quiesce is released and the change info is written back to the database.

    The change info must be stored on a volume that is not a part of the Snapshot copy. The change infois also written back to a database after a restore. The DOMINO_RESTORE_DATA_PATH must beset to the path where the Domino data is being restored this path might change depending on thetype of the restore being performed. A volume restore must be set to the same path as the Dominodata, while a single database restore is set to an alternate path on the same volume as the Dominodata. If the DOMINO_RESTORE_DATA_PATH is not set properly, the change info is not appliedto the database which can result in some data loss.

    A new log folder is created under DOMINO_CHANGE_INFO_PATH. All the archived logs arestored under this folder. To delete the archived logs, enable archive log options.

    Example:

    ARCHIVE_LOG_ENABLE=YARCHIVE_LOG_DIR=/home/domino/changeinfo/logsARCHIVE_LOG_RETENTION=30ARCHIVE_LOG_EXT=TXN

    If any database is corrupt, then the Domino plug-in continues with the backup of the remainingdatabases if APP_IGNORE_ERROR option is enabled. This is useful in a scenario where the userwants to back up multiple databases and does not want to stop the backup based on quiesce orunquiesce of single database failing.

    The following table lists the Domino plug-in parameters, the settings, and the description:

    Parameter Setting Description

    DOMINO_DATA_PATH Path to Domino Data directory.Example: /notes/notesdata

    DOMINO_INI_PATH Path to notes.ini file (includenotes.ini in path) Example: /notes/notesdata/notes.ini

    Information required to configure Snap Creator | 51

  • Parameter Setting Description

    DOMINO_CHANGE_INFO_PATH

    Path where change info filesshould be saved. Use a differentvolume than Domino Data orLog paths. Change info shouldnot be captured in the sameSnapshot copy. Example:/notes/changeinfo

    Note: To delete the oldchange info files, enablearchive log option

    DOMINO_DATABASE_TYPE

    Can be any of the followingvalues: 0 = Backup everything( 1+2+3 below) 1 = Backuponly for *.BOX files 2 =Backup only for *.NSF, *.NSGand NSH files. 3 = Backup onlyfor *.NTF files.

    LOTUS Path where Domino is installed.Example: /opt/ibm/lotus

    Notes_ExecDirectory Path that contains Dominoshared object (.so or .dll) files.Example: /opt/ibm/lotus/notes/latest/linux/

    DOMINO_RESTORE_DATA_PATH

    The Domino plug-in applieschange information todatabases after a restore. Inorder to do this properly, thisparameter must be set to thelocation where Domino Data isbeing restored. Use the samepath asDOMINO_DATA_PATH ifrestoring to the same location.If performing a single filerestore, provide the path whereyou are restoring yourdatabases. Example: /notes/notesdata

    52 | Snap Creator 3.5.0 Installation and Administration Guide

  • SnapManager for Microsoft Exchange plug-inThe SnapManager for Microsoft Exchange plug-in supports SnapManager 6.0 with MicrosoftExchange Server 2007 and Microsoft Exchange Server 2010.

    Note: SnapManager for Microsoft Exchange plug-in requires Snap Creator Agent to be installed.

    Note: SnapManager for Microsoft Exchange plug-in is not supported with Data ONTAP 8.1Cluster-Mode.

    The following table lists the SnapManager for Microsoft Exchange plug-in parameters, the settings,and the description:

    Parameter Setting Description

    SME_PS_CONF Path to the Powershellconfiguration file forSnapManager for MicrosoftExchange.Example: SME_PS_CONF=C:\Program Files\NetApp\SnapManager forExchange\smeShell.psc1

    SME_BACKUP_OPTIONS SnapManager for MicrosoftExchange backup options. SnapCreator uses a Powershellcmdlet for new-backup.Example:SME_BACKUP_OPTIONS=-Server 'EX2K10-DAG01' -GenericNaming -ManagementGroup 'Standard' -NoTruncateLogs $False -RetainBackups 8 -StorageGroup 'dag01_db01' -BackupCopyRemoteCCRNode$False

    SME_SERVER_NAME SnapManager for MicrosoftExchange server name

    SME_32bit (Y|N) Setting to enable use of 32-bitversion of Powershell.

    Information required to configure Snap Creator | 53

  • SnapManager for Microsoft SQL Server plug-inThe SnapManager for Microsoft SQL Server plug-in supports SnapManager 6.0 with Microsoft SQLServer 2007 and Microsoft SQL Server 2008.

    Note: SnapManager for Microsoft SQL Server plug-in requires Snap Creator Agent to be installed.Note: SnapManager for Microsoft SQL Server plug-in is not supported with Data ONTAP 8.1Cluster-Mode.

    The following table lists the SnapManager for Microsoft SQL Server plug-in parameters, the settings,and the description:

    Parameter Setting Description

    SMSQL_PS_CONF Path to the Powershellconfiguration file forSnapManager for MicrosoftSQL Server.Example:SMSQL_PS_CONF=C:\Program Files\NetApp\SnapManager for SQLServer\smsqlShell.psc1

    SMSQL_BACKUP_OPTIONS SnapManager for MicrosoftSQL Server backup options.Snap Creator uses a Powershellcmdlet for new-backup.Example:SMSQL_BACKUP_OPTIONS=-svr 'SQL' -d 'SQL\SHAREPOINT', '1','WSS_Content' -RetainBackups7 -lb -bksif -RetainSnapofSnapInfo 8 -trlog-gen -mgmt standard

    SMSQL_SERVER_NAME SnapManager for MicrosoftSQL Server name

    SMSQL_32bit (Y|N) Setting to enable use of 32-bitversion of Powershell.

    54 | Snap Creator 3.5.0 Installation and Administration Guide

  • Archive log plug-inThe Archive log plug-in works for any database. This plug-in does not communicate with thedatabase. It deletes archive logs that are older than the configured threshold value (in days).The following table lists the Archive log parameters, the settings and the description:

    Parameter Setting Description

    ARCHIVE_LOG_ENABLE (Y|N) Enables archive logmanagement (deletion of oldarchive logs).

    ARCHIVE_LOG_RETENTION

    Numbers of days the archivelogs are retained. Epoch time isused and is precise to thesecond.

    ARCHIVE_LOG_DIR Path to the directory thatcontains the archive logs.Optionally, for multiple archivelog directories,ARCHIVE_LOG_DIRcan be used.

    ARCHIVE_LOG_EXT File extension of the archivelogs, that is, if the archive logsare 10192091019.log, youwould set this to "log"; thesearch pattern used is:.

    ARCHIVE_LOG_RECURSIVE_SEARCH

    Setting allows to managearchive logs within subdirs. Ifarchive logs are located undersubdirs this option should beused.

    Information required to configure Snap Creator | 55

  • 56 | Snap Creator 3.5.0 Installation and Administration Guide

  • Configuring Snap Creator Server

    The Snap Creator configuration file is located in /path/to/scServer_v/configs//.conf. You can create multiple configurations, but Snap Creator Server runsonly one configuration at a time.

    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.

    Creating a configuration file using CLIYou can create a new directory or profile for your configuration under /path/to/scServer_v/configs. It is a best practice to name it after the host or application that is backedup.

    About this task

    This example uses the name oraprod01. The default template is located in /path/to/scServer_v/configs/default/default.conf.

    Steps

    1. Create the following directory:mkdir /path/to/scServer_v/configs/oraprod01

    2. Copy or rename the following 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.

    Creating a configuration file using GUIYou can create a configuration file using the GUI.

    Steps

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

    2.In the Management Configurations screen, click Add backup profile and enter the newprofile name.

    57

  • The profile name should relate to the application being backed up. Adding a profile creates adirectory 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. Proceed through the configuration wizard.

    5. Review the summary and click Finish.

    Note: You can view configuration files listed under the profile. It contains all the configurationspecific details. You can rename and delete a configuration by right-clicking and selectingDelete or Rename. The GUI creates the same configuration files you would create by using theCLI. You can update and edit configuration files created by the GUI from the CLI or from theCLI to the GUI.

    ReferencingReferencing is the ability to define variables within the configuration file. The configuration file isdynamic, which means that you can create and set variables within the configuration itself.

    This is done by using the % character. For example, use of SnapDrive instead of Data ONTAP API tocreate the Snapshot copies. As the Snapshot copy names need to be unique, you must set a dynamicvariable. The following is an example from a Windows SnapDrive configuration:

    NTAP_SNAPSHOT_CREATE_CMD1="c:/Program Files/NetApp/SnapDrive/sdcli" snapcreate -m fx1b4 -s %SNAME-%SNAP_TYPE_%SNAP_TIME-D E:

    or

    NTAP_SNAPSHOT_CREATE_CMD1="c:/Program Files/NetApp/SnapDrive/sdcli" snapcreate -m fx1b4 -s %SNAME-%SNAP_TYPE_recent -D E:

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

    Variables Description

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

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

    58 | Snap Creator 3.5.0 Installation and Administration Guide

  • Variables Description

    %ACTION This is the given action when you run SnapCreator: (snap|clone_vol|clone_lun|arch|restore|delete|snaplist|clonelist|pmsetup|ossv)

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

    %USER_DEFINED This passes a user-defined argument to the SnapCreator configuration file. For example, Tointegrate with a backup application likeNetBackup, CommVault, or Legato NetWorkeryou might have to pass the desired backupproduct's schedule into the configuration filewhen you have multiple schedules and want tocall NetBackup, CommVault, or LegatoNetWorker with a certain schedule. You couldalso achieve this by having multipleconfiguration files for the different scenarios.

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

    Parameter Setting Description

    SNAME (REQUIRED) Snapshot copy namingconvention should be unique.Snapshot copies are deletedaccording to the namingconvention and retention policyused.

    SNAP_TIMESTAMP_ ONLY(REQUIRED)

    (Y|N ) If set to Y, Snapshot copies endwith YYYYMMDDHHMMSS.Otherwise, new Snapshotcopies are renamed to end withYYYYMMDDHHMMSS.

    VOLUMES (REQUIRED) List of primary storagecontrollers and volumes youwant to create a Snapshot copyof, that is,controller1:vol1,vol2,vol3;controller2:vol1;controller3:vol2,vol3.

    Configuring Snap Creator Server | 59

  • Parameter Setting Description

    NTAP_SNAPSHOT_RETENTIONS (REQUIRED)

    Determines the number ofSnapshot copies you want toretain for a given policy, that is,daily:7,weekly:4,monthly:1.

    NTAP_USERS (REQUIRED) This is the list of appliancesand their corresponding usernames/passwords, that is,controller1:joe/password1;controller2:bob/password2;controller3:ken/password3.

    Note: If you want to useprotected passwords, first run./snapcreator-cryptpasswdand then save the scrambledpassword in the config file.

    NTAP_PWD_ PROTECTION(REQUIRED)

    (Y|N) Enables password protection.You must encrypt all passwords(storage system andapplications or plug-ins) andsave encrypted passwords inconfig file when this option isset to Y.

    TRANSPORT (REQUIRED) HTTP|HTTPS This allows you to choose theprotocol for APIcommunications.

    Note: HTTPS may requireopenssl-devel libraries.

    PORT (REQUIRED) This is the used tocommunicate with the storagecontroller(s), normally(80/443).

    LOG_NUM (REQUIRED) This is the number of .debugand .out reports that SnapCreator has to retain.

    60 | Snap Creator 3.5.0 Installation and Administration Guide

  • Parameter Setting Description

    CONFIG_TYPE (REQUIRED) PLUGIN|STANDARD We can have two types ofconfiguration: plug-in,standard. We can use multipleplug-in configs to build upcomplex quiesce and unquiescebackup workflows.

    CMODE_CLUSTER_USERS(REQUIRED FOR CLUSTER-MODE)

    List of primary/secondaryCluster-Mode clusters and theircorresponding usernames/passwords Example:cluster1:joe/password1;cluster2:bob/password2 #

    CMODE_CLUSTER_NAME(REQUIRED FOR CLUSTER-MODE)

    Name of the primary Cluster-Mode cluster

    CMODE_SNAPSHOT_FORCE_DELETE

    (Y|N) Setting which forces deletion ofSnapshot copies which shouldbe deleted based on Snapshotpolicy

    LOG_TRACE_ENABLE (Y|N) (Y|N) Setting which enablestrace messages. Trace messagesare an extra level of debug

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

    Parameter Setting Description

    VFILERS This is the list of vFiler unitsand their hosting appliances orvolumes, that is,vFiler1@controller1:vol1,vol2,vol3;vFiler2@controller2:vol1;vFiler3@controller3:vol2,vol3.

    Note: HTTPS is notsupported with vFilers

    Configuring Snap Creator Server | 61

  • Parameter Setting Description

    MANAGEMENT_INTERFACES

    This is an interface that you canspecify for every physicalappliance. All Data ONTAPAPI communications betweenSnap Creator and the controlleroccur through this interface.For example:MANAGEMENT_INTERFACES=controller1:controller1-mgmt;controller2:controller2-mgmt

    SECONDARY_INTERFACES

    For every appliance or vFilerunit, you can specify asecondary interface source/destination pair (name or IP). Itis used for SnapMirror andSnapVault updates. Forexample,controller1:controller1-backup/controller2-backup. Where:controller1 - Storage controlleror VFiler unit namecontroller1-backup - Secondaryinterface for controller1/vFiler1controller2-backup - Secondaryinterface for controller1/vFiler1's SnapMirror orSnapVault destination

    Note: The SnapVault/SnapMirror relationshipsmust be configured to usethis secondary interface.Snap Creator does notmanage SnapMirror/SnapVault relationships.

    62 | Snap Creator 3.5.0 Installation and Administration Guide

  • Parameter Setting Description

    USE_PROXY (Y|N) Setting which allows API callsto go through DataFabricManager server proxy insteadof storage controller directly. Ifthis option is used,NTAP_USERS is no longerrequired.

    ALLOW_IP_ADDR (Y|N) Setting which allows IP addressto be used for storage system.This applies to SnapVault,SnapMirror, and ProtectionManager. Using IPs can createproblems and should only beused under certain conditions.

    The following table lists the parameters required to set up Snapshot copy:

    Parameter Setting Description

    NTAP_SNAPSHOT_RETENTION_AGE

    Allows you to define aretention age (in days) forSnapshot copies. If configured,Snapshot copies are deletedonly if they exceed the numberdefined inNTAP_SNAPSHOT_RETENTIONS and if they areolder than the retention age (indays).

    SNAPDRIVE (Y|N) Allows you to use SnapDriveinstead of Data ONTAP API tocreate a Snapshot copy.

    SNAPDRIVE_DISCOVERY (Y|N) Enables use of SnapDrive forthe discovery feature. RequiresSnapDrive to be configured andworking on host wherediscovery is performed.

    Configuring Snap Creator Server | 63

  • Parameter Setting Description

    NTAP_SNAPSHOT_DISABLE

    (Y|N) Disables the Snap Creator fromcreating a Snapshot copy sothat Snap Creator can handleSnapVault or SnapMirror forSnapManager. For this settingto work, the SnapManagerSnapshot copies need to followthis naming convention:-_recent.

    NTAP_SNAPSHOT_NODELETE

    (Y|N) OverridesNTAP_SNAPSHOT_RETENTIONS and prevents Snapshotcopies from being deleted.Leaving this variable on canmake the volume full.

    NTAP_SNAPSHOT_DELETE_BY_AGE_ONLY

    (Y|N) RequiresNTAP_SNAPSHOT_RETENTION_AGE and forces deletionbased on Snapshot copy agerather than the number ofSnapshot copies.

    NTAP_SNAPSHOT_DEPENDENCY_IGNORE

    (Y|N) Applies only to Snapshot copydeletion menu "-action delete".Manually deleting Snapshotcopies with a dependency is notpermitted.

    NTAP_SNAPSHOT_CREATE_CMD

    This SnapDrive commandcreates a Snapshot copy andflushes the file system buffers.< #> is a number from 01-99.

    Note: This is required if youenable the SNAPDRIVEoption.

    Data ONTAP API is still usedto perform everything else, butthe SNAPDRIVE optioncreates Snapshot copies.

    64 | Snap Creator 3.5.0 Installation and Administration Guide

  • Parameter Setting Description

    NTAP_CONSISTENCY_GROUP_SNAPSHOT

    (Y|N) Enables use of consistencygroups. By using this setting,you can take a consistent (I/Ofencing) Snapshot copy acrossmore than one volume andmultiple storage controllers.

    Note: Enabling this optionrequiresNTAP_CONSISTENCY_GROUP_TIMEOUT

    NTAP_CONSISTENCY_GROUP_TIMEOUT

    urgent |medium |relaxed Specifies the wait time for I/Ofencing between volumes.Before we can create aSnapshot consistency group, allvolumes must be quiesced (I/Ofencing). The default settingand recommendation is medium(7 seconds); however, thisdepends on the number ofvolumes you have and thenumber of appliances that areinvolved. Urgent is 2 seconds,Medium is 7 seconds, Relaxedis 20 seconds.

    NTAP_CONSISTENCY_GROUP_WAFL_SYNC

    (Y|N) Setting which can improveperformance of the CGSnapshot by forcing a CPthrough a wafl-sync before thecg-start.

    NTAP_SNAPSHOT_RESTORE_AUTO_DETECT

    (Y|N) Setting which if disabledalways forces a SFSR whendoing a single file restore.

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

    Parameter Setting Description

    NTAP_SNAPVAULT_UPDATE

    (Y|N) Allows you to turn off and turnon the SnapVault updatefunction.

    Configuring Snap Creator Server | 65

  • Parameter Setting Description

    SNAPVAULT_ VOLUMES This is the list of sourceappliances and volumes onwhich you want to perform aSnapVault update, that is,controller1:vol1,vol2,vol3;controller2:vol1;controller3:vol2,vol3.

    Note: For SnapVault andSnapMirror updates to work,the relationships must exist.Snap Creator does not createthe relationships.

    Note: The host name(s) inthe SnapMirror or SnapVaultrelationship must be thesame as specified in theVOLUMES,SNAPMIRROR_VOLUMES, andSNAPVAULT_VOLUMESoptions. Also, the host whereSnap Creator runs must beable to resolve thehostname(s).Note: For vSphere/vCloudplug-in, set the value toauto:detect

    Note: Host names should bethe short host name (namethat appears on storagecontroller command prompt),not the FQDN.

    66 | Snap Creator 3.5.0 Installation and Administration Guide

  • Parameter Setting Description

    SNAPVAULT_QTREE_INCLUDE

    This is the list of sourceappliances and qtree paths thatshould be included in theSnapVault update. Without thisoption, all qtrees under avolume are vaulted bySnapVault if a relationshipexists. Qtrees listed in thefollowing example are vaultedby SnapVault and the rest areignored by SnapVault:controller1:/vol/qtree/qtree1,/vol/volume/qtree2;controller2:/vol/volume/qtree1.

    NTAP_SNAPVAULT_RETENTIONS

    Determines the number ofSnapshot copies on theSnapVault secondary that youwant to retain for a givenpolicy, that is, daily:21,weekly:12,monthly:3.

    NTAP_SNAPVAULT_RETENTION_AGE

    Allows you to define aretention age (in days) forSnapVault Snapshot copies. Ifconfigured, SnapVaultSnapshot copies are deletedonly if they exceed the numberdefined inNTAP_SNAPVAULT_RETENTIONS and if they areolder than the retention age (indays).

    Configuring Snap Creator Server | 67

  • Parameter Setting Description

    NTAP_SNAPVAULT_SNAPSHOT

    (Y|N) Enables use of SnapVaultSnapshot copies; that is,Snapshot copies that arecompatible with the StorageController SnapVaultscheduler. When using thisoption, Snapshot delete ishandled by the Storagecontroller and not by the SnapCreator. Additionally, Snapshotcopies are named as follows:sv_.. Thepolicy name comes from theNTAP_SNAPSHOT_RETENTIONS parameter and theretention set is also applied tothe Storage ControllerSnapVault schedule.

    NTAP_SNAPVAULT_NODELETE

    (Y|N) OverridesNTAP_SNAPVAULT_RETENTIONS and prevents Snapshotcopies from being deleted.Leaving this on can cause yourvolume to fill up.

    NTAP_SNAPVAULT_RESTORE_WAIT

    (Y|N) In the case of SnapVaultrestore, it forces Snap Creatorto wait for the operation tocomplete. This is recommendedbecause after the SnapVaultrestore completes, Snap Creatorprompts the user to delete therestore Snapshot copies that getcreated on primary storage andare no longer needed.

    NTAP_SNAPVAULT_ WAIT This is the wait time (inminutes) for the SnapVaultupdate process to completebefore taking a Snapshot copyon the SnapVault secondary.

    68 | Snap Creator 3.5.0 Installation and Administration Guide

  • Parameter Setting Description

    NTAP_SNAPVAULT_MAX_TRANSFER

    This is the maximumbandwidth SnapVault isallowed to use in kbps. If it isnot set, SnapVault uses themaximum available bandwidth.

    The following table lists the parameters required to set SnapMirror:

    Parameter Setting Description

    NTAP_SNAPMIRROR_UPDATE

    (Y|N) Allows you to turn off and turnon the SnapMirror updatefunction.

    NTAP_SNAPMIRROR_CASCADING_UPDATE

    Y/N Allows you to turn off and turnon the cascading SnapMirrorupdate function. This is aSnapMirror update using aSnapVault destination volume.

    Note: This is not supportedfor Data ONTAP 8.1 Cluster-Mode

    SNAPMIRROR_ VOLUMES This is the list of sourceappliances and volumes onwhich you want to perform aSnapMirror update, that is,controller1:vol1,vol2,vol3;controller2:vol1;controller3:vol2,vol3. Note: For vSphere/vCloudplug-in set the value toauto:detect

    SNAPMIRROR_CASCADING_VOLUMES

    List of SnapVault destinationappliances and volumes where,after a SnapVault update, youwant to perform a SnapMirrorupdate, that is, sec-controller1:vol1-sec,vol2-sec.

    Configuring Snap Creator Server | 69

  • Parameter Setting Description

    NTAP_SNAPMIRROR_WAIT

    This is the wait time (inminutes) for the SnapMirrorupdate process to completebefore creating a clone on theSnapMirror destination. IfNTAP_CLONE_SECONDARY=Y, Snap Creator waits untilthe SnapMirror update iscomplete before proceeding.

    Note: This can only be usedwithNTAP_CLONE_SECONDARY and ACTION clone_vol(only volume clones arecurrently supported).

    NTAP_SNAPMIRROR_USE_SNAPSHOT

    (Y|N) If enabled, the SnapMirrorupdate uses the newly createdSnapshot copy, thus creating aSnapshot copy on theSnapMirror destination.

    Note: This is required forNTAP_CLONE_SECONDARY because a Snapshot copyis needed in order to create aclone on the SnapMirrordestination.

    NTAP_SNAPMIRROR_MAX_TRANSFER

    This is the maximumbandwidth SnapMirror isallowed to use in kbps. If it isnot set, SnapMirror uses themaximum available bandwidth.

    The following table lists the parameters required to set up cloning:

    Parameter Setting Description

    NTAP_VOL_CLONE_RESERVE

    none | file volume This is the space guarantee fora cloned volume.

    70 | Snap Creator 3.5.0 Installation and Administration Guide

  • Parameter Setting Description

    NTAP_LUN_CLONE_RESERVATION

    true | false If set to true, space is reservedfor the cloned LUNs if theclone_lun Action is selected.Otherwise, space is notreserved.

    NTAP_CLONE_IGROUP_MAP

    Specify the appliance, sourcevolume, and an IGROUP. TheIGROUP is then mapped tocloned LUNs that reside in thesource volume or cloned LUNsthat reside in the volume clone,that is,controller1:src_volume1/igroup1;controller2:src_volume2/igroup2.

    Note: LUN clones assumethe same name as their parentvolume or LUN and end with_CLONE, that is, if thevolume is called myvol, itsclone would bemyvol_CLONE

    Note: Volume clones startwith "cl_" and end with "-YYYYMMDDHHMMSS".

    NTAP_CLONE_FOR_BACKUP

    (Y|N) If enabled, clones (volume andLUN) are created and thendeleted after the otheroperations are complete.Otherwise, clones are deletedbefore operations complete.

    Note: If you are backing upclones to tape, this should beset to Y. If you are doingdatabase refreshes, then youshould set it to N.

    Configuring Snap Creator Server | 71

  • Parameter Setting Description

    NTAP_CLONE_SECONDARY

    (Y|N) If enabled, clones are createdon the SnapMirror destinationafter the SnapMirror update iscomplete.

    Note: This setting should beused withNTAP_SNAPMIRROR_USE_SNAPSHOT,NTAP_SNAPMIRROR_WAIT,NTAP_CLONE_SECONDARY_VOLUMES , andACTION clone_vol.

    NTAP_CLONE_SECONDARY_VOLUMES

    This is a mapping of primary/secondary appliances and thesecondary volumes. This isrequired so that Snap Creatorcan find the secondaryvolumes, that is,controller1:controller1-sec/vol1,vol2,vol3;controller2:controller2-sec/vol1;controller3:controller3-sec/vol2,vol3.

    NTAP_NUM_VOL_CLONES This is the number of volumeclones you want to retain. Thisworks in a similar way to theSnapshot retention policy.

    Note: This only works forvolume clones that require aFlexClone license on thestorage controller.

    NTAP_NFS_EXPORT_HOST Host IP The hostname or IP addresswhere the clone should beexported. This is the host wherethe user wants to mount theclone volume by using NFS.

    72 | Snap Creator 3.5.0 Installation and Administration Guide

  • Parameter Setting Description

    NTAP_NFS_EXPORT_ACCESS

    root | read-write | read-only The host specified inNTAP_NFS_EXPORT_HOSTreceives access or permission tothe clone volume. root - Rootaccess is granted read-only -Read-only access is grantedread-write - Read/Writeaccess is granted.

    NTAP_NFS_EXPORT_PERSISTENT

    true | false Determines if NFS export ispersistent. If true is selected,the clone volume is exportedand the /etc/exports file onthe Storage Controller isupdated.

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

    Parameter Setting Description

    NTAP_PM_UPDATE (Y|N) Allows you to turn off and onthe Protection Manager updatethat registers Snap CreatorSnapshot copies in ProtectionManager.

    Note: IfNTAP_PM_UPDATE isenabled, you must configureNTAP_DFM_DATA_SET.

    NTAP_DFM_DATA_SET This is a list of appliances andProtection Manager data sets tovolume correlations, that is,controller1:dataset1/vol1,vol2;controller1:dataset2/vol3.

    NTAP_PM_RUN_BACKUP (Y|N) Starts the Protection Managerbackup, checks the progressand status, and waits for it tocomplete.

    Configuring Snap Creator Server | 73

  • Parameter Setting Description

    NTAP_DFM_SNAPSHOT_FORMAT

    Optional setting for the formatof the secondary Snapshotcopies when using ProtectionManager. This option requiresOnCommand 5.0 (DataFabricManager) or higher. Requiredvariable: %T - timestampOptional variables are:%R - retention type%L - dataset label %H - storagecontroller %N - volume name %A- application specific data.If this option is not set then thedefault Protection Managernaming convention will beused. The naming conventioncan only be set at the time ofdataset creation.

    The following table lists the parameters required to set up Open Systems SnapVault:

    Parameter Setting Description

    NTAP_OSSV_ENABLE (Y|N) Enables the Open SystemsSnapVault integration. Thisoption must be used incombination with theNTAP_OSSV_HOMEDIRparameter. Open SystemsSnapVault is also required onthe host running Snap Creator.

    Note: When Open SystemsSnapVault option is enabled,the path is specified asvolumes. When specifyingpaths in windows for OpenSystems SnapVault : shouldnot be used. For example, ifthe path is E:\DB then itshould used as E\DB.

    74 | Snap Creator 3.5.0 Installation and Administration Guide

  • Parameter Setting Description

    NTAP_OSSV_HOMEDIR /usr/snapvault The path to the Open SystemsSnapVault home directory, thatis, /usr/snapvault

    NTAP_OSSV_FS_SNAPSHOT

    (Y|N) This setting also requires theNTAP_OSSV_FS_SNAPSHOT_CREATE_CMD andallows to create a file systemSnapshot copy using OS /Filesystem command. The Filesystem Snapshot copy is thentransferred to the storagesystem using SnapVault.

    NTAP_OSSV_FS_SNAPSHOT_CREATE_CMD

    These are scripts or commandsto be executed during or beforethe Open Systems SnapVaultbackup process, where ## is anumber from 01- 99. This canbe used to perform backup filesystem Snapshot copies byusing Open SystemsSnapVault.

    The following table describes the Operations Manager settings:

    Parameter Setting Description

    OM_HOST The name or IP address of theOperations Manager host.

    OM_USER The user name of an OperationsManager user who haspermission to create events.

    OM_PWD The password for theOperations Manager user.

    OM_PORT The port to use forcommunications withOperations Manager; 8080 isthe default http port that theOperations Manager uses.

    Configuring Snap Creator Server | 75

  • Parameter Setting Description

    OM_EVENT_GENERATE (Y|N) Enables or disables eventcreation in OperationsManager.

    The following table describes the different APP commands:

    Command Setting Description

    APP_CLONE_FOLLOW_ UP_CMD

    These are scripts or commandsto be executed after thedatabase is cloned, where ## isa number between 01- 99. Thiscan be used to performapplication-specific follow-upactivities on SAP systems, suchas, installing a SAP license,adjusting database tables,deleting or updating content,and starting up the application.

    APP_QUIESCE_CMD These are scripts or commandsthat put your application intobackup mode where, "##" is anumber between 01-99.

    Note: This is ignored if youuse APP_NAME because itis handled internally in SnapCreator.

    APP_UNQUIESCE_CMD

    These are scripts or commandsthat take your application out ofbackup mode, where "##" is anumber from 01-99.

    Note: This is ignored if youuse APP_NAME because itis handled internally in SnapCreator.

    ARCHIVE_CMD Handles database archiving. Itcan also be used as a wrapper torun other scripts. The archivecommand, where ## is anumber from 01-99.

    76 | Snap Creator 3.5.0 Installation and Administration Guide

  • The following table describes the different PRE commands:

    Command Setting Description

    PRE_APP_QUIESCE_CMD

    This is the pre applicationbackup start command,where##is a number from01-99.

    PRE_NTAP_CMD This is the pre Snapshotcommand, where##is a numberfrom 01-99; it runs before alloperations.

    PRE_APP_UNQUIESCE_CMD

    This is the pre applicationbackup stop command,where##is a number from01-99.

    PRE_NTAP_CLONE_DELETE_CMD

    This is the pre clone deletecommand, where## is anumber from 01-99.

    Note: The purpose of clonedelete command(s) is to calla mount script or commandsso that cloned LUNs can bemounted for the purpose ofbacking up (probably totape).

    PRE_EXIT_CMD This is an optional commandthat is run after a fatal erroroccurs but before Snap Creatorexits. This is useful to revert tothe state it was before SnapCreator ran.

    Note: This command returnsan application into normaloperation mode before SnapCreator exits due to an error.

    Note: This is ignored if youuse APP_NAME because itis handled internally in SnapCreator.

    Configuring Snap Creator Server | 77

  • Command Setting Description

    PRE_RESTORE_CMD This is an optional commandthat can be run before you enteran interactive restore. Thisallows you to interact with theapplication being restored. Forexample, you might want toshut down the applicationbefore performing a restore.

    Note: This is not supportedwith MySQL plug-in.

    PRE_CLONE_CREATE _CMD

    This is an optional commandthat can be run before DataONTAP API cloning operationsoccur, where##is a numberfrom 01-99.

    The following table describes the different POST commands:

    Command Setting Description

    POST_APP_QUIESCECMD

    This is a post applicationbackup start command,where##is a number from01-99.

    POST_NTAP_CMD This is a post command,where##is a number from01-99. This runs after alloperations are complete.

    POST_APP_UNQUIESCE_CMD

    This is a post applicationbackup stop command,where##is a number from01-99.

    POST_NTAP_DATA_TRANSFER_CMD

    This is a post data transfercommand that runs afterSnapVault or SnapMirrortransfer, where##is a numberfrom 01-99.

    78 | Snap Creator 3.5.0 Installation and Administration Guide

  • Command Setting Description

    POST_RESTORE_ CMD This is an optional commandthat can be run after youcomplete an interactive restore.It allows you to interact withthe application being restored.After your restore is complete,you might want to start theapplication.

    Note: This is not supportedwith MySQL plug-in.

    POST_CLONE_CREATE_CMD

    This is an optional commandthat can be run after DataONTAP API cloning operationsoccur, where##is a numberfrom 01-99. The commands areused to perform operations suchas mounting cloned filesystems.

    The following table describes the mount and Umount commands:

    Command Setting Description

    MOUNT_CMD Mount commands are used tomount file system for cloningor mount actions where##is anumber starting from 01 - 99.

    UMOUNT_CMD Umount commands are used tomount file system for cloningor mount actions where##is anumber starting from 01 - 99.

    Note: You should use MOUNT_CMDS and UMOUNT_CMDS for mount/umount commandsinstead of Snap Creator pre/post commands for cloning.

    The following table