Administration GUIDE SharePoint Server iDataAgent
Getting Started - SharePoint Server iDataAgent
Introduction Key Features
Full Fidelity Backup and Recovery Simplified Backup and Recovery Strategy Fast Backups/Recover for Content Database Protect all SharePoint Components
RBS Aware Backup for Content Database Efficient Job Management and Reporting Block Level Deduplication
Content Indexing and Search Terminology
Microsoft SharePoint Server and Windows SharePoint Services include components that are backed up by the SharePoint Server iDataAgent, as well as data which must be backed up using the File System iDataAgent. SharePoint database files can also reside on separate SQL servers;
to secure this data, you must back up these files using the appropriate SQL Server iDataAgent. The SharePoint entities that can be backed up by the system are described in detail in the following sections.
The SharePoint Server iDataAgent offers the following key features:
Overview Deployment Configuration Decision
Table of Contents
Introduction
Key Features
Full Fidelity Backup and Recovery
Document level backups allows capturing of system oriented metadata such based on parameters such as modified by or version information in a canned manner so that this backed up information can be brought back as it was backed up. In place merge options determines the current state of the target entities and intelligently determines what to restore. The customization on top of base template can also be seamlessly captured during backups.
Simplified Backup and Recovery Strategy
Prior to v10, there were many options to choose from within a particular level of protection. Also there were less number of choices/strategies which optimized each level of protection. The backup and restore procedures in v10 have simplified the overall offerings as well as complexities and therefore the iDataAgent is more resilient against failures.
Fast Backups/Recover for Content Database
Snapshot of Content databases allows for faster backups of the SharePoint data. By using the offline browse and IntelliSnap feature, the same granularity of data can be recovered quickly from a snapshot.
Protect all SharePoint Components
All entities in the File System or IIS related to SharePoint are protected along with all logical SharePoint components.
RBS Aware Backup for Content Database
Content database backups are fully RBS aware* and protect RBS blobs along with databases regardless of backup methods (streaming, VSS, or IntelliSnap).
*Support only Microsoft provided File Stream RBS provider.
Efficient Job Management and Reporting
You can view and verify the status of the backup and recovery operations from the Job Controller and Event Viewer windows within the CommCell Console. You can also track the status of the jobs using reports, which can be saved and easily distributed. Reports can be generated for different aspects of data management. You also have the flexibility to customize the reports to display only the required data and save them to any specified location in different formats. For example, you can create a backup job summary report to view at-a-glance the completed backup jobs. In addition, you can also schedule these reports to be generated and send them on email without user intervention.
Block Level Deduplication
Deduplication provides a smarter way of storing data by identifying and eliminating the duplicate items in a data protection operation.
Deduplication at the data block level compares blocks of data against each other. If an object (file, database, etc.) contains blocks of data that are identical to each other, then block level deduplication eliminates storing the redundant data and reduces the size of the object in storage.
This way dramatically reduces the backup data copies on both the disk and tapes.
Content Indexing and Search
Content Indexing and Search enables users to content index their data and later search the data from a user-friendly web interface. The users can also perform restore operations or other advanced actions on the searched data.
The Windows File System documentation uses the following terminology:
Terminology
Client The computer in which the iDataAgent is installed and contains the data to be secured.
A software module in the system that performs SharePoint data protection operations.
Subclient
SharePoint Server iDataAgent - Release Highlights
New Features Changes Known Issues
Table of contents
New Features
New Feature Description Support/License/Service
Pack Support for SharePoint
Server 2013
SharePoint Server iDataAgent now supports SharePoint Server 2013.
Learn more...
License Type z Application Class 1 Service Pack
Available with Service Pack 2B or higher
Changes
Whats Changed Description Learn More ...
Browse Command Renamed as Browse and Restore
Browse command is now renamed and Browse and Restore and is available from the BackupSet, Subclient and Job levels.
Previously, the Browse command was available from the Client, Agent, BackupSet, or Subclient level.
Example
Browse and Restore - Windows File System iDataAgent
Creating a New Index
During Backup The option Create New Index is no longer honored in the Advanced Backup Options (Data) tab in the CommCell Console. By default, a new index is created during a full backup regardless of whether the option is selected or not. This option will be removed in a future Service Pack.
Previously this option was honored in the Advanced Backup Options (Data) tab in the CommCell Console.
Known Issues
Issue/Note Description Workaround
Browse and Find Operations Containing Multiple Backup Cycles may not display accurate results for List media and size
When you perform Browse or Find operations from the Backup Set or Subclient level containing multiple backup cycles, then the following may not be accurate:
z List media may not display an accurate list
z Size of the backup in the Browse window may not be reported accurately This issue will be fixed in a future Service Pack.
None
Find Operations from Browse window does not Recognize the options selected during browse
When Find operation is invoked from the Browse window, the Find operation does not
consider the filters given in the Browse window. Start the Find operation from Backup Set or Subclient right-click menu and provide the filters for Find to work correctly.
Viewing Logs, RMAN Logs, and Failed Items from Backup Job
When you execute the View Logs, the View RMAN Logs, or the View Failed Items operation from the backup history of a cluster client, a message appears that says No results found. This issue will be fixed in a future Service Pack.
None
System Requirements - SharePoint Server iDataAgent
The following requirements are for the SharePoint Server iDataAgent:
708 MB minimum of hard disk space for installing the software.
500 MB of free disk space is required for log directory.
An appropriate amount of temporary space must be allotted in the Job Results folder to accommodate staging of the SharePoint Service Application Databases, Site Collections and subsites. Calculated based on the size of the largest Service Application Database, 5 largest site collections and 5 largest subsites in the Farm.
All Windows-compatible processors supported
The File System iDataAgent will be automatically installed during installation of this software, if it is not already installed. For System Requirements specific to the File System iDataAgent, refer to System Requirements - Microsoft Windows File System iDataAgent.
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
System Requirements Supported Features License Requirements
Application
Microsoft Windows SharePoint Services version 3.0 up to the latest Service Pack Microsoft Office SharePoint Server 2007 up to the latest Service Pack
Microsoft Office Forms Server 2007 up to the latest Service Pack Microsoft Office Project Server 2007 up to the latest Service Pack Microsoft Search Server 2008 up to the latest Service Pack Microsoft Search Server 2008 Express up to the latest Service Pack Microsoft SharePoint Server 2010
Microsoft FAST Search Server 2010 Microsoft Search Server 2010 Microsoft Office Project Server 2010
Microsoft SharePoint 2010 Standard and Enterprise Microsoft SharePoint Foundation 2010
Microsoft Search Server 2010 Express Microsoft SharePoint Server 2013
Operating System
Windows Server 2012
Microsoft Windows Server 2012 Editions Windows Server 2008
Microsoft Windows Server 2008 32-bit and x64 Editions*
*Core Editions not supported
Windows
Microsoft Windows Server 2003 32-bit and x64 Editions* with a minimum of Service Pack 2
* Special configuration considerations apply. See Installing 32-bit Components on a Microsoft Windows x64 Platform for more information.
Hard Drive
Processor
Miscellaneous
Microsoft Visual C++ 2010 and 2008 Redistributable Packages are automatically installed. Note that these Visual C++ Redistributable Packages can co-exist with other versions of this software.
DISCLAIMER
Minor revisions and/or service packs that are released by application and operating system vendors are supported by our software but may not be individually listed in our System Requirements. We will provide information on any known caveat for the revisions and/or service packs. In some cases, these revisions and/or service packs affect the working of our software. Changes to the behavior of our software resulting from an application or operating system revision/service pack may be beyond our control. The older releases of our software may not support the platforms supported in the current release. However, we will make every effort to correct the behavior in the current or future releases when necessary. Please contact your Software Provider for any problem with a specific application or operating system.
Additional considerations regarding minimum requirements and End of Life policies from application and operating system vendors are also applicable
Getting Started - SharePoint Server iDataAgent
On the SharePoint farm, install the software on the Application Server with Search Service Application. The Application Server should have the same custom configurations as that of the Front End Web Servers.
The computer will be added as a client in the CommCell as soon as the installation completes successfully.
The software installation may require a system reboot if a pending rename operation from a previously installed application is found in the operating system, hence, plan your installation at a convenient time.
Prerequisites
The user (generally the domain account) selected during the SharePoint Server Agent installation will be used to run Communications Service (GxCVD) and Client Event Manager (GxEvMgrC) and would requires the following account privileges:
z Local administrative rights z FARM administrator rights
z Full permission to Data Protection Suite registry key z SP Shell administrator permissions
z Full control under Policy for Web Application for every Web Application
z SQL System Admin Server Role for the instance where SharePoint Databases resides z Site Administrator permissions for all Site Collections
The following accounts must have full permissions to the Job Results and Log Files folders:
z Data Protection Suite Services account
z SQL Server Services account for the SharePoint instance z SharePoint Services Timer account
z All Web Application Pools accounts
System Requirements
Verify that the computer in which you wish to install the software satisfies the minimum requirements specified in System Requirements.
Download Software Packages
Download the latest software package to perform the install.
Overview Deployment Configuration Decision
Where to Install
Planning Your Installation
Before You Begin
Installation
The software can be installed using one of the following methods:
Method 1: Remote Install Using CommCell Console Use this procedure to install remotely on a client computer.
Method 2: Interactive Install - Standard
Use this procedure to directly install the software from the installation package or a network drive.
To install software from the CommCell Console:
1. Open CommCell Console:
{ Click Start and point to All Programs.
{ Click HDPS .
{ Click Backup and Recovery Administrative Console.
2. From the CommCell Browser, click Tools | Add/Remove Software | Install Software.
3. Click Next.
4. Click Next.
Use this procedure to install the software by specifying installation settings and options.
Method 1: Install Software from CommCell Console
5. Click Manually Select Computers.
Click Next.
6. Enter the fully qualified domain name of the client computer.
For example: mycomputer.mydomain.mycompany.com Click Next.
{ Do not use space and the following characters when specifying the Host Name:
\|`~!_@#$%^&*()+=<>/?,[]{}:;'"
7. Choose one of the following:
{ Click Next if you want to use the default cache location
{ Click Override Software Cache and specify a new location in the Software Cache box and then click Next
8. Specify the User Name and Password that must be used to access the client computer, and then click Next.
z The software cache is the location from where the remote install program installs the software.
z This screen will not appear if the remote cache is not configured. For more information, see Managing Cache - Remote Cache.
z The user must be an Administrator or a member of the Administrator group on that computer.
z Account information is required while performing remote installs for the first time on a client. For subsequent remote installs on that client, click Next without specifying the account information.
9. Click SharePoint iDataAgent.
Click Next
10. Select the following:
{ Select a client group from the available Client Groups, and then click Add.
{ From the Global Filters list, select one of the following:
Use Cell level Policy to inherit the global filter policy configuration set for the CommCell.
Always use Global Filters to apply the global filters policy to the default subclient regardless of the policy set for the CommCell.
Do not use Global Filters if you plan to define specific filters for the Agent.
{ From the Storage Policy To Use list, select a storage policy.
{ Click Next.
This screen will not be displayed if Client Groups are not configured in the CommCell Console. For more information, see Client Computer Groups.
11. In the Server Name box, enter the name of the SharePoint Server.
Click Change.
12. Type the login credentials for the SharePoint Farm Administrator and click OK.
13. Click Next.
14. Click Next.
If necessary you can select additional options. Click the Help button to get more information on the available options.
15. Click Next.
If necessary you can select additional options. Click the Help button to get more information on the available options.
16. Select one of the following:
{ If firewall configuration is not required, click Next.
{ If this computer and the CommServe is separated by a firewall, click Configure firewall services.
For firewall options and configuration instructions, see Firewall Configuration and continue with the installation.
17. Select Immediate.
Click Next.
18. Click Finish.
19. You can track the progress of the job from the Job Controller window of the CommCell console.
{ From the Home menu, click Job Controller.
{ Once the job is complete, view the job details from the Admin Job History.
Right-click the <CommServe>, point to View and then click Admin Job History.
Click Select Install/Upgrade/Remove/Repair Software.
Click OK.
This screen will reflect the components you selected for install, and may look different from the example shown.
{ You can view the following by right-clicking the job:
Details of the job
Option to Resubmit the job
Events associated with the job
Logs associated with the job
Option to send the Logs associated with the job
20. To create a storage policy, you must have configured a library in the CommCell.
z If you do not already have a library configured, go to Disk Library Creation.
z If you have a library configured, go to Storage Policy Creation.
DISK LIBRARY CREATION:
1. From the CommCell Browser, navigate to Storage Resources, right-click the Libraries, point to Add and then click Disk Library...
Alternatively, you can also navigate to MediaAgents, right-click <MediaAgent>, point to All Tasks | Create Library and then click Disk Library...
2. From the Add Disk Library dialog box, specify the following:
In the Name box, specify name of the disk library.
In the Disk Device box, type the name of the folder in which the disk library must located or click button to select the folder.
Select Network Path, if you wish to specify a network path as the target share.
In the Connect As box, type the user name.
In the Password and Verify Password box, type the password to access the network share.
In the Folder box, type the mount path or click button to select a mount path.
Click OK.
3. The newly created disk library will be displayed under Libraries node.
This will create a library and Storage Policy. Click to proceed to the Configuration section.
Storage Policy Creation
1. From the CommCell Browser, navigate to Policies.
2. Right-click the Storage Policies and then click New Storage Policy.
3. Follow the prompts displayed in the Storage Policy Wizard. The required options are mentioned below:
Select the Storage Policy type as Data Protection and Archiving and click Next.
Enter the name in the Storage Policy Name box and click Next.
From the Library list, click the name of a disk library to which the primary copy should be associated and then click Next.
Ensure that you select a library attached to a MediaAgent operating in the current release.
From the MediaAgent list, click the name of a MediaAgent that will be used to create the primary copy and then click Next.
For the device streams and the retention criteria information, click Next to accept default values.
Select Yes to enable deduplication for the primary copy.
From the MediaAgent list, click the name of the MediaAgent that will be used to host the Deduplication Database (DDB).
In the Location box, type the name of the folder in which the DDB must be located or click the Browse button to select the folder and then click Next.
Review the details and click Finish to create the Storage Policy.
This will create a storage policy. Click to proceed to the Configuration section.
Several additional options are available for remotely installing the software from CommCell Console, refer to Install Software from the CommCell Console (Remote Install) for more information.
1. Log on to the client computer as an Administrator or as a member of the Administrator group on that computer.
2. Run SetupAll.exe from the Software Installation Discs.
3. Click I accept the terms in the license agreement.
Click Next.
4. Click Standard.
Method 2: Interactive Install - Standard
5. Click Join an Existing CommCell.
Click Next.
6. Click SharePoint.
Click Next.
7. Verify the default location for software installation.
Click Next.
If necessary, click Browse... to change the default location.
{ Do not install the software to a mapped network drive
{ Do not use the following characters when specifying the destination path: / : * ? " < > | # { It is recommended that you use alphanumeric characters only
8. Click Install.
The Summary on your screen should reflect the components you selected for install, and may look different from the example shown.
9. Click Yes.
10. Click Reboot Now.
11. Select Resume Unfinished Installation and click Next.
12. Click Next.
13. Select one of the following:
{ If firewall configuration is not required, click Next.
{ If this computer and the CommServe is separated by a firewall, click Configure firewall services.
For firewall options and configuration instructions, see Firewall Configuration and continue with the installation.
14. Enter the fully qualified domain name of the CommServe in the CommServe Host Name box.
{ Do not use space and the following characters when specifying the CommServe Host Name:
\|`~!@#$%^&*()+=<>/?,[]{}:;'"
Click Next.
15. Enter the following:
{ The local (NetBIOS) name of the client computer is displayed in the Select a Client name list.
If necessary you can also type a new (friendly) name for the client in this box. This name will be used in the CommCell and will also be displayed in the CommCell Console.
Do not use spaces when specifying a new name for the client.
{ The default network interface name of the client computer is displayed if the computer has only one network interface (NIC card).
If the computer has multiple network interfaces, select the interface name that is preferred for communication with the CommServe.
Click Next.
If a component is already installed on this computer, this screen will not be displayed; instead, the install program will use the same name as previously specified.
16. Select one of the following options:
{ If you do not want to disable Windows Firewall, click Next.
{ If you want to disable Windows Firewall for all profiles, click Yes, disable Windows Firewall for all profiles and then click Next.
17. Select a Client Group.
Click Next.
You will get this screen if you did not configure the firewall settings in step 13.
This screen will not be displayed if Client Groups are not configured in the CommCell Console. For more information, see Client Computer Groups.
18. Select a storage policy from the Storage Policy list.
Click Next.
19. Enter the name of the Microsoft SharePoint Server and click Next.
z If you do not have a Storage Policy, the list will not be displayed. You can create the Storage Policy later in step 22.
z Select the Configure for Laptop or Desktop Backup option to install Backup Monitor utility.
This utility allows you to view the backup job summary from the client computer without opening the CommCell Console. See Monitor - Laptop User for more information.
20. Enter the Administrator account information for the SharePoint Server and click Next.
21. Click Finish.
This screen will reflect the components you selected for install, and may look different from the example shown.
22. To create a storage policy, you must have configured a library in the CommCell.
z If you do not already have a library configured, go to Disk Library Creation.
z If you have a library configured, go to Storage Policy Creation.
DISK LIBRARY CREATION:
1. From the CommCell Browser, navigate to Storage Resources, right-click the Libraries, point to Add and then click Disk Library...
Alternatively, you can also navigate to MediaAgents, right-click <MediaAgent>, point to All Tasks | Create Library and then click Disk Library...
2. From the Add Disk Library dialog box, specify the following:
In the Name box, specify name of the disk library.
From the MediaAgent list, select the MediaAgent.
Perform one of the following:
Select Local Path if you wish to specify a local path in the MediaAgent computer.
In the Disk Device box, type the name of the folder in which the disk library must located or click button to select the folder.
Select Network Path, if you wish to specify a network path as the target share.
In the Connect As box, type the user name.
In the Password and Verify Password box, type the password to access the network share.
In the Folder box, type the mount path or click button to select a mount path.
Click OK.
3. The newly created disk library will be displayed under Libraries node.
This will create a library and Storage Policy. Click to proceed to the Configuration section.
Storage Policy Creation
If you already have a storage policy selected in step 18, click to proceed to the Configuration section.
If you do not have Storage Policy created, continue with the following step.
2. Right-click the Storage Policies and then click New Storage Policy.
3. Follow the prompts displayed in the Storage Policy Wizard. The required options are mentioned below:
Select the Storage Policy type as Data Protection and Archiving and click Next.
Enter the name in the Storage Policy Name box and click Next.
From the Library list, click the name of a disk library to which the primary copy should be associated and then click Next.
Ensure that you select a library attached to a MediaAgent operating in the current release.
From the MediaAgent list, click the name of a MediaAgent that will be used to create the primary copy and then click Next.
For the device streams and the retention criteria information, click Next to accept default values.
Select Yes to enable deduplication for the primary copy.
From the MediaAgent list, click the name of the MediaAgent that will be used to host the Deduplication Database (DDB).
In the Location box, type the name of the folder in which the DDB must be located or click the Browse button to select the folder and then click Next.
Review the details and click Finish to create the Storage Policy.
This will create a storage policy. Click to proceed to the Configuration section.
Default Options Selected During Standard Install
Listed below are the default options that are automatically selected while performing the Standard Install.
OPTION ENABLED /
DISABLED
DESCRIPTION
Add programs to the Windows Firewall Exclusion ListDisabled This option allows you to add Data Protection Suite programs to the Windows Firewall exclusion list.
This option is not selected.
Global Filter Options Enabled This option is used to filter out specific directories or files from the backups within the CommCell. The filters are set using the Control Panel in the
Components installed by default during Standard Install
Listed below are the components that are installed by default while performing the Standard Install:
1. Log on to the client computer as an Administrator or as a member of the Administrator group on that computer.
2. Run SetupAll.exe from the Software Installation Discs.
3. Click I accept the terms in the license agreement.
Click Next.
4. Click Custom.
Click Next.
SELECTED PACKAGE COMPONENTS INSTALLED
SharePoint Agent z SharePoint iDataAgent
z File System Core z Windows File System
Method 3: Interactive Install - Custom
5. Click Select components to install on this computer and click Next.
6. Expand SharePoint, and then click SharePoint iDataAgent.
Click Next.
7. Verify the default location for software installation.
Click Next.
If necessary, click Browse... to change the default location.
{ Do not install the software to a mapped network drive
{ Do not use the following characters when specifying the destination path: / : * ? " < > | # { It is recommended that you use alphanumeric characters only
8. Click Install.
9. Click Yes.
10. Click Reboot Now.
The Summary on your screen should reflect the components you selected for install, and may look different from the example shown.
11. Select Resume Unfinished Installation and click Next.
12. Click Next.
13. Select one of the following:
{ If firewall configuration is not required, click Next.
{ If this computer and the CommServe is separated by a firewall, click Configure firewall services.
For firewall options and configuration instructions, see Firewall Configuration and continue with the installation.
14. Enter the fully qualified domain name of the CommServe in the CommServe Host Name box.
{ Do not use space and the following characters when specifying the CommServe Host Name:
\|`~!@#$%^&*()+=<>/?,[]{}:;'"
Click Next.
15. Enter the following:
{ The local (NetBIOS) name of the client computer is displayed in the Select a Client name list.
If necessary you can also type a new (friendly) name for the client in this box. This name will be used in the CommCell and will also be displayed in the CommCell Console.
Do not use spaces when specifying a new name for the client.
{ The default network interface name of the client computer is displayed if the computer has only one network interface (NIC card).
Click Next.
16. Select one of the following options:
{ If you do not want to disable Windows Firewall, click Next.
{ If you want to disable Windows Firewall for all profiles, click Yes, disable Windows Firewall for all profiles and then click Next.
17. Select Add programs to the Windows Firewall Exclusion List, to add CommCell programs and services to the Windows Firewall Exclusion List.
Click Next.
If a component is already installed on this computer, this screen will not be displayed; instead, the install program will use the same name as previously specified.
This option enables CommCell operations across Windows firewall by adding CommCell programs and services to Windows firewall exclusion list.
It is recommended to select this option even if Windows firewall is disabled. This will allow the CommCell programs and services to function if the Windows firewall is enabled at a later time.
18. Select a Client Group.
Click Next.
19. Select one of the following:
{ Click Use Cell level Policy to inherit the global filter policy configuration set for the CommCell.
{ Click Always use Global Filters to apply the global filters policy to the default subclient regardless of the policy set for the CommCell.
{ Select Do not use Global Filters if you plan to define specific filters for the Agent.
Click Next.
This screen will not be displayed if Client Groups are not configured in the CommCell Console. For more information, see Client Computer Groups.
20. Select a storage policy from the Storage Policy list.
Click Next.
21. Enter the name of the Microsoft SharePoint Server and click Next.
z If you do not have a Storage Policy, the list will not be displayed. You can create the Storage Policy later in step 24.
z Select the Configure for Laptop or Desktop Backup option to install Backup Monitor utility.
This utility allows you to view the backup job summary from the client computer without opening the CommCell Console. See Monitor - Laptop User for more information.
22. Enter the Administrator account information for the SharePoint Server and click Next.
23. Click Finish.
This screen will reflect the components you selected for install, and may look different from the example shown.
24. To create a storage policy, you must have configured a library in the CommCell.
z If you do not already have a library configured, go to Disk Library Creation.
z If you have a library configured, go to Storage Policy Creation.
DISK LIBRARY CREATION:
1. From the CommCell Browser, navigate to Storage Resources, right-click the Libraries, point to Add and then click Disk Library...
Alternatively, you can also navigate to MediaAgents, right-click <MediaAgent>, point to All Tasks | Create Library and then click Disk Library...
2. From the Add Disk Library dialog box, specify the following:
In the Name box, specify name of the disk library.
From the MediaAgent list, select the MediaAgent.
Perform one of the following:
Select Local Path if you wish to specify a local path in the MediaAgent computer.
In the Disk Device box, type the name of the folder in which the disk library must located or click button to select the folder.
Select Network Path, if you wish to specify a network path as the target share.
In the Connect As box, type the user name.
In the Password and Verify Password box, type the password to access the network share.
In the Folder box, type the mount path or click button to select a mount path.
Click OK.
3. The newly created disk library will be displayed under Libraries node.
This will create a library and Storage Policy. Click to proceed to the Configuration section.
If you already have a storage policy selected in step 20, click to proceed to the Configuration section.
If you do not have Storage Policy created, continue with the following step.
2. Right-click the Storage Policies and then click New Storage Policy.
3. Follow the prompts displayed in the Storage Policy Wizard. The required options are mentioned below:
Select the Storage Policy type as Data Protection and Archiving and click Next.
Enter the name in the Storage Policy Name box and click Next.
From the Library list, click the name of a disk library to which the primary copy should be associated and then click Next.
Ensure that you select a library attached to a MediaAgent operating in the current release.
From the MediaAgent list, click the name of a MediaAgent that will be used to create the primary copy and then click Next.
For the device streams and the retention criteria information, click Next to accept default values.
Select Yes to enable deduplication for the primary copy.
From the MediaAgent list, click the name of the MediaAgent that will be used to host the Deduplication Database (DDB).
In the Location box, type the name of the folder in which the DDB must be located or click the Browse button to select the folder and then click Next.
Review the details and click Finish to create the Storage Policy.
This will create a storage policy. Click to proceed to the Configuration section.
25. If you have installed on a clustered computer, make sure to install the software on all the physical nodes and then follow the steps described in Cluster Configuration.
Custom Package
Create a compact software package for quick deployment to multiple clients.
Decoupled Install
Install the software first and later register the client in the CommCell.
Remote Install
Deploy the software from CommCell Console on multiple clients.
Installing Restore only Agents
Additional Installation Methods
Setup a client in the CommCell for restore purposes.
Silent Install
Deploy the software silently on multiple clients.
Getting Started - SharePoint Server iDataAgent
The following backup sets are supported for SharePoint Server iDataAgent. Configure these backup sets as needed, based on your SharePoint environment and restore needs. Click the name of a backup set to continue.
Overview Deployment Configuration Decision
BACKUP SET TYPE DESCRIPTION
Database Added by default during deployment. Items that are visible in the Central Administration under Farm Backup such as Farm Configuration Database, Web Application, Service Applications etc are backed up.
Ensure to exclude the SharePoint Services Applications from SQL Server backups, which are being backed up using the SharePoint Server iDataAgent.
Document This Backup Set is added by default during deployment. It backups up components like lists, document libraries etc.
The following components are not backed up using the Document Backup Set and therefore it is recommended to use Site Collection Backup set:
Alerts, Workflows, Recycle Bin and Events.
Site Collection Must be created under SharePoint Server iDataAgent. Use for backing up and restoring an entire site collection. This backup set provides faster backups than the document backup set, but it cannot restore individual items.
Getting Started - SharePoint Server iDataAgent- Database
The default subclient will backup the complete farm, therefore it is recommended to configure a user-defined subclient and assign a database to run your first backup.
1. From the CommCell Browser, navigate to <Client> | SharePoint Server | Databases.
Right-click Databases | All Tasks and click New Subclient.
2. In the General tab, enter the <Subclient Name>.
3. Click the Content tab.
Click the Browse button.
Click to select a <Database>.
Configuration Backup Restore
4. Click the Storage Device tab.
Select the Storage Policy from the drop down list.
Click Ok.
5. Perform the following steps to create a storage policy.
a. Click Create Storage Policy.
being backed up using the SharePoint Server iDataAgent.
If you do not have a Storage Policy created, follow the steps given below to create a Storage Policy.
i. Select the Storage Policy type as Data Protection and Archiving and click Next.
ii. Enter the name in the Storage Policy Name box and click Next.
iii. From the Library list, click the name of a disk library to which the primary copy should be associated and then click Next.
Ensure that you select a library attached to a MediaAgent operating in the current release.
iv. From the MediaAgent list, click the name of a MediaAgent that will be used to create the primary copy and then click Next.
v. For the device streams and the retention criteria information, click Next to accept default values.
vi. Select Yes to enable deduplication for the primary copy.
vii. From the MediaAgent list, click the name of the MediaAgent that will be used to host the Deduplication database (DDB).
In the Location box, type the name of the folder in which the DDB must be located or click the Browse to select the folder, and then click Next.
viii. Review the details and click Finish to create the Storage Policy.
Return to Step 4 to associate the Storage Policy to the subclient.
Getting Started - SharePoint Server iDataAgent - Database
Follow the steps given below to perform the first backup:
1. From the CommCell Console navigate to Client Computers | <Client> | SharePoint Server, and then click Databases.
In the right-pane, right-click the <Newly Created Subclient> and click Backup.
2. Ensure under Select Backup Type, Full is selected.
Under Job Initiation, Immediate is selected.
Click Ok.
3. In the Job Controller tab, track the process of your backup job.
Wait until the job has completed before you perform the next steps.
4. In the Databases tab, right-click <Newly Created Subclient>, and then click Backup History.
Configuration Backup Restore
\ 5. In the Backup History Filter dialog box, click OK.
6. In the Backup History tab, right-click the backup job to view the following job details:
{ Items that failed during the job { Items that succeeded during the job { Details of the job
{ Events of the job { Log files of the job
{ Media associated with the job
Getting Started - SharePoint Server iDataAgent - Database
Restoring your backed up data is crucial, therefore you should perform a restore operation immediately after your first full backup.
1. From the CommCell Console navigate to Client Computers | <Client> | SharePoint Server, and then click Databases.
In the right-pane, right-click the <Newly Created Subclient> and click Browse and Restore.
2. Click View Content.
3. In the left pane of the Client tab, expand Databases, click to select the backed up database and click Recover All Selected.
4. Click the Web Application tab and enter the password.
Configuration Backup Restore
5. In the Job Controller tab, track the process of your restore job.
6. Once the restore job has completed, right-click Database, point to View and then click Restore History.
7. Click Ok.
8. You can right-click the job and view the following details:
{ View Restore Items
You can view them as Successful, Failed, Skipped or All.
{ View Job Details
{ View Events of the restore job { View Log files of the restore job
Congratulations - You have successfully completed your first backup and restore.
If you want to further explore this Agent's features read the Advanced sections of this documentation.
Getting Started - SharePoint Server iDataAgent -
Documents
The default subclient will backup all document folders, therefore it is recommended to configure a user-defined subclient and assign a document library to run your first backup.
1. From the CommCell Browser, navigate to <Client> | SharePoint Server | Document.
Right-click Document | All Tasks and click New Subclient.
2. In the General tab, enter the <Subclient Name>.
Configuration Backup Restore
3. Click the Content tab.
Click the Browse button.
Click to select a <Library>.
Click Add and then click Close.
4. Click the Storage Device tab.
Select the Storage Policy from the drop down list.
Click Ok.
If you do not have a Storage Policy created, follow the steps given below to create a Storage Policy.
5. Perform the following steps to create a storage policy.
a. Click Create Storage Policy.
b. Follow the prompts displayed in the Storage Policy Wizard. The required options are mentioned below:
i. Select the Storage Policy type as Data Protection and Archiving and click Next.
ii. Enter the name in the Storage Policy Name box and click Next.
iii. From the Library list, click the name of a disk library to which the primary copy should be associated and then click Next.
Ensure that you select a library attached to a MediaAgent operating in the current release.
iv. From the MediaAgent list, click the name of a MediaAgent that will be used to create the primary copy and then click Next.
v. For the device streams and the retention criteria information, click Next to accept default values.
vi. Select Yes to enable deduplication for the primary copy.
vii. From the MediaAgent list, click the name of the MediaAgent that will be used to host the Deduplication database (DDB).
In the Location box, type the name of the folder in which the DDB must be located or click the Browse to select the folder, and then click Next.
viii. Review the details and click Finish to create the Storage Policy.
Return to Step 4 to associate the Storage Policy to the subclient.
Getting Started - SharePoint Server iDataAgent -
Documents
Follow the steps given below to perform the first backup:
1. From the CommCell Console navigate to Client Computers | <Client> | SharePoint Server, and then click Document.
In the right-pane, right-click the <Newly Created Subclient> and click Backup.
2. Select Full under Select Backup Type.
Under Job Initiation, Immediate is selected.
Click Ok.
3. In the Job Controller tab, track the process of your backup job.
Wait until the job has completed before you perform the next steps.
4. In the Documents tab, right-click <Newly Created Subclient>, and then click Backup History.
Configuration Backup Documents Restore
\ 5. In the Backup History Filter dialog box, click OK.
6. In the Backup History tab, right-click the backup job to view the following job details:
{ Items that failed during the job { Items that succeeded during the job { Details of the job
{ Events of the job { Log files of the job
{ Media associated with the job
Getting Started - SharePoint Server iDataAgent-
Documents
Restoring your backed up data by following the steps given below:
1. From the CommCell Console navigate to Client Computers | <Client> | SharePoint Server, and click Document.
In the right-pane, right-click the <Newly Created Subclient> and click Browse and Restore.
2. Click View Content.
3. In the left pane of the Client tab, expand Documents, click to select the backed up documents and click Recover All Selected.
Configuration Backup Restore
5. In the Job Controller tab, track the process of your restore job.
6. Once the restore job has completed, right-click Database, point to View and then click Restore History.
7. Click Ok.
8. You can right-click the job and view the following details:
{ View Restore Items
You can view them as Successful, Failed, Skipped or All.
{ View Job Details
{ View Events of the restore job { View Log files of the restore job
Congratulations - You have successfully completed your first backup and restore.
If you want to further explore this Agent's features read the Advanced sections of this documentation.
Getting Started - SharePoint Server iDataAgent - Site
Collection
It is recommended to configure a user-defined Site Collection backup set and create a user-defined subclient to run your first Site Collection backup.
1. From the CommCell Browser, navigate to <Client> | SharePoint Server.
Right-click SharePoint Server | All Tasks and click Create New Backup Set.
2. Enter the <Backup Set> name.
Select a Storage Policy from the available list.
From under Choose Backup Set Type, click to select Site Collection.
3. From the CommCell Browser, navigate to <Client> | SharePoint Server | <Site Collection Backup Set>.
Right-click <Site Collection Backup Set> | All Tasks and click New Subclient.
Configuration Backup Restore
4. In the General tab, enter the <Subclient Name>.
5. Click the Content tab.
Click the Browse button.
Click to select a <Site Collection>.
Click Add and then click Close.
6. Click the Storage Device tab.
Select the Storage Policy from the drop down list.
Click Ok.
7. Perform the following steps to create a storage policy.
a. Click Create Storage Policy.
b. Follow the prompts displayed in the Storage Policy Wizard. The required options are mentioned below:
i. Select the Storage Policy type as Data Protection and Archiving and click Next.
ii. Enter the name in the Storage Policy Name box and click Next.
If you do not have a Storage Policy created, follow the steps given below to create a Storage Policy.
Ensure that you select a library attached to a MediaAgent operating in the current release.
iv. From the MediaAgent list, click the name of a MediaAgent that will be used to create the primary copy and then click Next.
v. For the device streams and the retention criteria information, click Next to accept default values.
vi. Select Yes to enable deduplication for the primary copy.
vii. From the MediaAgent list, click the name of the MediaAgent that will be used to host the Deduplication database (DDB).
In the Location box, type the name of the folder in which the DDB must be located or click the Browse to select the folder, and then click Next.
viii. Review the details and click Finish to create the Storage Policy.
Return to Step 6 to associate the Storage Policy to the subclient.
Getting Started - SharePoint Server iDataAgent - Site
Collection
Follow the steps given below to perform the first backup:
1. From the CommCell Console navigate to Client Computers | <Client> | SharePoint Server, and then click <Site Collection Backup Set>.
In the right-pane, right-click the <Newly Created Subclient> and click Backup.
2. Ensure that Full is selected under Select Backup Type.
Ensure that under Job Initiation, Immediate is selected.
Click Ok.
3. In the Job Controller tab, track the process of your backup job.
Wait until the job has completed before you perform the next steps.
4. In the Site Collection tab, right-click <Newly Created Subclient>, and then click Backup History.
Configuration Backup Restore
\ 5. In the Backup History Filter dialog box, click OK.
6. In the Backup History tab, right-click the backup job to view the following job details:
{ Items that failed during the job { Items that succeeded during the job { Details of the job
{ Events of the job { Log files of the job
{ Media associated with the job
Getting Started - SharePoint Server iDataAgent - Site
Collection
Restoring your backed up data is crucial, therefore you should perform a restore operation immediately after your first full backup.
1. From the CommCell Console navigate to Client Computers | <Client> | SharePoint Server, and then click <Site Collection Backup Set>.
In the right-pane, right-click the <Newly Created Subclient> and click Browse and Restore.
2. Click View Content.
3. In the left pane of the Client tab, expand Site, click to select the backed up site and click Recover All Selected.
Configuration Backup Restore
5. In the Job Controller tab, track the process of your restore job.
6. Once the restore job has completed, right-click Site Collection Backup Set, point to View and then click Restore History.
7. Click Ok.
8. You can right-click the job and view the following details:
{ View Restore Items
You can view them as Successful, Failed, Skipped or All.
{ View Job Details
{ View Events of the restore job { View Log files of the restore job
Congratulations - You have successfully completed your first backup and restore.
If you want to further explore this Agent's features read the Advanced sections of this documentation.
Advanced Configuration - SharePoint Server iDataAgent -
Databases
The Microsoft SharePoint Server iDataAgent uses the following logical entities to manage backup and restore operations from the CommCell Console.
Agent
Table of Contents
SharePoint 2013 SharePoint 2010 Search Server 2008 SharePoint 2007 Microsoft Search Server 2013 Microsoft SharePoint Foundation 2010
SharePoint Server 2010 (Standard and Enterprise)
Microsoft Office Project Server 2010 Fast Search Server 2010 for SharePoint Microsoft Search Server 2010
Microsoft Search Server 2010 Express
Microsoft Search Server 2008 Microsoft Search Server 2008 Express
Microsoft Office SharePoint Server (MOSS) 2007 Microsoft Office Project Server 2007
Microsoft Office Forms Server 2007
Understanding the CommCell Console
Creating User-Defined Backup Sets
Creating User-Defined Subclients
Setting Object Identity for Out-of-Place Restores Configuring Backups for Windows SharePoint Services (WSS) Environments
Configuring Backups for Content Databases Configuring Pre/Post Processing for Backups
Setting up Pre/Post Processes Setting Post Backup Processes to Run During Failures Configuring User Accounts
At the Agent Level
Modifying an Agent, Backup Set, or Subclient
Deleting an Agent, Backup Set, or Subclient
Deleting an Agent Deleting a Backup Set Deleting a Subclient
Understanding the CommCell Console
Creating User-Defined Backup Sets
Creating User-Defined Subclients Setting Object Identity for Out-of- Place Restores
Configuring Backups for Windows SharePoint Services (WSS) Environments
Configuring Backups for Content Databases
Configuring Pre/Post Processing for Backups
Setting up Pre/Post Processes Setting Post Backup Processes to Run During Failures
Configuring User Accounts At the Agent Level
Modifying an Agent, Backup Set, or Subclient
Deleting an Agent, Backup Set, or Subclient
Deleting an Agent Deleting a Backup Set Deleting a Subclient
Understanding the CommCell Console
Creating User-Defined Backup Sets
Creating User-Defined Subclients
Setting Object Identity for Out- of-Place Restores
Configuring Backups for Windows SharePoint Services (WSS) Environments
Configuring Backups for Content Databases Configuring Pre/Post Processing for Backups
Setting up Pre/Post Processes Setting Post Backup Processes to Run During Failures
Configuring User Accounts At the Agent Level
Modifying an Agent, Backup Set, or Subclient
Deleting an Agent, Backup Set, or Subclient
Deleting an Agent Deleting a Backup Set Deleting a Subclient
Understanding the CommCell Console Creating User-Defined Backup Sets
Creating User-Defined Subclients
Setting Object Identity for Out-of-Place Restores
Configuring Backups for Windows
SharePoint Services (WSS) Environments Configuring Backups for Content Databases Configuring Pre/Post Processing for Backups
Setting up Pre/Post Processes
Setting Post Backup Processes to Run During Failures
Configuring User Accounts
At the Agent Level Modifying an Agent, Backup Set, or Subclient
Deleting an Agent, Backup Set, or Subclient
Deleting an Agent Deleting a Backup Set Deleting a Subclient
Understanding the CommCell Console
Database Backup Set
Defines the entities and information that are required to back up entire databases.
Document Backup Set
Defines all files and folders on the SharePoint server so that you can restore individual SharePoint files without restoring the entire database.
Site Collection Backup Set
Defines all the Site Collections that you can backup without backing up the entire database.
Subclient
Defines the contents of a backup operation, depending on whether the backup set includes databases or documents on the SharePoint server.
You can create user-defined backup sets that contain any number of databases that exist within the SharePoint server. You can use a
Databases backup set to group SharePoint databases and database components into separate entities with their own unique backup schedules.
For example, this is useful if you need to back up databses more frequently than others.
To create a Databases backup set:
1. From the CommCell Browser, expand Client Computers | <Client>.
2. Right-click SharePoint Server, point to All Tasks, and then click Create New Backup Set.
3. In the New Backup Set Name box, type a name.
4. In the Choose Backup Set Type section, select SharePoint Server Database.
5. From the Storage Policy list, click a storage policy name.
6. Click OK.
Creating User-defined Backup Sets
When you create a user-defined backup set, the contents of the user-defined backup set will be excluded from the Default backup set.
In many cases, large databases might contain portions of data that require more frequent backups than others. For example, tables that consist of records that are entered on a daily basis might require nightly backups, whereas tables that consist of records that are entered on a quarterly basis might require only monthly backups. You can create different subclients in order to assign different backup schedules to certain entities and to group entities for restore operations. Databases subclients can include the following:
z Configuration databases z Service applications
z Windows SharePoint Services Web applications z Service application proxies
To create a user-defined Databases subclient:
1. From the CommCell Browser, navigate to Client Computers | <Client> | SharePoint Server.
2. Right-click Databases, point to All Tasks, and then click New Subclient.
3. In the Subclient Name box, type a name for the subclient.
4. Click the Storage Device tab.
5. On the Data Storage Policy sub-tab in the Storage Policy list, click a storage policy name.
6. Click the Contents tab and then click Configure.
7. In the Add/Modify Subclient Content dialog box, select the databases or other entities that you want to include in the subclient.
8. In the Change all selected data types to list, select the name of the subclient that you entered in step 3.
9. Click OK.
10. Click OK.
By default during an Out-of-Place restore the object identity is not retained. However, you can configure this additional setting to retain the object identity of a SharePoint site's URL. Follow the steps given below to set the additional settings:
1. From the CommCell Browser, navigate to Client Computers.
2. Right-click the <Client> and then click Properties.
3. On the Client Computer Properties dialog box, click Advanced.
When you create a user-defined subclient, the contents of the user-defined subclient will be excluded from the Default subclient.
Setting Object Identity for Out-of-Place Restores
5. Click Add.
6. In the Name box, type bSiteImportRetainObjectIdentity. The Category and Type details will be automatically populated.
Alternatively, you can click Lookup and search for the additional setting using the Find box.
7. In the Value field, enter 1 to enable.
8. Click OK.
If you want to back up a SharePoint Database in a Windows SharePoint Services (WSS) environment, where the instance name of the Windows Internal Database is in the format, MachineName\Microsoft##SSEE, set the following options:
1. In SQL Server Configuration Manager|Protocols for <MachineName\Microsoft##SSEE>, change the Hide Instance flag to No.
2. In SQL Server Configuration Manager | SQLServer 2005 Services, run the SQL Server Browser service.
3. In SQL Server Configuration Manager|Protocols for <MachineName\Microsoft##SSEE>, set Named Pipes to active.
By default the Content databases are excluded from backups operation. We recommend to use the SQL Server iDataAgent to backup the Content Databases. However, you can configure to backup the content databases using the SharePoint Server iDataAgent as follows:
1. From the CommCell Browser, navigate to Client Computers |<Client>
2. Right-click SharePoint Server and then click Properties.
3. Clear the Exclude Content Databases checkbox.
Configuring Backups for Windows SharePoint Services (WSS)
Environments
Configuring Backups for Content Databases
You can add and modify Pre/Post processes for a subclient. These are batch files or shell scripts that you can run before or after certain job phases. For example, you can use an echo command to check the level of a backup. Similarly, you can include a case statement within a script to run specific operations based on the level of the backup job.
A Save As Script file can also be run as a pre/post process, if you include the absolute path of the associated input file in the script file.
Setting up Pre/Post Processes
1. From the CommCell Browser, expand Client Computers | <Client> | SharePoint Server, and then click <Backup Set>.
2. In the <Backup Set> tab, right-click the <Subclient>, and then click Properties.
3. In the Subclient Properties dialog box, click the Pre/Post Process tab.
4. To set up a Pre Backup process, next to the PreBackup process box, click Browse, and then select a process.
5. Click OK to save your selection.
Configuring Pre/Post Processing for Backups
6. To set up a Post Backup process, next to the PostBackup process box, click Browse, and then select a process.
7. Click OK to save your selection.
8. Click OK.
Setting Post Backup Processes to Run During Failures
By default, a specified post process command is executed only on successful completion of the backup operation or if the job is killed.
Use the following steps to run a post process even if the backup operation did not complete successfully. For example, this may be useful to bring a database online or release a snapshot.
1. From the CommCell Browser, expand Client Computers | <Client> | SharePoint Server, and then click <Backup Set>.
