IBM TSM for SharePoint 6.1 VSS Backup and Restore Solution Guide IBM System Storage DS6000 & DS8000 with DocAve 5.1.2.1 Document Date: June 2009 Authors: David West i, David Hartman ii Document version: 1.8
Table of Contents Introduction... 3 IBM System Storage DS6000... 3 IBM System Storage DS8000... 4 Storage Sizing and Configuration... 5 The IBM DS Open API CIM Agent... 6 Installation... 7 Configuration... 11 IBM System Storage Support for Microsoft VSS... 13 Installing the IBM Hardware Provider... 14 Configuring the free and reserved VSS volume pools... 16 Verifying the Installation... 17 Sample Disk Configuration for SharePoint VSS backups... 18 Tivoli Storage Manager for SharePoint... 18 Solution Overview... 18 System Requirements... 20 TSM Server Requirements... 22 Installing the DocAve Manager... 24 Installing the DocAve Agent... 25 Configuring Integration with TSM Server... 27 The DocAve Dashboard... 30 Backup Procedures... 31 Selecting SharePoint Content... 32 Configuring and Running the Backup... 33 Restore Procedures... 34 Setting the Date Range... 34 Finding and Selecting Data for Restore... 34 Advanced Restore Options... 36 Performing the Restore... 36 Conclusion... 37 Page 2
Introduction Many customers rely on Microsoft Office SharePoint Server (MOSS) 2007 as a key business application, and even short periods of unexpected downtime can seriously affect company productivity and collaboration. Companies of all sizes are using the advanced data management, collaboration, and web integration features of MOSS 2007, creating large content repositories serviced by front-end portals. Search requirements result in large indexes of these repositories and possibly other external content sources, resulting in an enormous amount of data to protect. Because of this ability to easily store and manage multiple application databases, data repositories, and web portals serviced through a variety of interfaces, the ability to backup and restore disparate data types, at a granular level, efficiently and consistently is essential. The demand for accurate backup and restore is growing as companies store more of their business-critical data on SharePoint Server 2007. In addition, many organizations are moving towards SharePoint as a replacement for traditional file servers, and extensions to Exchange & SQL Server. IBM Tivoli Storage Manager (TSM) for SharePoint provides farm, site, subsite, and item-level backup with restore granularity down to the single document or version level. Granular restore capability is the key to quicker restore times with SharePoint. When TSM is combined with a reliable, scalable disk subsystem like the IBM System Storage DS series, the result is a highly effective solution that is ready to help your organization meet demanding backup and recovery point/time objectives, without added administrative complexity. Due to the ever expanding amount of storage space required by complex and distributed SharePoint environments, the scalable IBM System Storage DS6000 or DS8000 are ideal platforms for medium to large companies. IBM System Storage DS6000 Note: The solution outlined in this document is available on all IBM System Storage disk products. However, it is important to install the correct VSS hardware provider for the disk product in use. The IBM System Storage DS6000 series is a member of the DS family of products and is built upon 2 Gbps fibre channel technology that provides RAID-protected storage with advanced functionality, scalability, and increased addressing capabilities. The DS6000 series is designed to offer a high reliability and high performance midrange storage solution through the use of hot-swappable redundant RAID controllers in a space efficient modular design. The DS6000 series provides storage sharing and consolidation for a wide variety of operating systems and mixed server environments. Page 3
The DS6000 series is designed to offer high scalability while maintaining excellent performance. With the DS6800 (Model 1750-522), you can install up to 16 disk drive modules (DDMs). For those needing more storage capacity, the optional DS6000 expansion enclosures (Model 1750-EX2) allow for a maximum of 128 DDMs per storage system and provide a maximum physical storage capability of 57.6 TB with fibre channel drives. The DS6800 measures 5.25-in. high and is available in a 19-in. rack mountable package with an optional modular expansion enclosure of the same size for additional capacity to help address your growing business needs. The DS6000 series addresses business efficiency needs through its heterogeneous connectivity, high performance and manageability functions, thereby helping to reduce total cost of ownership. The DS6000 series offers the following major features: PowerPC 750GX processors Dual active controllers are designed to maintain operations through the use of two processors that form a pair to back up the other A selection of Fibre Channel (FC) disk drives, including 73GB, 146GB, 300GB, and 450GB sizes with speeds of 10,000 or 15,000 revolutions per minute (RPM) Fibre Channel and FICON host attachments of up to 8 ports, which can be configured with an intermix of Fibre Channel Protocol (FCP) and FICON Fibre Channel Arbitrated Loop (FC-AL) switched device attachment of up to 2 dual loops 4GB battery backed, mirrored cache Redundant power and cooling system Disaster Recovery and Copy Service solutions Additional information on the DS6000 can be found here: http://www-03.ibm.com/systems/storage/disk/ds6000/index.html IBM System Storage DS8000 Created specifically for medium and large enterprises, the IBM System Storage DS8000 series offers high-capacity storage systems that are designed to deliver performance, scalability, resiliency and value. The DS8000 series is designed to provide exceptional performance while adding virtualization capabilities that can help you allocate system resources more effectively and better control application quality of service. The DS8000 series also offers powerful functions that are designed to help protect data from unforeseen events and maintain data availability, which can benefit businesses that must have continuous access to information. Page 4
The DS8000 series offers: Exceptional flexibility and scalability. The current physical storage capacity of the DS8000 series system can range from 1.1TB to 512TB, and it has an architecture designed to scale to over a petabyte. Significant addressing enhancements, IBM System Storage FlashCopy, Global and Metro Mirror functions, and streamlined configuration and management capabilities through the easy-to-use IBM DS Storage Manager are just some of the many additional advanced features of the DS8000 series. Innovative design creates impressive performance. With 4Gbps FC host adapters, the DS8000 models are as much as six times faster than the IBM TotalStorage Enterprise Storage Server (ESS) Model 800. Utilizing IBM POWER5+ processor technology, the DS8000 series delivers the first use of the IBM Virtualization Engine, which is designed to bring to a disk storage system the logical partition flexibility usually reserved for servers. Additional information on DS8000 can be found here: http://www-03.ibm.com/systems/storage/disk/ds8000/index.html Storage Sizing and Configuration In order to fully leverage the performance capabilities of the IBM System Storage DS6000 and 8000, consideration needs to be given to the logical configuration of the unit. Because most of SharePoint s data is stored within SQL Server (with the exception of SharePoint index files), the LUN setup and tuning recommendations are similar to our SQL server tuning recommendations. Note: For more information on configuring IBM System Storage for use with Microsoft SQL Server 2005, and SQL Server 2008, please refer to the SQL Server 2005 with IBM System Storage DS8000 & DS4000 Best Practices Guide, or the SQL Server 2008 with IBM System Storage DS8000 & DS4000 Best Practices Guide. Both documents are available at: http://www-03.ibm.com/systems/storage/solutions/isv/#microsoft It is important during the planning stages to understand how large the SharePoint index files can become, particularly if external file servers are being indexed as content sources. SharePoint indexes can grow up to 50% of the size of the content being indexed. If indexing is pointed at an external file server with 800GB of data, your SharePoint index file could be as large as 400GB for that content source alone. From a backup and restore perspective, many organizations do not backup the index files because they are regularly refreshed, are often massive in size, and can simply be rebuilt. However, if demanding RTO requirements include highly available SharePoint search capabilities, then the index should also be backed up. Page 5
In order to minimize application and user impact: Backups should occur when application is least active. Use of VSS backup greatly minimizes the impact on production systems, however there is still disk activity and network bandwidth to consider. Volume creation and storage sizing for maximum performance should follow published Microsoft guidelines for SharePoint. Please see the Microsoft SharePoint Deployment Guides for detailed information. For Microsoft Office SharePoint Server 2007: http://technet.microsoft.com/en-us/library/cc262957.aspx For Windows SharePoint Services v3.0: http://technet.microsoft.com/en-us/library/cc288426.aspx The IBM DS Open API CIM Agent The IBM System Storage DS Open Application Programming Interface (API) is a storage management client application that supports standard LUN management activities such as LUN creation, mapping and masking, and the creation or deletion of volumes. The DS Open API supports these activities through the use of the Storage Management Initiative Specification (SMI-S), as defined by the Storage Networking Industry Association (SNIA). The DS Open API is implemented through the IBM System Storage Common Information Model (CIM) agent, a middleware application that provides a CIM-compliant interface. The DS Open API uses the CIM technology to manage proprietary devices as open system devices through storage management applications. The DS Open API allows these storage management applications to communicate with a storage unit. For this solution, the IBM VSS hardware provider communicates through the CIM agent to manage LUN and snapshot processes on the DS6000 or 8000. This section includes an overview of the installation process and instructions for installing and configuring the CIM agent on a Windows 2003 or later operating system. Although this solution has the CIM agent on a dedicated Windows server, that is not a requirement. The CIM agent can be installed on any non-clustered server available. We advise using the most recent version of the CIM agent available on the IBM site. This solution covers installation of version 5.4 This section contains information from the IBM System Storage DS Open Application Programming Interface 5.4 Installation and Reference guide. For more detailed information the document can be downloaded from here: http://www- 01.ibm.com/support/docview.wss?rs=1118&context=STC4NKB&dc=DA420&uid=s sg1s7002567&loc=en_us&cs=utf-8&lang=en Page 6
Note: Recent DS6000 s and DS8000 s include a version of the CIM preinstalled on the Host Management Console (HMC), also known as imbedded CIM. You may use the imbedded CIM agent if it is enabled and configured. Contact IBM support to confirm status of the imbedded CIM on your system. Security Levels Installation Secure Mode All requests between the client application and the CIMOM are XML encoded requests sent over Hypertext Transfer Protocol (HTTP) or HTTP over Secure Sockets Layer (SSL). The CIMOM, upon receiving a request, parses the request and processes it. Responses, when they are returned to the client application, are transformed into XML-encoded CIM status and returned in HTTP responses to the client. The default of the CIM agent is to run in secure mode using SSL. Unsecure Mode Some vendor software might not be capable of communicating with the CIM agent in a secure mode. You can still use this vendor software by configuring the CIM agent to run with only basic user name and password security. See the configuration instructions for your operating system for the instructions for configuring the CIM agent for this less secure mode. The following summarizes the installation steps covered in this section. Install the agent Verify the CIM agent installation Configure the CIM agent Verify the connection to your storage unit Perform the following steps to install the CIM agent Log on to your system as a local administrator. Verify you have a recent version of IBM Java installed. Insert the CIM agent CD into the CD-ROM drive. The CIM agent program should start if you have autorun set on your system, or navigate to the CD-ROM drive and start the LaunchPad.bat file. Click Installation wizard from the LaunchPad window to start the installation. The LaunchPad window remains open behind the installation wizard so that you can access product information during the installation process. There may be a delay while the software initially loads. After the software loads, a DOS prompt window opens with the message: Initializing InstallShield Wizard... Preparing Java Virtual Machine... Page 7
The Welcome window opens suggesting what documentation you should review prior to installation. Click Next to continue. Read the license agreement, and click Accept to continue. If the installation wizard detects a prior installation of the CIM agent, the Product Installation Check window opens. Check the Preserve Configuration check box if you want to preserve your configuration settings. Follow any specific instructions in the window. After you have followed all instructions, select Next. The Destination Directory window opens. Click Next to accept the default directory, or click Browse to select a different directory for installation and then click Next. The Destination Directory window is displayed only if a version of CIM agent is not already installed. Otherwise, the CIM agent is reinstalled or upgraded to the same install location. The Server Communication Configuration window opens as shown below. If one or more of the default ports is the same as another port already in use, modify the default port and click Next. Note: Use this command to check ports in use: netstat -an Select the appropriate communication protocol and click Next to continue with installation. Note: If your applications do not support secure communications, select HTTP as the protocol or both to enable either one, as shown below. This setting can be changed later if needed. Page 8
The Configuration Parameters window opens as shown below. Optionally enter a user name and password for the CIM server. Click Add to optionally enter any information about devices that you would like to configure the agent to communicate with. When adding a device, a device type, IP address, username, and password must be specified. When adding a DS6000 or DS8000 family device, the device type should be ds, the IP address should be of the master console, and the username and password should be the same one used to log into the DS Command Line Interface or DS Storage Manager. After you have finished adding the configuration information, click Next. Page 9
The Installation Preview window opens. Click Install to confirm the installation location and file size. The Installation Progress window indicates how much of the installation has been completed. The installation installs the CIM agent files, starts the Service Location Protocol (SLP) service, and starts the CIM Object Manager service. When the Installation Progress window closes, the Finish window opens. Click Finish to exit the installation wizard. Exit the LaunchPad program by clicking Exit on the LaunchPad window. If you have not done so already, continue with the post installation tasks for the CIM agent using the instructions in the following sections. Restart your system if required. Verifying the installation Perform the following steps to verify your CIM agent installation: Verify the installation of the Service Location Protocol (SLP) from Windows services panel. Find the SLP service and verify it is started and set to manual. Start the service if it is not running. The CIM agent controls starting and stopping of this service as needed. Verify the installation of the CIM agent from Windows services panel. Find the IBM System Storage CIM Agent for DS Open API and verify it is started and set to automatic. Start the service if it is not running. Page 10
If you are able to perform all of the verification tasks successfully, the DS CIM agent has been successfully installed. Configuration This section configures the CIM agent after it has been installed. These steps are the same instructions listed in the Post Installation Tasks option on the LaunchPad window. Verify you can ping each DS that the CIM agent will manage by typing the following command: ping <IP>, using the IP address of the target DS. If you did not enter the DS storage system information during installation, or want to add another storage unit, type the following command to configure the CIM agent for each DS server that the CIM agent can access. dscimcli mkdev <ip> -type <type> -user <user> -password <password> ip For a DS server, this is the IP address of the primary hardware or software master console (HMC/SMC). type For DS6000/8000, this entry should be ds user/password For a DS server, this is the storage manager GUI or DSCLI user name and password After you have defined the DS server(s), type the following command to verify the devices were correctly added and have connected: dscimcli lsdev -l Below is a sample of expected output from the command Note: The CIM agent periodically collects and caches information from the defined storage units, therefore the CIM agent might periodically take longer to respond to requests, including immediately after adding a new storage unit. Configure the CIMOM for each user that you want to have authority to use the CIMOM by running the CIMOM configuration program. During the CIM agent installation, the default user name to access the CIM agent CIMOM is created. The default user name is superuser with a default password of passw0rd. You must use the default user name and password when you use the mkuser command for the first time after installation. After you have added other users, you can initiate the mkuser command using a user name that you defined instead of using the default. Page 11
1. Start the CIM agent, if it is not started, by typing the following command: startagent 2. Type the following command: dscimcli mkuser -user cimuser -password cimpass 3. You can change the default password for superuser by starting the mkuser command for a user that you added. Issue the following command to change the password: dscimcli chuser superuser -password passw0rd -newpassword <newpassword> Type the exit command to close the CIMOM configuration program. If you were able to perform all of the configuring tasks successfully, the CIM agent has been successfully installed and configured. Verifying CIM Agent Connection During this task, the CIM agent software connects to the storage unit that you identified in the configuration task. Verify that you have network connectivity to the DS unit from the system where the CIM agent is installed by pinging the IP address of the DS master console. Verify that the DS CLI is operational and can connect to the storage unit. Open a command prompt window and issue the following command: dscimcli lsdev -l You should see the following output: Note: In some cases the DS CLI does not work correctly unless the system has been restarted following the new installation of the CLI. Go to Windows Services and verify the Service Location Protocol (SLP) in the list of services is running. For this service, verify the status column is marked Started and the Startup Type column is set to automatic. Start the service if it is not started. Page 12
Verify that the CIMOM is active by finding CIM Object Manager - DS Open API in the Windows services panel. Verify the service is set to automatic and started. IBM System Storage Support for Microsoft VSS The Microsoft Volume Shadow Copy Service can provide a point-in-time (shadow) copy of a Windows host volume while the volume is mounted and files are in use. The following components are used to provide support for the service: IBM System Storage hardware provider, known as the IBM System Storage Support for Microsoft Volume Shadow Copy Service and Virtual Disk Service software. This is also referred to as the IBM hardware provider. Microsoft Volume Shadow Copy Service (VSS) For this solution, the IBM hardware provider is installed on the SharePoint and SQL servers and a VSS non-persistent backup is performed. To provide the point-in-time shadow copy, the components complete the following process: The TSM for SharePoint Docave Agent (VSS requestor) on the SharePoint server initiates a snapshot backup. VSS notifies the IBM hardware provider that a copy is needed. The DS6000/8000 prepares the volumes for a snapshot, placing the volumes into the VSS_Reserved pool. The SharePoint VSS writer gathers information on which volumes are being used by SharePoint and SQL, and coordinates with the hardware provider to reserve the appropriate size VSS volumes. VSS quiesces the software applications (Microsoft Office SharePoint Server 2007, and SQL Server 2008 in this case) that are writing data on the hosts and flushes file system buffers to prepare for the copy. The VSS volumes are then mounted to the SharePoint and SQL servers by the IBM VSS hardware provider. The DS6000/8000 creates the shadow copy using the IBM s FlashCopy Copy Service. VSS notifies the writing applications that I/O operations can resume, and notifies the backup application that the backup was successful. Backup data is copied from the VSS volumes to TSM allocated storage After the data transfer to the TSM server is complete, VSS volumes are disconnected from the SharePoint and SQL servers, and returned to the VSS_Free pool. The IBM hardware provider maintains a free pool of LUNs for use as FlashCopy targets and a reserved pool of LUNs which are disks currently hosting snapshots. These pools are actually Volume Groups on the DS6000 or DS8000 and the hardware provider moves the volumes between the groups as needed. Page 13
Installation Overview The steps for implementing IBM System Storage Support for Microsoft VSS must be completed in the correct sequence. Complete the following tasks: Verify the system requirements. Confirm an IBM DS Open API CIM agent is available in the environment. Install the IBM System Storage Support for Microsoft VSS on each host. Verify the installation, configuration, and communication Create the free and reserve pool volume groups on the DS6000/8000 System Requirements The following software is required: IBM System Storage Support for Microsoft Volume Shadow Copy Service and Virtual Disk Service software version 3.2 or later. Windows Server 2003 or 2008 operating system. The following editions of Windows Server are supported: o Standard Server Edition 32-bit version o Enterprise Edition, 32-bit version o Standard Server Edition 64-bit version o Enterprise Edition, 64-bit version Installation of the Common Information Module (CIM) in the environment, which was covered in the previous section, or access to imbedded CIM. Installing the IBM Hardware Provider Perform the following steps to install the IBM System Storage Support for Microsoft VSS: Log on to Windows as an administrator. Download the IBM VSS installation package from the following Web sites (note that code is system and firmware-version specific): DS8000: http://www- 304.ibm.com/systems/support/supportsite.wss/selectproduct?taskind=4&brandin d=5000028&familyind=5329631&typeind=0&modelind=0&osind=0&psid=sr&contin ue.x=1 DS6000: http://www- 304.ibm.com/systems/support/supportsite.wss/supportresources?brandind=50000 28&familyind=5329629&taskind=1 Page 14
Double click on the name of the file that you downloaded to start the installation process. The Welcome panel is displayed. Click Next to continue. The License Agreement panel is displayed. You can click Cancel at any time to exit the installation. To move back to previous screens while using the wizard, click Back. Read the license agreement information. Select whether you accept the terms of the license agreement, and click Next. If you do not accept, you cannot continue with the installation. The Choose Destination Location panel is displayed. Click Next to accept the default directory where the setup program will install the files, or click Change to select a different directory. Click Next. The Ready to Install the Program panel is displayed. Click Install to begin the installation. The Setup Status panel is displayed. The Select CIM Server panel is displayed. Select the required CIM server or select Enter the CIM Server address manually, and click Next. The Enter CIM Server Details panel is displayed. Page 15
Enter the following information in the fields: o In the CIM Server Address field, type the name of the server IP address where the CIM agent is installed. o In the CIM User field, type the user name that the IBM System Storage Support for Microsoft VSS will use to gain access to the server where the CIM agent is installed. For example, enter the name administrator. This account must be assigned to the Administrator role to function properly. You may also use the default superuser account or an account created specifically for this purpose. In the CIM Password field, type the password for the user name that the IBM System Storage Support for Microsoft VSS will use to gain access to the CIM agent and click Next. Note: If these settings change after installation, you can use the ibmvcfg.exe tool to update IBM VSS provider software with the new settings. If you do not have the CIM agent server, port, or user information, contact your CIM agent administrator. The InstallShield Wizard Complete panel is displayed. Click Finish. If necessary, the InstallShield Wizard prompts you to restart the system. Configuring the free and reserved VSS volume pools The IBM System Storage Support for Microsoft VSS maintains a free and a reserved pool of volumes. When a shadow copy is created, the IBM System Storage Support for Microsoft VSS software selects a volume in the free pool, assigns it to the reserved pool, and then removes it from the free pool. This protects the volume from being overwritten by other VSS requests. Page 16
To successfully perform a Volume Shadow Copy Service operation, there must be enough volumes in the free pool. The free pool volumes must be the same size or larger than the source volumes. Use the DS6000/8000 command-line interface (CLI) or the web based DS Storage Manager console to perform the following steps: Create a host attachment for the free pool of volumes, then create a volume group and connect it to this host attachment. You can use the default name VSS_FREE or specify a different name for both of these items. When setting up the host attachment, use the worldwide port name (WWPN) 5000000000000000 (15 zeroes) Create a host attachment for the reserved pool of volumes, then create a volume group and connect it to this host attachment. You can use the default name VSS_RESERVED or specify a different name. When setting up the host attachment, use the WWPN 5000000000000001 (14 zeroes) Restriction: The free pool volumes cannot be mapped to any other hosts. Free pool volumes must be of the same size as the volumes you wish to backup. Volumes of varying sizes are permitted in the free pool. VSS will choose volumes of the appropriate size as needed. Use the ibmvcfg add command to add volumes to the free pool. Alternately, you can use the DS Storage Manager console to add volumes to the VSS_Free volume group. NOTE: If you do not use the default WWPNs 5000000000000000 and 5000000000000001, you must manually configure the IBM System Storage Support for Microsoft VSS software with the alternate WWPNs. Verifying the Installation This task verifies that the IBM System Storage Support for Microsoft VSS software is correctly installed. Perform the following steps to verify the installation: From the Windows Services panel, ensure that the service named IBM System Storage Support for Microsoft Volume Shadow Copy Service and Virtual Disk Service software appears and that Status is set to Started and Startup Type is set to Automatic. Open a command prompt window and issue the following command: vssadmin list providers Ensure that the service named IBM System Storage Support for Microsoft VSS software is listed as a provider. Use the command ibmvcfg showconfig to confirm the parameters. Page 17
Use the ibmvcfg listvols command to test the connection to the IBM System Storage master console. Use the ibmvcfg listvols free command to verify volumes in the free pool. This can also be used to confirm the expected volumes are being used during a VSS backup. You can observe them leaving the free pool and moving to the reserved pool. Use the ibmvcfg listvols reserved command to view volumes in the reserve pool If you are able to successfully perform all of these verification tasks, the IBM System Storage Support for Microsoft VSS software was successfully installed. Sample Disk Configuration for SharePoint VSS backups The table below shows a small scale example of how the SharePoint, SQL, and VSS volumes were configured to provide snapshot backup support for our test environment. Volume Location LUN VSS (in VSS_Free) MOSS_index SharePoint Server 100 GB 100 GB x 3 SQL_MOSS_dbs SQL Server 150 GB 150 GB x3 SQL_MOSS_logs SQL Server 70 GB 70 GB x 3 During a VSS backup, the IBM VSS hardware provider will take one complete set of LUNs (100, 150 and 70 GB volumes) from the VSS Free pool per snapshot. This is a result of the SharePoint VSS writer gathering information on all involved volumes on all servers in the farm, and coordinating the snapshot of those LUNs with the hardware provider. Notice the sets of LUNS in the free pool match the production volume sizes in use. Tivoli Storage Manager for SharePoint Solution Overview The Tivoli Storage Manager for SharePoint solution uses the AvePoint DocAve 5.1.2.1 software, which fully integrates with the TSM backup server. DocAve is an Enterprise scale, item level and full farm backup and restore solution for MOSS 2007 or Windows SharePoint Services 3.0. Combined with the powerful TSM backup server, all SharePoint backup operations can be completely automated. TSM for Sharepoint now includes VSS support for fast backups of the entire farm, and standard backups for selected components, with granular item restore capability. Page 18
This document covers the basic installation, configuration, and administration tasks required to setup and manage the backups and restores. For more detailed information, consult the TSM for SharePoint 6.1 DocAve User Guide at: http://publib.boulder.ibm.com/infocenter/tsminfo/v6/topic/com.ibm.itsm.ic.doc/doc Ave_v5_IBM_TSM_User_Guide.pdf We recommend reading the entire User Guide, before following the steps in this specific solution guide. Supported Platforms Microsoft Office SharePoint Server (MOSS) 2007, with Service Pack 1 Windows SharePoint Services (WSS) v3, with Service Pack 1 Windows Server 2003, 2008 SQL Server 2000, 2005,and 2008 All of the above are supported on x86 or x64 platforms Note: SQL Embedded Edition is not supported, SQL Express is supported except for Platform incremental backups. DocAve Components There are three core backup components required by this solution; the DocAve Manager, the DocAve Agent, and the TSM Server where the backup data resides. The DocAve Manager Server consists of 4 core services, which can be installed on one server, or distributed across multiple servers depending on the size of your environment and performance requirements. The 4 services are: Control Service Business logic and communication service Web Service Used to access the DocAve web management interface Media Service Manages and coordinates storage devices Search Service Generates full text index and performs search Supported Backup and Restore Methods Farm Level: Backs up the entire SharePoint Farm Site Level: Backs up and restores the entire site collection. Sub-Site Level: Backs up and restores an entire sub-site. Item Level: allows selective backup within a site or sub-site and provides granular restore options down to the item level. This is the most powerful and often used Page 19
backup method in an enterprise environment. Full, Incremental, or Differential: Each of these backup methods are available for each level (Farm, Site, Sub-Site, and Item Level) of backup. VSS backup: Snapshot backup of all levels, with granular restore capability. VSS snapshots are used temporarily to send the SQL database data to the DocAve media server. Depending on the network connection between the SQL server and the media server, the backup speed will vary. The main benefit is reduced impact on SQL and SharePoint servers Real-time restores written directly onto a production SharePoint server are possible. Cross restores to an alternate server on the network are also supported. DocAve uses the terms in place for restores to the original server location, or out of place for restores to an alternate server Automated data pruning, and a web-based centralized administration console simplifies scheduling, monitoring, reporting, and account management. Key Assumptions While every attempt has been made to clearly describe the various installation processes required for this solution, this paper is intended for IT professionals familiar with the following: Microsoft Office SharePoint Server 2007 Microsoft SQL Server Windows Server 2008 IBM TSM Server IBM System Storage DS 6000 and 8000 management Storage subsystems and terminology VSS backup and restore terminology and processes The ability to manage and maintain the above is assumed. Descriptions of the setup and management of these systems is outside the scope of this document. System Requirements This section describes the minimum hardware, software, and operating system requirements for a successful installation. DocAve Manager Server Requirements Server and processor Intel Pentium III-compatible 1000-MHz processor minimum. Dual Intel Xeon 3.0 Ghz or faster recommended Page 20
Memory 2 GB of RAM minimum, 4 GB (or greater) recommended Hard disk 1GB minimum available, 3GB (or greater) recommended. Operating system Requires one of the following: Windows XP SP2 (supported for application design, development, and testing; no support for production use) Windows Server 2003 SP1, or Windows Server 2008 (32bit and 64bit).NET Framework Version 2.0 or higher DocAve Client / Agent requirements The Agent component requires the same system requirements above, with the following additional SharePoint and Storage requirements: SharePoint Front-End Web Server for SharePoint: MOSS 2007/WSS3.0 Service Packs Microsoft Office SharePoint Server 2007, SP1 Windows SharePoint Services 3.0, SP1 Page 21
TSM Server Requirements This solution requires some specific configurations on the TSM backup server (described below). The TSM server can be installed and configured either before or after the DocAve software components. The DocAve installation does not query the TSM backup server during the installation as earlier versions did. The DocAve Manager Server communicates with the TSM Backup Server, and stores the backup data in the TSM server s backup pools. In this configuration, only indexing data is stored on the Manager Server for catalog purposes, while the actual backup data resides on the TSM server. Note: The installation and configuration of a TSM 6.1 backup server is well beyond the scope of this document. However, detailed information on the subject can be found at the IBM Tivoli Storage Information Center at the following URL: http://publib.boulder.ibm.com/infocenter/tsminfo/v6/index.jsp The following are initial TSM server requirements to get started: A TSM `server, with adequate disk and storage pool space assigned to it for your environment. Gather all IP, port, and account information which the DocAve Page 22
connection will require when setting up the storage associations. The machine may run any OS supported by the TSM serve A TSM client node defined for each DocAve manager server that will send data to the TSM server. Node passwords if password authentication is enabled on the TSM server. Network Share used by the DocAve Manager server and is required during the setups steps below. This stores DocAve information and can be on any server in the environment, however creating it on the DocAve server is the most logical location for it. Additional policies can be configured on the TSM server, and within the DocAve interface, to provide complete control of the backup data and schedules. This provides the flexibility and control needed to meet specific and complex data retention and space requirements. Some of these advanced options include: Data Pruning Job Pruning Data Coalescing Filter Policies Data retention and versioning All backup operations can be fully automated. Please see the DocAve Administration Guide for detailed information on these policies and options. Page 23
Installing the DocAve Manager Follow these steps to install the Manager components: Log on to the server with an administrator account. Launch the DocAve Manager installation file and complete the standard license agreement, user information, and installation path options. Select which DocAve Manager services you wish to install. For our test environment all services were installed on one server. Large environments may require dedicated servers for some services. The available services are shown below: If you are distributing the services across several servers, the Control service must be installed first. All other services will require you to input the Control Service Host Name and Port number in order to communicate with the Manager server. Also make note of any SSL or HTTPs settings when installing these components. Click Next to continue. Use the default port numbers unless a known conflict exists. Page 24
Important: Make note of the port numbers and verify any firewalls between the DocAve Manager server and servers running the DocAve Agent are allowing communication through these ports (this includes the Windows built in firewall, or other server based firewalls). The Agent installation includes a communication test during the installation (covered below) which checks for communication between all services. Notice on the above dialog box, you can enable SSL and HTTPS to secure communications between the Manager and Agent services. Please see the DocAve 5 Administration Guide for details on configuring security certificates. Installing the DocAve Agent Follow the steps in this section to install the Agent component on the SharePoint server. Note: You must install the DocAve Agent on a SharePoint server with the Front-End Web Server role. Log in to the machine with an account that has local administrator rights, and administrative permissions within SharePoint and SQL Server. Page 25
Launch the DocAve Agent installer on the Front-End Web server. Proceed through the standard welcome, license, name, and installation path dialog boxes by clicking Next. After the files are copied, the following confirmation and test window appears. Enter the name of the DocAve Manager Server running the Control Service and confirm the ports are correct for your installation. Click on the Test button to confirm communication between the Agent and Manager servers. If the test fails, confirm that required ports are open between the servers and any firewalls in use. You may also test the account to be used by the Agent by entering the account name and password, and clicking the Test button. Important Note: For the User Account, you must select an account which has administrative access to both the SharePoint Front-End Web Server and your SQL Server. Use of a SharePoint service account is recommended. Click Finish to complete to DocAve Agent installation. Page 26
Configuring Integration with TSM Server There are several storage options for the DocAve backups. For this solution, we will only cover configuration of backups to a TSM server. This provides a more robust, flexible, and configurable backup environment. Before you can begin backing up to a TSM server you must configure a Network Share, which is used by the TSM Server data type. The following steps walk you through setting up both of these items. Creating the Network Share The Network share is a requirement to use TSM as the backup destination. It is used to store DocAve information during backups to TSM server. On the DocAve Manager server, create a network share and grant permissions to the domain account being used by DocAve. From the DocAve web interface, go to Control Panel, then Data Management, and select Device Manager. Select Net Share in the Data Type from the drop-down box. Click Add next to Physical Device in the right panel. Enter a name for the new device in the Physical Device text box. Page 27
Input the path to the share you just created. The path must be provided in UNC format: \\<computer name>\<network share name>\<directory path>. Input the Domain\username, and password to set up access to the network share that cached data will be written to and stored. Click Save to save the profile for the new physical drive and it will be listed under Physical Drive. Creating a TSM device From the DocAve web interface, go to Control Panel, then Data Management, and select Device Manager. Select TSM from the Data Type drop-down box. Click Add next to Physical Device in the right panel. Enter a name for the device in the Device Name text box. Select a Communication Method from the corresponding drop-down box, there are three options: TCP/IP; SHARED MEM; and NAMED PIPES. Input the TCP Port, TCP Server Address, Node Name and Password to set up access to the network path that data will be written to and stored. Note: This is the TSM Server information that is being entered, not the TSM client node information. Page 28
Click Save to save the profile for the new physical drive and it will be listed under Physical Device. Creating a Logical device The below steps associate physical devices created earlier with a logical device, which the DocAve backup plans use as the storage target. From the Device Manager screen, enter a name for the new Logical Device in the Logical Device Name box. Select a Data Type from the drop-down box, for this solution select TSM. Select the Media Agent tab next to Physical Device tab. From the right panel, drag the icon of the TSM Server you created earlier to the open area under the Media Agent tab. Select the Physical Device tab next to the Media Agent tab, and drag the TSM Server to the open area under the Physical Device tab. The TSM Data Type requires a Cache Storage location. From the drop down list, select the Net Share physical device you created earlier. Click Save to save the device settings and they will be listed under Logical Device, as shown below. Page 29
Note: If you modify TSM Logical Device configuration, including changes to the TSM Physical Device configuration, the media service may need to be restarted. If you modify any of the following, you must restart the media service. TCP Server Address Node Name or Password TCP Port or Communication method The DocAve Dashboard Below is a view of the Dashboard when the DocAve console is opened. You can quickly view the structure and status of your environment at a glance. It includes a tip of the day, system health, and the status of running or completed jobs. You can specify the interval and the scope of the status using the drop-down boxes. By clicking on different color parts in the pie chart, you can drill down into specific detail for that item. Page 30
Backup Procedures DocAve s Custom Backup Builder contains two types of backups: a Granular Backup and a Platform Backup. It allows administrators to backup their SharePoint environment on any level, from an entire Farm down to a specific Folder/ List. Note: VSS is only available for Platform Level backups, however you can still perform granular restores, down to the document level, from a VSS based Platform backup. Note: According to Microsoft, STSADM backups are not recommended for sites greater than 15 GB. As a result, DocAve s Site or Site Collection Granular backup options, which leverage STSADM, are not recommended in such cases. We recommend using the Granular Backup Item Level option or Platform Level backups in most instances, both of which offer the ability to restore at the Site or Site Collection level. This section covers a Platform level backup plan using VSS snapshots. The steps to perform a non-vss, or standard Granular level backup are fairly similar, and the DocAve interface is very intuitive. For more detailed steps please refer to the DocAve Administrators Guide. Page 31
Platform Level Backup is a Farm-level backup solution which enables SharePoint Administrators to backup Web Applications, Content Databases, search and index servers and Front-End servers. Platform Level Backup can also backup file system resources on front-end servers. Selecting SharePoint Content The first step is to find and select the SharePoint data to backup, as follows: Navigate to DocAve -> Data Protection -> Custom Backup Builder and select Platform Backup. On the backup tree builder window, select the name of the Agent Host from the drop down box. This is normally the SharePoint Front-End Web server where the DocAve Agent is installed. Clicking on the Agent displays the SharePoint Farm topology. The expanded tree lists the levels available for backup, with the exception of the SharePoint Front-End Web Servers, the tree can be expanded to the lowest level. For each selected level, there is a check-box corresponding to each level on the data tree, the box is unchecked by default. Checking the box indicates that all content on that level and underneath that level will be backed up. Below is a view of the DocAve Platform Backup Builder, with the entire SharePoint Farm selected. Page 32
Configuring and Running the Backup Select the Backup Method, VSS in this case. Select a Data Pruning configuration (optional). Data Pruning is beyond the scope of this document, and is covered well in the DocAve Administrators Guide. Select the TSMserver you created earlier from the Logical Device list. Specify your Scheduling and Restore Granularity options. Repeat these steps to create additional schedules as necessary. Save the plan by clicking Save. After the plan has successfully been saved, it will be displayed in the right panel area. To run the plan immediately, click Run Now. A confirmation window will appear so that you can confirm or change options, then click Run. After the job starts, click the Go to The Job Report button to view the status in Job Monitor. Below is a view of the Job Monitor, showing a successful Platform VSS backup using the configuration outlined in this paper. Note that you can click on the Details button for more information. Page 33
Restore Procedures The restore process is very intuitive, and the steps for each type of restore job are similar, regardless of which type of backup job you are restoring from. This section only covers restores from a Platform Level backup, since our solution is focused on VSS backup and restore. Setting the Date Range The first step of the restore process is to enter the time window of backups you want to restore data from: Navigate to DocAve -> Data Protection -> Restore Controller, and select Platform Restore. Select an Agent from the drop-down box. Choose a time range in the Time Window fields for From and To. By default, it is set to one week prior than the current time. You can click on the calendar icon to the right of the From and To field to change the time range. Select a date and time in the calendar pop-up window and click OK. Click Load Timeline. It will display yellow points indicating when the backup jobs ran during the specified period. Mouse-over the yellow time points and they will show a quick summary of the backup job in a pop-up window. Clicking on the time point, you can review the detailed contents of the job in the tree mode area. Finding and Selecting Data for Restore In the Restore Controller\Platform Restore interface, click on the time point to display the backup data in tree view. Click the Farm Name to expand the data tree. Click DB Filter to search a site collection by typing the URL of the site collection, and then click Search, it will list the database which the site collection is in. Page 34
Alternately, you can click Detail after the Content Database listing to view the content of the database under the Detail tab. Under the Detail tab, it lists the content of the database. You can click the corresponding URL to expand the tree. Click the Information icon to view the content inside, and check the corresponding box to select the content to restore. The Detail tab provides granularity down to the item level. By default, once you check the content, all items in it will also be checked. If you uncheck some items inside, the check-box will become a dash sign. For large environments, you may want to limit the results displayed in the tree by clicking the Search icon. For case-sensitive searches, check the Case Sensitive box located in the lower-left of the window. You can view the search result under the Search Result tab. Select the data to be restored. There is a check-box corresponding to each selected level on the data tree which is by default unchecked. Page 35
Advanced Restore Options Once the backed up data has been located and selected, there are several options available for the restore, as well as some prerequisites and additional configurations needed. Going into detail on these items is beyond the scope of this document, but includes the following: In Place and Out of Place restore Restore databases to most recent state Restore database only Safe Restore Include security Full Farm restore Refer to the DocAve Administrators Guide for in-depth coverage of these options and configurations. Performing the Restore Continuing in the Platform Restore screen, with our data selected. The following steps cover launching a basic restore job: In the Restore Settings panel, select In Place restore. Select a Restore Option: either Overwrite, Append, or Not Overwrite. Not overwrite: Will not restore the content if it already exists on the target. For example, if an entire folder s content is selected for restore, but only one document was removed from the destination folder, only the removed document will be restored. Overwrite: Will restore the content over whatever exists on the destination. This will delete the content on the destination and replace it with the content selected to be restored. Select a time for the restore to run. By default, Now is selected and will run the process as soon as Go is clicked. You can set a scheduled date and time for this restore by clicking the calendar icon. Optionally, enter a Description to help identify the job in the Job Monitor. Click Go. If you set the start time as now, it will run the restore job immediately. Otherwise, it will run the job at the specified time. You can view the job status real-time in Job Monitor, similar to the backup job monitoring, and view or export the backup report. Page 36
Below is a view of the completed restore with detailed status report window. Conclusion The system configurations described in this document are designed to address demanding enterprise requirements for highly-available Microsoft Office SharePoint Server 2007 deployments. Tivoli Storage Manager for SharePoint is designed to enable granular, reliable backups of SharePoint sites, sub-sites, and items. With the addition of Microsoft VSS support, the entire SharePoint farm can be quickly, easily, and reliably backed up with a negligible impact on production services. The granular restore capabilities help reduce backup and restore complexity and duration because restores are performed directly on the production server, and only the needed data is restored. These are the type of restores most often requested by users. The DocAve GUI is highly intuitive, and abstracts the administrators from the complexity of diverse backup & restore functionality of large-scale environments. Coupled with the extremely powerful Tivoli Storage Manager, which offers advanced enterprise-class functionality such as data-deduplication, offloaded (LAN free) backups & restores, tiered storage repositories and archive management, this solution can scale & integrate easily. IBM System x servers and System Storage arrays are designed to provide the processing throughput and scalable storage needed for large SharePoint environments. IBM Tivoli Storage Manager for SharePoint is designed to help support true fault and disaster tolerance. The combination of IBM Tivoli Storage Manager and SharePoint forms a solid backup and recovery platform for mission-critical SharePoint deployments. Page 37
Copyright 2009 by International Business Machines Corporation. This document could include technical inaccuracies or typographical errors. IBM may make changes, improvements or alterations to the products, programs and services described in this document, including termination of such products, programs and services, at any time and without notice. Any statements regarding IBM s future direction and intent are subject to change or withdrawal without notice, and represent goals and objectives only. The information contained in this document is current as of the initial date of publication only, and IBM shall have no responsibility to update such information. Performance data for IBM and non-ibm products and services contained in this document was derived under specific operating and environmental conditions. The actual results obtained by any party implementing any such products or services will depend on a large number of factors specific to such party s operating environment and may vary significantly. IBM makes no representation that these results can be expected or obtained in any implementation of any such products or services. THE INFORMATION IN THIS DOCUMENT IS PROVIDED AS-IS WITHOUT ANY WARRANTY, EITHER EXPRESS OR IMPLIED. IBM EXPRESSLY DISCLAIMS ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR INFRINGEMENT. References in this document to IBM products, programs, or services does not imply that IBM intends to make such products, programs or services available in all countries in which IBM operates or does business. Any reference to an IBM program or product in this document is not intended to state or imply that only that program or product may be used. Any functionally equivalent program or product, that does not infringe upon IBM s intellectually property rights, may be used instead. It is the user s responsibility to evaluate and verify the operation of any non-ibm product, program, or service. The provision of the information contained herein is not intended to, and does not grant any right or license under any IBM patents or copyrights. Inquiries regarding patent or copyright licenses should be made, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. IBM, the IBM logo, System x, and System Storage are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. Microsoft, Windows, SharePoint, and SQL Server are trademarks of Microsoft Corporation in the United States, other countries, or both. i IBM Systems & Technology Group, Kirkland, WA, davwest@us.ibm.com ii IBM Systems & Technology Group, Raleigh, NC, dhartma@us.ibm.com Page 38