NetApp Snap Creator Framework Installation and Administration Guide

Transcription

1 NetApp Snap Creator Framework Installation and Administration Guide NetApp, Inc. 495 East Java Drive Sunnyvale, CA U.S. Telephone: +1 (408) Fax: +1 (408) Support telephone: +1 (888) Web: Feedback: Part number: _A0 May 2013

2

3 Table of Contents 3 Contents What Snap Creator Framework does... 6 Snap Creator architecture... 6 What Snap Creator Agent is... 7 Snap Creator Agent multithreading... 9 Security features of Snap Creator Snap Creator integration Guidelines to define Snap Creator policies Snap Creator server APIs Preparing to install Snap Creator Downloading the Snap Creator software Creating a Data ONTAP user for Snap Creator with Data ONTAP operating in 7-Mode Creating a Snap Creator user for clustered Data ONTAP Commands for creating a role for a Snap Creator user in clustered Data ONTAP Installing Java on Snap Creator Server Preinstallation steps for the Domino plug-in Settings specific to Linux, Solaris, and AIX Settings specific to Windows Installing Snap Creator on Windows Installing Snap Creator on UNIX Installing Snap Creator Server Installing Snap Creator Agent Uninstalling Snap Creator from Windows Uninstalling Snap Creator from UNIX Upgrading from Snap Creator Running Snap Creator on alternative ports Information required to configure Snap Creator Oracle plug-in MySQL plug-in DB2 plug-in Sybase plug-in... 47

4 4 NetApp Snap Creator Framework Installation and Administration Guide MaxDB plug-in IBM Domino plug-in SnapManager for Microsoft Exchange plug-in SnapManager for Microsoft SQL Server plug-in VMware (VIBE) plug-in vcloud vapp backup and restore by using the VMware plug-in Virtual machine backup and restore by using the VMware plug-in Red Hat KVM plug-in Citrix Xen plug-in Archive log plug-in Creating a configuration file in Snap Creator Creating a configuration file using the CLI Creating a configuration file using the GUI Creating a global configuration file using the GUI Referencing Snap Creator Agent configuration Snap Creator backup process List of commands Running Snap Creator Server using the CLI Running Snap Creator Agent using the CLI Running Snap Creator using the GUI Creating and managing roles Creating and managing users Creating a schedule Monitoring jobs Monitoring agent Viewing data and log details Performing restore using Snap Creator Performing volume restore Performing single file restore Performing application-defined restore Performing restore with the Domino plug-in Performing volume restore for Domino by using the CLI Performing volume restore for Domino by using the GUI Performing single file restore with NFS for Domino using the CLI Performing single file restore with NFS for Domino using the GUI

5 Table of Contents 5 Performing single file restore with block protocols for Domino Using the plug-in framework to create custom plug-ins Troubleshooting Snap Creator issues Logs Troubleshooting Snap Creator GUI errors Troubleshooting network issues Troubleshooting the tmp directory permission issues Troubleshooting the Snap Creator start issue Error messages Copyright information Trademark information How to send your comments Index

6 6 NetApp Snap Creator Framework Installation and Administration Guide What Snap Creator Framework does Snap Creator Framework is a backup and restore software framework that enables you to integrate Snapshot technology with applications and hypervisors. Snap Creator is platform and operating system independent. It provides integration through plug-ins that enable it to support any application or hypervisor on a storage system. Snap Creator uses the plug-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 Systems SnapVault, SnapMirror, the NetApp Management Console data protection capability, Operations Manager console, and FlexClone technology. Snap Creator architecture Snap Creator consists of a server and an agent layer. The server sends operations like quiesce or unquiesce to a given database by using the agent, which runs remotely or locally. The communication layer from the agent to the server is Simple Object Access Protocol (SOAP) over HTTP. Snap Creator introduces a new architecture for the server, but the agent architecture remains the same as version 3.x. The server exposes the APIs, which allow the GUI and CLI to run remotely. The GUI must be installed on the same system on which the server is installed. The GUI can remotely connect to another server but cannot be detached. The CLI is independent and can be installed on any system which has access to the server. Snap Creator consists of three main components:

7 Snap Creator engine - This is the main program, which can either run on a central backup server or where the application is installed. It uses Data ONTAP API to communicate with the storage systems and other NetApp software products and uses OnCommand Unified Manager APIs to communicate with the NetApp Management Console data protection capability. Only Snapshot technology is required for Snap Creator to function. Other NetApp software products are optional. Application and hypervisor plug-in (optional) - This normally runs where the application or hypervisor 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 Framework does 7 What Snap Creator Agent is Snap 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 be scheduled from the same host. This provides a single pane of glass (SPOG) for backup and restore operations.

8 8 NetApp Snap Creator Framework Installation and Administration Guide 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 interact with the agent. Currently, Apache CXF (for Java) and PowerShell (for Windows) can be used. The supported application plug-ins are built into the agent. Other community plug-ins are available and can be added to the scagent/plugins directory. In addition to the application plug-ins, all PRE commands, POST commands, and APP commands can be executed remotely through the agent. This provides the ability to mount file systems or to perform additional application processing remotely. The agent has an access file under /path/to/ scagent_v<#>/config/agent.conf where certain commands are allowed to run. By default, all commands that are not part of Snap Creator or a supported plug-in are denied. This means that only the built-in or community plug-ins can execute commands through the agent. PRE or POST scripting commands or scripts must be allowed in agent.conf. Note: Snap Creator supports only Snap Creator Agent. The following illustration shows the agent communication:

9 What Snap Creator Framework does 9 Snap Creator Agent multithreading Snap 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:

10 10 NetApp Snap Creator Framework Installation and Administration Guide Simple deployment In simple deployment, Snap Creator Server opens a connection to Snap Creator Agent. The connection between the server and agent remains active and the agent cannot accept further requests until the server stops. Deployment using a watchdog In this deployment, Snap Creator Agent creates a separate process (watchdog) after accepting a request from Snap Creator Server to quiesce the database. The watchdog process inherits the environment and all the settings of the parent process and unquiesces the database after a configured timeout. 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 shown in the illustration) and passes the communication responsibility (req') to this process. This newly created process inherits the basic Snap Creator Agent settings and Snap Creator Server communicates with this process. If configured, this process creates a watchdog when the quiesce operation 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:

11 Domino MySQL VMware KVM Xen What Snap Creator Framework does 11

12 12 NetApp Snap Creator Framework Installation and Administration Guide Security features of Snap Creator Snap Creator provides security features such as role-based access control (RBAC) and host security for 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, and delete users. Operator: This role is configured to be a super user and has access to all the APIs except RBAC. 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. Some examples of permissions are backup, clone volume, and restore. Operations: Operations are the base values that Snap Creator checks for authorization. Some examples of operations are gettask, fileclonecreate, createtask, dircreate, and so on. Profiles Note: Operations cannot be added, removed, or modified. 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 call SchedulergetJob and then checks if the profile associated with the job is assigned to the user.

13 Security features of Snap Creator 13 If a user, who is assigned the Operator role, creates a profile by using the GUI or CLI, then that profile is automatically assigned to the user. RBAC for storage controllers If you are not using the OnCommand Unified Manager proxy, you need a user name and password to communicate 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 the necessary API permissions. Network communications are through HTTP (80) or HTTPS (443), so you must have one or both of these ports open between the host where Snap Creator runs and the storage controllers. A user must be created on the storage controllers for authentication. For HTTPS, you must ensure that the user is enabled and configured on the storage controllers. Snap Creator Agent security Snap Creator uses host security to allow only authorized hosts to access the agent. This feature allows you to specify multiple host lines. If a command contains the path of the Snap Creator installation directory, it is blocked.

14 14 NetApp Snap Creator Framework Installation and Administration Guide Snap Creator integration Snap Creator integrates either fully or optionally with other software products and technologies. Optionally integrates with both SnapDrive for UNIX and SnapDrive for Windows. Snap Creator can use the Manage ONTAP Solution to send calls directly to the storage controller to create Snapshot copies, or use SnapDrive. Optionally uses SnapVault directly instead of the NetApp Management Console data protection capability to transfer Snapshot copies to the secondary storage. Snapshot technology, SnapVault, SnapMirror, LUN cloning, volume cloning, and igroup mapping using Data ONTAP API. Any application or database that runs in an open systems environment (you can create your own application 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 Management Console data protection capability). Optionally integrates with Open Systems SnapVault. Note: Snap Creator does not support SnapVault, Operations Manager console, the NetApp Management Console data protection capability, and Open Systems SnapVault on clustered Data ONTAP 8.1, clustered Data ONTAP 8.1.1, and clustered Data ONTAP For SnapMirror and SnapVault, the storage system and the host must be resolved either though the Domain Name System (DNS) or in /etc/hosts. For clustered Data ONTAP, the cluster and 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

15 15 Guidelines to define Snap Creator policies Snap Creator policies are user-defined Snapshot copy retentions that apply to the Snapshot copies on the primary storage and SnapVault Snapshot copies on the secondary storage. You can use a policy to 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 configuration parameter. For SnapVault, you can associate the same policy with different SnapVault retention periods. For example, to create daily Snapshot copies and retain them for seven days on the primary storage and 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 the preceding 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 an additional weekly policy, define the policy, and then call it in Snap Creator once a week by using cron or task manager with SNAP_TYPE set to Weekly.

16 16 NetApp Snap Creator Framework Installation and Administration Guide 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 that you must start an API and then check the status to view the messages and the exit results of the workflow. Repository APIs These APIs are related to the Snap Creator repository. The repository stores information about backup configurations. You can use the repository APIs to create, delete, or update backup configurations. RBAC APIs These APIs are used to perform user or role management. Snap Creator does not integrate with Active Directory, Lightweight Directory Access Protocol (LDAP), or other user management systems. 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 your application plug-in or perform operations directly with storage without invoking a workflow. You must 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 Developer Community. Related information Snap Creator API documentation: netapp.github.com/sc-framework Snap Creator Developer Community: snapcreator.netapp.com

17 17 Preparing to install Snap Creator Before installing Snap Creator, you must perform certain tasks, such as downloading the Snap Creator software, creating a Data ONTAP user, installing Java on Snap Creator, and adding Secure Sockets Layer (SSL) libraries for the UNIX environment. Downloading the Snap Creator software You can download the Snap Creator software from the NetApp Support Site. Snap Creator is listed in the 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 Data ONTAP operating in 7-Mode Snap Creator uses the Data ONTAP APIs to communicate with the storage system. To ensure that the user account is granted access to only Snap Creator, create a new role, group, and user. This controls the 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 then enter it in the CLI console. Steps 1. Create a role defining the rights required for Snap Creator on the storage system by entering the following command:

18 18 NetApp Snap Creator Framework Installation and Administration Guide 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 by entering 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 ONTAP Clustered Data ONTAP requires creation of two users on the clustered Data ONTAP system a cluster user and a virtual storage server (vserver) user. Both users require the HTTP, ONTAPI library, 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 also create a new cluster user and a new vserver user. If you create new users, you must create roles for the new users. The users cannot be interchanged. For example, the cluster user does not have access to the necessary APIs to perform certain actions such as creating a Snapshot copy. This is true even if you use the default 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 then enter 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 -vserver clus3240rre In this command, the CRBAC_NEW role is created on the clus3240rre cluster and storage aggregate is the command directory name.

19 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 -application console,ssh,ontapi,http -authmethod password -role CRBAC_New -vserver clus3240rre In this command, the scuser1 user is created on the clus3240rre cluster. Preparing to install Snap Creator 19 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 -vserver Snapcreator In this command, the VSERVERRBACROLE_New role is created on the Snapcreator vserver and volume 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

20 20 NetApp Snap Creator Framework Installation and Administration Guide 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 Data ONTAP While creating a Snap Creator user in clustered Data ONTAP, a role must be created for a new cluster 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 directory name storage aggregate cluster identity show vserver export-policy rule show Command to be run role create -role CRBAC_New -cmddirname storage aggregate -vserver clus3240rre role create -role CRBAC_New -cmddirname cluster identity show -vserver clus3240rre role create -role CRBAC_New -cmddirname vserver exportpolicy rule show -vserver clus3240rre volume file role create -role CRBAC_New -cmddirname volume file - vserver clus3240rre system license show vserver services unixgroup show vserver services unixuser show network interface show role create -role CRBAC_New -cmddirname system license show -vserver clus3240rre role create -role CRBAC_New -cmddirname vserver services unix-group show -vserver clus3240rre role create -role CRBAC_New -cmddirname vserver services unix-user show -vserver clus3240rre role create -role CRBAC_New -cmddirname network interface show -vserver clus3240rre

21 Preparing to install Snap Creator 21 Command directory name security login show security login role show volume efficiency show system node show Command to be run role create -role CRBAC_New -cmddirname security login show -vserver clus3240rre role create -role CRBAC_New -cmddirname security login role show -vserver clus3240rre role create -role CRBAC_New -cmddirname volume efficiency show -vserver clus3240rre role create -role CRBAC_New -cmddirname system node show -vserver clus3240rre 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 clone create 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 system node run system services ndmp network fcp adapter show vserver fcp initiator show role create -role CRBAC_New -cmddirname vserver nfs status -vserver clus3240rre role create -role CRBAC_New -cmddirname system node run -vserver clus3240rre role create -role CRBAC_New -cmddirname system services ndmp -vserver clus3240rre role create -role CRBAC_New -cmddirname network fcp adapter show -vserver clus3240rre role create -role CRBAC_New -cmddirname vserver fcp initiator show -vserver clus3240rre

22 22 NetApp Snap Creator Framework Installation and Administration Guide Command directory name vserver fcp show vserver fcp status lun igroup show vserver iscsi connection show vserver iscsi interface accesslist show vserver iscsi nodename vserver iscsi show vserver iscsi status vserver iscsi session show Command to be run role create -role CRBAC_New -cmddirname vserver fcp show -vserver clus3240rre role create -role CRBAC_New -cmddirname vserver fcp status -vserver clus3240rre role create -role CRBAC_New -cmddirname lun igroup show -vserver clus3240rre role create -role CRBAC_New -cmddirname vserver iscsi connection show -vserver clus3240rre role create -role CRBAC_New -cmddirname vserver iscsi interface accesslist show -vserver clus3240rre role create -role CRBAC_New -cmddirname vserver iscsi nodename -vserver clus3240rre role create -role CRBAC_New -cmddirname vserver iscsi show -vserver clus3240rre role create -role CRBAC_New -cmddirname vserver iscsi status -vserver clus3240rre role create -role CRBAC_New -cmddirname vserver iscsi 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 system node autosupport invoke vserver export-policy rule create lun igroup add lun igroup create role create -role CRBAC_New -cmddirname lun mapped show -vserver clus3240rre role create -role CRBAC_New -cmddirname system node autosupport invoke -vserver clus3240rre role create -role CRBAC_New -cmddirname vserver exportpolicy rule create -vserver clus3240rre role create -role CRBAC_New -cmddirname lun igroup add -vserver clus3240rre role create -role CRBAC_New -cmddirname lun igroup create -vserver clus3240rre

23 Preparing to install Snap Creator 23 Command directory name lun igroup set vserver iscsi interface accesslist add Command to be run role create -role CRBAC_New -cmddirname lun igroup set -vserver clus3240rre role create -role CRBAC_New -cmddirname vserver iscsi 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 unixgroup create vserver services unixuser create vserver export-policy show volume efficiency on volume efficiency start volume snapshot create role create -role CRBAC_New -cmddirname vserver services unix-group create -vserver clus3240rre role create -role CRBAC_New -cmddirname vserver services unix-user create -vserver clus3240rre role create -role CRBAC_New -cmddirname vserver exportpolicy show -vserver clus3240rre role create -role CRBAC_New -cmddirname volume efficiency on -vserver clus3240rre role create -role CRBAC_New -cmddirname volume efficiency start -vserver clus3240rre role create -role CRBAC_New -cmddirname volume snapshot create -vserver clus3240rre volume modify role create -role CRBAC_New -cmddirname volume modify - vserver clus3240rre

24 24 NetApp Snap Creator Framework Installation and Administration Guide Command directory name volume autosize volume clone create Command to be run role create -role CRBAC_New -cmddirname volume autosize -vserver clus3240rre role create -role CRBAC_New -cmddirname volume clone create -vserver clus3240rre volume create role create -role CRBAC_New -cmddirname volume create - vserver clus3240rre volume modify role create -role CRBAC_New -cmddirname volume modify - vserver clus3240rre nfs iscsi fcp role create -role CRBAC_New -cmddirname nfs -vserver Snapcreator -vserver clus3240rre role create -role CRBAC_New -cmddirname iscsi -vserver Snapcreator -vserver clus3240rre role create -role CRBAC_New -cmddirname fcp -vserver Snapcreator -vserver clus3240rre 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 volume offline volume unmount role create -role CRBAC_New -cmddirname volume destroy -vserver clus3240rre role create -role CRBAC_New -cmddirname volume offline -vserver clus3240rre role create -role CRBAC_New -cmddirname volume unmount -vserver clus3240rre options role create -role CRBAC_New -cmddirname options - vserver clus3240rre

25 Preparing to install Snap Creator 25 Command directory name system node autosupport Command to be run 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 event mailhistory role create -role CRBAC_New -cmddirname event destination -vserver clus3240rre 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 directory name vserver export-policy rule show volume file adduser vserver services unixgroup show Command to be run role create -role VSERVERRBACROLE_New -cmddirname vserver export-policy rule show -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume file -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname adduser -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname vserver services unix-group show -vserver Snapcreator

26 26 NetApp Snap Creator Framework Installation and Administration Guide Command directory name vserver services unixuser show volume efficiency show volume show Command to be run role create -role VSERVERRBACROLE_New -cmddirname vserver services unix-user show -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume efficiency show -vserver Snapcreator 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 volume options volume mount volume file clone create restore-file vserver nfs status vserver fcp initiator show vserver fcp show vserver fcp status lun igroup show role create -role VSERVERRBACROLE_New -cmddirname iscsi -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume role create -role VSERVERRBACROLE_New -cmddirname options -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume mount -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume file clone create -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname restore-file -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname vserver nfs status -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname vserver fcp initiator show -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname vserver fcp show -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname vserver fcp status -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname lun igroup show -vserver Snapcreator

27 Preparing to install Snap Creator 27 Command directory name vserver iscsi connection show vserver iscsi interface accesslist show vserver iscsi nodename vserver iscsi show vserver iscsi status vserver iscsi session show lun geometry lun show lun mapped show lun igroup add lun igroup create lun igroup set vserver iscsi interface accesslist add lun create lun map Command to be run role create -role VSERVERRBACROLE_New -cmddirname vserver iscsi connection show -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname vserver iscsi interface accesslist show -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname vserver iscsi nodename -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname vserver iscsi show -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname vserver iscsi status -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname vserver iscsi session show -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname lun geometry -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname lun show -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname lun mapped show -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname lun igroup add -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname lun igroup create -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname lun igroup set -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname vserver iscsi interface accesslist add -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname lun create -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname lun map -vserver Snapcreator

28 28 NetApp Snap Creator Framework Installation and Administration Guide Command directory name lun move lun online lun comment lun modify lun unmap vserver services unixgroup create vserver services unixuser create vserver export-policy show volume efficiency on volume efficiency start volume snapshot create volume snapshot delete volume modify volume autosize volume clone create volume create Command to be run role create -role VSERVERRBACROLE_New -cmddirname lun move -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname lun online -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname lun comment -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname lun modify -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname lun unmap -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname vserver services unix-group create -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname vserver services unix-user create -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname vserver export-policy show -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume efficiency on -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume efficiency start -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume snapshot create -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume snapshot delete -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume modify -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume autosize -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume clone create -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume create -vserver Snapcreator

29 Preparing to install Snap Creator 29 Command directory name volume modify vserver iscsi isns query volume file clone volume clone volume snapshot restore lun resize volume efficiency off volume size lun delete lun offline volume destroy volume offline volume unmount version snapmirror Command to be run role create -role VSERVERRBACROLE_New -cmddirname volume modify -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname vserver iscsi isns query -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume file clone -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume clone -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume snapshot restore -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname lun resize -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume efficiency off -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume size -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname lun delete -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname lun offline -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume destroy -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume offline -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname volume unmount -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname version -vserver Snapcreator role create -role VSERVERRBACROLE_New -cmddirname snapmirror -vserver SnapCreator

30 30 NetApp Snap Creator Framework Installation and Administration Guide Installing Java on Snap Creator Server For Snap Creator to function, Java must be installed. Java Runtime Environment (JRE) 1.6 or later must 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 -version java 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-in The Domino plug-in is included as part of the Snap Creator installation. There are a few preinstallation steps to be performed depending on the operating system used. Settings specific to Linux, Solaris, and AIX IBM 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 same account 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 installing Domino to the default location, you can copy and paste the following commands into the environment: ln -s /opt/ibm/lotus/notes/latest/linux/libxmlproc.so /usr/lib/ libxmlproc.so ln -s /opt/ibm/lotus/notes/latest/linux/libndgts.so /usr/lib/libndgts.so

31 Preparing to install Snap Creator 31 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 then enter it in the command-line interface (CLI) console. Settings specific to Windows You 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 the Desktop, it can usually be found in the Start menu). 2. Click the Advanced tab in Windows 2003 or the Advanced system settings tab in Windows Click Environmental Variables. There are two sections: User variables and System variables. Select a system variable. For a user variable, 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 Creator service. a) Click Start > Control Panel > Administrative Tools > Services > SnapCreatorService. b) Click Restart.

32 32 NetApp Snap Creator Framework Installation and Administration Guide Installing Snap Creator on Windows You can install the Snap Creator Server and Snap Creator Agent on Windows by using the Windows installer. Before you begin For Windows 2003 Agent service, you must have installed Microsoft.NET Framework 3.5 or later. 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 monitor size should be between 1 and 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

33 33 Installing Snap Creator on UNIX For UNIX, the Snap Creator software package is a compressed file, which when extracted contains both the server and agent. The UNIX Services (agent/server) feature provides a start script for the server and agent. The start scripts are written in UNIX shell script (bourne shell) and are designed to run on all the UNIX environments that are supported by Snap Creator. Installing Snap Creator Server You can install Snap Creator Server on UNIX. Snap Creator Server is designed to run on any open systems 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 proper permissions. If the setup command does not work, you can add the necessary permissions by running 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 Server (Y N)? 6. Optional: Enter the controller serial number. Note: The intent is to add the controller serial number applicable to the Snap Creator application. The Snap Creator application archives this information for later use. You can run the -version command to retrieve this serial number when contacting technical support to open 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 Enter the user name and password for the administrator of the GUI.

34 34 NetApp Snap Creator Framework Installation and Administration Guide 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 Agent Snap Creator Agent is designed to run on any open systems platform. If the agent is not required, you can choose to run the Snap Creator Server 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 Agent (Y N)? 5. Enter the Snap Creator Agent port. 6. Start the Snap Creator Agent by following the instructions provided on the screen.

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

36 36 NetApp Snap Creator Framework Installation and Administration Guide 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.

37 37 Upgrading from Snap Creator When you upgrade from Snap Creator to Snap Creator 4.0.0, the database schema is upgraded and all the configuration file passwords are updated for compatibility with Snap Creator About this task Only the upgrade from Snap Creator to Snap Creator is supported. To upgrade from earlier versions, you must upgrade one version at a time. For example, to upgrade from Snap Creator 3.3.0, you must first upgrade from to 3.4.0, to 3.5.0, to 3.6.0, and then from to This process does not upgrade the Snap Creator agent. You must upgrade the Snap Creator agent 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/snapcreator directory. Note: You should not delete the Snap Creator 3.6.x backup copies created in Step 1 and Step Uninstall the current installation of Snap Creator (for Windows). 4. Install Snap Creator Delete the Snap Creator 4.0.x database under the scserver4.0.x/engine/snapcreator directory. 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 user must be the administrator in Snap Creator If the Snap Creator user is not an Administrator and the same user is used for the Default Administrator role, the upgrade process sets the same user in Snap Creator as an Operator instead of an Administrator.