Installing Snap Creator Agent - NetApp Community

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 storage

aggregate -vserver clus3240rre

cluster identity show role create -role CRBAC_New -cmddirname cluster

identity 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 license

show -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 network

interface show -vserver clus3240rre



Command to be run

security login show role create -role CRBAC_New -cmddirname security login


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 node


version role create -role CRBAC_New -cmddirname version -

vserver clus3240rre

version security login role create -role bainew1 -vserver

SnapCreator -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 nfs

status -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 services

ndmp -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 fcp


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


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


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 iscsi

nodename -vserver clus3240rre

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


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


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


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


lun igroup create role create -role CRBAC_New -cmddirname lun igroup

create -vserver clus3240rre



Command to be run

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


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 volume

efficiency on -vserver clus3240rre

volume efficiency start role create -role CRBAC_New -cmddirname volume

efficiency start -vserver clus3240rre

volume snapshot create role create -role CRBAC_New -cmddirname volume snapshot


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


volume clone create role create -role CRBAC_New -cmddirname volume clone


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

Snapcreator -vserver clus3240rre

iscsi role create -role CRBAC_New -cmddirname iscsi -vserver


fcp role create -role CRBAC_New -cmddirname fcp -vserver


lun resize role create -role CRBAC_New -cmddirname lun resize -

vserver clus3240rre

volume efficiency off role create -role CRBAC_New -cmddirname volume

efficiency 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


volume offline role create -role CRBAC_New -cmddirname volume offline


volume unmount role create -role CRBAC_New -cmddirname volume unmount


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

clus3240rre

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 event

destination -vserver clus3240rre

event mailhistory role create -role CRBAC_New -cmddirname event

mailhistory -vserver clus3240rre

event route role create -role CRBAC_New -cmddirname event route -

vserver clus3240rre

event snmphistory role create -role CRBAC_New -cmddirname event

snmphistory -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 -cmddirname

volume file -vserver Snapcreator

adduser role create -role VSERVERRBACROLE_New -cmddirname

adduser -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 -cmddirname

volume 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 -cmddirname

volume

options role create -role VSERVERRBACROLE_New -cmddirname

options -vserver Snapcreator

volume mount role create -role VSERVERRBACROLE_New -cmddirname

volume mount -vserver Snapcreator

volume file clonecreate


volume file clone create -vserver Snapcreator

restore-file role create -role VSERVERRBACROLE_New -cmddirname

restore-file -vserver Snapcreator

vserver nfs status role create -role VSERVERRBACROLE_New -cmddirname

vserver nfs status -vserver Snapcreator

vserver fcp initiatorshow


vserver fcp initiator show -vserver Snapcreator

vserver fcp show role create -role VSERVERRBACROLE_New -cmddirname

vserver fcp show -vserver Snapcreator

vserver fcp status role create -role VSERVERRBACROLE_New -cmddirname

vserver fcp status -vserver Snapcreator

lun igroup show role create -role VSERVERRBACROLE_New -cmddirname lun

igroup 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 -cmddirname

vserver iscsi nodename -vserver Snapcreator

vserver iscsi show role create -role VSERVERRBACROLE_New -cmddirname

vserver iscsi show -vserver Snapcreator

vserver iscsi status role create -role VSERVERRBACROLE_New -cmddirname

vserver iscsi status -vserver Snapcreator

vserver iscsi sessionshow


vserver iscsi session show -vserver Snapcreator

lun geometry role create -role VSERVERRBACROLE_New -cmddirname lun

geometry -vserver Snapcreator

lun show role create -role VSERVERRBACROLE_New -cmddirname lun

show -vserver Snapcreator

lun mapped show role create -role VSERVERRBACROLE_New -cmddirname lun

mapped show -vserver Snapcreator

lun igroup add role create -role VSERVERRBACROLE_New -cmddirname lun

igroup add -vserver Snapcreator

lun igroup create role create -role VSERVERRBACROLE_New -cmddirname lun

igroup create -vserver Snapcreator

lun igroup set role create -role VSERVERRBACROLE_New -cmddirname lun

igroup set -vserver Snapcreator

vserver iscsi interfaceaccesslist add


vserver iscsi interface accesslist add -vserver

Snapcreator

lun create role create -role VSERVERRBACROLE_New -cmddirname lun

create -vserver Snapcreator

lun map role create -role VSERVERRBACROLE_New -cmddirname lun

map -vserver Snapcreator



Command to be run

lun move role create -role VSERVERRBACROLE_New -cmddirname lun

move -vserver Snapcreator

lun online role create -role VSERVERRBACROLE_New -cmddirname lun

online -vserver Snapcreator

lun comment role create -role VSERVERRBACROLE_New -cmddirname lun

comment -vserver Snapcreator

lun modify role create -role VSERVERRBACROLE_New -cmddirname lun

modify -vserver Snapcreator

lun unmap role create -role VSERVERRBACROLE_New -cmddirname lun

unmap -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 -cmddirname

volume efficiency on -vserver Snapcreator

volume efficiency start role create -role VSERVERRBACROLE_New -cmddirname

volume efficiency start -vserver Snapcreator

volume snapshot create role create -role VSERVERRBACROLE_New -cmddirname

volume snapshot create -vserver Snapcreator

volume snapshot delete role create -role VSERVERRBACROLE_New -cmddirname

volume snapshot delete -vserver Snapcreator

volume modify role create -role VSERVERRBACROLE_New -cmddirname

volume modify -vserver Snapcreator

volume autosize role create -role VSERVERRBACROLE_New -cmddirname

volume autosize -vserver Snapcreator

volume clone create role create -role VSERVERRBACROLE_New -cmddirname

volume clone create -vserver Snapcreator

volume create role create -role VSERVERRBACROLE_New -cmddirname

volume create -vserver Snapcreator



Command to be run

volume modify role create -role VSERVERRBACROLE_New -cmddirname

volume modify -vserver Snapcreator

vserver iscsi isns query role create -role VSERVERRBACROLE_New -cmddirname

vserver iscsi isns query -vserver Snapcreator

volume file clone role create -role VSERVERRBACROLE_New -cmddirname

volume file clone -vserver Snapcreator

volume clone role create -role VSERVERRBACROLE_New -cmddirname

volume clone -vserver Snapcreator

volume snapshotrestore


volume snapshot restore -vserver Snapcreator

lun resize role create -role VSERVERRBACROLE_New -cmddirname lun

resize -vserver Snapcreator

volume efficiency off role create -role VSERVERRBACROLE_New -cmddirname

volume efficiency off -vserver Snapcreator

volume size role create -role VSERVERRBACROLE_New -cmddirname

volume size -vserver Snapcreator

lun delete role create -role VSERVERRBACROLE_New -cmddirname lun

delete -vserver Snapcreator

lun offline role create -role VSERVERRBACROLE_New -cmddirname lun

offline -vserver Snapcreator

volume destroy role create -role VSERVERRBACROLE_New -cmddirname

volume destroy -vserver Snapcreator

volume offline role create -role VSERVERRBACROLE_New -cmddirname

volume offline -vserver Snapcreator

volume unmount role create -role VSERVERRBACROLE_New -cmddirname

volume unmount -vserver Snapcreator

version role create -role VSERVERRBACROLE_New -cmddirname

version -vserver Snapcreator

snapmirror role create -role VSERVERRBACROLE_New -cmddirname

snapmirror -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 17

Installing Java on Snap Creator Server on page 30

Creating a Data ONTAP user for Snap Creator with Data ONTAP operating in 7-Mode on page 17

Creating 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 17

Installing Java on Snap Creator Server on page 30

Creating a Data ONTAP user for Snap Creator with Data ONTAP operating in 7-Mode on page 17

Creating 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|<plugin>

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.<PLUG-IN>: 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 <plug-in> 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:<Y|N>)

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_<SID> 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 @<org> 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



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 restore check (default: 30seconds).

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

VIBE_VMWARE_SNAPSHOT Takes a VMware Snapshot copy during backup(default: N).

VIBE_NOPING Setting to not ICMP ping VMware or storagecontrollers (default: N).

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


Related information


vCloud vApp backup and restore by using the VMware plug-inSnap Creator supports the backup of vCloud vApp through the VMware plug-in. vApp and virtualmachine backups are made by the VMware plug-in through the vCloud Director API and vSphereAPI, which are invoked on the VMware vCloud Director and VMware vCenter server, respectively.

For vApp backup and restore, you must provide the following details in the configuration file:

• vCloud IP and credentials



• vCloud organizations, virtual data centers (vDCs), and vApp names

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

You must consider the following when performing the 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 Directormetadata using REST APIs.

• You should provide details of the vCloud with the organizations, vDCs, and vApps to be backedup.

• If a vDC is listed, all the vApps in the vDC are backed up.• The vCloud module discovers virtual machines associated with any vApp that needs to be backed

up and puts them on a backup list.• If a vApp selected for backup is contained within an organization or a vDC that is also selected

for backup, the vApp is backed up only once.

Note: For Virtual Machine File System (VMFS) restore operations by using 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.

Virtual machine backup and restore by using the VMware plug-inSnap Creator supports the backup of VMware virtual machines through the VMware plug-in. Virtualmachine backups are taken through the vSphere API on the VMware vCenter server.

For virtual machine backup, you must provide the following details in the configuration file:

• vCenter IP or host name and credentials• vSphere virtual machines and datastore names

Note: Snap Creator discovers vCenter only if vCenter is configured on the default port (443).

For the restore operation, you should provide the backup parameters and the Snapshot copy name.

Consider the following when performing the VMware backup and restore processes:

• If a virtual machine is listed and is not available, the plug-in displays an error message. It will notbe able to restore a lost virtual machine even if it is backed up.

• If a datastore is listed, all the virtual machines in the datastore are backed up.• Only the listed virtual machines or virtual machines located in the datastores specified are backed

up.• If a virtual machine selected for backup is contained within a datastore that is also selected for

backup, it will be backed up only once.• The VMware plug-in supports both Network File System (NFS) and VMware Virtual Machine

File System (VMFS) datastores.• Virtual machine restores on an NFS datastore use Single File SnapRestore (SFSR) on the storage

system, which avoids host copies.


• To restore a virtual machine 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 it to the cluster.

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

Red Hat KVM plug-inKernel-based Virtual Machine (KVM) is a virtualization solution for the Linux kernel. Snap Creatoruses the KVM plug-in to backup and restore the guest virtual machines. The plug-in internally usesvirsh commands.

The KVM plug-in supports guest operating systems such as Linux, Windows, and Solaris.

You must consider the following when you use the KVM plug-in:


management are not supported.• In a storage area network environment, the Linux Host Utilities (LHU) kit is required to collect

information about LUNs and volumes from the storage controller.The LHU kit should be installed on a KVM hypervisor, which is a Snap Creator Agent.

Note: If the LHU kit is not installed and the configuration is a mix of network attached storageand storage are network environments, then the backup and restore operations work only on aNetwork File System (NFS).

• The KVM plug-in supports only the Linux version of the Snap Creator 4.0.0 Agent.• Volume restore is not supported; only application-defined restores are supported.• The deleted virtual machines cannot be restored.• The storage controller IPs and host should be either in /etc/hosts on the KVM host or in a

Domain Name System (DNS).• Only one KVM host per configuration is supported.• If a virtual machine is created by using an iso repository, then to perform any action, you should

disconnect this repository from the virtual machine through the Virt Manager console in CD-ROM options.

• The SC_AGENT_TIMEOUT value should be more than the default value.You should set the value to 600 or higher.

• The volumes are automatically discovered by using autodetect.You cannot see the discovered destination volumes if it is not in a SnapMirror relationship. Youshould use dpstatus to check the status of the SnapMirror relationship. If a SnapMirrorrelationship does not exist, you must first create the SnapMirror relationship.

• If the value of APP_DEFINED_RESTORE is Y, then the SnapVault restore operation by usingthe GUI is not supported.


• While creating a SnapMirror and SnapVault configuration by using the GUI, the volume detailsmust be entered manually because the SnapMirror and SnapVault relationship is not detectedautomatically.

Supported KVM configurations

• NAS: Supports guest virtual machines installed on NFS volumes.• SAN: Supports guest virtual machines installed on a raw multipath device (LUN with multiple

paths).

Note: Configurations with multiple virtual machines installed on a single multipath device are notsupported.

Guest virtual machines installed on LVM or on an image file in the SAN environment are notsupported.

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


KVM_RESTORE_VM_LIST (Required only during restore) List of virtualmachines to be restored (required only duringrestore).

Example: VM1,VM2

KVM_VM_MAPPING (Required) Mapping between the virtualmachine and its associated storage controller,LUN or file path (required). This parameter isupdated dynamically during the discoveryprocess.

Example: VM1: storage_controller1:/vol/vol1/lun1;VM2:storage_controller2:/vol/vol2/lun2;

KVM_VM_CONFIG_DIR (Optional) Path to the directory where all theXML configuration files of the virtual machineare stored. The default value is /etc/libvirt/qemu.

KVM_CMD_RETRY_COUNT (Optional) Number of times you rerun thecommand when running it fails in the KVMplug-in. The default value is 3.



Related information


Citrix Xen plug-inSnap Creator supports the backup and restore of Citrix Xen virtual machines by using the Xen plug-in.

The Xen plug-in supports Windows and XenServer.

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


management are not supported.• Raw device mapping is not supported.• Volume restore is not supported, only application-defined restore operations are supported.• Deleted virtual machines can be restored.• Xen Host can be used as a Snap Creator Agent.

You should not use Xen Host as a Snap Creator Server.• The SC_AGENT_TIMEOUT value should be more than the default value.

You should set the value to 600 or higher.• If the value of APP_DEFINED_RESTORE is Y, then the SnapVault restore operation by using

the GUI is not supported.

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


XEN_VMS List of virtual machines of a particular hostseparated by a slash (/).

Example: <host IP>:VM1/VM2/VM3

XEN_HOST_USERS List of Xen hosts and the corresponding username and password.

Example: <host IP>:<username>/<password>

XEN_BIN_PATH Path of the Xen server executable (xe). The Xenconsole is required for importing and exportingthe virtual machine metadata.

Example: c:\Program Files\Citrix\XenCenter\xe.exe




XEN_METADATA_PATH Path on the server where you can download thevirtual machine metadata.

Example: c:\scmetadata

XEN_VM_SNAPSHOT Parameter to turn the virtual machineconsistency Snapshot copy on or off. Theoptions are Y and N.


Related information


Archive log plug-inThe Archive log plug-in is supported on all databases. This plug-in does not communicate with thedatabase. It deletes the archive logs that are older than the configured threshold value (in days).

The following table lists the Archive log parameters, settings, and description:


ARCHIVE_LOG_ENABLE (Y|N|policy:age) Enables archive logmanagement (deletion of theold archive logs).

ARCHIVE_LOG_RETENTION

Specifies the number of daysthe archive logs are retainedfor. Epoch time is used.

ARCHIVE_LOG_DIR Path to the directory thatcontains the archive logs.Optionally, for multiple archivelog directories,ARCHIVE_LOG_DIR<##>can be used.

ARCHIVE_LOG_EXT File extension of the archivelogs, that is, if the archive logsare 10192091019.log, youshould set this to log; the searchpattern used is:<something>.<extension>




ARCHIVE_LOG_RECURSIVE_SEARCH

(Y|N) Enables the management ofarchive logs withinsubdirectories. If the archivelogs are located undersubdirectories, this optionshould be used.


Creating a configuration file in Snap Creator

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

You can edit the configuration file by using Visual Interactive (VI) in UNIX or any text editor inWindows. You can also use the Snap Creator GUI to edit and manage configuration files.

Creating a configuration file using the CLIYou can create a configuration file using the CLI.

Steps

1. Create a new profile for the configuration file.

A profile is a subdirectory that contains the configuration file. New profiles must be created underthe configs directory: /path/to/scServer_v<#>/engine/configs.

Note: You must name the profile after the host or application being backed up.

2. To create a new configuration file, first create a new blank file.

Example

touch /tmp/<new file name>.conf

3. Import the blank file as a configuration file by running the following command:/path/to/scServer_v<#>/snapcreator --user username --passwd password --action configImport --profile profile --config New_config_name --importFile New_file_name

Example

/path/to/scServer_v<#>/snapcreator --user <user> --passwd <password> --action configImport --profile VMware --config vmware1 --importFile /tmp/vmware.conf

In this example, a new configuration file is imported into the VMware profile with theconfiguration name VMware1 using the /tmp/vmware file created in step 2.

4. Edit the newly imported configuration file using a text editor.

Note:

• For SnapMirror and SnapVault, you must provide the storage system name and not the IP.

67

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

Steps

1. Log in to the following URL: http://myserver.mydomain.com:8080/UI

Note: The first time you use the GUI, the Add Profile window is automatically displayed afterthe welcome screen. Whenever you add a new profile, the Configuration wizard isautomatically displayed.

2. From the Management drop-down menu, click Configurations.

3. In the Profiles and Configurations pane, click Add Profile, enter the new profile name, andclick OK.

The profile name should relate to the application that is being backed up. When you add a profile,a directory is created under /path/to/scServer_v<#>/engine/configs.

The new profile is created.

4. Right-click the profile and select New Configuration.

5. Complete the steps in the configuration wizard.

6. Review the summary and click Finish.

Note:

• For SnapMirror and SnapVault, you must provide the storage system name and not the IP.• You can delete, rename, or download a configuration file by right-clicking and selecting

Delete, Rename, or Download, respectively.• The GUI creates the same configuration files that you create by using the CLI. You can

update and edit the configuration files created by the GUI from the CLI or by the CLI fromthe GUI.

Creating a global configuration file using the GUIYou can use the global configuration file to separate storage controller/Vserver or VMwarecredential configuration from the backup policy. This enables you to control access and handlebackup and restore operations.

Steps

1.From Management, click Global Configurations.


2. Click Create Global and complete the steps in the configuration wizard.

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.

For example, use of SnapDrive instead of Data ONTAP API to create the Snapshot copies. Becausethe Snapshot copy names need to be unique, you must set a dynamic variable. The following is anexample from a Windows SnapDrive configuration:

NTAP_SNAPSHOT_CREATE_CMD1="c:/Program Files/NetApp/SnapDrive/sdcli.exe"

snap create -m fx1b4 -s %SNAME-%SNAP_TYPE_%SNAP_TIME -D E:

or

NTAP_SNAPSHOT_CREATE_CMD1="c:/Program Files/NetApp/SnapDrive/sdcli.exe"

snap create -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 used when you run Snap Creator and it isyour 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.

%ACTION This is the list of actions you can perform whenyou run Snap Creator: (backup|cloneVol|cloneLun|arch|restore|backupDel|

backupList|cloneList|pmsetup|ossv)

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

Creating a configuration file in Snap Creator | 69

Variables Description

%USER_DEFINED This passes a user-defined argument to the SnapCreator configuration file. For example, tointegrate with a backup application such asNetBackup, CommVault, or Legato NetWorker,you 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.

Snap Creator parameters

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


SNAME Specifies the Snapshot copynaming convention. It shouldbe unique. Snapshot copies aredeleted according to the namingconvention.

SNAP_TIMESTAMP_ ONLY (Y|N ) Sets the Snapshot namingconvention. If set to Y,Snapshot copies end withYYYYMMDDHHMMSS.Otherwise, new Snapshotcopies are renamed to end withYYYYMMDDHHMMSS.

VOLUMES Lists the primary storagecontrollers and volumes youwant to create a Snapshot copyof.

For example,controller1:vol1,vol2,vol3;controller2:vol1;controller3:vol2,vol3.



NTAP_SNAPSHOT_ RETENTIONS Determines the number ofSnapshot copies to be retainedfor a given policy.

For example, daily:7,weekly:4,monthly:1.

NTAP_USERS Lists the storage systems andtheir corresponding user namesand passwords.

For example, controller1:joe/password1;controller2:bob/password2;controller3:ken/password3.

NTAP_PWD_ PROTECTION (Y|N) Enables password protection.You must encrypt all passwords(storage system andapplications or plug-ins) andsave encrypted passwords inconfiguration file.

TRANSPORT HTTP|HTTPS Allows you to use either HTTPor HTTPS to connect to thestorage controller.

Note: HTTPS might requireopenssl-devel libraries.

PORT Configures the port number thestorage controllers use,normally (80/443).

LOG_NUM Specifies the numberof .debug and .out reportsthat Snap Creator has to retain.

CONFIG_TYPE PLUGIN|STANDARD Specifies the configurationtype. There are two types ofconfigurations: plug-in andstandard. You can use multipleplug-in configurations to buildcomplex quiesce and unquiescebackup workflows.



CMODE_CLUSTER_USERS (Required for clustered DataONTAP) Lists the primary/secondary clustered DataONTAP clusters and theircorresponding user names/passwords.

For example, cluster1:joe/password1;cluster2:bob/password2 #

CMODE_CLUSTER_NAME (Required for clustered DataONTAP) Specifies the name ofthe primary clustered DataONTAP cluster.

CMODE_SNAPSHOT_FORCE_DELETE

(Y|N) Ensure deletion of Snapshotcopies which should be deletedbased on the Snapshot copypolicy. In clustered DataONTAP, Snapshot copies arenot deleted if it has anydependencies; like clone.

LOG_TRACE_ENABLE (Y|N) Allows logging of all theevents. If disabled, the ManageONTAP Solution result objectsdoes not get logged.

NTAP_TIMEOUT Seconds Sets the timeout value for allstorage controller ManageONTAP Solution calls. Defaultis 60 seconds.

USE_GLOBAL_CONFIG (Y|N) Allows you to use globalconfiguration to store values.

FEDERATED_APPLICATIONS Lists the configuration andprofile names for the federatedapplications under theconfiguration.

For example,databases@db2;databases@oracle



CMODE_SET (Y|N) Defines if the configuration is aclustered Data ONTAP or DataONTAP operating in 7-Modeconfiguration.

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


VFILERS List the vFiler units and theirhosting storage systems orvolumes. For example,vFiler1@controller1:vol1,vol2,vol3;vFiler2@controller2:vol1;vFiler3@controller3:vol2,vol3.

Note: HTTPS is notsupported with vFiler units

MANAGEMENT_ INTERFACES Lists the primary storagecontrollers and theirmanagement interfaces used forcommunications.

For example,MANAGEMENT_INTERFACES=controller1:controller1-mgmt;controller2:controller2-mgmt



SECONDARY_ INTERFACES List the primary storagecontrollers or vFiler units andtheir secondary interfacessource or destination forSnapVault and SnapMirrorrelationships.

For example,controller1:controller1-source/controller2-destination

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

USE_PROXY (Y|N) Allows API calls to go throughOnCommand Unified Managerserver proxy instead of storagecontroller directly. If this optionis used, NTAP_USERS is notrequired.

ALLOW_IP_ADDR (Y|N) Allows IP address to be usedfor storage system. This appliesto SnapVault, SnapMirror, andthe NetApp ManagementConsole data protectioncapability. Using IPs can createproblems and should only beused under certain conditions.

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



NTAP_SNAPSHOT_RETENTION_AGE

Allows you to define a retentionage (in days) for Snapshotcopies. If configured, Snapshotcopies are deleted only if theyexceed the number defined 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 the use of SnapDrivefor the storage discovery. Thisis required in SAN or iSANenvironment when usingVALIDATE_VOLUMESparameter.

NTAP_SNAPSHOT_ DISABLE (Y|N) Disables the Snap Creator fromcreating a Snapshot copy so thatSnap Creator can handleSnapVault or SnapMirror forSnapManager. For this settingto work, the SnapManagerSnapshot copies need to followthis naming convention:<snapshot copy name>-<policy>_recent.

NTAP_SNAPSHOT_ NODELETE (Y|N) OverridesNTAP_SNAPSHOT_RETENTIONS and prevents Snapshotcopies from being deleted.Enabling this variable can makethe volume full.



NTAP_SNAPSHOT_DELETE_BY_AGE_ONLY

(PRIMARY|SECONDARY|BOTH|N)

Allows the deletion of oldSnapshot copies. 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 using the actionbackupDel. Manually deletingSnapshot copies with adependency is not permitted.

NTAP_SNAPSHOT_CREATE_CMD<#>

Creates 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 option createsSnapshot copies.

NTAP_CONSISTENCY_GROUP_SNAPSHOT

(Y|N) Enables use of consistencygroups for creating consistentSnapshot copy across multiplevolumes.

NTAP_CONSISTENCY_GROUP_TIMEOUT

(URGENT|MEDIUM|RELAXED)

Specifies the wait time forstorage controller toconsistently group Snapshotcopies.

NTAP_CONSISTENCY_GROUP_WAFL_SYNC

(Y|N) Improves the performance of aconsistency group Snapshotcopy by forcing a CP through awafl-sync before the cg-start.

NTAP_SNAPSHOT_RESTORE_AUTO_DETECT

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



NTAP_SNAPSHOT_CLEANUP (Y|N) Remove any Snapshot copiestaken in the event of backupfailure.

NTAP_USE_EXTERNAL_SNAPSHOT

(Y|N) Allows to import non-SnapCreator Snapshot copy, mostrecent Snapshot copy ismatched.

NTAP_EXTERNAL_SNAPSHOT_REGEX

A regular expression formatching imported Snapshotcopies, requires theNTAP_USE_EXTERNAL_SNAPSHOT option.

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


NTAP_SNAPVAULT_ UPDATE (Y|N) Allows you to turn theSnapVault update function onand off.



SNAPVAULT_ VOLUMES List the source storage systemsand volumes on which you wantto perform a SnapVault update.For example,controller1:vol1,vol2,vol3;controller2:vol1;controller3:vol2,vol3.

Note:

• For SnapVault andSnapMirror updates towork, the relationshipsmust exist. Snap Creatordoes not create therelationships.

• The host names in theSnapMirror or SnapVaultrelationship must be thesame as specified in theVOLUMES,SNAPMIRROR_VOLUMES, andSNAPVAULT_VOLUMES options. Also, the hostwhere Snap Creator runsmust be able to resolvethe host names.

• For the vSphere orvCloud, set the value toauto:detect

• Host names should be theshort host name (namethat appears on storagecontroller commandprompt), not the FQDN.



SNAPVAULT_QTREE_ INCLUDE List the source storage systemsand qtree paths that should beincluded in the SnapVaultupdate. Without this option, allqtrees under a volume arevaulted by SnapVault if arelationship exists. Qtrees listedin the following example arevaulted by SnapVault and therest are ignored 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 a retentionage (in days) for SnapVaultSnapshot copies. If configured,SnapVault Snapshot copies aredeleted only if they exceed thenumber defined inNTAP_SNAPVAULT_RETENTIONS and if they areolder than the retention age (indays).



NTAP_SNAPVAULT_SNAPSHOT (Y|N) Enables use of SnapVaultSnapshot copies; that is,Snapshot copies that arecompatible with the StorageController SnapVault scheduler.When using this option,Snapshot copy delete is handledby the Storage controller andnot by the Snap Creator.Additionally, Snapshot copiesare named as follows:sv_<POLICY>.<##>. 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.



NTAP_SNAPVAULT_MAX_TRANSFER

This is the maximum bandwidthSnapVault is allowed to use inkbps. If it is not set, SnapVaultuses the maximum availablebandwidth.

The following table lists the parameters required to set SnapMirror:


NTAP_SNAPMIRROR_ UPDATE (Y|N) Allows you to turn theSnapMirror update function onand off.

NTAP_SNAPMIRROR_CASCADING_UPDATE

(Y|N) Allows you to turn thecascading SnapMirror updatefunction on and off. This is aSnapMirror update using aSnapVault destination volume.

Note: This is not supportedfor clustered Data ONTAP8.1.

SNAPMIRROR_ VOLUMES This is the list of source storagesystems and volumes on whichyou want to perform aSnapMirror update, that is,controller1:vol1,vol2,vol3;controller2:vol1;controller3:vol2,vol3.

Note: Note: For the vSphere/vCloud plug-in, set the valueto auto:detect.

SNAPMIRROR_CASCADING_VOLUMES

List of SnapVault destinationstorage systems and volumeswhere, after a SnapVaultupdate, you want to perform aSnapMirror update, that is, sec-controller1:vol1-sec,vol2-sec.



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 cloneVol(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 maximum bandwidthSnapMirror is allowed to use inkbps. If it is not set, SnapMirroruses the maximum availablebandwidth.

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


NTAP_VOL_CLONE_ RESERVE none|file|volume This is the space guarantee for acloned volume.



NTAP_LUN_CLONE_RESERVATION

true|false If set to true, space is reserved forthe cloned LUNs if the cloneLunaction is selected. Otherwise, space isnot reserved.

NTAP_CLONE_IGROUP_ MAP Specifies the storage system, sourcevolume, and an IGROUP. TheIGROUP is then mapped to clonedLUNs that reside in the sourcevolume or cloned LUNs that residein the volume clone, that is,controller1:src_volume1/igroup1;controller2:src_volume2/igroup2.

Note:

• LUN clones assume the samename as their parent volume orLUN and end with _CLONE,that is, if the volume is calledmyvol, the clone would bemyvol_CLONE.

• Volume clones start with "cl_"and end with "-YYYYMMDDHHMMSS".

NTAP_CLONE_FOR_ BACKUP (Y|N) If enabled, clones (volume and LUN)are created and then deleted after theother operations are complete.Otherwise, clones are deleted beforethe operations complete.

Note: If you are backing up clonesto tape, this should be set to Y. Ifyou are doing database refreshes,then you should set it to N.



NTAP_CLONE_ SECONDARY (Y|N) If enabled, clones are created on theSnapMirror destination after theSnapMirror update is complete.

Note: This setting should be usedwithNTAP_SNAPMIRROR_USE_SNAPSHOT,NTAP_SNAPMIRROR_WAIT,NTAP_CLONE_SECONDARY_VOLUMES, and actioncloneVol.

NTAP_CLONE_SECONDARY_VOLUMES

This is a mapping of primary orsecondary storage systems and thesecondary volumes. This is requiredso that Snap Creator can find thesecondary volumes, 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 volume clonesyou want to retain. This workssimilar to the Snapshot copyretention policy.

Note: This only works for volumeclones that require a FlexClonelicense on the storage controller.

NTAP_NFS_EXPORT_HOST Host IP The host name or IP address wherethe clone should be exported. This isthe host where you mount the clonevolume by using NFS.



NTAP_NFS_EXPORT_ACCESS root|read-write|read-only

The host specified inNTAP_NFS_EXPORT_HOSTreceives access or permission to theclone volume.

• root - Root access is granted.• read-only - Read-only access is

granted.• read-write - Read/Write access

is granted.

NTAP_NFS_EXPORT_PERSISTENT true|false Determines if NFS export ispersistent. If true is selected, theclone volume is exported andthe /etc/exports file on theStorage Controller is updated.

NTAP_CIFS_EXPORT_ENABLE (Y|N) Setting to share a cloned volumeusing CIFS.

The following table lists the parameters required to set up the NetApp Management Console dataprotection capability:


NTAP_PM_UPDATE (Y|N) Allows you to turn the NetAppManagement Console dataprotection capability update thatregisters Snap Creator Snapshotcopies in the NetAppManagement Console dataprotection capability on and off.

Note: IfNTAP_PM_UPDATE isenabled, you must configureNTAP_DFM_DATA_SET.

NTAP_DFM_DATA_SET List the storage systems and theNetApp Management Consoledata protection capability datasets to volume correlations, thatis, controller1:dataset1/vol1,vol2;controller1:dataset2/vol3.



NTAP_PM_RUN_BACKUP (Y|N) Starts the the NetAppManagement Console dataprotection capability backup,checks the progress and status,and waits for it to complete.

NTAP_DFM_SNAPSHOT_FORMAT Optional setting for the formatof the secondary Snapshotcopies when using the NetAppManagement Console dataprotection capability. Thisoption requires OnCommand5.0 or later. Required variable:%T - timestamp

Optional variables are:

• %R - retention type• %L - dataset label• %H - storage controller• %N - volume name• %A - application specific

data

If this option is not set, then thedefault the NetAppManagement Console dataprotection capability namingconvention is used. The namingconvention can only be set atthe time of dataset creation.

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



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 be used as E\DB.

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 Opearingsystem or File systemcommand. The File systemSnapshot 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 Systems SnapVault.

The following table describes the Operations Manager console settings:



OM_HOST The name or IP address of theOperations Manager consolehost.

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

OM_PWD The password for theOperations Manager consoleuser.

OM_PORT The port to use forcommunications withOperations Manager console;8088 is the default HTTP portand 8488 is the default HTTPSport that the OperationsManager console uses.

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

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.

The following table describes the different PRE commands:


PRE_APP_QUIESCE_ CMD<##> This is the pre applicationbackup start command, where## is a number from 01-99.

PRE_NTAP_CMD<##> This is the pre Snapshotcommand, where ## is anumber from 01-99; it runsbefore all operations.

PRE_APP_UNQUIESCE_ CMD<##> This is the pre applicationbackup stop command, where## is a number from 01-99.



PRE_NTAP_CLONE_DELETE_CMD<##>

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

Note: The purpose of clonedelete command is to call amount script or commands sothat 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 returns anapplication into normaloperation mode beforeSnap Creator exits due toan error.

• This is ignored if you useAPP_NAME because it ishandled internally inSnap Creator.

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

Note: For Windows, use cmd.exe /c before any PRE command.

The following table describes the different POST commands:


POST_APP_ QUIESCECMD<##> This is a post applicationbackup start command, where## is a number from 01-99.

POST_NTAP_CMD<##> This is a post command, where## is a number from 01-99.This runs after all operationsare complete.

POST_APP_UNQUIESCE _CMD<##> This is a post applicationbackup stop command, where## is a number from 01-99.

POST_NTAP_DATA_TRANSFER_CMD<##>

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

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

Note: For Windows, use cmd.exe /c before any POST command.

The following table describes the mount and unmount commands:


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

UMOUNT_CMD<##> Unmount commands are usedto mount file system for cloningor mount actions, where ## is anumber starting from 01-99.

Note: You should use MOUNT_CMDS and UMOUNT_CMDS for mount and unmountcommands instead of Snap Creator PRE or POST commands for cloning.

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


NTAP_ASUP_ERROR_ ENABLE (Y|N) Enables Snap Creator errormessages to also log an autosupport message on the storagecontroller. Snap Creator alwayscreates an info auto supportmessage when the backup hasstarted and is complete.



SENDTRAP This command interfaces withyour monitoring software oremail allowing you to passalerts generated from SnapCreator into your ownmonitoring infrastructure. The%MSG variable is the messagesent from Snap Creator. Thefollowing is an example of howto send an email on a UNIXsystem:SENDTRAP=/usr/bin/mailx

-s %MSG

[email protected]

</dev/null. For Windows,use cmd.exe /c before anycommand. For example,SENDTRAP= cmd.exe /c echo%how.

SUCCESS_TRAP This command interfaces withyour monitoring software oremail allowing you to pass thesuccess message generatedfrom Snap Creator into yourown monitoring infrastructure.The %SUCCESS_MSG variable isthe success message for SnapCreator. The following is anexample of how to send anemail on a UNIX system:SUCCESS_TRAP=/usr/bin/

mailx -s %SUCCESS_MSG

[email protected]

</dev/null. For Windows,use cmd.exe /c before anycommand. For example,SUCCESS_TRAP= cmd.exe /cecho %Hello.



SUCCESS_MSG After a successful Snap Creatorbackup, this setting logs themessage defined and also sendsit to SUCCESS_TRAP, ifdefined, or to SENDTRAP, ifSENDTRAP is defined.

The following table lists the parameters required for client/server configuration:


SC_AGENT <host name orIP>:<port>

Snap Creator has the capabilityto perform tasks on remotehosts. A task is either a definedplug-in (parameterAPP_NAME) or a commandspecified with the parameters_CMD, for example,NTAP_SNAPSHOT_CREATE_CMD01. To specify a remotehost, enter its name or IPaddress followed by a colonand the port the Snap CreatorAgent is listening on. On theremote host, start the SnapCreator Agent by running thecommand:

<path to

scAgent_v<#>>/bin/

snapcreator --start-

agent <port>



SC_CLONE_ TARGET <host name or IP of theclone target>:<port>

Snap Creator has the capabilityto perform clone operations.Using the action cloneVol incombination with {PRE|POST}_CLONE_CREATE_CMDxx, you can handle thestorage objects on the remoteside. For example, mounting/unmounting file systems. Tospecify a clone target, enter itsname or IP address followed bya colon and the port the SnapCreator Agent is listening on.

SC_AGENT_ TIMEOUT Time (in seconds) Specifies the timeout inseconds. The implementedclient/server architecture uses atimeout mechanism. Thismeans that if the client does notrespond in the specifiedinterval, the server fails with atimeout message. However, thetask on the client is not abortedand requires furtherinvestigation. On a server withhigh load or known long-running tasks such as ownscripts or complex SnapDriveoperations, it might benecessary to extend the timeoutand adapt this value to yourown requirements. By default, atimeout of 300 seconds is used.

Note: Some plug-ins havespecificSC_AGENT_TIMEOUTvalue requirement.



SC_AGENT_WATCHDOG_ENABLE (Y|N) Enables or disables the agentwatchdog process. When theagent receives a quiescerequest, the watchdog processstarts. The watchdog processwaits for theSC_AGENT_UNQUIESCE_TIMEOUT and unquiesces theapplication. If an unquiescerequest is received by the agent,the watchdog process isterminated.

Note: For all plug-ins thedefault setting is Y. For VIBEplug-in the default setting isN, and it should always be N.

SC_AGENT_UNQUIESCE_TIMEOUT

Time (in seconds) This optional setting specifiesthe timeout in seconds. If thecommunication with the agentis not possible and anapplication is in the quiescestate, the agent automaticallyreturns the application into itsnormal mode of operationwithout communication fromthe server. If this setting is notset, then the unquiesce timeoutis set to whatever theSC_AGENT_TIMEOUT isplus 5 seconds.



SC_TMP_DIR (Y|N) Allows you to use a user-defined, alternate temporarydirectory to store the SnapCreator related files. The usercreates the directory andmanages the user access. Theplug-ins use temporary files tointeract with the database. Thetemporary files are created inthe host's default tempdirectory, which has writeaccess to all the users. If thedirectory is full, Snap Creatordisplays an error while creatingthe temp files.

SC_AGENT_LOG_ENABLE (Y|N) Setting which enables loggingon agent. The Snap CreatorServer sends operations to theagent. If something happensbefore agent sends callback toserver, the messages could belost. This allows agentmessages to be logged on agentso they are never lost.


Snap Creator Agent configuration

If Snap Creator Server uses a profile that has commands or scripts in PRE, POST, or APP other thanthe built-in application plug-ins command to be executed on the host where the agent resides, thenthose commands or scripts must be added to /path/to/scAgent_v<#>/config/agent.conf.

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

command: echo

command: /bin/mount

command: /path/to/myscript

In this example, the agent allows Snap Creator Server to run echo, /bin/mount, or /path/to/myscript in addition to the application plug-ins. If the application plug-ins are not used and theagent is required, you should run the application quiesce and unquiesce commands for applicationconsistency.

The * wildcard can be used to allow all commands, but it is not recommended for security reasons.


Snap Creator backup process

The Snap Creator backup process is the same for all the applications and involves running optionalscripts, commands, or using the plug-in interfaces.

The scripts or commands are triggered by using the PRE and POST command parameters in theconfiguration file. All the PRE and POST commands can be run remotely by using Snap CreatorAgent. For the application quiesce and unquiesce operations, you must use the Snap Creatorapplication plug-ins or run commands and scripts.

Typically, the backup process involves the following steps:

1. Achieving application consistency

2. Optional: Achieving file system consistency

3. Creating a Snapshot copy

4. Returning the application to normal mode

5. Optional: Cloning the LUN or volume

6. Optional: Performing various SnapMirror or SnapVault functions

7. Deleting old Snapshot copies, thus managing retention policies on both primary and secondarystorage devices in the case of SnapVault or SnapMirror.

List of commandsThere are several commands such as application quiesce, unquiesce which are used as part of theSnap Creator backup process.

Application quiesce and unquiesce commands

The quiesce and unquiesce commands are used to achieve application consistency when not usingSnap Creator application plug-ins. Snapshot copies of volumes without application consistency areonly crash consistent.

Archive commands

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

PRE commands

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

• The application quiesce commands or application integration plug-ins• The Data ONTAP API or SnapDrive calls• The application unquiesce command or application integration plug-ins

99

• The volume or LUN clone delete commands are run

The following are the different types of PRE commands:

• PRE app quiesce

• PRE NetApp

• PRE app unquiesce

• PRE clone create

• PRE NetApp clone delete

• PRE exit

• PRE restore (in the case of interactive restore)

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

Note: PRE commands or scripts that do not exit with status 0 are handled as an error within SnapCreator.

POST commands

POST commands are user-defined commands or scripts that are run after the application quiescecommand, the Data ONTAP API calls, and the application unquiesce command.

The following are the different types of POST commands:

• POST application quiesce

• POST NetApp

• POST application unquiesce

• POST data transfer

• POST clone create

• POST restore (in the case of interactive restore)

A POST command can be used after the application unquiesce command is run to make sure thatthe database is running in normal mode. For example, run the database check command or script as aPOST application unquiesce command.

Note: POST commands or scripts that do not exit with status of 0 are handled as an error withinSnap Creator.


Running Snap Creator Server using the CLI

You can perform actions such as creating a Snapshot copy, volume clone, and LUN clone by runningSnap Creator Server and the associated parameters by using the command-line interface (CLI).

You should schedule Snap Creator Server from either UNIX cron, Windows task manager, or theSnap Creator built-in GUI scheduler. When scheduling from the Windows task manager, you shouldcreate a .bat file.

You can run Snap Creator Server by using the following command:

./snapcreator --server IP --port Port --user User --passwd Password --

profile Profile --config Config --action Action --policy Policy Optional

Arguments

The following table lists the connection information:


--server <IP|hostname> The IP address or hostname of the Snap CreatorServer.

--port <number> The port number of the Snap Creator Server.

--user <user> The user name used for Snap Creator Serverauthentication.

--passwd <password> The password used for Snap Creator Serverauthentication.

The following table lists the configuration information:


--profile <Profile> The profile you want to run. Profiles aredirectories located in configs directory. If theconfiguration file is not specified, then thedefault configuration file is used.

list Displays all the profiles and configurations.

For example:

snapcreator.exe --server IP --port

Port --user User --passwd Password

--profile list

The following table lists the workflow actions:

101


backup Performs a backup operation based on theconfiguration located under the profile.

For example:



--profile Profile --config Config --

action backup --policy Policy --

verbose

ossv Performs a back operation using Open SystemsSnapVault. This requires the Snap CreatorAgent. The server communicates with the agentand performs a SnapVault update. No primarybackup will be made.

For example:




action ossv --policy Policy --

verbose

cloneLun Performs a backup operation on the primary andthen clones the backup using a LUN clone. Thevolume mapping of igroups are also handled.This requires a SAN or iSAN environment.

For example:




action cloneLun --policy Policy --

verbose



cloneVol Performs a backup operation on the primary andthen clones the backup using a volume clone.The volume mapping of igroups, NFS, or CIFSare also handled. This requires a SAN or iSANor NAS environment.

For example:




action cloneVol --policy Policy --

verbose

cloneDel Performs a clone deletion operation based on thepolicy. Only one copy of the LUN clone isretained. Volume clones have policy-associatedusage.

For example:




action cloneDel --policy Policy --

verbose

clone Performs an application-defined clone operation.Certain plug-ins might have the capability toperform their own cloning operation. For suchplug-ins, the cloning operation is handled by theplug-in.

For example:




action clone --policy Policy --

verbose

Running Snap Creator Server using the CLI | 103


restore Performs an interactive restore operation for agiven policy. You can choose to perform a fileor a volume restore operation. You can alsoperform a non-interactive restore operation.

For example:




action restore --policy Policy --

verbose

backupDel Performs a manual deletion of an existingbackup. This operation is menu driven. You canalso perform a non-interactive backup deletion.

For example:




action backupDel --policy Policy --

verbose

backupList Lists the Snap Creator backups on the primaryand secondary storage system.

For example:




action backupList --policy Policy --

verbose

volumeList Lists the Snap Creator volumes for the specifiedconfiguration on the primary storage system.

For example:




action volumeList --verbose



cloneList Lists the Snap Creator volume clones for thegiven configuration.

For example:




action cloneList --verbose

dpstatus Shows the data protection status of theSnapVault and SnapMirror relationship for acontroller. If SnapVault or SnapMirror is notconfigured, the results are not displayed.

For example:




action dpstatus --verbose

pmsetup Configures the NetApp Management Consoledata protection capability dataset for a givenconfiguration.

For example:




action pmsetup --verbose

arch Performs archive log management according tothe settings in the configuration file. Thisrequires the Snap Creator Agent.

For example:




action arch --verbose



quiesce Performs the quiesce operation for a givenapplication. This requires the Snap CreatorAgent.

For example:




action quiesce --verbose

unquiesce Performs the unquiesce operation for a givenapplication. This requires the Snap CreatorAgent.

For example:




action unquiesce --verbose

discover Performs discovery for a given application. Thisrequires the Snap Creator Agent.

For example:




action discover --verbose

mount Performs the mount operation of an existingbackup. Creates a volume clone based on thebackup and allows the mounting of the clonethrough Snap Creator Agent andMOUNT_CMD.

For example:




action mount --backupName myapp --

verbose



umount Performs the unmount operation of an existingbackup. Deletes a volume clone based on thebackup and allows the unmounting of the clonethrough Snap Creator Agent andUMOUNT_CMDs.

For example:




action umount --backupName myapp --

verbose

scdump Dumps logs, configuration files, and supportinformation for a given profile in a ZIP filecalled scdump located under the Snap Creatorroot directory.

For example,



-- profile Profile --config Config

--action scdump --verbose

custom Application-driven action which performscustom functionality of the defined application.This requires a Snap Creator Agent and isdependent if plug-in implements customfunctionality.

dispatch Executes any Snap Creator workflow. Thisallows for invoking custom workflows or anyworkflow that exists in Snap Creator under thescServer/etc/workflow directory.

The following table lists the workflow arguments:


--config You can choose to run an optional non-defaultconfiguration. Custom configuration files arelocated in the engine/configs/<Profile>directory.

--policy <Policy Name> The backup retention policy defined in theconfiguration: hourly, daily, weekly, or monthly.



--userDefined <Value> Sets a user defined value which can be accessedin the configuration file.

--backupName <name> The name of the backup which should be used.Applies to the actions cloneVol, mount, umount,restore, and backupDel.

--cloneName <clone> The name of the clone which should be used.Applies to the actions cloneDel and umount.

--cntName <controller> The name of the primary storage controllerwhich should be used. Applies to the actionsrestore, backupDel, and cloneDel.

--volName <volume> The name of the primary volume which shouldbe used. Applies to the actions restore andbackupDel.

--fileNames <files> List of the full path to the files or LUNs whichshould be restored. Applies to the action restorewhen using non-interactive mode.

--nonInteractive Runs the operation in non-interactive mode.Applies to the actions restore and backupDel.

--workflow <name> The name of a workflow. Workflows are locatedin the scServer/etc/workflow directory.

--params <params> Defines custom parameters in the form ofkey=value pairs.

The following table lists the repository actions:


profileCreate Creates a new profile in the repository.

For example:



--profile Profile --action

profileCreate --verbose



profileDelete Deletes an existing profile from the repository.

For example:




profileDelete --verbose

Note: The configuration files in the profilewill also get deleted.

configImport Imports a configuration file into repository.

For example:




action configImport --importFile /

path/to/file --verbose

configExport Exports a configuration from the repository.

For example:




action configExport --exportFile /


globalImport Imports a global configuration file into therepository.

For example:



--action globalImport --importFile /


globalExport Exports a global configuration from therepository.

For example:



--action globalExport --ExportFile /




globalDelete Deletes a global configuration from therepository.

For example:



--action globalDelete --verbose

profileGlobalImport Imports a global configuration file for a profileinto the repository.

For example:




profileglobalImport --importFile /


profileGlobalExport Exports a global configuration file for a profilefrom the repository.

For example:




profileglobalExport --exportFile /


profileGlobalDelete Deletes a global configuration for a profile fromthe repository.

For example:




profileglobalDelete --verbose

The following table lists the repository arguments:


--importFile <file> Path to the configuration file. Applies to theaction importConfig.



--exportFile <file> The full path to the configuration file whichshould be exported. Applies to the actionexportConfig.

The following table lists the scheduler actions:


jobStatus Lists all jobs and their status.

For example:



--action jobStatus --verbose

schedRun Runs an existing schedule in the scheduler.

For example:



--action schedRun --schedId ID --

verbose

schedCreate Creates a new schedule in the scheduler.

For example:


Port --user User --passwd Passwd --

profile Profile --config Config --

action schedCreate --policy Policy

--schedName HourlyBackup --

schedFreqId 2 --schedActionId 1 --

schedMin 33 --schedActive true --

schedStartDate 2012-08-07 --verbose

schedDelete Deletes a schedule in the scheduler.

For example:



--action schedDelete --schedId ID --

verbose



schedUpdate Updates an existing schedule in the scheduler.

For example:


Port --user User --passwd Passwd --

profile Profile --config Config --

action schedUpdate --policy Policy

--schedName HourlyBackup --

schedFreqId 2 --schedActionId 1 --

schedMin 33 --schedActive true --

schedStartDate 2012-08-07 --verbose

schedList Lists all schedules in the scheduler.

For example:



--action schedList --verbose

schedActionList Lists the supported scheduler actions. You mustrun this before creating a task.

For example:



--action schedActionList --verbose

schedFreqList Lists the supported scheduler frequencies. Youmust run this before creating a task.

For example:



--action schedFreqlist --verbose

schedDetails Shows additional details for a schedule in thescheduler.

For example:



--action schedDetails --schedId 1 --

verbose

The following table lists the scheduler arguments:



--schedName <name> The name of the schedule.

--schedFreqId <id> The frequency the schedule should use.

--schedActionId <id> The action the schedule should use.

--schedActive <bool> Enables or disables the schedule (true|false).

--schedDayofWeek <day> The day of the week the schedule should run.

--schedHour <hour> The hour the schedule should run.

--schedMin <min> The minute the schedule should run.

--schedCron <cron> Uses the cron format for the schedule.

--schedStartDate <date> The date and time when the schedule shouldstart or be made active.

--schedId <id> The schedule ID.

The following table lists the RBAC actions:


userAdd Creates a new user.

For example:



--action userAdd --username john --

userPwd test123 --verbose

userDelete Deletes a user.

For example:



--action userDelete --username john

--verbose

userList Lists all the users.

For example:



--action userList --verbose



userListAssigned Lists all the assigned users for a role.

For example:



--action userListAssigned --roleName

admin --verbose

userListForProfile Lists all the users who are assigned a profile.

For example:




userListForProfile --verbose

roleAdd Creates a new role.

For example:



--action roleAdd --roleName admin --

roleDesc description --verbose

roleDelete Deletes a role.

For example:



--action roleDelete --roleName admin

--verbose

roleAssign Assigns a role to a user.

For example:



--action roleAssign --userName john

--roleName admin --verbose

roleUnassign Unassigns a role from a user.

For example:



--action roleUnassign --userName

john --roleName admin --verbose



roleListAssigned Lists all the assigned roles for a user.

For example:



--action roleListAssigned --userName

john --verbose

permAdd Creates a new permission.

For example:



--action permAdd --permName backup

--permDesc Description --verbose

permDelete Deletes a permission.

For example:



--action permDelete --permName

backup --verbose

permAssign Assigns a permission to a user.

For example:



--action permAssign --permName

backup --roleName admin --verbose

permUnassign Unassigns a permission from a user.

For example:



--action permUnassign --permName

backup --roleName admin --verbose

permList Lists all the permissions.

For example:



--action permList --verbose



permListAssigned Lists all the assigned permissions for a role.

For example:



--action permListAssigned --roleName

backup --verbose

opAssign Assigns an operation to a permission.

For example:



--action opAssign --opName

backupCreate --permName backup --

verbose

opUnassign Unassigns an operation from a permission.

For example:



--action opUnassign --opName

backupCreate --permName backup --

verbose

opList Lists all operations.

For example:



--action opList --verbose

opListAssigned Lists all the assigned operations for apermission.

For example:



--action opListAssigned --permName

backup --verbose



profileAssign Assigns a profile to a user.

For example:




profileAssign --userName john --

verbose

profileUnassign Unassigns a profile from a user.

For example:




profileUnassign --userName john --

verbose

profileListForUser Lists all the profiles assigned to a user in RBAC.

For example:



--action profileListForUser --

userName john --verbose

The following table lists the RBAC arguments:


--userName <name> The name of the user.

--userPwd <pwd> The password of the user.

--roleName <name> The name of the role.

--roleDesc <name> The description of the role.

--permName <name> The name of the permission.

--permDesc <name> The descriptions of the permission.

--opName <name> The name of the operation.

The following table lists the Agent actions:



agentStatus Lists all the agents and their statuses.

For example:



--action agentStaus --verbose

pingAgent Performs a ping action on a Snap Creator Agent.

For example:



--action pingAgent --agentName

hostname --agentPort port --verbose

The following table lists the Agent arguments:


--agentName <hostname> The host name or IP of the Snap Creator Agent.

--agentPort <port> The port the Snap Creator Agent is running on.

The following table lists the server actions:


pingServer Performs a ping action on the Snap CreatorServer.

For example:



--action pingServer --verbose

The following table lists the optional arguments:


--verbose Prints information to the screen.

--debug Prints debug information to the screen and log.

--version Prints the Snap Creator version.

--credentials Stores Snap Creator Server credentials.



--pwdCrypt Encrypts a password for storing in aconfiguration file.

--pwdConvert <path> Converts all passwords for all configuration filesfound in the specified path to the 4.0.0 format.

--timeout <seconds> Sets the timeout for Snap Creator Servercommunications, the default is 60 seconds.

--help <action> Help for a specific Snap Creator action.


Running Snap Creator Agent using the CLI

You can run the Snap Creator Agent and the associated parameters by using the command-lineinterface (CLI).

Step

1. Start the Snap Creator Agent by running the following command:

./snapcreator --start-agent port Optional arguments

where:

• port: Starts the Snap Creator Agent on the specified port. If no port is specified, port 9090 isused.

• Optional arguments

• --verbose: Prints information to the screen• --debug: Prints information to the screen and log.

Note:

• You can start the Snap Creator Agent automatically on UNIX by using the /path/to/scAgent_v<#>/bin/scAgent script.You can start the agent in multithreaded mode by using the following command:

./snapcreator --start-multithreaded-agent <port>

• For HP-UX, you should start the Snap Creator Agent by using the Bash shell.


Running Snap Creator using the GUI

You can use the Snap Creator GUI to create a backup, volume clone, LUN clone, and so on.

You can perform the following actions by clicking Actions in the Configuration Content pane:

• LUN clone creation• Backup operation on the primary storage system and then clone the backup• Backup operation based on the configuration located under the profile• Restore operation for a given policy• Dump log files, configuration files, and support information for a given profile• Discovery for a given application• Archive log management• Quiesce operation for an application• Unquiesce operation for an application• Mount operation of an existing backup• Unmount operation of an existing backup• Backup operation using Open Systems SnapVault

Note:

• When you update a configuration file, validations are not performed and you can update anyconfiguration parameter.You must ensure that the changes that are made to the configuration file are valid.

• You cannot edit the PRE and POST commands by using the GUI.However, you can update the PRE and POST commands by editing the configuration.

121

Creating and managing roles

You can create multiple roles and assign permissions to the roles by using the Snap Creator CLI andGUI.

Step

1. Depending on whether you want to use the CLI or GUI, perform the appropriate action:

If youwant touse the...

Then...

CLI a. Create a role by entering the following command:

snapcreator.exe --server IP --port Port --user User --passwdPassword --action roleAdd --roleName Role_name --roleDescRole_description --verbose

b. Assign permissions to the role by entering the following command:

snapcreator.exe --server IP --port Port --user User --passwdPassword --action PermAssign --permName Permission_name --roleName Role_name --verbose

GUI a. From Users and Roles click Role management.

b. In the Roles tab, click Add.

c. In the Add role window, enter the details and click Save.

d. To assign permissions to the role, select the role and click Assign Permissions, and then inthe Assign Permissions to the role window, select the permissions, drag them from the leftpane to the right pane and click Save.


Creating and managing users

You can create users and perform several actions, such as assigning profiles and roles to the users byusing the Snap Creator command-line interface (CLI) and graphical user interface (GUI).

Step


If youwant tousethe...

Then...

CLI a. Create a user by entering the following command:

snapcreator.exe --server IP --port Port --user User --passwdPassword --action userAdd --userName User_name --userPwdPassword --verbose

b. Assign a profile to the user by entering the following command:

snapcreator.exe --server IP --port Port --user User --passwdPassword --profile Profile --action ProfileAssign --userNameUser_name --verbose

c. Assign a role to the user by entering the following command:

snapcreator.exe --server IP --port Port --user User --passwdPassword --action roleAssign --userName User_name --roleNameRole_name --verbose

GUI a. From Users and Roles, click User management.

b. In the Users tab, click Add.

c. In the New User window, enter the user details and click Save.

d. To assign a profile to the user, select the user, click Assign Profiles, and in the Assignprofiles to the user window, select the profiles, drag them from the left pane to the rightpane, and click Save.

e. To assign roles to the user, select the user, click Assign Roles, and in the Assign Roles to theuser window, select the role, drag it from the left pane to the right pane, and click Save.

123

Creating a schedule

You can create a schedule and run the tasks by using the Snap Creator CLI and GUI.

Step



Then...

CLI a. Create a schedule by entering the following command:

snapcreator.exe --server IP --port Port --user User --passwdPassword -- profile Profile --config Config --actionschedCreate --policy Policy --schedName Schedule_name> --schedFreqId ID --schedActionId ID --schedMin minute --schedActive true or false> --schedStartDate Start_date> --verbose

b. Run a task by entering the following command:

snapcreator.exe --server IP --port Port --user User --passwdPassword --action schedRun --schedId ID --verbose

GUI a. From the Management drop-down menu, click Schedules.

b. In the Tasks window, Click Create.

c. In the New Task window, enter the details and click Save.

d. To run the task, click Run and to edit the task, click Edit.

Result

The new schedule is listed and you can view the details in the Task window.

Note: If you create an hourly schedule with n minutes, the first job runs after n minutes andthereafter after every 1 hour.

Example: If you create an schedule on 12.56 p.m. with Hourly and 25 minutes, the job first runs at1.21 p.m., then runs at 2.21 p.m., and so on.

Note: If you delete a profile or configuration file while a schedule is running, then the job fails.

For information about creating a schedule using cron, see the cron trigger tutorial.


Related information

Cron trigger tutorial: www.quartz-scheduler.org/documentation/quartz-1.x/tutorials/crontrigger

Creating a schedule | 125

http://www.quartz-scheduler.org/documentation/quartz-1.x/tutorials/crontrigger

Monitoring jobs

You can monitor the status of the jobs by using the command-line interface (CLI) and the graphicaluser interface (GUI).

Step


If you want touse the...

Then...

CLI To view the list of jobs and their statuses, enter the following command:

snapcreator.exe --server IP --port Port --user User --passwd Password --action jobStatus --verbose

GUI From Management, click Job Monitor.

You can see list of jobs and details, such as Job ID, Job status, Start time, End time, andso on.


Monitoring agent

You can monitor the agent status by using the Snap Creator command-line interface (CLI) andgraphical user interface (GUI).

Step



Then...

CLI To view the status of the agent, enter the following command:

snapcreator.exe --server IP --port Port --user User --passwd Password --action agentStaus --verbose

GUI From Management, click Agent Monitor.

You can view the agent details such as IP/hostname, port, version, and status.

127

Viewing data and log details

You can view the volume, backup, and volume clone details for each configuration by using the SnapCreator command-line interface (CLI) and graphical user interface (GUI).

Step



Then...

CLI • To view the list of backups on the primary and secondary storage system, enter thefollowing command:

snapcreator.exe --server IP --port Port --user User --passwdPassword --profile Profile --config Config --actionbackupList --policy Policy --verbose

• To view the list of volumes for the specified configuration on the primary storage system,enter the following command:

snapcreator.exe --server IP --port Port --user User --passwdPassword --profile Profile --config Config --actionvolumeList --verbose

• To view the list of volume clones for the given configuration, enter the following command:

snapcreator.exe --server IP --port Port --user User --passwdPassword --profile Profile --config Config --action cloneList--verbose

• To view the log details, use the scdump command.

GUI • To view the backup details, click the Backups tab from Data.• To view the volume details, click the Volumes tab from Data.• To view the volume clone details, click the Volume Clones tab from Data.• To view the log details, click the Logs tab from Reports and the select the profile,

configuration, log type, and log file.


Performing restore using Snap Creator

You can perform volume restore, single file restore, VMware restore, and Domino restore using SnapCreator.

Note: If you use SnapDrive for Windows, you must use SnapDrive for restore. SnapDrive storesmetadata inside Snapshot copies, which is needed when it performs a restore.

Performing volume restoreYou can perform a volume restore by using the Snap Creator CLI or GUI.

Step



Then...

CLI Enter the following command:

./snapcreator --server IP --port Port --user User --passwdPassword --profile Profile --config config --action restore --policy <Policy> --verbose

Note: To perform a volume restore non-interactively, use the following command:

./snapcreator --server IP --port Port --user User --passwdPassword --profile <Profile> --config <config> --actionrestore --policy Policy --verbose --nonInteractive --cntNameController volName Volume backupName name

GUI a. Select the configuration file and in the Profiles and Configurations pane, click Action andselect Restore.

b. Enter the restore details and in the Restore type drop-down list, select Volume Restore.

c. Complete the wizard to perform the volume restore.

129

Performing single file restoreYou can perform a single file restore by using the Snap Creator CLI or GUI.

Step



Then...


./snapcreator --server IP --port Port --user User --passwdPassword --profile Profile --config config --action restore --policy Policy --verbose

Note: To perform a single file restore non-interactively, use the following command:

./snapcreator --server IP --port Port --user User --passwdPassword--profile Profile --config config --action restore --policy Policy --verbose --non_interactive --cntNamecontroller volName volume backupName name --files files

GUI a. Select the configuration file and in the Profiles and Configurations pane, click Action andselect Restore.

b. Enter the restore details and in the Restore type drop-down list, select Single FileRestore.

c. Complete the wizard to perform the single file restore.

Performing application-defined restoreYou can perform application-defined restore operations for the VMware, KVM, and Xen plug-ins byusing the Snap Creator CLI or GUI.

About this task

In certain VMware environments, restore operations can take a long time. In such cases, you caneither use the Snap Creator CLI or set up two agents—one for backup and the other for restore.

Note: VMware restore by using the GUI is supported only for Snap Creator Agent.

Step




Then...


./snapcreator --server IP --port Port --user User --passwdPassword --profile Profile --config config --action restore--policy Policy --verbose

GUI a. Select the configuration file and in the Profiles and Configurations pane, clickAction and select Restore.

b. Enter the restore details and complete the wizard.

Performing restore with the Domino plug-inUsing the Domino plug-in, you can perform point in time restore, up to the minute restore, andselectable up tp the minute restore for both volume and a single file.

The Domino plug-in provides the following restore options:

• point in time: Restores a volume or single file to the specific time of the selected Snapshot copy.• up to the minute: Restores a volume or single file and then plays forward the Domino transaction

logs to the most recent copy.• selectable up to the minute: Restores a volume or single file and then plays forward the Domino

transaction logs to a specified time.

All the above options are available in both the GUI and CLI.

Note: For up to the minute and selectable up to the minute single file restore, Domino transactionlogging must be enabled.

In all the options, the change information is written back to database after the restore operation iscomplete. The DOMINO_RESTORE_DATA_PATH parameter in the configuration file must be setto the path where the Domino data is being restored. This path might change depending on the typeof restore that is being performed. The DOMINO_RESTORE_DATA_PATH parameter can be set toperform the following restore operations:

• Volume restore: DOMINO_RESTORE_DATA_PATH = DOMINO_DATA• Single database restore: DOMINO_RESTORE_DATA_PATH= a subdirectory on the same

volume that the Domino Data volume exists on.

If DOMINO_RESTORE_DATA_PATH is not set correctly, then the change information is notapplied to the database, which results in a post-restore error.

Performing restore using Snap Creator | 131

Performing volume restore for Domino by using the CLIYou can perform a full volume restore for Domino by using the Snap Creator CLI.

Before you begin

• You must have stopped the Domino server.

Steps

1. Run the command for the restore operation: snapcreator.exe --server IP --port Port--user User --passwd Password --profile Profile --config Config --action

restore --policy Policy --verbose.

2. Select the volume that should be restored by typing the number next to the volume name.

3. Select the Snapshot copy that should be restored by typing the number next to the volume name.

4. Select the type of restore. For volume restore, select 01.

A warning prompt is displayed.

5. Enter y.

6. Select another volume to restore if required.

Note: You should not use q unless an error has occurred. Using q causes Snap Creator to exitwithout performing any post-restore activities.

7. Select the restore type from the restore menu for Domino.

If you want to perform... Then...

Point in time restore a. Select Point in time restore by entering 01.

b. Select the replication option.

Up to the minute restore a. Select Up to the minute restore by entering 02.

b. Select the replication option.

Selectable up to theminute restore

a. Select Selectable up to the minute restore by entering 03.

b. Enter the date and time.

Note: Change information and Domino transaction logs can only beplayed forward. This means that the selected point-in-time must beafter the time the Snapshot copy was created.

c. Select the replication option.


Result

The restore process is complete.

Performing volume restore for Domino by using the GUIYou can restore an entire volume for Domino by using the Snap Creator GUI.

Before you begin


Steps

1. Select the configuration file in the Profiles and Configurations pane, click Action, and selectRestore.

2. Enter the restore details and select Volume restore in the Restore type drop-down list.

3. Select from the following restore types and enter the Domino-specific details and click Next:

• Point in time• Up to the minute• Selectable up to the minute

4. Follow the steps in the wizard to complete the restore process.

After you finish

Start the Domino server.

Performing single file restore with NFS for Domino using the CLIYou can perform a single file restore with NFS for Domino by using the CLI.

Before you begin


Steps

1. Run the command for the restore operation: snapcreator.exe --server IP --port Port--user User --passwd Password --profile Profile --config Config --action

restore --policy Policy --verbose.

2. Select the volume to be restored by typing the number next to the volume name.

3. Select the Snapshot copy to be restored by typing the number next to the volume name.

4. Select the type of restore. For single file restore, select 02.

5. Select the files.


For applications or file systems with a small number of files, an automated menu is displayed,which allows you to select a file. For Domino, there can be hundreds or thousands of files. Youshould enter the name of the files to be restored. The following message is displayed:

Would you like to bypass file selection and manually enter a file for restore (y|n)?

6. Enter the file name and path to be restored.

Note: The path must be relative to the selected volume, so pay close attention to what alreadyexists.

7. Enter the local path on the storage system of the restored file.

8. Select the restore type from the restore menu.

Note: After this step, the restore process is the same for all the three restore types except forSelectable point-in-time restore, where you must enter the time and date to which the Dominotransaction logs are played.

9. Select the replication option for this database.

10. Review the single file restore selection summary and to continue, enter y.

11. Select if you want to restore to the original location of the file.

12. Enter the alternate path to restore (If you have entered n in the Step 10).

13. Confirm the settings and to continue, enter y.

The restore operation is complete. The file is restored to the file system, but none of the post-restore activities, such as applying change information are complete. You are provided with anoption to restore files on other volumes.

Note: Currently only one file restore is supported at a time.

14. To continue, enter c.

Note: You should not use q unless an error has occurred. Using q causes Snap Creator to exitwithout performing any post-restore activities.

The post-restore processes run in the background and are not displayed on the screen.

Result

The restore process is complete.


Performing single file restore with NFS for Domino using the GUIYou can perform single file restore for Domino using the Snap Creator GUI.

Steps

1. Select the configuration file in the Profiles and Configurations pane, click Action, and selectRestore.

2. Enter the restore details and select Single File restore in the Restore type drop-down list.

3. Browse through the directory structure and select the file to be restored and click Next.

Note: Only a single file can be restored at a time. The path is from the perspective of thestorage system, not the server file system. This is because the file is restored at the storagesystem level.

4. Select the destination path for the restored file and click Next.

Note: The restore path must be the same restore path that is listed in the configuration file.Also, the subdirectory structure must reflect in the restore path.

5. Select the restore type from the following and enter the Domino-specific details, and click Next:

• Point in time• Up to the minute• Selectable up to the minute

6. Complete the steps in the wizard to complete the restore process.

Performing single file restore with block protocols for DominoYou can apply change information to a restore that is performed outside of Snap Creator. Thiscustom action allows for all the functionality of the built-in restore functions of the Domino plug-in.

Before you begin

You must have installed SnapDrive.

About this task

Using the custom action involves the following steps:

1. Mounting a Snapshot copy using SnapDrive

2. Copying the required file from the Snapshot copy to the volume managed by Snap Creator

3. Running Snap Creator with the custom action

In the following example, SnapDrive for Windows installed on Windows 2008 is used and the SnapCreator Server acts as a centralized backup server; all the restore operations occur on this server.


Steps

1. Click Server Manager > Storage > SnapDrive > physical server name > Disks.

2. Right-click Disks and select Connect Disk to connect to a Snapshot copy.

The Connect Disk wizard is displayed.

3. Select the storage system, volume, and Snapshot copy that have to be connected.

Note down the exact name of the Snapshot copy that is being mounted. This is required whenSnap Creator is run in a later step.

4. Select the LUN type.

5. Enter the LUN properties.

6. Select the initiators to be used by the LUN.

7. Select the Initiator group management type.

8. Review the summary and click Finish.

The selected Snapshot copy is mounted to the chosen mount point.

Note: If the version of Snap Creator used is earlier than Snap Creator 3.6.0, then the mountedSnapshot copy can be used as a point-in-time single file restore.

9. Copy the files from the Snapshot copy to the restore location.

10. Run Snap Creator using the action custom.

Example

snapcreator.exe --server IP -- port Port --user User --passwd Password--action custom --profile profile --config config --paramssnapname=<snapshot name> datapath=<path to restored database>restoretype=<u2m|su2m> disablereplication=<Y|N>

where

• profile is the name of the Snap Creator profile used.• config is the name of the Snap Creator configuration file used.• snapname is the name of the Snapshot copy used to recover data from.• datapath is the path to the restored Domino database, including the database name.• restoretype is the type of restore to be performed.

u2m for up to the minute restore, su2m for selectable up to the minute restore. Leave thisparameter blank to perform a point in time restore.

• disablereplication is an option to disable Domino replication.• restoretime is used only with restoretype=su2m. The format should be <date><time>.

For example, '01/28/2013 17:13:00'.

Note: You can run Snap Creator using the custom action only by using the command-lineinterface.


11. Unmount the Snapshot copy that was mounted in Step 1 by right-clicking the mounted disk andselecting Disconnect Disk.


Using the plug-in framework to create customplug-ins

The plug-in framework enables you to create your own plug-ins for Snap Creator or reuse theexisting plug-ins. The plug-in provides Snap Creator with the steps for handling backup and recoveryof a given application.

The plug-in framework defines the following methods:

• quiesce - Method for handling quiesce for a given application plug-in• unquiesce - Method for handling unquiesce for a given application plug-in• discover - Method for handling discovery of storage objects for a given application plug-in• scdump - Method for handling collection of support information, database, operating system, and

SnapDrive• restore - Method for handling restore for a given application plug-in• restore_pre - Method for handling prerestore operations for a given application plug-in (can use

built-in restore CLI of Snap Creator)• restore_post - Method for handling post-restore operations for a given application plug-in (can

use built-in restore CLI of Snap Creator)• clone_pre - Method for handling preclone operations for a given application plug-in• clone_post - Method for handling post-clone operations for a given application plug-in• describe - Method for describing what a plug-in implements. This is optional for Perl plug-ins but

required for native plug-ins under plug-ins/native.• clone_all - Method for handling cloning for a given application plug-in (cannot use built-in

cloning interface)• clone_cleanup - Method for handling cleanup if a clone operation fails• restore_clenaup - Method for handling cleanup if a restore operation fails

Note:

• The plug-in framework supports Perl, PowerShell, Java, UNIX Shell, and Python forprogramming.

• The plug-in framework enables you to implement objects and functions that exist within theSnap Creator.For example, error handling is available, which means the plug-in can use the standardimplementation Snap Creator uses. This reduces the work required to create a plug-in.

• Perl plug-ins are installed under /plug-ins/<PLUG-IN-name>/<PLUG-IN>.pm.• Native plug-ins are installed under /plug-ins/native/plug-in.sh,plug-

in.java.plug-in.bat, and so on.• The plug-in must be installed where it is supposed to run. This can be Snap Creator Server or

Snap Creator Agent depending on the set up of Snap Creator.


For more information about the plug-in framework, plug-ins, and a plug-in user guides, see the SnapCreator Developer Community.

Related information

www.snapcreator.com

Using the plug-in framework to create custom plug-ins | 139

http://www.snapcreator.com

Troubleshooting Snap Creator issues

You can troubleshoot Snap Creator issues by using the information in the Snap Creator logs and errormessages.

LogsYou can use Snap Creator logs for troubleshooting. The logs contain information about everythingSnap Creator does.

Messages can be INFO, CMD, OUTPUT, DEBUG, WARN, or ERROR.

• INFO: Standard, normally occurring operations.• CMD: External command or script that Snap Creator runs (according to configuration) and the

return code from the command or script is logged. Typically, these are PRE, POST, or APPquiesce or unquiesce commands.

• OUTPUT: Data ONTAP API call.• DEBUG: Debug information.• WARN: These messages are to draw your attention, but it is considered to be a normal activity

usually and does not require any action (for example, when you delete Snapshot copies).• ERROR: Anything with ERROR is a problem and most likely requires manual action to fix the

error. Snap Creator exits on any ERROR message. It is important to fix any problem thatoccurred before it runs again. Snap Creator does not automatically fix problems, but you canspecify what is to be done before exiting by using PRE_EXIT_CMD defined in the configurationfile.

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

The out, debug, stderr, and agent logs are retained as defined by the LOG_NUM value in theconfiguration file while the error log is always appended. All logs are written to the /path/to/scServer_v<#>/engine/logs/<profile> directory.

There are four logs for every profile and configuration:

• Out• Debug• Error• Stderr

Out log

The out log contains only verbose logging information.


Debug log

The debug log contains verbose and debug logging information.

Trace messages are an extra level of debug logs, which can be used by the plug-in to show tracemessages. LOG_TRACE_ENABLE - (Y|N) Setting enables or disables trace messages.

Error log

The error log contains a history of all the ERROR events for a given configuration. The error loghelps in viewing information about errors that occurred in the past. You can also monitor this log fileand use it to integrate Snap Creator with your monitoring application.

Stderr log

This is usually empty but contains stderr if there are any issues. This usually shows bugs in the code.

Snap Creator Agent

The Snap Creator Agent optionally creates logs. This is enabled by default with the following option:

SC_AGENT_LOG_ENABLE=Y

The three logs for every profile and configuration created on an agent are as follows:

• Out• Debug• Stderr

Additionally, the agent console debug can be enabled by specifying the additional -- debugoption:

./snapcreator --start-agent --verbose --debug

SCDUMP

Snap Creator collects all support information using scdump and places it into a .zip file locatedunder the root Snap Creator directory. This information is useful for troubleshooting. The .zip fileconsists of the following items:

• Snap Creator version (build information, date, and so on)• Host operating system and architecture• Database and version• SnapDrive version• Other environment variables

The syntax for scdump is as follows:

./snapcreator --server IP --port Port --user User --passwd Password --

profile profile --config Config --action scdump --verbose

Troubleshooting Snap Creator issues | 141

Troubleshooting Snap Creator GUI errorsThe Snap Creator GUI might show an error while starting the GUI, when using HTTPS on Linux.

Error starting the GUI

HTTP ERROR 503

Problem accessing /. Reason: SERVICE_UNAVAILABLE

You might receive this error message when there is insufficient space for the temp file.

Verify if you have sufficient space in the temp folder in the respective operating system folders.

Example: For Linux, check /tmp.

HTTPS errors when using Snap Creator on Linux

HTTPS might not work on Linux out-of-the-box. This appears mainly to be an issue with SUSE, butit can apply to any UNIX. Snap Creator does not include the required SSL libraries.

Install openssl and ensure that symlinks are created correctly.

The requirements for HTTPS for Linux/UNIX are as follows:

• openssl package• SSL symlinks

Ensure that the following symlinks are located under /usr/lib or /usr/lib64 (depending on ifthe operating system is 64-bit or not):

• libssl.so.6• libcrypto.so.6

If the symlinks do not exist, change the directory to /usr/lib or /usr/lib64 and run followingcommands:

• ln -sf libssl.so.0.9.8 libssl.so.6

• ln -sf libcrypto.so.0.9.8 libcrypto.so.6


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

IP/Host name

Unless you use host equiv, the storage system name from the hostname command on thecontroller should be the same as that entered in the Snap Creator configuration file.

Do not use a fully qualified domain name (FQDN) when the host name of a storage system isabbreviated.

Ensure that the IP resolution matches the name you specified. If there is a mismatch, correct it byusing host equiv on the storage system.

To enable host equiv, perform the following steps:

1. Enter the following command:

options https.admin.hostsequiv.enable on

2. Edit the /etc/hostsequiv file and add the following: <IP/Name of host in SnapCreator config> <Snap Creator user>

The NetApp Management Console data protection capability

The storage controller name defined in the Snap Creator configuration parameter VOLUMES mustmatch the storage controller name in the NetApp Management Console data protection capability. Ifthey do not match, you can use the operating system host file to force things to match.

Firewall

If there is a firewall between the host running Snap Creator and your storage system, ensure that youhave access control lists (ACLs) (bi-directional) open for 80, 443, or both.

• 80: Used to communicate with the storage system if HTTP is selected.• 443: Used to communicate with the storage system if HTTPS is selected.

If the agent is running, the port on which the agent is running must be open. Ensure that the returntraffic from the storage system is allowed to go to the system running Snap Creator on at least thenon-privileged ports.

NAT

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


HTTPS

To use HTTPS (443) for Linux, Solaris, or AIX, install the openssl-devel RPM. This RPM containsthe openssl libraries, which are required to use SSL.

Troubleshooting the tmp directory permission issuesIf the tmp directory does not have executable permissions, then the Snap Creator binaries might notrun.

You must provide the execute permission for the tmp directory. If you want to tell Snap Creator touse a specific temporary directory, you can do so by setting TMPDIR. Example: export TMPDIR=/temp2.

Troubleshooting the Snap Creator start issueThe Snap Creator Server or the Windows service might not start.

You face this issue if Java is not installed or the wrong bit level or version of Java is installed. Youmust install Java Runtime Environment (JRE) 1.6 or later. You must ensure that the bit levels (32-bitor 64-bit) of Java and Snap Creator are the same.

Error messagesYou must be aware of the error messages associated with different Snap Creator operations.

Each error message includes an area code and a five-digit unique identifier. For example, ERROR:[<area code>-<unique area error identifier>] <error message>. The area code identifies where theerror occurs. The different area codes are as follows:

• scf - Snap Creator Framework• repo - Repository• storage - Storage• agt - Snap Creator Agent• gui - Snap Creator GUI• ora - Oracle plug-in• mys - MySQL plug-in• db2 - DB2 plug-in• syb - Sybase plug-in• ltd - Domino plug-in• psg - PostgreSQL plug-in• vmw - VMware plug-in• max - MaxDB plug-in


• kvm - KVM plug-in• xen - Xen plug-in• sme - SnapManager for Microsoft Exchange plug-in• sms - SnapManager for Microsoft SQL Server plug-in

The following table lists the Snap Creator Framework error messages:

Error code Description/resolution

scf-00001 Ensure that a serial number is set or left blank. Theserial number when set can only be numeric. Thismeans that the Snap Creator setup was not run. Runthe snapcreator --setup command.

scf-00002 Application backup failed due to an application error.Check the logs and application settings.

scf-00003 Application backup failed due to an application error.Check the logs and application settings.

scf-00004 Application clone failed due to an application error.Check the logs and application settings.

scf-00005 Application clone cleanup failed due to an applicationerror. Check the logs and application settings.

scf-00006 Application pre clone operation failed due to anapplication error. Check the logs and applicationsettings.

scf-00007 Application post clone operation failed due to anapplication error. Check the logs and applicationsettings.

scf-00008 The igroup mapping for LUN clone failed. Check theerror. You might have a Manage ONTAP Solutionerror which might reveal the cause of the problem.

scf-00009 Snap Creator started the backup delete operation inNetApp Management Console but failed to listSnapshot copies. Ensure that Snap Creator isregistering backup and check the configurationparameters NTAP_PM_UPDATE andNTAP_DFM_DATA_SET.



scf-00010 Snap Creator started the backup delete operation inNetApp Management Console but Snapshot copiesexist. Ensure that Snap Creator is registering backupand check the configuration parametersNTAP_PM_UPDATE andNTAP_DFM_DATA_SET.

scf-00011 Ensure that Snap Creator is registering backup andcheck the configuration parametersNTAP_PM_UPDATE andNTAP_DFM_DATA_SET.

scf-00012 Ensure that the dataset exists and conformant status isconformant. Also make sure the dataset must becreated by Snap Creator. Datasets which are notcreated by Snap Creator are not application datasetsand it does not work.

scf-00013 Check the configuration parametersNTAP_PM_UPDATE andNTAP_DFM_DATA_SET.


scf-00015 Snap Creator started the NetApp ManagementConsole backup and getting the progress of the samefailed. Check the configuration parametersNTAP_PM_UPDATE andNTAP_DFM_DATA_SET.

scf-00016 Snap Creator was unable to find any SnapMirrorrelationships for the given controller. Log in to thestorage controller and run a snapmirror statuscommand and ensure that the relationship exists.

scf-00017 Snap Creator was unable to find SnapMirrorrelationships for the given controller:volumes. Log into the storage controller and run a snapmirrorstatus command and ensure that the relationshipsfor the given controller name exists. If a differentname is used, then you must configure theSECONDARY_INTERFACES parameter to tell SnapCreator what maps to the storage controller.



scf-00018 Snap Creator was unable to find any SnapVaultrelationships for the given controller. Log in to thestorage controller and run a snapvault statuscommand and ensure that the relationship exists.

scf-00019 Snap Creator was unable to find the SnapVaultrelationship. Log in to the storage controller and runsnapvault status, and ensure that the SnapVaultrelationship for the given controller name exists. If adifferent name is used, then you must configure theSECONDARY_INTERFACES parameter to tell SnapCreator what maps to the storage controller.

scf-00020 Snap Creator was unable to start SnapVault update.Log in to the storage controller and run snapvaultstatus command and ensure that the SnapVaultrelationship for the given controller name exists. If adifferent name is used, then you must configure theSECONDARY_INTERFACES parameter to tell SnapCreator what maps to the storage controller.

scf-00021 Check the error and storage controller settings forSnapMirror.

scf-00022 The SnapMirror update took longer than theconfigured wait time. You can adjust the wait time byincreasing the value forNTAP_SNAPMIRROR_WAIT in the configurationfile.

scf-00023 The SnapVault update took longer than the configuredwait time. You can adjust the wait time by increasingthe value for NTAP_SNAPVAULT_WAIT in theconfiguration file.

scf-00024 Check the error and storage controller settings forSnapVault.

scf-00025 Application post restore operation failed due to anapplication error. Check the logs and applicationsettings.

scf-00026 Application restore cleanup operation failed due to anapplication error. Check the logs and applicationsettings.



scf-00027 Application pre-restore operation failed due to anapplication error. Check the logs and applicationsettings.

scf-00028 Application discovery failed due to an applicationerror. Check the logs and application settings. Inaddition, automatic discovery can be disabled bysetting APP_AUTO_DISCOVERY=N andcommenting out VALIDATE_VOLUMES.

scf-00029 The application plug-in is not supported to useautomatic discovery. Disable automatic discovery bysetting APP_AUTO_DISCOVERY=N.

scf-00030 File system quiesce failed due to file system error.Check logs and file system settings. To ignore errorsand proceed with the backup, you can setAPP_IGNORE_ERROR=Y.

scf-00031 File system quiesce failed due to file system error.However, APP_IGNORE_ERROR=Y so SnapCreator will proceed with the backup. Check logs andfile system settings.

scf-00033 Application unquiesce failed due to application error.However, APP_IGNORE_ERROR=Y so SnapCreator will proceed with the backup. Check logs andapplication settings.

scf-00034 The LUN clone creation failed. Check error, youmight have a Manage ONTAP Solution error whichmight reveal the cause of the problem.

scf-00035 The LUN list create failed. Check error, you mighthave a Manage ONTAP Solution error which mightreveal the cause of the problem.

scf-00036 Application quiesce finished with no exit code. Checkthe logs and application settings.

scf-00037 Application quiesce failed due to application error.Check logs and application settings. To ignoreapplication errors and proceed with backup, you canset APP_IGNORE_ERROR=Y.



scf-00038 Application quiesce failed due to application errorhowever APP_IGNORE_ERROR=Y so Snap Creatorwill proceed with the backup. Check logs andapplication settings.

scf-00039 Check NTAP_USERS and ensure that the storagecontroller is defined in the configuration file.

scf-00040 Check the VOLUMES setting in the configuration fileand ensure that the correct controller: volumes areconfigured.

scf-00041 The parameter CMODE_CLUSTER_NAME isrequired and used for AutoSupport and SnapMirror.Define this correctly in configuration file.

scf-00042 The parameter CMODE_CLUSTER_NAME andCMODE_CLUSTER_USERS are required and usedfor AutoSupport and SnapMirror. Define thiscorrectly in configuration file.

scf-00043 Check configuration and change parameter. ClusteredData ONTAP does not support SnapVault.

scf-00044 This happens if the META_DATA_VOLUME is notspecified in VOLUMES. Add to VOLUMES the metadata volume.

scf-00045 This happens if the volume specified inMETA_DATA_VOLUME is the only volume presentin VOLUMES. There should be other volumes also.Should not use META_DATA_VOLUME for normalSnapshot operation.

scf-00046 Update the configuration file and set theSNAP_TIMESTAMP_ONLY option to Y.

scf-00047 Edit the configuration file and disable one of the twooptions.

scf-00048 Application mount failed due to an application error.Check the logs and application settings.

scf-00049 Application unmount failed due to an applicationerror. Check the logs and application settings.

scf-00050 Application custom failed due to an application error.Check the logs and application settings.



scf-00051 Check the debug error message. There could be aproblem communicating with the server.

scf-00052 Restore failed due to an application error. Check thelogs and application settings.

scf-00053 File system unquiesce failed due to file system error.However, APP_IGNORE_ERROR=Y so SnapCreator will proceed with the backup. Check logs andfile system settings.

scf-00054 File system unquiesce failed due to file system error.However, APP_IGNORE_ERROR=Y so SnapCreator will proceed with the backup. Check logs andfile system settings.


scf-00058 Could not update the file. This is usually permissionsproblem or failed to parse the values returned fromapplication. Check the permissions of the user runningSnap Creator and ensure that the permissions arecorrect.

scf-00059 The scdump action failed due to an application error.Check the logs and application settings.

scf-00060 A required field in the DTO is not set or is invalid.This caused a validation error when processing theDTO. Correct the issue and resend the DTO.

scf-00061 Snap Creator could not delete the archive logs for agiven application. Check the permissions for the SnapCreator user, this could be the Snap Creator Server orSnap Creator Agent depending on the configuration.

scf-00062 Authentication failed, user does not have permissionto perform the operation.

scf-00063 Application discovery usingVALIDATE_VOLUMES=DATA failed due to anapplication error. Check the logs and applicationsettings.



scf-00064 Application discovery usingVALIDATE_VOLUMES=DATA failed. SnapCreator was unable to discover any data volumesresiding on the storage system. To disable automaticdiscovery comment out VALIDATE_VOLUMES.

scf-00065 Application discovery detected that some volumes aremissing. Check which volumes are missing and addthem to VOLUMES parameter so they can beincluded in the backup.

scf-00066 Agent configured is not reachable. This might bebecause agent is down or local firewall issue. Checkthe configuration parameter SC_AGENT.

scf-00067 Snap Creator could not find external Snapshot copybased on regx patternNTAP_EXTERNAL_SNAPSHOT_REGEX. Log onto the controller and match the backupList outputwith regx pattern.

scf-00068 File system pre-restore failed due to file system error.Check logs and file system settings.

scf-00069 File system pre-restore failed due to file system error.However, APP_IGNORE_ERROR=Y so SnapCreator will proceed with other operations. Checklogs and file system settings.

scf-00070 File system post restore failed due to file system error.Check logs and file system settings.

scf-00071 File system post restore failed due to file system error.However, APP_IGNORE_ERROR=Y so SnapCreator will proceed with other operations. Checklogs and file system settings.

scf-00072 The policy you are using is not valid. Checkconfiguration file and configureNTAP_SNAPSHOT_RESTENTIONS properly.

Repository error messages


REPO-01001 Check if the global.conf file exists in theconfig folder.



REPO-01002 The global.conf file already exists in theconfig folder. Either delete the globalconfiguration file first or update the existing file.

REPO-01103 Failed to create the global.conf file in theconfig folder. Check permissions of the userrunning Snap Creator against directory.

REPO-01203 Failed to update the global.conf file in theconfig folder. Check permissions of userrunning Snap Creator against directory.

REPO-01303 Failed to remove global.conf file in theconfig folder. Check whether the file is presentin config folder or check permissions of userrunning Snap Creator against directory

REPO-01403 Failed to read global.conf file in the configfolder. Check if your global configuration file isdeleted.

REPO-01503 Failed to update the global.conf file in theconfig folder. Check permissions of userrunning Snap Creator against directory.

REPO-01603 Failed to read global.conf file in the configfolder. Check if your global configuration file isdeleted.

REPO-02002 Profile with same name already exists. If theprofile is not visible, then the user does not havepermission on this profile.

REPO-02003 Check if your profile is renamed or deleted alsothe user might not have permission on thisprofile.

REPO-02103 Failed to create global.conf file in the profile.Check permissions of user running Snap Creatoragainst directory.

REPO-02106 Failed to create profile in the config folder.Check permissions of user running Snap Creatoragainst directory.



REPO-02203 Failed to update the profile in the configfolder. Check permissions of user running SnapCreator against directory.

REPO-02213 Failed to rename profile in the config folder.Check permissions of user running Snap Creatoragainst directory or check if your profile isalready renamed or deleted.

REPO-02703 Listing profiles failed. Check the config folderpath.

REPO-03002 Configuration file with same name alreadyexists for given profile. Choose a different name.

REPO-03212 Failed to rename the configuration from profile.Check if your configuration is renamed ordeleted and also check permissions of userrunning Snap Creator against directory.

REPO-03303 Failed to delete configuration from profile in theconfig folder. Check permissions of userrunning Snap Creator against directory.

Storage error messages


STORAGE-00001 Volume clone is not created by Snap Creator ortime stamp appended in clone name is not valid.

STORAGE-00002 Failed to create executor for storage. Check thelogs for Manage ONTAP Solution errors whichmight reveal the cause of the problem.

STORAGE-00003 Host is not reachable. Ensure that the localfirewall settings are correct and host is able toping from the system where Snap Creator Serveris installed.

STORAGE-01003 Check the logs for errors. You most likely havea Manage ONTAP Solution error which mightreveal the cause of the problem.

STORAGE-01004 Provide same source and destination volumes.


































































Snap Creator Agent error messages

Error code Description/Resolution

agt-00001 The Snap Creator Agent or some other processis running on the port specified. Try a differentport.

agt-00003 The parameters given were not correct to startthe Snap Creator Agent. Check the requiredparameters.

agt-00004 The SC_AGENT configuration parameter mustbe defined when using a remote agent.

agt-00005 You are not allowed to perform back to backquiesce operations and one operation is alreadyrunning. Wait or run unquiesce.



agt-00006 The watchdog process is unable to spawn. Thesystem most likely has reached the maximumnumber of processes. Disable the watchdog inthe configuration or check the operating systemsettings.

agt-00008 The quiesce and unquiesce operation did notcomplete and backup is only crash consistent.Check the logs. This can happen if the quiesceoperation takes too long and you are using awatchdog. The watchdog process performs aforced unquiesce after x seconds as defined inthe configuration.

agt-00009 Pre and Post commands must be allowed in theagent.conf on the agent side. Update theagent.conf and allow necessary commands.

agt-00010 The agent could not read its configuration file.Check the permissions on the agent.conf file.

agt-00011 A command was sent to the agent but is notallowed. Update the agent.conf to allow thecommand.

agt-00012 This error occurs while loading a plug-in. Checkthe plug-in and APP_NAME setting.

agt-00013 This error occurs while running the setENVmethod inside plug-in. Check the plug-in andensure the syntax is correct.

GUI error messages


gui-00001 Ensure that the encrypted password in theconfiguration file is correct.

gui-00002 Ensure that you are using the correct SnapCreator executable. Verify that /etc/snapcreatorgui.conf is correct.

gui-00003 Ensure that the logs and corresponding profilefolder exist.



gui-00004 Check if Snap Creator home/logs/profilename exists.

gui-00005 Check if the corresponding profile andconfiguration exists in the configs directory.

gui-00006 Try running snapcreator profile setup,if the snapcreatorgui.conf is lost.

gui-00007 Check if your configuration is renamed ordeleted.

gui-00008 Check your user name and password and verifyif you have run snapcreator profilesetup command.

gui-00009 Check if permissions on file or folder exist.

gui-00010 Check if permissions on file or folder exist.

gui-00011 Choose a different profile or delete the existingone.

gui-00012 Verify if configs directory exists and if haverun snapcreator profile setup command.

gui-00013 Check the logs for more information.

gui-00014 Close the configuration and open it again.

gui-00015 Check the permissions on file and if they exist.

gui-00017 Check if your vCenter is correct and has a validdatacenter.

gui-00019 Try again, as the datastore might have beendeleted during retrieval.

gui-00020 Try again, as the datastore might have beendeleted during retrieval.

gui-00021 Try again, verify if your vCenter is correct.

gui-00022 Add datastores to your vCenter.

gui-00023 Try again, verify your vCenter.

gui-00024 The version of vCloud Director you are using isnot supported.

gui-00025 Enter correct credentials and try again.



gui-00026 Organizations not found for vCD. Createorganizations and retry.

gui-00027 Check your vCenter credentials.

gui-00028 Check the controller details/NTAP_USERS.

gui-00029 Verify the vCloud Director URL.

gui-00030 Check if vDCs exist for the organizations.

gui-00031 Check if vApps exist for the vDCs.

Oracle plug-in error messages


ora-00001 Verification failed, check the ORA error and re-run sqlplus manually.

ora-00002 Oracle 8 and 9 are not supported by SnapCreator.

ora-00003 RAC check failed, check the ORA error and re-run sqlplus manually.

ora-00004 Archive log mode check failed, check the ORAerror and re-run sqlplus manually.

ora-00005 Archive log mode must be set. Configure the dbin archive log mode and restart backup.

ora-00006 Check permissions of the directory wherebackup control file is being created.

ora-00007 The archive log only mode was selected andfailed. The oracle plug-in will do an archive logcurrent. Check the ORA error and try runningmanually.

ora-00008 The hot backup mode begin sqlplus commandfailed. Check the ORA error and re-run sqlplusmanually.

ora-00009 Quiesce completed but with errors, check thelogs.



ora-00010 The hot backup mode end sqlplus commandfailed. Check the ORA error and re-run sqlplusmanually.

ora-00012 Unquiesce completed but with errors, check thelogs.

ora-00013 Discovery is enabled but cannot locate data filesand archive logs. Check the ORA error and re-run sqlplus manually.

ora-00014 Database discovery failed, check the log.

ora-00015 SCDUMP failed and unable to collect operatingsystem information. Check the command thatwas run and try running manually.

ora-00017 SCDUMP failed and unable to collectSnapDrive information. Check the path toSnapDrive command and permissions.

ora-00018 SCDUMP failed and unable to collect Oracleinformation. Check the ORA error and re-runsqlplus manually.

ora-00019 The SQLPLUS_CMD is a required oracle plug-in config parameter.

ora-00020 The sqlplus command failed check error.

MySQL plug-in error messages


mys-00001 A connection to database cannot be established.Try telnet to port 3306, this could be localfirewall or network issue.


mys-00003 Quiesce failed, check the log.


mys-00006 Unquiesce failed, check the log.



mys-00007 The sql query did not return output, check foradditional errors.

mys-00008 Discovery failed, check the log.

mys-00009 SCDUMP failed, could not collect operatingsystem information. Check the error and ensurethat the operating system command is specifiedin the path.

mys-00010 SCDUMP failed, could not collect SnapDriveinformation. Check the error and ensure that theSnapDrive command is specified in the path.

DB2 plug-in error messages


db2-00001 Quiesce failed for db. Check the error messageand try running the command manually.

db2-00002 Quiesce of databases failed, check the log.

db2-00003 Unquiesce failed for db. Check the errormessage and try running the commandmanually.

db2-00004 Unquiesce of databases failed. Check the log.

db2-00005 Discovery of database failed could not find path.Check the path settings.

db2-00007 Discovery could not retrieve table spaces. Checkthe database error and try running manually.

db2-00008 Discovery could not retrieve table spacecontainers. Check the database error and tryrunning manually.

db2-00009 Discovery could not retrieve databaseconfiguration. Check the database error and tryrunning manually.

db2-00010 Discovery failed, check the log.

db2-00011 SCDUMP failed, could not collect OSinformation. Check the and ensure it is inPATH.



db2-00013 SCDUMP failed, could not collect theSnapDrive information. Check the commandand ensure that it is in PATH.

db2-00014 SCDUMP failed, could not collect the dbinformation. Check the database error and tryrunning manually.

Domino plug-in error messages


ltd-00001 For Domino plug-in to workSNAP_TIMESTAMP_ONLY should always beset to Y in the configuration file. This error isdisplayed if SNAP_TIMESTAMP_ONLY is setto N.

ltd-00002 Domino plug-in was unable to quiesce all thedatabases successfully. Check the logs to findthe exact reason for the error or run SnapCreator in debug mode to find the error.

ltd-00003 Domino plug-in was unable to unquiesce all thedatabases successfully. Check the logs to findthe exact reason for the error or run SnapCreator in debug mode to find the error.

ldt-00004 Application discovery failed due to anapplication error. Check the configuration andapplication settings. You can disable automaticdiscovery by settingAPP_AUTO_DISCOVERY=N andcommenting out VALIDATE_VOLUMES.

ldt-00005 The scdump action failed due to an error whilecollecting the operating system information.Check the logs and try running the commandmanually by hand.

ldt-00006 The scdump action failed due to an error whilecollecting SnapDrive information. Check thelogs and try running the command manually byhand.



ldt-00008 Domino plug-in was unable to restore all thedatabases successfully. Check the logs to findthe exact reason for the error or run SnapCreator in debug mode to find the error.

ldt-00009 Reasons could be

• Domino plug-in is not supported on thisplatform.

• Prerequisites for the Domino plug-in to runare not satisfied. Check documentation(Domino plug-in setup).

KVM plug-in error messages


kvm-00001 This error is seen when the plug-in fails tocollect virtual machine information. See thedebug logs for more details.

kvm-00002 This error is seen when theKVM_VM_MAPPING_LIST parameter in theconfiguration file is not properly defined or novirtual machines are present in the KVMHypervisor. To overcome this issue, you mustset APP_AUTO_DISCOVERY to 1.

kvm-00003 This error is seen when the quiescing function ofthe KVM plug-in fails. See the debug logs formore details.

kvm-00004 This error is seen when the unquiescing functionof the KVM plug-in fails. See the debug logs formore details.

kvm-00005 This error is seen when the plug-in fails tocollect the hypervisor (OS) information.

kvm-00006 This error is seen when the plug-in fails to getthe hypervisor (OS) version.

kvm-00007 This error is seen when the plug-in fails to getthe libvirt package version of the hypervisor(OS).



kvm-00008 This error is seen when the mandatory parameterKVM_RESTORE_VM_LIST is not defined inthe configuration file during a restore operation.

kvm-00009 This error is seen when the prerestore functionof the KVM plug-in fails. See the debug logs formore details.

kvm-00010 This error is seen when the post-restore functionof the KVM plug-in fails. See the debug logs formore details.

kvm-00011 This error is seen when the cleanup-restorefunction of the KVM plug-in fails. See thedebug logs for more details.

kvm-00012 This error is seen when the KVM plug-in fails tochange the state of the virtual machines. See thedebug logs for more details.

kvm-00013 This error is seen when the KVM plug-in fails toget the state of the virtual machine (vm_name)and could not perform the suspend action. Youshould not use the Snapshot copy taken duringthis run for restoring the virtual machine,because it might lead to an inconsistent state.See the debug logs for more details.

kvm-00014 This error is seen when the KVM plug-in fails tochange the state of the virtual machine(vm_name) to the suspend action. You shouldnot use the Snapshot copy taken during this runfor restoring the virtual machine, because itmight lead to an inconsistent state. See thedebug logs for more details.

kvm-00015 This error is seen when the KVM plug-in fails tofind the directory containing the virtual machineconfiguration XML files. See the debug logs formore details.

kvm-00016 This error is seen when the KVM plug-in fails tofind the directory contents. See the debug logsfor more details.



kvm-00017 This error is seen when the directory does notcontain any virtual machine configuration XMLfiles. See the debug logs for more details.

kvm-00018 This error is seen when the KVM plug-in fails tofind the LHU kit version. See the debug logs formore details.

kvm-00019 This error is seen when the KVM plug-in fails torun the sanlun command. See the debug logsfor more details.

kvm-00020 This error is seen when the KVM plug-in fails toget the mapping information between multipathdevices and storage controller volumes. See thedebug logs for more details.

kvm-00021 This error is seen when the KVM plug-in fails toget information about NFS volumes. See thedebug logs for more details.

kvm-00022 This error is seen when the KVM plug-in fails toget the host name of the storage controller. Seethe debug logs for more details.

kvm-00023 This error is seen when the KVM plug-in fails toget the DNS information of the machine. Eitherupdate the DNS or add the IP address and hostname in the /etc/hosts file of KVMhypervisor.

kvm-00024 This error is seen when the KVM plug-in fails toget the host name of the machine. See the debuglogs for more details.

kvm-00025 This error is seen when there are no virtualmachines, which belong to the supported SnapCreator KVM configuration. See the debug logsfor more details.

kvm-00026 This error is seen when the KVM plug-in fails toget the volume list of the storage controllers. Seethe debug logs for more details.



kvm-00027 This error is seen when the KVM plug-in fails toget the state of the virtual machine and could notperform the resume, destroy, or start action. Youhave to perform the action manually. See thedebug logs for more details.

kvm-00028 This error is seen when the KVM plug-in fails tochange state of the virtual machine to theresume, destroy, or start action. You have toperform the action manually. See the debug logsfor more details.

kvm-00029 This error is seen when the mandatory parameterKVM_RESTORE_VM_LIST is not defined inthe configuration file during the restoreoperation.

kvm-00030 This error is seen when KVM plug-in fails to getManage ONTAP Solution instances of storagecontrollers. See the debug logs for more details.

kvm-00031 This error is seen when the restore operation isperformed through the CLI and the snap_nameargument is missing.

kvm-00032 This error is seen when the KVM plug-in fails toget the virtual machine information listed in theKVM_RESTORE_VM_LIST parameter. Seethe debug logs for more details.

kvm-00033 This error is seen when the KVM plug-in failedto find storage controller information of thevirtual machine. See the debug logs for moredetails

kvm-00034 This error is seen when the KVM plug-in failedto find the login credentials of the storagecontroller in the configuration file. Add the logincredentials in the NTAP_USERS parameter inthe configuration file.

kvm-00035 This error is seen when the KVM plug-in failedto restore the virtual machine. See the debuglogs for more details.



kvm-00036 This error is seen when the KVM plug-in fails toperform the file restore operation. See the debuglogs and also the storage controller syslogmessages for more details.

kvm-00037 This error is seen when the KVM plug-in fails toget Manage ONTAP Solution instances of thestorage controller. See the debug logs for moredetails.

kvm-00038 This error is seen when the KVM plug-in fails toget SnapDrive information. See the debug logsfor more details.

kvm-00039 This error is seen when the required parameterKVM_VM_MAPPING is not defined in theconfiguration file. Set this parameter to'auto:detect:detect' and rerun the test.

kvm-00040 This error is seen during the restore operationwhen an improper Snapshot copy name isprovided or the restore file does not exist in theprovided Snapshot copy.

kvm-00041 This error is seen during the restore operationwhen an improper Snapshot copy name isprovided or the restore file does not exist in theprovided Snapshot copy.

kvm-00042 This error is seen when the Snapshot copyvalidation fails during a restore operation. Seethe debug logs for more details.

kvm-00043 This error indicates that the KVM plug-in willonly run on a Linux operating system. Ensurethat scServer or scAgent is running on Linux.

kvm-00044 This error is seen when the virtual machineconfiguration XML file (file_path) is not in theproper format. Ensure that the correct format isused. See the debug logs for more details.

kvm-00045 This error is seen when the KVM plug-in wasnot able to find the host name of the storagecontroller. Update the NTAP_USERS parameterwith the host name of the storage controller inthe configuration file.



kvm-00046 This error is seen when the KVM plug-in wasnot able to find the storage controller or LUNdetails for the block device. See the debug logsfor more details.

kvm-00047 This error is seen when more than one virtualmachines share the same device. This is not asupported configuration.

Xen plug-in error messages


xen-00001 This error is seen when the plug-in fails toconnect to the Xen host by using a remoteprocedure call. See the debug logs for moredetails.

xen-00002 This error is seen when the plug-in fails to getthe host list information. See the debug logs formore details.

xen-00003 This error is seen when the plug-in fails to getthe host instance by using the address. See thedebug logs for more details.

xen-00004 This error is seen when the plug-in fails to getthe host record object. See the debug logs formore details.

xen-00005 This error is seen when the plug-in failed to getthe virtual machine instance from vmname orthe virtual machine does not exist with the givenname. See the debug logs for more details.

xen-00006 This error is seen when there are duplicatevirtual machine names. See the debug logs formore details.

xen-00007 This error is seen when the plug-in failed to getthe virtual machine record object. See the debuglogs for more details.

xen-00008 This error is seen when there is more than onevirtual machine with the same name or thevirtual machine with given name does not exist.See the debug logs for more details.



xen-00009 This error is seen when the plug-in fails to getthe virtual machine instance by using uuid. Seethe debug logs for more details.

xen-000010 This error is seen when the plug-in fails to createa virtual machine consistent Snapshot copy. Seethe debug logs for more details.

xen-000011 This error is seen when the plug-in fails toexecute the vm-export command. One problemmight be that the metadata path does not exist.See the debug logs for more details.

xen-000012 This error is seen when the plug-in fails to openthe file handle for the metadata file. Oneproblem might be that the metadata path doesnot exist. See the debug logs for more details.

xen-000013 This error is seen when the plug-in fails to getthe host IQN information. See the debug logs formore details.

xen-000014 This error is seen when the plug-in fails to getthe VBD information of the virtual machine. Seethe debug logs for more details.

xen-000015 This error is seen when the plug-in fails to getthe VDI information of the virtual machine. Seethe debug logs for more details.

xen-000016 This error is seen when the plug-in fails to getthe uuid of VDI. The disk might be deleted orpointing to a null reference. See the debug logsfor more details.

xen-000017 This error is seen when the plug-in fails to getthe Storage Repository instance. See the debuglogs for more details.

xen-000018 This error is seen when the plug-in fails to getthe Storage Repository type (NFS/iSCSI/FC).See the debug logs for more details.

xen-000019 This error is seen when the plug-in fails to getthe Storage Repository PBD information. Seethe debug logs for more details.



xen-000020 This error is seen when the plug-in fails to getthe Storage Repository device configurationinformation. See the debug logs for more details.

xen-000021 This error is seen when the plug-in fails to getigroup information of the attached LUN. See thedebug logs for more details.

xen-000022 This error is seen when the plug-in fails to getthe LUN path of the attached LUN. See thedebug logs for more details.

xen-000023 This error is seen when the plug-in fails to getthe Storage Repository information of the disksattached to the virtual machine. The disk mightbe deleted or pointing to a null reference. Seethe debug logs for more details.

xen-000024 This error is seen when the plug-in fails to getthe PBD record of the VDI. See the debug logsfor more details.

xen-000025 This error is seen when the plug-in fails to getthe Storage Repository object of the VDI. Thedisk might be deleted or pointing to a nullreference. See the debug logs for more details.

xen-000026 This error is seen when the plug-in fails to getthe SM configuration information of the VDIdisk. The disk might be deleted or pointing to anull reference. See the debug logs for moredetails.

xen-000027 This error is seen when the plug-in fails to getthe virtual machine Snapshot copy list. See thedebug logs for more details.

xen-000028 This error is seen when the plug-in fails to getthe VDI disk information of the Snapshot copy.See the debug logs for more details.

xen-000029 This error is seen when the restore is startedwithout giving the Snapshot copy name. See thedebug logs for more details.



xen-000030 This error is seen when the plug-in fails to openthe metadata file. See the debug logs for moredetails.

xen-000031 This error is seen when the plug-in fails to copythe VDI file from the Snapshot copy. This mightbe because snaphost was created before creatingthe VDI. See the debug logs for more details.

xen-000032 The Snapshot copy name might have beenchanged manually. See the debug logs for moredetails.

xen-000033 This error is seen when the plug-in fails toswitch the virtual machine off during the restoreoperation. See the debug logs for more details.

xen-000034 This error is seen when the plug-in fails to deletethe virtual machine during the restore operation.See the debug logs for more details.

xen-000035 This error is seen when the plug-in fails to copythe VDI files from Snapshot copy during therestore operation. See the debug logs for moredetails.

xen-000036 This error is seen when the plug-in fails toimport the virtual machine metadata file during arestore operation. See the debug logs for moredetails.

xen-000037 This error is seen when the plug-in fails to getthe virtual machine instance after the restoreoperation. See the debug logs for more details.

xen-000038 This error is seen when the plug-in fails torestore the consistency Snapshot copy. See thedebug logs for more details.

xen-000039 This error is seen when the plug-in fails topower on the virtual machine after the restoreoperation. You must manually power on. See thedebug logs for more details.

SnapManager for Microsoft Exchange plug-in error messages



sme-00001 SnapManager for Microsoft Exchange is onlysupported on Windows.

sme-00002 Quiesce failed, check other error messages andthe log.

sme-00003 SCDUMP failed, could not collect the operatingsystem information. Ensure that the operatingsystem command is in path and check the log.

sme-00004 SCDUMP failed, could not collect SnapDriveinformation. Ensure that the SnapDrivecommand is in path and check the log.

sme-00005 The PowerShell command failed. Check theerror message and try running manually.

SnapManager for Microsoft SQL Server plug-in error messages


sms-00001 SnapManager for Microsoft SQL Server is onlysupported on Windows.

sms-00002 Quiesce failed, check other error messages andthe log.

sms-00003 SCDUMP failed, could not collect the operatingsystem information. Ensure that the operatingsystem command is in path and check the log.

sms-00004 SCDUMP failed, could not collect SnapDriveinformation. Ensure that the SnapDrivecommand is in path and check the log.

sms-00005 The PowerShell, command failed. Check theerror message and try running manually.

Sybase ASE plug-in error messages


syb-00001 Wait for unquiesce to complete or run aunquiesce manually.

syb-00002 Could not verify the database, check to ensurethat it is running and try running the commandmanually.



syb-00004 Quiesce failed, check the log.

syb-00005 Unquiesce failed, check the log.

syb-00006 Error running isql command. Check additionalerror information and try running commandmanually.

syb-00007 Error running isql command. Check additionalerror information and try running commandmanually.

syb-00008 Discovery failed, while running isql command.Check additional error information and tryrunning the command manually or send thenecessary information back to the framework.Check for additional errors and information inthe log.

syb-00009 SCDUMP failed, could not collect operatingsystem information. Ensure that the operatingsystem command is in path and check the log.

syb-00010 SCDUMP failed, could not collect SnapDriveinformation. Ensure that the SnapDrivecommand is in path and check the log.

syb-00012 A Sybase command failed, check the error andtry running manually.

syb-00013 Generic error message, check the error and log.

VMware plug-in error messages


vmw-00001 A SOAP error (web access) occurred whiletrying to call RemoveSnapshot() in VMware fora Snapshot copy taken as part of the backup orrestore operation. Use Snapshot Manager in thevSphere Infrastructure client to remove anyunwanted Snapshot copies.



vmw-00002 Calling the CreateSnapshot() function inVMware did not work as expected -- either thevirtual machine cannot make a Snapshot copy ora vSphere error occurred. Use the vSphereInfrastructure client to evaluate the Snapshotcopy error condition.

vmw-00003 The IP address associated to the NFS datastorecould not be translated. This means that basedon the storage controllers specified, there is noIP address on any storage controller associatedto an NFS export. Verify all the appropriatestorage controllers are listed in theNTAP_USERS field of the Snap Creatorconfiguration file.

vmw-00004 The hostname and IP address associated to theNFS datastore could not be translated. Thismeans that based on the storage controllersspecified, there is no IP address on any storagecontroller associated to an NFS export. Verify ifall the appropriate storage controllers are listedin the NTAP_USERS field of the Snap Creatorconfiguration file.

vmw-00005 The VIBE module could not find a disk extendassociated to the VMFS datastore, which meansthat a matching datastore to disk translation didnot appear based on the VMware query of theVMFS disk extent list. Verify if the VMFSdatastore listed in the backup has disk extentsassociated to it.

vmw-00006 Based on a translation of LUN to VMwareUUID, a matching LUN was not found. Thismeans that the LUNs on the storage controllersassociated to the NTAP_USERS field do notmap to this VMFS datastore. Verify if all theappropriate storage controllers are listed in theNTAP_USERS field of the Snap Creatorconfiguration file.



vmw-00007 The reported Data ONTAP API call wasunsuccessful. Read the error message andcontact technical support for any necessaryassistance in translating the error message. Thecondition can normally occur in situations whereRBAC is in use and the Snap Creator user on thestorage controllers do not have sufficient accessfor the API call.


vmw-00009 A SOAP error (web access) occurred whiletrying to query the list of data center objects inVMware. Review the event logs in the vSphereinfrastructure client to remove any unwantedSnapshot copies.

vmw-00010 A general vSphere API error occurred whiletrying to query the list of data center objects inVMware. Review the event logs in the vSphereinfrastructure client to remove any unwantedSnapshot copies.

vmw-00011 A general vSphere API error occurred whiletrying to query the managed object reference toa given data center object in VMware. Reviewthe event logs in the vSphere infrastructureclient to remove any unwanted Snapshot copies.

vmw-00012 The datastore specified for backup is notassociated to the data center in the vCenterserver. The VIBE module currently supports onedata center per vCenter server. In addition,verify if the datastore name is properly listed inthe Snap Creator configuration file.



vmw-00013 The set of Snapshot copy locations queriedthrough the process of collecting VMFS andNFS datastore information found a datastore thatdoes not have an associated Snapshot copylocation. Verify that all the storage controllersare listed in the NTAP_USERS field in the SnapCreator configuration file.

vmw-00014 The format of theVIBE_TRIM_VSPHERE_NAMES field isincorrect. Review the format in the Snap Creatorconfiguration file for accuracy.

vmw-00015 A SOAP error (web access) occurred whiletrying to query a specific virtual machine objectin VMware. Review the event logs in thevSphere infrastructure client to remove anyunwanted Snapshot copies.

vmw-00016 A general vSphere API error occurred whiletrying to query a specific virtual machine objectin VMware. Review the event logs in thevSphere infrastructure client to remove anyunwanted Snapshot copies.

vmw-00017 The REST API call /api/versions to the vCloudDirector failed. This call should always succeed,which might mean the vCD server specified inthe Snap Creator configuration file is notcorrect. Verify the Snap Creator configurationfile or check the vCD logs for more information.

vmw-00018 The REST API call /api/versions to the vCloudDirector did not return a proper authenticationcookie. This call should always succeed, whichmight mean the vCD server specified in theSnap Creator configuration file is not correct.Verify the Snap Creator configuration file orcheck the vCD logs for more information.

vmw-00019 The REST API call /login to the vCloudDirector failed. Verify the proper user name,password and URL for the vCD and review thevCD logs for any RBAC or other errorconditions.



vmw-00020 The REST API call to list all Organizationswithin vCloud Director failed. Verify the properuser name, password and URL for the vCD andreview the vCD logs for any RBAC or othererror conditions.

vmw-00021 The REST API call to query a specificOrganization within vCloud Director failed.Verify the proper user name, password and URLfor the vCD and review the vCD logs for anyRBAC or other error conditions.

vmw-00022 The REST API call to query the list of vAppsassociated to a vDC within vCloud Directorfailed. Verify the proper user name, passwordand URL for the vCD and review the vCD logsfor any RBAC or other error conditions.

vmw-00023 The REST API call to collect the vCenter serverassociated to a given vApp within vCloudDirector failed. Verify the proper user name,password and URL for the vCD and review thevCD logs for any RBAC or other errorconditions.

vmw-00024 The REST API call to get the specific virtualmachines associated to a vApp within vCloudDirector failed. Verify the proper user name,password and URL for the vCD and review thevCD logs for any RBAC or other errorconditions.

vmw-00025 The gethostbyname() call for the specifiedvCenter server in the Snap Creator configurationfile could not be translated. Verify if thespecified vCenter name can be translated to anIP address, or specify an IP address instead.

vmw-00026 The IP address associated to the vCenter servercannot be pinged via ICMP. Verify the IPaddress is correct, or use the VIBE_NOPING=Yfield in the Snap Creator configuration file.



vmw-00027 The permissions associated to the vCenter username or password is invalid. Verify the vCenterserver access with the vCenter user name andpassword specified in the Snap Creatorconfiguration file.

vmw-00028 A general login error occurred using the vCenteruser name and password in the Snap Creatorconfiguration file. Review the event and accesslogs in the vSphere infrastructure client for moredetails.

vmw-00029 An authentication error occurred using thevCenter user name and password in the SnapCreator configuration file. Either the user nameor password is incorrect. Review the event andaccess logs in the vSphere infrastructure clientfor more details.

vmw-00030 The IP address associated to the storagecontroller cannot be pinged using ICMP. Verifythe IP address is correct, or use theVIBE_NOPING=Y field in the Snap Creatorconfiguration file.

vmw-00031 The Data ONTAP API call system-get-infofailed. If RBAC is in use, verify that the user hasaccess to the system-get-info API call. Inaddition, verify if API access is available to thedefault HTTPS port for Data ONTAP APIaccess.

vmw-00032 Execution of the Data ONTAP API call system-cli was unsuccessful, and the 'ifconfig -a' outputcould not be pulled from the controller. Verify ifthe network interface and Data ONTAP APInetwork configuration information is availableand correct.





vmw-00035 A general SOAP error occurred when executingthe PowerOffVM() operation in vSphere.Review the vSphere infrastructure client logs fordetails on why the operation could not becompleted.

vmw-00036 The vSphere PowerOffVM() call wasunsuccessful. Review the vSphere infrastructureclient logs for details on why the operation couldnot be completed.

vmw-00037 A general SOAP error occurred when executingthe PowerOnVM() operation in vSphere.Review the vSphere infrastructure client logs fordetails on why the operation could not becompleted.

vmw-00038 The vSphere PowerOnVM() call wasunsuccessful. Review the vSphere infrastructureclient logs for details on why the operation couldnot be completed.

vmw-00039 The vCloud power off REST API operationfailed. Review the vCD logs for specific reasonson why the operation could not be completed.



vmw-00040 The vCloud power on REST API operationfailed. Review the vCD logs for specific reasonson why the operation could not be completed.

vmw-00041 The volume path does not consist of<controller_name>:<volume_name>. Reviewthe logs and see where the volume or storagecontrollers are not being translated properly.




vmw-00045 There are situations where the restore operationon the storage controller takes a very long time,either due to a busy Filesystem or a largeamount of data requiring to be restored. In thiscase, the VIBE_RESTORE_TIME value in theSnap Creator configuration file must beincreased to allow for a longer restorationperiod.













vmw-00054 The LUN with the appropriate UUID mapped toan vSphere host does not have any initiatorgroups associated to the LUN, which means thatthe datastore might have either been unmappedor removed in the middle of a restore operation.Verify the LUN IDs on the storage controller areunique and that there are no forced mounts ofduplicate datastores in the vSphere environment.




vmw-00056 Execution of the RefreshStorageSystem()vSphere API call failed due to a general SOAPerror (web services). Verify connectivity to thevCenter server and proper vSphere host andcluster configuration within the vSphereenvironment where the virtual machine restore istaking place.

vmw-00057 Execution of the RefreshStorageSystem()vSphere API call failed to the vCenter server.Verify connectivity to the vCenter server andproper vSphere host and cluster configurationwithin the vSphere environment where thevirtual machine restore is taking place.

vmw-00058 Execution of the RescanVmfs() vSphere APIcall failed due to a general SOAP error (webservices). Verify connectivity to the vCenterserver and proper vSphere host and clusterconfiguration within the vSphere environmentwhere the virtual machine restore is takingplace.

vmw-00059 Execution of the RescanVmfs() vSphere APIcall failed to the vCenter server. Verifyconnectivity to the vCenter server and propervSphere host and cluster configuration withinthe vSphere environment where the virtualmachine restore is taking place.





vmw-00062 A SOAP error occurred when refreshing thevSphere session to the vCenter server. This iscalled after a restore operation, primarily forsituations where a long restore operation istaking place and the connection to the vCenterserver times out. Verify the timeout values in thevCenter server or ensure proper networkconnectivity to the vCenter server.

vmw-00063 A general error occurred when refreshing thevSphere session to the vCenter server. This iscalled after a restore operation, primarily forsituations where a long restore operation istaking place and the connection to the vCenterserver times out. Verify the timeout values in thevCenter server or ensure proper networkconnectivity to the vCenter server.

vmw-00064 A SOAP error occurred when refreshing thesession manager Managed Object view of thevSphere session to the vCenter server. This iscalled after a restore operation, primarily forsituations where a long restore operation istaking place and the connection to the vCenterserver times out. Verify the timeout values in thevCenter server or ensure proper networkconnectivity to the vCenter server.



vmw-00065 A general error occurred when refreshing thesession manager Managed Object view of thevSphere session to the vCenter server. This iscalled after a restore operation, primarily forsituations where a long restore operation istaking place and the connection to the vCenterserver times out. Verify the timeout values in thevCenter server or ensure proper networkconnectivity to the vCenter server.

vmw-00066 Creation of a new vCenter session after a longrestore operation has failed. Verify the timeoutvalues in the vCenter server or ensure propernetwork connectivity to the vCenter server. Thisshould normally not occur unless someone ischanging the vCenter configuration andauthentication during an active restore operation.

vmw-00067 Creation of a new vCenter session after a longrestore operation has failed. Verify the timeoutvalues in the vCenter server or ensure propernetwork connectivity to the vCenter server. Thisshould normally not occur unless someone ischanging the vCenter configuration andauthentication during an active restore operationand is even more unique in that the vSphere APIcall has come back with an undefined errorcondition.

vmw-00068 The permissions associated to the vCenter username and password is invalid. Verify vCenterserver access with the vCenter user name andpassword specified in the Snap Creatorconfiguration file. This would only happen ifthere is an active restore, a timeout has occurredto the vCenter server and the authenticationparameters to the vCenter server for the userhave changed.

vmw-00069 A SOAP error (web access) occurred whiletrying to query a specific Host System object invSphere during a restore operation on an NFSdatastore. Review the event logs in the vSphereinfrastructure client to remove any unwantedSnapshot copies.



vmw-00070 A general error occurred while trying to query aspecific Host System object in vSphere during arestore operation on an NFS datastore. Reviewthe event logs in the vSphere infrastructureclient to remove any unwanted Snapshot copies.

vmw-00071 When querying for host systems associated tothe vCenter server, no hosts came back asconnected to the vCenter server. This is a highlyimprobable error -- verify connectivity to thevCenter server and proper configuration of hostsystems through the vSphere infrastructureclient.

vmw-00072 The datastore specified for restore does not showon any host system in vSphere. This is highlyunlikely to occur unless the datastore isdisconnected in the middle of a restoreoperation. Verify the connectivity to the vCenterserver and proper configuration of host systemsthrough the vSphere infrastructure client.

vmw-00073 Collection of the entity view of the host systemspecified for restore where the original VMFSdatastore is found could not be executed to thevCenter server. Given the restore host systemhas already been uncovered, this query shouldalways be successful unless there is aconnectivity problem or an vSphere host is putinto maintenance mode during a restoreoperation. Verify the connectivity to the vCenterserver and proper configuration of host systemsthrough the vSphere infrastructure client.

vmw-00075 Query of the entity view on the restore hostcould not be executed to the vCenter server.Given the restore host system has already beenuncovered, this query should always besuccessful unless there is a connectivity problemor an vSphere host is put into maintenance modeduring a restore operation. Verify connectivity tothe vCenter server and proper configuration ofhost systems through the vSphere infrastructureclient.



vmw-00076 Discovery of the new VMFS datastore that hasbeen cloned, mapped and rescanned to therestore host has failed. This means that despitemultiple HBA and VMFS rescans, mapping ofthe cloned LUN associated to the VMFSdatastore and refreshing of the restore host, thenew datastore is still not shown. Verify theadvanced options settings with the vSphere host,ensure that the resignatured VMFS volumes canbe discovered, verify connectivity to the vCenterserver and validate proper configuration of hostsystems through the vSphere infrastructureclient.

vmw-00077 A query of the session manager in the vCenterserver object failed due to a SOAP error (webservices). Verify that the connection to thevCenter server has not timed out.

vmw-00078 A query of the session manager in the vCenterserver object failed. Verify that the connectionto the vCenter server has not timed out.

vmw-00079 Data cannot be copied from the VMFS datastoreSnapshot copy into the original datastore for thevirtual machine. The <msg> output outlines whythe VMware API call failed. Verify properconfiguration and permissions to the datastorefolder through the vSphere infrastructure client.

vmw-00080 A SOAP error (web access) occurred whiletrying to execute the RevertToCurrentSnapshot()on a virtual machine in vSphere during a restoreoperation on a VMFS datastore. Review theevent logs in the vSphere infrastructure client toremove any unwanted Snapshot copies.

vmw-00081 A general error occurred while trying to executethe RevertToCurrentSnapshot() on a virtualmachine in vSphere during a restore operationon a VMFS datastore. Review the event logs inthe vSphere infrastructure client to remove anyunwanted Snapshot copies.



vmw-00082 The LUN or volume clone associated to therestore of a virtual machine on a VMFSdatastore could not be taken offline or destroyed.If FlexClone licensing exists on the storagecontroller, it is the volume clone that cannot betaken offline or destroyed. If a LUN clone wascreated, then the cloned LUN cannot be takenoffline or destroyed. Review the storagecontroller event messages for errors related tothe Data ONTAP API calls.

vmw-00083 The VIBE restore Snapshot copies created aspart of the restore process cannot be removed.The storage controller Snapshot copies on thevolume where the datastore was created must beremoved manually.

vmw-00084 The single-file snap restore (SFSR) operation onthe storage controller failed. There will generallybe another error message in the Snap Creator logdisplaying exactly why the SFSR operation didnot complete. Look for timeout conditions,space availability or vSphere refresh times formore clues as to why the SFSR operation did notcomplete.

vmw-00085 If the first SFSR restore operation on the NFSdatastore did not complete, and the second SFSRrestoring back to the VIBE restore Snapshotcopy also fails, this message appears. Reviewstorage controller and Snap Creator logs formore detailed messages as to why the SFSRoperations are not completing.

vmw-00086 A SOAP error (web access) occurred whiletrying to execute the RevertToCurrentSnapshot()on a virtual machine in vSphere during a restoreoperation on an NFS datastore. Review the eventlogs in the vSphere infrastructure client toremove any unwanted Snapshot copies.



vmw-00087 A general error occurred while trying to executethe RevertToCurrentSnapshot() on a virtualmachine in vSphere during a restore operationon an NFS datastore. Review the event logs inthe vSphere infrastructure client to remove anyunwanted Snapshot copies.

vmw-00088 The VIBE restore Snapshot copy created as partof the restore process cannot be removed. Thestorage controller Snapshot copy on the volumewhere the datastore was created must beremoved manually.

vmw-00089 If the storage does not appear in an internal listbased on a vCenter and datastore pair internallyto VIBE, then the list was improperly configuredbased on data collection of existing vSphere andvCloud objects. Review the logs and SnapCreator configuration files and ensure that all theparameters are properly defined and no othererrors appear in the Snap Creator log files.

vmw-00090 The Snapshot copy specified with the --snap_name option does not exist for the volumeand storage controller listed. Confirm thespelling and existence of the Snapshot copybeing restored.

vmw-00091 The Data ONTAP API call snaphost-list-infofailed -- see the Snap Creator log for other errormessages indicating why the Data ONTAP APIcall failed.

vmw-00092 VIBE requires that the Snapshot copy beingused for restore purposes on the storagecontroller not be busy -- it cannot be part of aclone or be busy according to the status on thestorage controller. Running backupList on thestorage controller and looking at the state of theSnapshot copy in the volume where the datastoreis located indicates if the Snapshot copy is busy,and why.

vmw-00093 This is a general failure message. Look for othererror messages for specific failure conditions.



vmw-00094 The VIBE_VCENTER_USER field in the SnapCreator configuration file must always bedefined. Check the Snap Creator configurationfile and make sure that the value is defined andnot commented out.

vmw-00095 The VIBE_VCENTER_PASSWD field in theSnap Creator configuration file must always bedefined. Check the Snap Creator configurationfile and make sure that the value is defined andnot commented out.

vmw-00096 The VIBE_VCLOUD_USER field in the SnapCreator configuration file must always bedefined when the VIBE_VCLOUD_NAMESconfiguration option is being used. Check theSnap Creator configuration file and make surethat the value is defined and not commented out.

vmw-00097 The VIBE_VCLOUD_PASSWD field in theSnap Creator configuration file must always bedefined when the VIBE_VCLOUD_NAMESconfiguration option is being used. Check theSnap Creator configuration file and make surethat the value is defined and not commented out.

vmw-00098 The action field must be defined. This generallyhappens through use of the --action optionwhen executing Snap Creator. Verify propercommand line use of Snap Creator.

vmw-00100 When performing a restore operation, theSnapshot copy name must be specified on thecommand line or through execution in the GUIin order to know which Snapshot copy toperform the restore from. Verify the SnapCreator command line for proper syntax.

vmw-00101 The format of VIBE_VCLOUD_NAMES mustbe defined based on the format specified in thecomments of the Snap Creator configuration file.If any organizations, vDCs or vApps havecolons in the names, or any objects withinvSphere use colons, use different namingconventions so that parsing ofVIBE_VCLOUD_NAMES works properly.



vmw-00102 When defining a new backup set within a SnapCreator configuration file, the organization fieldmust always be specified. Verify theVIBE_VCLOUD_NAMES syntax in the SnapCreator configuration file.

vmw-00103 The format of VIBE_VSPHERE_NAMES mustbe defined based on the format specified in thecomments of the Snap Creator configuration file.If any vCenters, datastores or virtual machineshave colons in the names, use different namingconventions so that parsing ofVIBE_VCLOUD_NAMES works properly.

vmw-00104 When defining a new backup set within a SnapCreator configuration file, the vCenter field mustalways be specified. Verify theVIBE_VSPHERE_NAMES syntax in the SnapCreator configuration file.

vmw-00105 This value must be either Y (the default) or N tospecify not to take VMware Snapshot copies.

vmw-00106 Check the NTAP_USERS value in the SnapCreator configuration file for proper syntax andformat.

vmw-00107 Check the NTAP_USERS value in the SnapCreator configuration file for proper syntax andformat.

vmw-00108 The virtual machine Snapshot copy creationprocess failed. There will be another errormessage in the log indicating the failure. Reviewthe vSphere infrastructure client logs forVMware error messages.

vmw-00109 At least one of the virtual machines whereSnapshot copies were being created did notexecute properly. Review the Snap Creator andvSphere infrastructure client logs for errormessages.



vmw-00110 The virtual machine Snapshot copy removalprocess failed. There will be another errormessage in the log indicating the failure. Reviewthe vSphere infrastructure client logs forVMware error messages.

vmw-00111 At least one of the virtual machines whereSnapshot copies were being removed did notexecute properly. Review the Snap Creator andvSphere infrastructure client logs for errormessages.

vmw-00112 The scdump() function used for supportdebugging requires collection of the operatingsystem information. The internal request tocheck the operating system version did notsucceed. Review the Snap Creator logs forinformation as to why the error occurred.

vmw-00113 The scdump() function used for supportdebugging requires collection of the operatingsystem information. The internal request tocheck the operating system version did notsucceed. Review the Snap Creator logs forinformation as to why the error occurred.

vmw-00114 Check the NTAP_PM_UPDATE value in theSnap Creator configuration file for proper syntaxand format.

vmw-00115 The datastore system associated to the vSpheresession context is invalid. Check if the vSpherehost used for restores is operational and not inmaintenance mode. Review the vSphereinfrastructure client logs for more informationabout the vSphere host status.

vmw-00116 The storage system associated to the vSpheresession context is invalid. Check if the vSpherehost used for restores is operational and not inmaintenance mode. Review the vSphereinfrastructure client logs for more informationabout the vSphere host status.



vmw-00117 The datastore system associated to the vSpheresession context does not have any managedobject reference. Check if the vSphere host usedfor restores is operational and not inmaintenance mode. Review the vSphereinfrastructure client logs for more informationabout the vSphere host status.

vmw-00118 The storage system associated to the vSpheresession context does not have any managedobject reference. Check if the vSphere host usedfor restores is operational and not inmaintenance mode. Review the vSphereinfrastructure client logs for more informationabout the vSphere host status.

vmw-00119 The QueryUnresolvedVmfsVolumes() vSphereAPI call on the host system failed. Review thevSphere infrastructure client logs for moreinformation about the vSphere host status.

vmw-00120 The ResolveMultipleUnresolvedVmfsVolumes()vSphere API call on the host system failed.Review the vSphere infrastructure client logs formore information about the vSphere host status.


vmw-00122 A SOAP error (web access) occurred whiletrying to call RemoveSnapshot() in VMware fora Snapshot copy taken as part of the backup orrestore operation. Use Snapshot Manager in thevSphere infrastructure client to remove anySnapshot copy created that is unwanted.



vmw-00123 Execution of the RescanAllHba() vSphere APIcall failed due to a general SOAP error (webservices). Verify the connectivity to the vCenterserver and proper vSphere host and clusterconfiguration within the vSphere environmentwhere the virtual machine restore is takingplace.

vmw-00124 Execution of the RescanAllHba() vSphere APIcall failed to the vCenter server. Verify theconnectivity to the vCenter server and propervSphere host and cluster configuration withinthe vSphere environment where the virtualmachine restore is taking place.

vmw-00125 A query of the file manager in the vCenterserver object failed due to a SOAP error (webservices). Verify the connection to the vCenterserver has not timed out.

vmw-00126 A query of the file manager in the vCenterserver object failed. Verify that the connectionto the vCenter server has not timed out.

vmw-00127 Collection of the entity view of the virtualmachine during the virtual machine iterationprocess could not be executed to the vCenterserver. This is specifically for when vCloudobjects are re-translated to virtual machineobjects in vSphere. Verify the connectivity tothe vCenter server and proper configuration ofhost systems through the vSphere infrastructureclient and that the vCenter IP address is correct.

vmw-00128 Collection of the entity view of the virtualmachine during the virtual machine iterationprocess could not be executed to the vCenterserver. This is specifically for when vCloudobjects are re-translated to virtual machineobjects in vSphere. Verify the connectivity tothe vCenter server and proper configuration ofhost systems through the vSphere infrastructureclient and that the vCenter IP address is correct.



vmw-00129 When the vApp powerOff REST API isexecuted, the REST return status indicates anunknown condition. The powerOff call shouldalways return a Task or Error, so it means a thirdcondition of unknown type was returned. Checkwith VMware on the possible return codes forvCloud powerOff API operations.

vmw-00130 When the vApp powerOn REST API isexecuted, the REST return status indicates anunknown condition. The powerOn call shouldalways return a Task or Error, so it means a thirdcondition of unknown type was returned. Checkwith VMware on the possible return codes forvCloud powerOn API operations.

vmw-00131 When the vApp powerOff REST API isexecuted, the REST return status indicates anerror condition. Review the error code forinformation about the failure, and check withVMware on the possible return codes for vCloudpowerOff API operations.

vmw-00132 When the vApp powerOn REST API isexecuted, the REST return status indicates anerror condition. Review the error code forinformation about the failure, and check withVMware on the possible return codes for vCloudpowerOn API operations.



vmw-00133 This condition occurs when VMware is unableto see new datastores listed in the vSphereenvironment during restore operations. Thesequence of events is to clone, map and onlinethe new LUN associated to the VMFS datastorebeing restored on the identified ESX host. Oncethis is done, the vSphere API callQueryUnresolvedVmfsVolumes() is called tofind unresolved VMFS volumes not currentlymapped to a datastore or resigned on the ESXhost. Essentially, the API call returned no newentries, which means VMware does not see thenew LUN. Check the existing vSphereconfiguration to determine if new datastores canbe provisioned on the restore ESX host, as wellas check with VMware on the condition of theESX host when new datastores are connected.

vmw-00134 This condition occurs when the vSphere API callQueryUnresolvedVmfsVolumes() fails on theESX host identified for restore. Check theexisting vSphere configuration to determine ifnew datastores can be provisioned on the restoreESX host, as well as check with VMware on thecondition of the ESX host when new datastoresare connected.

vmw-00135 Snap Creator deletes virtual machine Snapshotcopies on VMs about to be restored beforestarting the restore process. It is called to removeleftover Snapshot copies if any exist. If thisoperation fails, it means Snap Creator has foundleftover virtual machine Snapshot copies(created by Snap Creator) that it cannot delete.Delete these virtual machine Snapshot copiesmanually before attempting the restoreoperation.



vmw-00136 When attempting to remove virtual machineSnapshot copies, the remove function could notfind a Snap Creator created virtual machineSnapshot copy. Verify the existing VMwareSnapshot copies and also ensure two SnapCreator backup jobs of the same virtual machineobjects are not taking place at the same time.

vmw-00137 The restore operation failed. Look for additionalvmw-<num> errors in the log output for moredetails as to what failed during the restoreprocess.

vmw-00138 When attempting to remove virtual machineSnapshot copies, the remove function could notfind a Snap Creator created virtual machineSnapshot copy. In addition, there were noSnapshot copies (period) for the virtual machine.There is no root Snapshot copy list when thiserror occurs. Verify the existing VMwareSnapshot copies and also ensure two SnapCreator backup jobs of the same virtual machineobjects are not taking place at the same time.


Copyright information

Copyright © 1994–2013 NetApp, Inc. All rights reserved. Printed in the U.S.

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

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

THIS SOFTWARE IS PROVIDED BY NETAPP "AS IS" AND WITHOUT ANY EXPRESS ORIMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE,WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL NETAPP BE LIABLE FOR ANYDIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIALDAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTEGOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESSINTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHERIN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OROTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IFADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

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

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

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


Trademark information

NetApp, the NetApp logo, Network Appliance, the Network Appliance logo, Akorri,ApplianceWatch, ASUP, AutoSupport, BalancePoint, BalancePoint Predictor, Bycast, CampaignExpress, ComplianceClock, Cryptainer, CryptoShred, CyberSnap, Data Center Fitness, DataONTAP, DataFabric, DataFort, Decru, Decru DataFort, DenseStak, Engenio, Engenio logo, E-Stack,ExpressPod, FAServer, FastStak, FilerView, Flash Accel, Flash Cache, Flash Pool, FlashRay,FlexCache, FlexClone, FlexPod, FlexScale, FlexShare, FlexSuite, FlexVol, FPolicy, GetSuccessful,gFiler, Go further, faster, Imagine Virtually Anything, Lifetime Key Management, LockVault, Mars,Manage ONTAP, MetroCluster, MultiStore, NearStore, NetCache, NOW (NetApp on the Web),Onaro, OnCommand, ONTAPI, OpenKey, PerformanceStak, RAID-DP, ReplicatorX, SANscreen,SANshare, SANtricity, SecureAdmin, SecureShare, Select, Service Builder, Shadow Tape,Simplicity, Simulate ONTAP, SnapCopy, Snap Creator, SnapDirector, SnapDrive, SnapFilter,SnapIntegrator, SnapLock, SnapManager, SnapMigrator, SnapMirror, SnapMover, SnapProtect,SnapRestore, Snapshot, SnapSuite, SnapValidator, SnapVault, StorageGRID, StoreVault, theStoreVault logo, SyncMirror, Tech OnTap, The evolution of storage, Topio, VelocityStak, vFiler,VFM, Virtual File Manager, VPolicy, WAFL, Web Filer, and XBB are trademarks or registeredtrademarks of NetApp, Inc. in the United States, other countries, or both.

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

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

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

NetApp, Inc. is a licensee of the CompactFlash and CF Logo trademarks.

NetApp, Inc. NetCache is certified RealSystem compatible.

201

http://www.ibm.com/legal/copytrade.shtml

How to send your comments

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

Your feedback is important in helping us to provide the most accurate and high-quality information.If you have suggestions for improving this document, send us your comments by email to [email protected]. To help us direct your comments to the correct division, include in thesubject line the product name, version, and operating system.

You can also contact us in the following ways:

• NetApp, Inc., 495 East Java Drive, Sunnyvale, CA 94089 U.S.• Telephone: +1 (408) 822-6000• Fax: +1 (408) 822-4501• Support telephone: +1 (888) 463-8277


mailto:[email protected]

Index

A

application plug-insoverview of 6

C

Citrix Xen plug-inperforming application-defined restore 130

clustered Data ONTAPcreating roles for Snap Creator user 20

configuration filecreating using CLI 67creating using GUI 68

configuringcreating configuration file

using CLI 67

D

dataviewing 128

deployment typesmultithreaded 9simple 9using a watchdog 9

Domino plug-inadding path before installing 31preinstallation steps for 30settings on AIX 30settings on Linux 30settings on Solaris 30

G

global configuration filecreating using GUI 68

I

installing Snap Creatorcreating Data ONTAP user 17

installing Snap Creatorclustered Data ONTAP 18creating Snap Creator user 18

integrationOperations Manager console 14OSSV 14

Snap Creatorinstalling the server 33

K

KVM plug-inperforming application-defined restore 130

L

log detailsviewing 128

P

policiesSnapshot copy retention 15SnapVault retention 15

R

rolescommands for creating 20

S

security featuresagent security 12RBAC 12

Snap Creatoragent monitoring 127alternative ports 39APIs 16backup process 99commands

application quiesce 99application unquiesce 99archive command 99post command 99pre command 99

configuring 40configuring agent 98

Index | 203

creating a schedule 124creating users 123downloading software 17information for configuring 40installing on UNIX 33installing on Windows 32job monitoring 32, 126performing restore

single file restore 130volume restore 129

referencingdefining variables 69

roles 122running using GUI 121, 127security features 12UNIX services 33

Snap Creator 3.6.0upgrading from 37

Snap Creator 4.0.0upgrading to 37

Snap Creator Agentarchitecture of 7deployment types in 9installing 34multithreading in 9running using CLI 120

Snap Creator architectureSimple Object Access Protocol

APIs 6Snap Creator on UNIX

uninstalling 36Snap Creator on Windows

uninstalling 35Snap Creator plug-ins

Archive log plug-in 65Citrix Xen plug-in 130creating custom plug-in 138DB2 plug-in 46Domino plug-in

block protocol 135CLI 132, 133GUI 133, 135single file restore 133, 135volume restore 132, 133

Domino plug-insrestoring using 131

KVM plug-in 62, 130MaxDB plug-in 50MySQL plug-in 46Oracle plug-in 44

plug-in framework 138point-in-time 132, 133, 135selectable point-in-time 132, 133, 135SnapManager for Microsoft Exchange plug-in 56SnapManager for Microsoft SQL Server plug-in 57Sybase plug-in 47up-to-the-minute 132, 133, 135VMware (VIBE) plug-in 58VMware plug-in 130Xen plug-in 64

Snap Creator Serverconfiguring 67installing Java 30installing JRE 30running using CLI 101

Snap Creator softwarepreparing to install 17

Snap Creator usercommands for creating roles 20creating roles 20

T

troubleshootingdebug log 140error log 140error messages 140, 144GUI error 142logs 140network issues

firewall 143IP name 143NAT 143

out log 140scdump 140start issue 144stderr log 140tmp directory

permission 144

V

VMware plug-inperforming application-defined restore 130vCloud vApp

backup and restore 60VMware vCenter server

backup and restore 61volume restore

using CLI for 129


using GUI for 129

Index | 205

Date post:	12-Feb-2022
Category:	Documents
Upload:	others
View:	7 times
Download:	0 times