netapp® snap creator™ framework 4.0.0 installation and...

NetApp® Snap Creator™ Framework 4.0.0Installation and Administration Guide

NetApp, Inc.495 East Java DriveSunnyvale, CA 94089 U.S.Telephone: +1 (408) 822-6000Fax: +1 (408) 822-4501Support telephone: +1 (888) 463-8277Web: www.netapp.comFeedback: [email protected]

Part number: 215-07460_A0May 2013

Contents

What Snap Creator Framework does ........................................................ 6Snap Creator architecture ............................................................................................ 6

What Snap Creator Agent is ........................................................................................ 7

Snap Creator Agent multithreading ............................................................................. 9

Security features of Snap Creator ............................................................ 12Snap Creator integration ........................................................................... 14Guidelines to define Snap Creator policies .............................................. 15Snap Creator server APIs .......................................................................... 16Preparing to install Snap Creator ............................................................. 17

Downloading the Snap Creator software .................................................................. 17

Creating a Data ONTAP user for Snap Creator with Data ONTAP operating in

7-Mode ................................................................................................................ 17

Creating a Snap Creator user for clustered Data ONTAP ......................................... 18

Commands for creating a role for a Snap Creator user in clustered Data

ONTAP .................................................................................................... 20

Installing Java on Snap Creator Server ..................................................................... 30

Preinstallation steps for the Domino plug-in ............................................................. 30

Settings specific to Linux, Solaris, and AIX ................................................. 30

Settings specific to Windows ........................................................................ 31

Installing Snap Creator on Windows ....................................................... 32Installing Snap Creator on UNIX ............................................................. 33

Installing Snap Creator Server .................................................................................. 33

Installing Snap Creator Agent ................................................................................... 34

Uninstalling Snap Creator from Windows .............................................. 35Uninstalling Snap Creator from UNIX .................................................... 36Upgrading from Snap Creator 3.6.0 ......................................................... 37Running Snap Creator on alternative ports ............................................ 39Information required to configure Snap Creator ................................... 40

Oracle plug-in ............................................................................................................ 44

MySQL plug-in ......................................................................................................... 46

DB2 plug-in ............................................................................................................... 46

Sybase plug-in ........................................................................................................... 47

Table of Contents | 3

MaxDB plug-in ......................................................................................................... 50

IBM Domino plug-in ................................................................................................. 52

SnapManager for Microsoft Exchange plug-in ......................................................... 56

SnapManager for Microsoft SQL Server plug-in ...................................................... 57

VMware (VIBE) plug-in ........................................................................................... 58

vCloud vApp backup and restore by using the VMware plug-in .................. 60

Virtual machine backup and restore by using the VMware plug-in ............. 61

Red Hat KVM plug-in ............................................................................................... 62

Citrix Xen plug-in ..................................................................................................... 64

Archive log plug-in ................................................................................................... 65

Creating a configuration file in Snap Creator ......................................... 67Creating a configuration file using the CLI .............................................................. 67

Creating a configuration file using the GUI .............................................................. 68

Creating a global configuration file using the GUI ................................................... 68

Referencing ............................................................................................................... 69

Snap Creator Agent configuration ........................................................... 98Snap Creator backup process ................................................................... 99

List of commands ...................................................................................................... 99

Running Snap Creator Server using the CLI ........................................ 101Running Snap Creator Agent using the CLI ......................................... 120Running Snap Creator using the GUI .................................................... 121Creating and managing roles .................................................................. 122Creating and managing users .................................................................. 123Creating a schedule .................................................................................. 124Monitoring jobs ........................................................................................ 126Monitoring agent ...................................................................................... 127Viewing data and log details .................................................................... 128Performing restore using Snap Creator ................................................. 129

Performing volume restore ...................................................................................... 129

Performing single file restore .................................................................................. 130

Performing application-defined restore ................................................................... 130

Performing restore with the Domino plug-in .......................................................... 131

Performing volume restore for Domino by using the CLI .......................... 132

Performing volume restore for Domino by using the GUI ......................... 133

Performing single file restore with NFS for Domino using the CLI ........... 133

Performing single file restore with NFS for Domino using the GUI .......... 135

4 | NetApp Snap Creator Framework 4.0.0 Installation and Administration Guide

Performing single file restore with block protocols for Domino ................ 135

Using the plug-in framework to create custom plug-ins ....................... 138Troubleshooting Snap Creator issues ..................................................... 140

Logs ......................................................................................................................... 140

Troubleshooting Snap Creator GUI errors .............................................................. 142

Troubleshooting network issues .............................................................................. 143

Troubleshooting the tmp directory permission issues ............................................. 144

Troubleshooting the Snap Creator start issue .......................................................... 144

Error messages ........................................................................................................ 144

Copyright information ............................................................................. 200Trademark information ........................................................................... 201How to send your comments .................................................................... 202Index ........................................................................................................... 203

Table of Contents | 5

What Snap Creator Framework does

Snap Creator Framework is a backup and restore software framework that enables you to integrateSnapshot technology with applications and hypervisors.

Snap Creator is platform and operating system independent. It provides integration through plug-insthat enable it to support any application or hypervisor on a storage system. Snap Creator uses theplug-ins to handle actions such as quiesce and unquiesce for a given application or hypervisor.

Snap Creator includes supported plug-ins for the following applications:

• Oracle• DB2• MySQL• Sybase ASE (Sybase)• IBM Domino (Domino)• SnapManager for Microsoft SQL Server• SnapManager for Microsoft Exchange• MaxDB• VMware (vSphere and vCloud Director)• Red Hat KVM• Citrix Xen

Additional application plug-ins are available and supported through the Snap Creator Community.

Snap Creator provides a management interface for Snapshot technology, SnapVault, Open SystemsSnapVault, SnapMirror, the NetApp Management Console data protection capability, OperationsManager console, and FlexClone technology.

Snap Creator architectureSnap Creator consists of a server and an agent layer. The server sends operations like quiesce orunquiesce to a given database by using the agent, which runs remotely or locally. Thecommunication layer from the agent to the server is Simple Object Access Protocol (SOAP) overHTTP.

Snap Creator introduces a new architecture for the server, but the agent architecture remains the sameas version 3.x. The server exposes the APIs, which allow the GUI and CLI to run remotely. The GUImust be installed on the same system on which the server is installed. The GUI can remotely connectto another server but cannot be detached. The CLI is independent and can be installed on any systemwhich has access to the server.

Snap Creator consists of three main components:


• Snap Creator engine - This is the main program, which can either run on a central backup serveror where the application is installed. It uses Data ONTAP API to communicate with the storagesystems and other NetApp software products and uses OnCommand Unified Manager APIs tocommunicate with the NetApp Management Console data protection capability. Only Snapshottechnology is required for Snap Creator to function. Other NetApp software products areoptional.

• Application and hypervisor plug-in (optional) - This normally runs where the application orhypervisor is installed. It provides application integration including consistency.

• Configuration file - This controls what Snap Creator does.

The following illustration shows the Snap Creator architecture:

What Snap Creator Agent isSnap Creator Agent is a lightweight daemon that runs remotely or locally on the host. For example,the server sends quiesce or unquiesce operations to a given application by using the agent.

All the Snap Creator configurations are stored centrally on the server and all backup jobs can bescheduled from the same host. This provides a single pane of glass (SPOG) for backup and restoreoperations.

What Snap Creator Framework does | 7

The following illustration shows the agent architecture:

By default, port 9090 is used for agent communications. However, you can also use any other port.

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 and can be added to the scAgent/plugins directory. Inaddition to the application plug-ins, all PRE commands, POST commands, and APP commands canbe executed remotely through the agent. This provides the ability to mount file systems or to performadditional application processing remotely. The agent has an access file under /path/to/scAgent_v/config/agent.conf where certain commands are allowed to run. By default, allcommands that are not part of Snap Creator or a supported plug-in are denied. This means that onlythe built-in or community plug-ins can execute commands through the agent. PRE or POST scriptingcommands or scripts must be allowed in agent.conf.

Note: Snap Creator 4.0.0 supports only Snap Creator 4.0.0 Agent.

The following illustration shows the agent communication:


Snap Creator Agent multithreadingSnap Creator Agent handles parallel requests by distributing the requests that come from the agent.

The following illustration shows the different types of Snap Creator Agent deployment:


Simple deployment

In simple deployment, Snap Creator Server opens a connection to Snap Creator Agent. Theconnection between the server and agent remains active and the agent cannot accept further requestsuntil the server stops.

Deployment using a watchdog

In this deployment, Snap Creator Agent creates a separate process (watchdog) after accepting arequest from Snap Creator Server to quiesce the database. The watchdog process inherits theenvironment and all the settings of the parent process and unquiesces the database after a configuredtimeout.

The agent is blocked until the server stops or closes the connection.

Multithreaded deployment using a watchdog

In a multithreaded deployment, Snap Creator Agent creates an additional process (SC-A', as shownin the illustration) and passes the communication responsibility (req') to this process. This newlycreated process inherits the basic Snap Creator Agent settings and Snap Creator Servercommunicates with this process. If configured, this process creates a watchdog when the quiesceoperation is called.

After the additional process is created, the agent can accept additional requests.

Note: The multithreaded agent is not supported on Windows and the following plug-ins:


• Domino• MySQL• VMware• KVM• Xen


Security features of Snap Creator

Snap Creator provides security features such as role-based access control (RBAC) and host securityfor Snap Creator Agent. The users can be assigned access to specific profiles.

RBAC in Snap Creator

In Snap Creator 4.0.0, RBAC involves users, roles, permissions, operations, and profiles. The users,roles, and permissions can be defined by the Snap Creator users.

• Users

• Users are uniquely identified by a user name and password.• User can be assigned and unassigned to one or more roles and profiles.• The SNAPCREATOR_USER in the snapcreator.properties file is added as a user

when the Snap Creator Server is started.• The SNAPCREATOR_USER in the snapcreator.properties file is assigned the Default

Administrator role when the user is created during startup.• Roles: Roles have one or more permissions. The assigned permissions determine the actions a

user can perform and also which GUI elements the user can access. There are three built-in roles:

• Administrator: Has full access to all the APIs. This is the only role which can create, edit, anddelete users.

• Operator: This role is configured to be a super user and has access to all the APIs exceptRBAC.

• Viewer: Has very limited access. This role has access to read-only API calls.

Note: These built-in roles cannot be added, removed, or modified.

• Permissions: Permissions are a set of operations the user is authorized to perform. Someexamples of permissions are backup, clone volume, and restore.

• Operations: Operations are the base values that Snap Creator checks for authorization. Someexamples of operations are getTask, fileCloneCreate, createTask, dirCreate, and so on.

Note: Operations cannot be added, removed, or modified.

• Profiles

• Profiles are assigned to users.• Profiles in RBAC are created in the profile directory on the file system by using the graphical

user interface (GUI) or the command-line interface (CLI).• Certain Snap Creator APIs check if a user is assigned to a profile and also check the

permissions for operations.For example, if a user wants a job status, RBAC verifies if the user has authorization to callSchedulergetJob and then checks if the profile associated with the job is assigned to the user.


• If a user, who is assigned the Operator role, creates a profile by using the GUI or CLI, thenthat profile is automatically assigned to the user.

RBAC for storage controllersIf you are not using the OnCommand Unified Manager proxy, you need a user name and password tocommunicate with the storage controllers. Passwords can be encrypted for security.

Note: You should not use the root user. It is recommended to create a backup user with thenecessary API permissions.

Network communications are through HTTP (80) or HTTPS (443), so you must have one or both ofthese ports open between the host where Snap Creator runs and the storage controllers. A user mustbe created on the storage controllers for authentication. For HTTPS, you must ensure that the user isenabled and configured on the storage controllers.

Snap Creator Agent securitySnap Creator uses host security to allow only authorized hosts to access the agent. This featureallows you to specify multiple host lines. If a command contains the path of the Snap Creatorinstallation directory, it is blocked.

Security features of Snap Creator | 13

Snap Creator integration

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

• Optionally integrates with both SnapDrive for UNIX and SnapDrive for Windows.Snap Creator can use the Manage ONTAP Solution to send calls directly to the storage controllerto create Snapshot copies, or use SnapDrive.

• Optionally uses SnapVault directly instead of the NetApp Management Console data protectioncapability to transfer Snapshot copies to the secondary storage.

• Snapshot technology, SnapVault, SnapMirror, LUN cloning, volume cloning, and igroupmapping using Data ONTAP API.

• Any application or database that runs in an open systems environment (you can create your ownapplication backup script or plug-in).

• NetBackup, CommVault, or any backup software with CLI commands.• Optionally integrates with Operations Manager console for monitoring (the ability to create

events in Operations Manager console).• Optionally integrates with the NetApp Management Console data protection capability to perform

secondary backup (Snap Creator backup copies can be registered in the NetApp ManagementConsole data protection capability).

• Optionally integrates with Open Systems SnapVault.

Note:

• Snap Creator 4.0.0 does not support SnapVault, Operations Manager console, the NetAppManagement Console data protection capability, and Open Systems SnapVault on clusteredData ONTAP 8.1, clustered Data ONTAP 8.1.1, and clustered Data ONTAP 8.1.2.

• For SnapMirror and SnapVault, the storage system and the host must be resolved either thoughthe Domain Name System (DNS) or in /etc/hosts. For clustered Data ONTAP, the clusterand Vserver must be resolved either though the DNS or in /etc/hosts.

For latest information about support and compatibility matrices, see the Interoperability Matrix.

Related information

Interoperability Matrix: support.netapp.com/NOW/products/interoperability


http://support.netapp.com/NOW/products/interoperability/

Guidelines to define Snap Creator policies

Snap Creator policies are user-defined Snapshot copy retentions that apply to the Snapshot copies onthe primary storage and SnapVault Snapshot copies on the secondary storage. You can use a policyto define the number of Snapshot copies that you want to retain and the Snapshot copy age.

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

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

NTAP_SNAPSHOT_RETENTIONS=daily:7

NTAP_SNAPVAULT_RETENTIONS=daily:28

You can also specify the minimum number of days after which a Snapshot copy is deleted. In thepreceding example, use the following options:

NTAP_SNAPSHOT_RETENTION_AGE=7

NTAP_SNAPVAULT_RETENTION_AGE=28

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

NTAP_SNAPSHOT_DELETE_BY_AGE_ONLY=Y

Note: 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 the policy, and then call it in Snap Creator once a week by usingcron or task manager with SNAP_TYPE set to Weekly.

15

Snap Creator server APIs

APIs are used by the Snap Creator graphical user interface (GUI) and command-line interface (CLI)and other products or services. These APIs are based on the SOAP web service.

The APIs are grouped under web services.

Engine APIs

These APIs run Snap Creator workflows. Workflow-based APIs are task based, which means thatyou must start an API and then check the status to view the messages and the exit results of theworkflow.

Repository APIs

These APIs are related to the Snap Creator repository. The repository stores information aboutbackup configurations. You can use the repository APIs to create, delete, or update backupconfigurations.

RBAC APIs

These APIs are used to perform user or role management. Snap Creator does not integrate withActive Directory, Lightweight Directory Access Protocol (LDAP), or other user managementsystems. The users and roles are created in the Snap Creator environment.

Storage interface APIs

These APIs are direct storage calls. You can use these APIs to create a Snapshot copy from yourapplication plug-in or perform operations directly with storage without invoking a workflow. Youmust provide the storage credentials for authentication.

Scheduler APIs

These APIs are related to the scheduler actions. You can use the scheduler APIs to schedule a job,run a job, update a job, and so on.

For more details, see the API documentation.

Note: To access the API documentation, you should register in the Snap Creator DeveloperCommunity.

Related information

Snap Creator 4.0.0 API documentation: netapp.github.com/SC-FrameworkSnap Creator Developer Community: snapcreator.netapp.com


http://netapp.github.com/SC-Framework/https://snapcreator.netapp.com/

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, installing Java on Snap Creator, and adding SecureSockets Layer (SSL) libraries for the UNIX environment.

Downloading the 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 clicking View & Download.

2. From Software download instructions, click CONTINUE.

3. Accept the End User License Agreement.

4. Select the operating system and bit level of the software package.

Related information

NetApp Support Site: support.netapp.com

Creating a Data ONTAP user for Snap Creator with DataONTAP operating in 7-Mode

Snap Creator uses the Data ONTAP APIs to communicate with the storage system. To ensure that theuser account is granted access to only Snap Creator, create a new role, group, and user. This controlsthe access and limits the scope of the Snap Creator account.

About this task

You must use the Data ONTAP command-line interface (CLI) (SSH, console connection, or Telnet)to create a new role, group, and user account.

Note: You should copy and paste the command into a text editor, verify the command, and thenenter it in the CLI console.

Steps

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

17

http://support.netapp.com/

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-*

Note: The command shown in this step includes all the API roles used by Snap Creator.However, you can restrict the user access by including only the required roles.

2. Create a new group on the storage system and assign the role created in Step 1 to the group byentering the following command:

useradmin group add groupname -r rolename

3. Create a user account by entering 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.

Creating a Snap Creator user for clustered Data ONTAPClustered Data ONTAP requires creation of two users on the clustered Data ONTAP system—acluster user and a virtual storage server (vserver) user. Both users require the HTTP, ONTAPIlibrary, and Secure Shell (SSH) applications.

About this task

The cluster user can use the admin role and the vserver user can use the vsadmin role. You can alsocreate a new cluster user and a new vserver user. If you create new users, you must create roles forthe new users.

The users cannot be interchanged. For example, the cluster user does not have access to the necessaryAPIs to perform certain actions such as creating a Snapshot copy. This is true even if you use thedefault cluster administrator account. vserver accounts with the appropriate access must be used.

You must use the Data ONTAP command-line interface (CLI) (SSH, console connection, or Telnet)to create a new role, group, and user account.

Note: You should copy and paste the command into a text editor, verify the command, and thenenter it in the CLI.

Steps

1. (For a new cluster user only) Create a role by running the following command:

role create -role CRBAC_New -cmddirname storage aggregate -vserverclus3240rre

In this command, the CRBAC_NEW role is created on the clus3240rre cluster and storageaggregate is the command directory name.


Note: This command must be run for all the command directory names.

2. Create a cluster user by running the following command:

security login create -username scuser1 -applicationconsole,ssh,ontapi,http -authmethod password -role CRBAC_New -vserverclus3240rre

In this command, the scuser1 user is created on the clus3240rre cluster.

Example

clus3240rre::> security login create -username scuser1 -application console -authmethod password -role CRBAC_New -vserver clus3240rre

Please enter a password for user 'scuser1':Please enter it again:

clus3240rre::> security login create -username scuser1 -application http -authmethod password -role CRBAC_New -vserver clus3240rre

clus3240rre::> security login create -username scuser1 -application ontapi -authmethod password -role CRBAC_New -vserver clus3240rre

clus3240rre::> security login create -username scuser1 -application ssh -authmethod password -role CRBAC_New -vserver clus3240rre

3. (For a new vserver user only) Create a role by running the following command:

role create -role VSERVERRBACROLE_New -cmddirname volume file -vserverSnapcreator

In this command, the VSERVERRBACROLE_New role is created on the Snapcreator vserver andvolume file is the command directory name.

Note: This command must be run for all the command directory names.

4. Create a vserver user by running the following command:

security login create -username sc_vserver1 -application ssh,ontapi,http-authmethod password -role VSERVERRBACROLE_New -vserver Snapcreator

In this command, the sc_vserver1 user is created on the Snapcreator vserver.

Example

clus3240rre::> security login create -username sc_vserver1 -application http -authmethod password -role VSERVERRBACROLE_New -vserver Snapcreator

Preparing to install Snap Creator | 19

Please enter a password for user 'sc_vserver1':Please enter it again:

clus3240rre::> security login create -username sc_vserver1 -application ontapi -authmethod password -role VSERVERRBACROLE_New -vserver Snapcreator

clus3240rre::> security login create -username sc_vserver1 -application ssh -authmethod password -role VSERVERRBACROLE_New -vserver Snapcreator

Related references

Commands for creating a role for a Snap Creator user in clustered Data ONTAP on page 20

Commands for creating a role for a Snap Creator user in clustered DataONTAP

While creating a Snap Creator user in clustered Data ONTAP, a role must be created for a newcluster user or Vserver user by running a few commands.

The following table lists the commands that are required to create a role for a new cluster user:

Command directoryname

Command to be run

storage aggregate role create -role CRBAC_New -cmddirname storageaggregate -vserver clus3240rre

cluster identity show role create -role CRBAC_New -cmddirname clusteridentity show -vserver clus3240rre

vserver export-policyrule show

role create -role CRBAC_New -cmddirname vserver export-

policy rule show -vserver clus3240rre

volume file role create -role CRBAC_New -cmddirname volume file -vserver clus3240rre

system license show role create -role CRBAC_New -cmddirname system licenseshow -vserver clus3240rre

vserver services unix-group show

role create -role CRBAC_New -cmddirname vserver

services unix-group show -vserver clus3240rre

vserver services unix-user show


services unix-user show -vserver clus3240rre

network interface show role create -role CRBAC_New -cmddirname networkinterface show -vserver clus3240rre



Command to be run

security login show role create -role CRBAC_New -cmddirname security loginshow -vserver clus3240rre

security login roleshow

role create -role CRBAC_New -cmddirname security login

role show -vserver clus3240rre

volume efficiencyshow

role create -role CRBAC_New -cmddirname volume

efficiency show -vserver clus3240rre

system node show role create -role CRBAC_New -cmddirname system nodeshow -vserver clus3240rre

version role create -role CRBAC_New -cmddirname version -vserver clus3240rre

version security login role create -role bainew1 -vserverSnapCreator -cmddirname version -access readonly

volume show role create -role CRBAC_New -cmddirname volume show -vserver clus3240rre

vserver show role create -role CRBAC_New -cmddirname vserver show -vserver clus3240rre

volume file clonecreate

role create -role CRBAC_New -cmddirname volume file

clone create -vserver clus3240rre

system node role create -role CRBAC_New -cmddirname system node -vserver clus3240rre

volume file role create -role bainew1 -vserver SnapCreator -cmddirname volume file show-disk-usage -access all

vserver nfs status role create -role CRBAC_New -cmddirname vserver nfsstatus -vserver clus3240rre

system node run role create -role CRBAC_New -cmddirname system node run-vserver clus3240rre

system services ndmp role create -role CRBAC_New -cmddirname system servicesndmp -vserver clus3240rre

network fcp adaptershow

role create -role CRBAC_New -cmddirname network fcp

adapter show -vserver clus3240rre

vserver fcp initiatorshow

role create -role CRBAC_New -cmddirname vserver fcp

initiator show -vserver clus3240rre



Command to be run

vserver fcp show role create -role CRBAC_New -cmddirname vserver fcpshow -vserver clus3240rre

vserver fcp status role create -role CRBAC_New -cmddirname vserver fcpstatus -vserver clus3240rre

lun igroup show role create -role CRBAC_New -cmddirname lun igroup show-vserver clus3240rre

vserver iscsiconnection show

role create -role CRBAC_New -cmddirname vserver iscsi

connection show -vserver clus3240rre

vserver iscsi interfaceaccesslist show


interface accesslist show -vserver clus3240rre

vserver iscsi nodename role create -role CRBAC_New -cmddirname vserver iscsinodename -vserver clus3240rre

vserver iscsi show role create -role CRBAC_New -cmddirname vserver iscsishow -vserver clus3240rre

vserver iscsi status role create -role CRBAC_New -cmddirname vserver iscsistatus -vserver clus3240rre

vserver iscsi sessionshow


session show -vserver clus3240rre

lun geometry role create -role CRBAC_New -cmddirname lun geometry -vserver clus3240rre

lun show role create -role CRBAC_New -cmddirname lun show -vserver clus3240rre

lun mapped show role create -role CRBAC_New -cmddirname lun mapped show-vserver clus3240rre

system nodeautosupport invoke

role create -role CRBAC_New -cmddirname system node

autosupport invoke -vserver clus3240rre

vserver export-policyrule create


policy rule create -vserver clus3240rre

lun igroup add role create -role CRBAC_New -cmddirname lun igroup add-vserver clus3240rre

lun igroup create role create -role CRBAC_New -cmddirname lun igroupcreate -vserver clus3240rre



Command to be run

lun igroup set role create -role CRBAC_New -cmddirname lun igroup set-vserver clus3240rre

vserver iscsi interfaceaccesslist add


interface accesslist add -vserver clus3240rre

lun create role create -role CRBAC_New -cmddirname lun create -vserver clus3240rre

lun map role create -role CRBAC_New -cmddirname lun map -vserver clus3240rre

lun move role create -role CRBAC_New -cmddirname lun move -vserver clus3240rre

lun online role create -role CRBAC_New -cmddirname lun online -vserver clus3240rre

lun comment role create -role CRBAC_New -cmddirname lun comment -vserver clus3240rre

lun modify role create -role CRBAC_New -cmddirname lun modify -vserver clus3240rre

lun unmap role create -role CRBAC_New -cmddirname lun unmap -vserver clus3240rre

vserver services unix-group create


services unix-group create -vserver clus3240rre

vserver services unix-user create


services unix-user create -vserver clus3240rre

vserver export-policyshow


policy show -vserver clus3240rre

volume efficiency on role create -role CRBAC_New -cmddirname volumeefficiency on -vserver clus3240rre

volume efficiency start role create -role CRBAC_New -cmddirname volumeefficiency start -vserver clus3240rre

volume snapshot create role create -role CRBAC_New -cmddirname volume snapshotcreate -vserver clus3240rre

volume modify role create -role CRBAC_New -cmddirname volume modify -vserver clus3240rre



Command to be run

volume autosize role create -role CRBAC_New -cmddirname volume autosize-vserver clus3240rre

volume clone create role create -role CRBAC_New -cmddirname volume clonecreate -vserver clus3240rre

volume create role create -role CRBAC_New -cmddirname volume create -vserver clus3240rre

volume modify role create -role CRBAC_New -cmddirname volume modify -vserver clus3240rre

nfs role create -role CRBAC_New -cmddirname nfs -vserverSnapcreator -vserver clus3240rre

iscsi role create -role CRBAC_New -cmddirname iscsi -vserverSnapcreator -vserver clus3240rre

fcp role create -role CRBAC_New -cmddirname fcp -vserverSnapcreator -vserver clus3240rre

lun resize role create -role CRBAC_New -cmddirname lun resize -vserver clus3240rre

volume efficiency off role create -role CRBAC_New -cmddirname volumeefficiency off -vserver clus3240rre

volume size role create -role CRBAC_New -cmddirname volume size -vserver clus3240rre

lun delete role create -role CRBAC_New -cmddirname lun delete -vserver clus3240rre

lun offline role create -role CRBAC_New -cmddirname lun offline -vserver clus3240rre

volume destroy role create -role CRBAC_New -cmddirname volume destroy-vserver clus3240rre

volume offline role create -role CRBAC_New -cmddirname volume offline-vserver clus3240rre

volume unmount role create -role CRBAC_New -cmddirname volume unmount-vserver clus3240rre

options role create -role CRBAC_New -cmddirname options -vserver clus3240rre



Command to be run

system nodeautosupport

role create -role CRBAC_New -cmddirname system node

autosupport -vserver clus3240rre

snapmirror role create -role CRBAC_New -cmddirname snapmirror -vserver clus3240rre

event role create -role CRBAC_New -cmddirname event -vserverclus3240rre

event config role create -role CRBAC_New -cmddirname event config -vserver clus3240rre

event log role create -role CRBAC_New -cmddirname event log -vserver clus3240rre

event destination role create -role CRBAC_New -cmddirname eventdestination -vserver clus3240rre

event mailhistory role create -role CRBAC_New -cmddirname eventmailhistory -vserver clus3240rre

event route role create -role CRBAC_New -cmddirname event route -vserver clus3240rre

event snmphistory role create -role CRBAC_New -cmddirname eventsnmphistory -vserver clus3240rre

event status role create -role CRBAC_New -cmddirname event status -vserver clus3240rre

The following table lists the commands that are required to create a role for a new Vserver user:


Command to be run

vserver export-policyrule show

role create -role VSERVERRBACROLE_New -cmddirname

vserver export-policy rule show -vserver Snapcreator

volume file role create -role VSERVERRBACROLE_New -cmddirnamevolume file -vserver Snapcreator

adduser role create -role VSERVERRBACROLE_New -cmddirnameadduser -vserver Snapcreator

vserver services unix-group show


vserver services unix-group show -vserver Snapcreator



Command to be run

vserver services unix-user show


vserver services unix-user show -vserver Snapcreator

volume efficiencyshow


volume efficiency show -vserver Snapcreator

volume show role create -role VSERVERRBACROLE_New -cmddirnamevolume show -vserver Snapcreator

nfs role create -role VSERVERRBACROLE_New -cmddirname nfs -vserver Snapcreator

fcp role create -role VSERVERRBACROLE_New -cmddirname fcp -vserver Snapcreator

iscsi role create -role VSERVERRBACROLE_New -cmddirname iscsi-vserver Snapcreator

volume role create -role VSERVERRBACROLE_New -cmddirnamevolume

options role create -role VSERVERRBACROLE_New -cmddirnameoptions -vserver Snapcreator

volume mount role create -role VSERVERRBACROLE_New -cmddirnamevolume mount -vserver Snapcreator

volume file clonecreate


volume file clone create -vserver Snapcreator

restore-file role create -role VSERVERRBACROLE_New -cmddirnamerestore-file -vserver Snapcreator

vserver nfs status role create -role VSERVERRBACROLE_New -cmddirnamevserver nfs status -vserver Snapcreator

vserver fcp initiatorshow


vserver fcp initiator show -vserver Snapcreator

vserver fcp show role create -role VSERVERRBACROLE_New -cmddirnamevserver fcp show -vserver Snapcreator

vserver fcp status role create -role VSERVERRBACROLE_New -cmddirnamevserver fcp status -vserver Snapcreator

lun igroup show role create -role VSERVERRBACROLE_New -cmddirname lunigroup show -vserver Snapcreator



Command to be run

vserver iscsiconnection show


vserver iscsi connection show -vserver Snapcreator

vserver iscsi interfaceaccesslist show


vserver iscsi interface accesslist show -vserver

Snapcreator

vserver iscsi nodename role create -role VSERVERRBACROLE_New -cmddirnamevserver iscsi nodename -vserver Snapcreator

vserver iscsi show role create -role VSERVERRBACROLE_New -cmddirnamevserver iscsi show -vserver Snapcreator

vserver iscsi status role create -role VSERVERRBACROLE_New -cmddirnamevserver iscsi status -vserver Snapcreator

vserver iscsi sessionshow


vserver iscsi session show -vserver Snapcreator

lun geometry role create -role VSERVERRBACROLE_New -cmddirname lungeometry -vserver Snapcreator

lun show role create -role VSERVERRBACROLE_New -cmddirname lunshow -vserver Snapcreator

lun mapped show role create -role VSERVERRBACROLE_New -cmddirname lunmapped show -vserver Snapcreator

lun igroup add role create -role VSERVERRBACROLE_New -cmddirname lunigroup add -vserver Snapcreator

lun igroup create role create -role VSERVERRBACROLE_New -cmddirname lunigroup create -vserver Snapcreator

lun igroup set role create -role VSERVERRBACROLE_New -cmddirname lunigroup set -vserver Snapcreator

vserver iscsi interfaceaccesslist add


vserver iscsi interface accesslist add -vserver

Snapcreator

lun create role create -role VSERVERRBACROLE_New -cmddirname luncreate -vserver Snapcreator

lun map role create -role VSERVERRBACROLE_New -cmddirname lunmap -vserver Snapcreator



Command to be run

lun move role create -role VSERVERRBACROLE_New -cmddirname lunmove -vserver Snapcreator

lun online role create -role VSERVERRBACROLE_New -cmddirname lunonline -vserver Snapcreator

lun comment role create -role VSERVERRBACROLE_New -cmddirname luncomment -vserver Snapcreator

lun modify role create -role VSERVERRBACROLE_New -cmddirname lunmodify -vserver Snapcreator

lun unmap role create -role VSERVERRBACROLE_New -cmddirname lununmap -vserver Snapcreator

vserver services unix-group create


vserver services unix-group create -vserver Snapcreator

vserver services unix-user create


vserver services unix-user create -vserver Snapcreator

vserver export-policyshow


vserver export-policy show -vserver Snapcreator

volume efficiency on role create -role VSERVERRBACROLE_New -cmddirnamevolume efficiency on -vserver Snapcreator

volume efficiency start role create -role VSERVERRBACROLE_New -cmddirnamevolume efficiency start -vserver Snapcreator

volume snapshot create role create -role VSERVERRBACROLE_New -cmddirnamevolume snapshot create -vserver Snapcreator

volume snapshot delete role create -role VSERVERRBACROLE_New -cmddirnamevolume snapshot delete -vserver Snapcreator

volume modify role create -role VSERVERRBACROLE_New -cmddirnamevolume modify -vserver Snapcreator

volume autosize role create -role VSERVERRBACROLE_New -cmddirnamevolume autosize -vserver Snapcreator

volume clone create role create -role VSERVERRBACROLE_New -cmddirnamevolume clone create -vserver Snapcreator

volume create role create -role VSERVERRBACROLE_New -cmddirnamevolume create -vserver Snapcreator



Command to be run

volume modify role create -role VSERVERRBACROLE_New -cmddirnamevolume modify -vserver Snapcreator

vserver iscsi isns query role create -role VSERVERRBACROLE_New -cmddirnamevserver iscsi isns query -vserver Snapcreator

volume file clone role create -role VSERVERRBACROLE_New -cmddirnamevolume file clone -vserver Snapcreator

volume clone role create -role VSERVERRBACROLE_New -cmddirnamevolume clone -vserver Snapcreator

volume snapshotrestore


volume snapshot restore -vserver Snapcreator

lun resize role create -role VSERVERRBACROLE_New -cmddirname lunresize -vserver Snapcreator

volume efficiency off role create -role VSERVERRBACROLE_New -cmddirnamevolume efficiency off -vserver Snapcreator

volume size role create -role VSERVERRBACROLE_New -cmddirnamevolume size -vserver Snapcreator

lun delete role create -role VSERVERRBACROLE_New -cmddirname lundelete -vserver Snapcreator

lun offline role create -role VSERVERRBACROLE_New -cmddirname lunoffline -vserver Snapcreator

volume destroy role create -role VSERVERRBACROLE_New -cmddirnamevolume destroy -vserver Snapcreator

volume offline role create -role VSERVERRBACROLE_New -cmddirnamevolume offline -vserver Snapcreator

volume unmount role create -role VSERVERRBACROLE_New -cmddirnamevolume unmount -vserver Snapcreator

version role create -role VSERVERRBACROLE_New -cmddirnameversion -vserver Snapcreator

snapmirror role create -role VSERVERRBACROLE_New -cmddirnamesnapmirror -vserver SnapCreator


Installing Java on Snap Creator ServerFor Snap Creator to function, Java must be installed. Java Runtime Environment (JRE) 1.6 or latermust be installed on Snap Creator Server.

Steps

1. Download Java from the Java web site.

Note: The bit levels (32-bit or 64-bit) of Java and Snap Creator must be the same.

2. Verify the version and bit level of Java by entering the following command:java -version

Example

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 displays the installed version of Java. If the bit level is not displayed,then the installation is 32-bit.

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

Settings specific to Linux, Solaris, and AIXIBM Domino for Linux is available only as a 32-bit application. Regardless of the server bit level,the 32-bit version of Snap Creator must be used to support IBM Domino.

Snap Creator Agent cannot be run as the root user. You should run Snap Creator by using the sameaccount that is used to install IBM 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. After installingDomino to the default location, you can copy and paste the following commands into theenvironment:

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

Note: You should copy and paste the command into a text editor, verify the command, and thenenter it in the command-line interface (CLI) console.

Settings specific to WindowsYou must add the path to the Domino binary files into the environmental variables for Windows.This path should be the same as Notes_ExecDirectory listed in the Domino options table.

Steps

1. On the Desktop, right-click My Computer and select Properties (If My Computer is not on theDesktop, it can usually be found in the Start menu).

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

3. Click Environmental Variables.

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

4. Locate and select PATH, then click Edit.

5. Append ; after the last value, and then add the Domino path.

6. Click OK in each window until you exit to the Desktop.

7. If you perform these steps after the Snap Creator is installed, you must restart the Snap Creatorservice.

a) Click Start > Control Panel > Administrative Tools > Services > SnapCreatorService.b) Click Restart.


Installing Snap Creator on Windows

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

Before you begin

• For Windows 2003 Agent service, you must have installed Microsoft .NET Framework 3.5 orlater.

Steps

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

2. Run the installation package executable and complete the steps in the installation wizard.

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

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

Related tasks

Downloading the Snap Creator software on page 17Installing Java on Snap Creator Server on page 30Creating a Data ONTAP user for Snap Creator with Data ONTAP operating in 7-Mode on page 17Creating a Snap Creator user for clustered Data ONTAP on page 18


Installing Snap Creator on UNIX

For UNIX, the Snap Creator software package is a compressed file, which when extracted containsboth the server and agent.

The UNIX Services (agent/server) feature provides a start script for the server and agent. The startscripts are written in UNIX shell script (bourne shell) and are designed to run on all the UNIXenvironments that are supported by Snap Creator.

Installing Snap Creator ServerYou can install Snap Creator Server on UNIX. Snap Creator Server is designed to run on any opensystems platform.

Steps

1. Extract the *.tar.gz file to /usr/local.

2. Change the directory to Snap Creator Server root directory /path/to/scServer_v.

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

./snapcreator --setup

Note: Upon extraction, the Snap Creator executable should configured with the properpermissions. If the setup command does not work, you can add the necessary permissions byrunning the following command: chmod 755 snapcreator

4. Accept the End User License Agreement (EULA).

5. Enter y when the following message appears:Setup NetApp Snap Creator Framework 4.0.0 Server (Y|N)?

6. Optional: Enter the controller serial number.

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. You can runthe -version command to retrieve this serial number when contacting technical support toopen a Snap Creator case.

7. Enter the Snap Creator port.

8. To enable job monitoring, enter y.

9. Enter the job monitor size.

Note: The job monitor size should be between 1 and 1000.

10. Enter the user name and password for the administrator of the GUI.

33

11. Start Snap Creator Server by following the instructions provided on the screen.

Related tasks

Downloading the Snap Creator software on page 17Installing Java on Snap Creator Server on page 30Creating a Data ONTAP user for Snap Creator with Data ONTAP operating in 7-Mode on page 17Creating a Snap Creator user for clustered Data ONTAP on page 18

Installing Snap Creator AgentSnap Creator Agent is designed to run on any open systems platform. If the agent is not required, youcan choose to run the Snap Creator Server locally on the application server.

Steps

1. Extract the *.tar.gz file to /usr/local.

2. Change the directory to the Snap Creator Server root directory /path/to/scAgent_v.

3. Accept the End User License Agreement (EULA).

4. Enter y when the following message appears:Setup NetApp Snap Creator Framework 4.0.0 Agent (Y|N)?

5. Enter the Snap Creator Agent port.

6. Start the Snap Creator Agent by following the instructions provided on the screen.


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 configuration files to retain the existing configuration.• If the server is manually started from the console, you must have stopped it.• You must have backed up the Snap Creator database.

Step

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

35

Uninstalling Snap Creator from UNIX

You can uninstall Snap Creator from UNIX by deleting the Snap Creator installation folder.

Before you begin

• You must have backed up the log and configuration files.• You must have stopped the Snap Creator Server and Agent.• You must have backed up the Snap Creator database.

Step

1. Delete the Snap Creator installation folder.


Upgrading from Snap Creator 3.6.0

When you upgrade from Snap Creator 3.6.0 to Snap Creator 4.0.0, the database schema is upgradedand all the configuration file passwords are updated for compatibility with Snap Creator 4.0.0.

About this task

Only the upgrade from Snap Creator 3.6.0 to Snap Creator 4.0.0 is supported. To upgrade fromearlier versions, you must upgrade one version at a time. For example, to upgrade from Snap Creator3.3.0, you must first upgrade from 3.3.0 to 3.4.0, 3.4.0 to 3.5.0, 3.5.0 to 3.6.0, and then from 3.6.0 to4.0.0. This process does not upgrade the Snap Creator agent. You must upgrade the Snap Creatoragent at the same time when the Snap Creator Server is upgraded.

Steps

1. Make a backup of the profiles under the scServer3.6.x/configs directory.

2. Make a backup of the Snap Creator database under the scServer3.6.x/gui/snapcreatordirectory.

Note: You should not delete the Snap Creator 3.6.x backup copies created in Step 1 and Step 2.

3. Uninstall the current installation of Snap Creator (for Windows).

4. Install Snap Creator 4.0.0.

5. Delete the Snap Creator 4.0.x database under the scServer4.0.x/engine/snapcreatordirectory.

6. Copy the backed up profiles to the scServer4.0.x/engine/configs directory.

7. Copy the backed up Snap Creator 3.6.x database directory to the scServer4.0.x/engine/snapcreator directory.

8. Open the command-line interface (CLI) and change the directory to scServer4.0.x/engine.

9. Run the following command:

java -jar snapcreator.jar -upgrade

10. Start the Snap Creator Server.

Note:

• When setting the Default Administrator role to a user in Snap Creator 4.0.0, the same usermust be the administrator in Snap Creator 3.6.0. If the Snap Creator 3.6.0 user is not anAdministrator and the same user is used for the Default Administrator role, the upgradeprocess sets the same user in Snap Creator 4.0.0 as an Operator instead of an Administrator.

37

• During the upgrade process, user names with special characters are not supported. Forexample, if you have any user name with special characters in Snap Creator 3.6.0, you mustrename all the users and then proceed with the upgrade.


Running Snap Creator on alternative ports

You can run Snap Creator on ports other than the default port or the port specified during theinstallation.

Step

1. Depending on your operating system, use the appropriate command to run Snap Creator:

If you areusing...

Then...

UNIX • To run on port 8081, use the following command:

java -jar snapcreator.jar -port 8081

• To run on the default port, use the following command:

java -jar snapcreator.jar

For VMware, KVM, and Xen plug-ins:

• To run on port 8081, use the following command:

java -XX:MaxPermSize=128m -jar snapcreator.jar -port 8081


java -XX:MaxPermSize=128m -jar snapcreator.jar

Windows • To run on port 8081, use the following command:

java -jar snapcreator.jar -port 8081


java -jar snapcreator.jar

For VMware, KVM and, Xen plug-ins:

• To run on port 8081, use the following command:

java -XX:MaxPermSize=128m -jar snapcreator.jar -port 8081


java -XX:MaxPermSize=128m -jar snapcreator.jar

Note: These commands must be run from the .jar path.

39

Information required to configure Snap Creator

Snap Creator 4.0.0 supports Oracle, MySQL, DB2, VMware (vSphere and vCloud Director), SybaseASE, Domino, MaxDB, KVM, Xen, SnapManager for Microsoft SQL Server, and SnapManager forMicrosoft Exchange plug-ins. Community plug-ins are not included in the package and must bedownloaded separately.

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

Parameters Setting Description

APP_NAME oracle|db2|mysql|domino|vibe|smsql|sme|sybase|maxdb|kvm|xen|

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 orunquiesce commands or scripts.: Copy the plug-into the /path/to/scServer|scAgent/plug-ins directoryand specify the plug-in in theAPP_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 Creatorshould ignore errors fromapplication plug-ins. This isuseful when you want to backup multiple databases and donot want to stop the backup ifthe quiesce or unquiesce of onedatabase fails.

APP_DEFINED_BACKUP (Y|N) The application plug-in isexpected to perform the entirebackup operation includingquiesce, creating a Snapshotcopy, and unquiesce. The built-in plug-ins do not support thiskind of backup.

APP_DEFINED_RESTORE (Y|N) Enables application-basedrestore operations. In the eventof a restore operation, SnapCreator sends a request to theapplication plug-in and theplug-in handles the request.

APP_DEFINED_MOUNT (Y|N) The built-in mount abilities ofSnap Creator are ignored.Instead, the plug-in isresponsible for all mountactivities including volume orLUN clone creation. The built-in plug-ins do not support thistype of mount.

APP_DEFINED_UMOUNT (Y|N) The built-in unmount abilitiesof Snap Creator are ignored.Instead, the plug-in isresponsible for handling allunmount activities includingvolume or LUN clone deletion.The built-in plug-ins do notsupport this type of unmount.

Information required to configure Snap Creator | 41


APP_AUTO_DISCOVERY (Y|N) Enables application autodiscovery. Snap Creator sends adiscover request to theapplication plug-in and theplug-in is then responsible forthe discovery of the storageconfiguration. This can be donedynamically or persistent withtheAPP_CONF_PERSISTENCEparameter, if the information isto be saved to the configurationfile. This parameter is similar toVALIDATE_VOLUMES, butallows it through plug-inframework to add the discoverfunctionality to any applicationplug-in.

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

VALIDATE_ VOLUMES DATA Snap Creator validates that allthe volumes in which thedatabase resides are part of thebackup operation. Currently,there are some limitations. OnlyNetwork File System (NFS) issupported. Only the data filesfor the supported databases arechecked.

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



META_DATA_VOLUME Allows for a Snapshot copy ofthe specified volume to becreated after the unquiesceoperation. This can be valuablefor certain plug-ins where theSnapshot copy of data must becreated 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 includingvolume or LUN clone creationand deletion. The built-in plug-ins do not support this type ofclone.

JAVA_HOME Text Setting which points to the JavaVirtual Machine (JVM) thatshould be used forexecuting .class and .jarfiles. If set, $JAVA_HOME/bin/java is used. otherwise justjava to run the .class/.jarfile #

JVM_ARGS Text Setting to control the JavaVirtual Machine settings whennative Java .class or .jarfiles are executed. The defaultsetting is -Xms32M -Xmx128M.

JAVA_CLASSPATH Text Setting which defines the Javaclasspath. By default, plug-ins/native is configured andcan be completed with thisenvironment variable, whichwill be appended to the default.



PERL_HOME Text Setting which points to the Perlinterpreter that should be usedfor executing .pl files. If set,$PERL_HOME/bin/perl isused, otherwise just PERL torun the .pl file.

PERL_OPTS Text Setting to control the PERLinterpreter settings when nativePerl files are executed. Optionsfor additional settings includedirectories (-I) that can bepassed to the Perl interpreter.

PYTHON_HOME Text Setting which points to thePython interpreter that shouldbe used for executing .py files.If set, $PYTHON_HOME/pythonis used, otherwise just pythonto run the .py file.

PYTHON_OPTS Text Setting to control the Pythoninterpreter settings when nativePython files are executed.

Oracle plug-inThe Oracle plug-in supports Oracle 10g database or later versions. The Oracle plug-in usesSQL*Plus to communicate with the database.

To use C Shell (CSH) with the Oracle plug-in on UNIX or Linux platforms, the following conditionsshould be met:

• Snap Creator Agent must be started as the Oracle user, instead of the root user.• The Oracle user must have the proper environmental variables (ORACLE_HOME and

ORACLE_SID) set in order for the plug-in driven SQL*Plus commands to work.This can be done with a shell startup file, such as ~/.cshrc.

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

Parameter Setting Description

APP_NAME oracle The application name



ORACLE_DATABASES A list of Oracle databases and the user names.For example, db1:user1;db2:user2.

SQLPLUS_CMD The path to the sqlplus command

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

ORA_TEMP The path to the directory to store thetemporary file. For example, /tmp (the Oracleuser must have permissions to this directory).

ARCHIVE_LOG_ONLY (Y|N|policy:)

Informs the Oracle plug-in to only perform aswitch log operation. This setting is useful ifyou are handling archive logs backupsseparately from data backups.

ORACLE_HOME The path to the Oracle home directory

ORACLE_HOME_ The path to the Oracle home directory for agiven system identifier (SID). When backingup multiple databases, it might be importantto specify more than one Oracle homedirectory.

ORACLE_EXPORT_PARAMETERS

(Y|N ) The ORACLE_HOME and ORACLE_SIDenvironment parameters are exported by usingthe export command. This is applicable onlyin UNIX or a Linux-based environment.

ORACLE_BACKUPMODE Option to configure offline or online backupsby using the Snap Creator policy. The defaultoption is online.ORACLE_BACKUPMODE=hourly:online,daily:offline

Note: For latest information about support or compatibility matrices, see the InteroperabilityMatrix.

Related information




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

Note: The MySQL plug-in does not support backup and restore operations for multiple databases.

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


APP_NAME mysql The application name.

MYSQL_DATABASES A list of MySQL databases, theuser name and password; thatis, db1:user1/pwd1;db2:user2/pwd2

HOST Name of the host where thedatabases are located; localhost

PORTS List of databases and the portsthey are listening on; that is,db1:3307;db2:3308

MASTER_SLAVE (Y|N) Specifies if the databases are apart of the Master-Slaveenvironment.


Related information


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

The following table lists the DB2 plug-in parameters:


APP_NAME db2 The application name.




DB2_DATABASES A list of DB2 databases and theuser name. For example,DB2_DATABASES=db1:user1;db2:user2

DB2_CMD The path used by the db2command to interact with thedatabase. If the path is notspecified, then sqllib/db2 isused. For example,DB2_CMD= /ibm/sqllib/bin/db2.


Related information


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, Sybase ASE 15.5, and Sybase ASE 15.7.

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


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




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, sybsystemprocs,and tempdb databases areexcluded. Encrypted passwordsare supported ifNTAP_PWD_PROTECTIONis set.

Example:SYBASE_DATABASES=DBAtest2:sa/53616c7465645f5f76881b465ca8ce3745c239b60e04351e

Example:SYBASE_DATABASES=+ALL:sa/53616c7465645f5f76881b465ca8ce3745c239b60e04351e

SYBASE_DATABASES_EXCLUDE

(Y|N ) Allows databases to beexcluded if the +ALL constructis used. Use a semicolon (;) toallow multiple databases.Example:SYBASE_DATABASES_EXCLUDE=pubs2;test_db1.

SYBASE_TRAN_DUMP Allows to perform Sybasetransaction dump after creatingSnapshot copy. Each databaserequiring a transaction dumpneeds to be specified. Theformat isDB1:PATH;DB2:PATH, wherepath is a directory. Example:SYBASE_TRAN_DUMP=pubs2:/sybasedumps/pubs2



SYBASE_TRAN_DUMP_FORMAT

Allows you to specify the dumpnaming convention. Three"keys" can be specified, %S =Instance name fromSYBASE_SERVER %D isdatabase fromSYBASE_DATABASES and%T is a unique timestamp. Thedefault 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 isqlcommand. Example:SYBASE_ISQL_CMD=/opt/sybase/OCS-15_0/bin/

isql

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

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

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/



SYBASE_MANIFEST_FORMAT

Allows you 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 copy naming. Thedefault format is %S_%D_%T.manifest. Example:SYBASE_MANIFEST_FORMAT=%S_%D_%T.manifest

SYBASE_MANIFEST_DELETE

(Y|N ) Allows the manifest to bedeleted after the Snapshot copyhas been made. The manifestfile should be captured in theSnapshot copy so that it isalways available with thebackup. Example:SYBASE_MANIFEST_DELETE=Y


Related information


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

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


APP_NAME maxdb Indicates the application name.




XUSER_ENABLE (Y|N) Enables or disables the use ofan xuser for MaxDB so apassword is not required for thedatabase user.

HANDLE_LOGWRITER (Y|N) Executes suspend logwriter orresume logwriter if set to Y.

DBMCLICMD Specifies the path to theMaxDB dbmcli command. Ifnot set, dbmcli on the searchpath is used.

SQLCLICMD The path to the MaxDBsqlcli command, if not setsqlcli on the search path isused.

MAXDB_UPDATE_HIST_LOG

(Y|N) Tells the MaxDB backupprogram if it should update theMaxDB history log.

MAXDB_DATABASES List of databases to be backedup with the user name andpassword separated by acomma. 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 beencreated. This applies to NFSonly. The directory must pointto the location which containsthe .snapshot directory.Multiple directories can beincluded in a comma-separatedlist. Multiple databases can bespecified as a semicolon-separated list. In MaxDB 7.8and later versions, the databasebackup request will be markedas Failed in the backup history.Example:MAXDB_CHECK_SNAPSHOT_DIR=SID:directory[,directory...][SID2:directory[,directory...]


Related information


IBM Domino plug-inThe Domino plug-in supports Domino 8.0, Domino 8.0.x, Domino 8.5, and Domino 8.5.x.

The IBM Domino application consistency feature provides application consistency by interfacingwith the Domino APIs through the Domino plug-in. This plug-in is supported on Windows, Linux,AIX, and Solaris.

The Domino plug-in collects a list of all the databases, templates, and mailboxes in the Dominoenvironment. Each file is then placed into backup mode. When the databases are in backup mode, allthe changes to the databases are stored in a temporary path known as changeinfo. This backupprocess does not impact the end user. If archive-style Domino transaction logging is used, theDomino plug-in for Snap Creator also archives transaction logs when the backup process ends.



The change information must be stored on a volume that is not a part of the Snapshot copy. Thechange information is also written back to a database after the restore operation is completed.DOMINO_RESTORE_DATA_PATH must be set to the path where the Domino data is beingrestored. This path might change depending on the type of restore operation that is being performed.A volume restore operation must be set to the same path as the Domino data, whereas a singledatabase restore operation is set to an alternate path on the same volume as the Domino data. IfDOMINO_RESTORE_DATA_PATH is not set properly, the change information is not applied tothe database.

A new log folder is created under DOMINO_CHANGE_INFO_PATH. All the archived logs arestored in this folder. To automatically delete the archived logs, you must enable the archive logoptions.

Example

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

If any database is corrupt and APP_IGNORE_ERROR is enabled, then the Domino plug-incontinues with the backup operation of the remaining databases. This is useful when you want toback up multiple databases and do not want to stop the backup operation if the quiesce or unquiesceof one of the databases fails.

Note: You should set the SC_AGENT_TIMEOUT value to 3600 or higher.

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


DOMINO_DATA_PATH Specifies the path to theDomino data directory.Example: /notes/notesdata

DOMINO_INI_PATH Specifies the path to thenotes.ini file (includenotes.ini in the path)Example: /notes/notesdata/notes.ini



DOMINO_CHANGE_INFO_PATH

Specifies the path where thechange information files shouldbe saved. The volume usedshould not be the same as thatused for the Domino data andlog paths. Change informationshould not be captured in thesame Snapshot copy.Example: /changeinfo

Note: To delete the oldchange information files, youmust enable the archive logoption.

DOMINO_DATABASE_TYPE

This parameter can have thefollowing values:

• 0 = Backup everything( 1+2+3 below)

• 1 = Backup only for *.BOXfiles

• 2 = Backup only for*.NSF, *.NSG, and NSHfiles

• 3 = Backup only for *.NTFfiles

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

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

linux/



DOMINO_RESTORE_DATA_PATH

Path to the restored datadirectory. You must use thesame volume as the Dominodata path. You must use thesame path asDOMINO_DATA_PATH ifrestoring to the same location.If performing a single filerestore, provide the path whereyou are restoring yourdatabases.

Example: /notes/notesdata

VALIDATE_DOMINO_DATA_PATH

(Y|N) Parameter to validate theDomino data directory. If it isset to Y, the Domino plug-inwill backup only the files thatare located in the Domino datadirectory. If it is set to N, theDomino plug-in will back up allthe files that are managed bythe Domino server, regardlessof the path.

Note: If the value of thisparameter is set to N, thenthere might be problemswhile restoring the files thatare located outside theDomino data directory.

If the volume names are of thesame standard length as the filenames (E:\Domino\Mail | F:\Domino\Apps), then therestore operation works asexpected. However, if the filenames are of a different length,the file names get truncated andthe change information is notapplied correctly.



Related information


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: The SnapManager for Microsoft Exchange plug-in requires Snap Creator Agent to beinstalled. You should set the SC_AGENT_TIMEOUT value to 900 or higher.

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


SME_PS_CONF Path to the PowerShellconfiguration file forSnapManager for MicrosoftExchange.

Example:SME_PS_CONF="C:\Program Files\NetApp

\SnapManager for

Exchange\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 the use of the32-bit version of PowerShell.




Related information


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: The SnapManager for Microsoft SQL Server plug-in requires Snap Creator Agent to beinstalled. You should set the SC_AGENT_TIMEOUT value to 900 or higher.

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


SMSQL_PS_CONF Path to the PowerShellconfiguration file for theSnapManager for MicrosoftSQL Server.

Example:SMSQL_PS_CONF="C:\Program Files\NetApp

\SnapManager for SQL

Server\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' -

RetainBackups 7 -lb -

bksif -

RetainSnapofSnapInfo 8

-trlog -gen -mgmt

standard




SMSQL_SERVER_NAME SnapManager for MicrosoftSQL Server name.

SMSQL_32bit (Y|N) Setting to enable the use of the32-bit version of PowerShell.


Related information


VMware (VIBE) plug-inSnap Creator supports the backup of VMware virtual machines and vApps through the VMwareplug-in. The VMware plug-in is an integrated plug-in for both virtual machines with vSphere andvApps with vCloud.

You should consider the following when you use the VMware plug-in:

• The VMware plug-in is supported only on Windows and Linux.

• If you are using a non-Windows or non-Linux Snap Creator Server, you need a Snap CreatorWindows or Linux agent to run the VMware plug-in.

• OnCommand Unified Manager server as a proxy is not supported.• The actions mount, unmount, backup operation using Open Systems SnapVault, and archive log

management are not supported.• VMware HA with VMware plug-in is not tested and not supported.• VMware vCenter Linked Mode with VMware plug-in is not tested and not supported.• Data ONTAP consistency group Snapshot copies with VMware plug-in is not tested and not

supported.• The VMware plug-in does not support raw device mapping (RDM).• The volumes are discovered using autodetect.

You cannot see the discovered destination volumes if it is not in a SnapMirror relationship. Usedpstatus to check the SnapMirror relationship. If a SnapMirror relationship does not exist, youmust first create the SnapMirror relationship.

• After the restore operations are complete, you must run a Snap Creator backup of the restoredvirtual machines and vApps to ensure that the new environment is cleaned up and all VMwareSnapshot copies are removed.If the plug-in is not able to clean up VMware Snapshot copies and displays an error, you mustremove the VMware Snapshot copies manually. The VMware plug-in does not guarantee 100%VMware Snapshot copy removal and it is a known VMware issue.



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

• The deleted virtual machines cannot be restored.• The volume restore operation is not supported, only application-defined restore operations are

supported.• The SC_AGENT_TIMEOUT value should set to 1800 or higher.• The default value of VIBE_VMWARE_SNAPSHOT (VMware Snapshot option) is N.• If the value of APP_DEFINED_RESTORE is Y, then the SnapVault restore operation using the

GUI is not supported.• While creating a SnapMirror and SnapVault configuration by using the GUI, the volume details

must be entered manually because the SnapMirror and SnapVault relationship is not detectedautomatically.

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

Parameter Description

VIBE_VCLOUD_IPADDR IP addresses or host name of the vCloudDirector to log in to (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: The vCloud Director systemadministrator user name must be used toperform the backup or restore operation.These operations fail if the user is anorganization administrator or any other user.

VIBE_VCLOUD_PASSWD Password associated with the specifiedVCLOUD_USER (vCloud only).

VIBE_VCENTER_USER User name to log in to vCenter.

VIBE_VCENTER_PASSWD Password associated with the specifiedVCENTER_USER.

VIBE_VCLOUD_NAMES List of Organization, Virtual Data Center, andvApp object names to back up (vCloud only).

Example:VIBE_VCLOUD_NAMES=ORG:VDC1,VDC2:VAPP1,VAPP2;ORG2:VDC3:;ORG3::VAPP6


Parameter Description

VIBE_VSPHERE_NAMES List of datastores and virtual machines to backup per vCenter (vSphere only).

Example:VIBE_VSPHERE_NAMES=VCENTER1:DS1:VM1;VCENTER2;DS2,DS3:;VCENTER3::VM4

VIBE_TRIM_VSPHERE_NAMES List of virtual machines to remove from backupper vCenter (vSphere only).

Example:VIBE_TRIM_VSPHERE_NAMES=VCENTER1:VM99;VCENTER2:VM5,VM12

VIBE_RESTORE_INTERVAL Time between each