Using ConfigureSharePoint

  • Article

Applies To: System Center 2012 - Data Protection Manager, System Center 2012 R2 Data Protection Manager, System Center 2012 SP1 - Data Protection Manager

Before you begin to protect a SharePoint farm, you must configure protection for SharePoint by using the ConfigureSharePoint.exe tool.

In DPM, ConfigureSharePoint.exe is a tool that is required to be run on the front-end Web server from where you plan to protect SharePoint farm data. The ConfigureSharePoint.exe file can be found in the <DPM Installation Path>\bin folder on the front-end Web server. This tool must be run in the following scenarios:

  • Before you begin to protect a SharePoint farm

  • Change in SharePoint farm administrator password

  • Change in SharePoint farm administrator account

Permissions

To run the ConfigureSharePoint.exe tool, ensure that you meet the following prerequisites:

  • You must be a member of the Administrators group on the local computer to run this tool.

  • You must run this tool from an elevated command prompt.

The ConfigureSharePoint.exe tool provides the following permissions to the farm administrator on the front-end Web server:

  • Read and Execute to all DPM directories: DPM has to load the DLLs from the DPM Bin directory when WSSCmdletWrapper.exe runs.

  • Read, Execute, and Write (all) access on the Temp directory in the DPM directory: DPM has to create a directory inside the DPM Temp directory where item-level catalog dumps are created. DPM also creates a log file, WSSCmdletWrapperCurr.errlog, inside the DPM Temp directory.

  • Read permissions to the DPM hive in the registry.

Syntax

ConfigureSharePoint [-EnableSharePointProtection] [-EnableSPSearchProtection] [-ResolveAllSQLAliases] [-SetTempPath <path>]

Note

To run this command, you must be a local administrator on the front-end Web server. In Windows Server 2008 and later versions, ensure that you run this command from an elevated command prompt.

Parameters

Parameter Description

EnableSharePointProtection
  • To enable SharePoint farm protection using a DPM server, you must ensure that you run this option on the front-end Web server from where you plan to protect SharePoint farm data.

    Do not run this option on more than one front-end Web server.

    To run this option on multiple servers, run the command “Stsadm –o unregisterwsswriter” on the front-end Web servers from where you do not plan to protect SharePoint farm data.

This option performs the following:

  • Enables the SharePoint VSS writer required for SharePoint farm protection.

  • Registers the identity of the DCOM application WssCmdletsWrapper to run as a user whose credentials are entered with this option. If you are prompted to enter your user credentials, then enter the credentials of a farm administrator.

EnableSPSearchProtection
  • You must run this option from any one of the front-end Web servers from where you plan to protect the Windows SharePoint Services 3.0/MOSS 2007 Search service. This server can be an indexing service or any other front-end Web server.

    Do not run this option on multiple servers.

    If you want to run this option on multiple servers, then delete the registry key SharePointSearchEnumerationEnabled under HKLM\Software\Microsoft\ Microsoft Data Protection Manager\Agent\2.0\ on the front-end Web server that is not used for protecting SharePoint Search services.

  • Enables the protection of SP Search and MOSS 2007 SSP by using the registry key SharePointSearchEnumerationEnabled under HKLM\Software\Microsoft\ Microsoft Data Protection Manager\Agent\2.0\ on the front-end Web Server.

  • Registers the identity of the DCOM application WssCmdletsWrapper to run as a user whose credentials are entered with this option. If you are prompted to enter your user credentials, then enter the credentials of a farm administrator.

ResolveAllSQLAliases

This option displays all the aliases reported by the SharePoint VSS writer and resolves them to the corresponding SQL Server. It also displays their resolved instance names. If the servers are mirrored, it also displays the mirrored server. It reports all the SQL Server aliases that are not being resolved to a SQL Server.

> [!NOTE] > This option can be run only after you run the ConfigureSharePoint [-EnableSharePointProtection] or ConfigureSharePoint [-EnableSPSearchProtection] command on the front-end Web server. >

SetTempPath

Sets the environment variables TEMP and TMP to the specified path. Item-level recovery fails if a large site collection, site, list, or item is being recovered and there is insufficient space in the farm administrator Temporary folder. This option allows you to change the folder path of the temporary files to a volume that has sufficient space to store the site collection or site being recovered.

-----
For additional resources, see Information and Support for System Center 2012.

Tip: Use this query to find online documentation in the TechNet Library for System Center 2012. For instructions and examples, see Search the System Center 2012 Documentation Library.
-----