Manage content deployment paths and jobs

Applies to: SharePoint Server 2010

A content deployment path creates a connection between a source site collection and a destination site collection. Content deployment uses that connection to publish content from the source site collection to the destination site collection. These site collections can be in the same server farm, or in separate server farms. For information about designing a topology for your content deployment scenario, see Design content deployment topology (SharePoint Server 2010).

You use a content deployment job to schedule moving content along a content deployment path from the source site collection to the destination site collection. You can create jobs to run on schedules that you specify, and you can customize the frequency with which the jobs run to best suit your content publishing requirements.

When you create a content deployment job, you can configure the job to copy the entire source site collection, or only a subset of sites. You can also specify whether the job only deploys new, changed, or deleted content, or have the job deploy all content, including content that was previously deployed in other jobs.

A separate Quick Deploy job enables Web page authors to quickly publish Web pages independently of any scheduled jobs. For information about Quick Deploy jobs, see Manage Quick Deploy jobs.

For an overview of the content deployment feature, how it works, and important considerations for using content deployment with your publishing solution, see Content deployment overview (SharePoint Server 2010). For information about planning content deployment and more information about paths, jobs, and permissions, see Plan content deployment (SharePoint Server 2010).

To create content deployment paths and jobs, perform the following procedures in the order listed:

• Create a new content deployment path

• Create a new content deployment job

After you have created a content deployment path and job, you can perform the following procedures in any order:

• Manually start a content deployment job

• Edit a content deployment path

• Disable or delete a content deployment path

• Edit a content deployment job

• Test a content deployment job

• Cancel a content deployment job

• Delete a content deployment job

Create a new content deployment path

You can create a new content deployment path by using either Central Administration or Windows PowerShell. Use the following procedure to create a new content deployment path by using Central Administration.

Before you perform this procedure, confirm that:

• The Central Administration Web site on the destination server has been configured to accept incoming content deployment jobs.

To create a new content deployment path by using Central Administration

1. Verify that you have the following administrative credentials:

   • You must be a member of the Farm Administrators group on the Central Administration server.

2. On the Central Administration Web site, in the General Application Settings section, click Configure content deployment paths and jobs.

3. On the Manage Content Deployment Paths and Jobs page, click New Path.

4. On the Create Content Deployment Path page, in the Type the name of this path box, type a name for the content deployment path.

5. In the Type the description of the content deployment path box, type a description of the content deployment path.

6. In the Source Web Application and Site Collection section, in the Source web application list, click a source Web application.

7. On the Source site collection menu, click a source site collection.

   The Web application and site collection determine the source location from which the content will be deployed. After you make your selections, the source location is displayed under URL.

8. In the Destination Central Administration Web Application section, in the Type the URL of the Destination Central Administration Server box, type the URL of the destination Central Administration server.

   Note

   This is the URL of the Central Administration Web site in the destination server farm. If the content deployment settings on the Central Administration server were configured to use HTTPS protocol, make sure that the URL to the destination Central Administration Web site begins with https://, or you will be unable to connect to the destination Web site.

9. In the Authentication Information section, select one of the following:

   • Use Integrated Windows authentication   Select this option if you want to use Integrated Windows authentication to connect to the destination server. Credentials sent by using Integrated Windows authentication will be encrypted before being sent to the destination server for authentication.

   • Use Basic authentication   Select this option if you want to use Basic authentication to connect to the destination server. Credentials sent by using Basic authentication are not encrypted, and therefore are not secure.

10. Enter the user name and password for the account that will be used to connect to the destination server, and then click Connect.

    Note

    If the credentials you entered are valid, the message Connection succeeded appears, and a list of eligible destination Web applications and site collections is displayed in the Destination Web Application and site collection section.

11. In the Destination Web Application and site collection section, in the Destination Web application list, click a destination Web application.

    Note

    If you want to deploy to another site collection within the same Web application, be sure the source and destination site collections are in separate content databases.

12. In the Destination Site Collection list, click a destination site collection.

13. In the User Names section, select the Deploy user names check box if you want user names that are associated with content to be included when this path is used for content deployment jobs.

14. In the Security Information section, in the Security information in the content deployment list, click one of the following, and then click OK.

    • All   This is the default selection. All of the security information that is associated with the content is deployed with the content.

    • Role Definitions Only   Only role definitions (role definitions are collections of permissions) are deployed with the content. Users and groups, including those that are associated with the role definitions, are not deployed with the content.

    • None   No security information that is associated with content is deployed with the content.

Use the following procedure to create a new content deployment path by using Windows PowerShell.

To create a new content deployment path by using Windows PowerShell

1. Verify that you meet the following minimum requirements:

   • See Add-SPShellAdmin.

2. On the Start menu, click All Programs, click Microsoft SharePoint 2010 Products, and then click SharePoint 2010 Management Shell.

3. From the Windows PowerShell command prompt (that is, PS C:\>), type the following command and press ENTER after each line of the command:

   $credentials=Get-Credential

   New-SPContentDeploymentPath -Name <Name of the new deployment path> -SourceSPWebApplication <GUID, URL or a valid SPWebApplication object of the source Web application> -SourceSPSite <GUID, URL or a valid SPSite object of the source site> -DestinationCentralAdministrationURL <URL of the Central Administration Web site on the destination server> -DestinationSPWebApplication <GUID, URL or a valid SPWebApplication object of the destination Web application> -DestinationSPSite <GUID, URL or a valid SPSite object of the destination site> -PathAccount $credentials

   Note

   The Get-Credential cmdlet will display a prompt to enter a user name and password. Type the user name and password for the account that will be used to connect to the destination server.

   For more information, including additional parameters you can use, see New-SPContentDeploymentPath. You can also use the New-SPContentDeploymentPath cmdlet in a script. For information, see Scripting with Windows PowerShell.

Create a new content deployment job

You can schedule a content deployment job by selecting the Run this job on the following schedule check box in the Frequency section of the Edit Content Deployment Job page or the Create Content Deployment Job page.

You can schedule the job to run:

• One time only

• Every 15, 30, or 45 minutes

• Once per hour

• Once per day

• Once per week

• Once per month

You can create schedules that are more complex by using the Microsoft Office SharePoint Server 2007 object model. You can also clear the Run this job on the following schedule check box to start the job manually. For information about using the object model to deploy content, see Deploying Content Between Servers.

You can create a new content deployment job by using either Central Administration, or Windows PowerShell. Use the following procedure to create a new content deployment job by using Central Administration.

To create a new content deployment job by using Central Administration

1. Verify that you have the following administrative credentials:

   • You must be a member of the Farm Administrators group on the Central Administration server.

2. On the Central Administration Web site, in the General Application Settings section, click Configure content deployment paths and jobs.

3. On the Manage Content Deployment Paths and Jobs page, click New Job.

4. On the Create Content Deployment Job page, in the Name and Description section, in the Name box, type a name for the content deployment job.

5. In the Description box, type a description for the content deployment job.

6. In the Path section, on the Select a content deployment path menu, click the content deployment path.

7. In the SQL Snapshots section, select one of the following:

   • Do not use SQL snapshots   Select this option if you do not want the job to use SQL Server database snapshots. This option is the default option.

   • Automatically create and manage snapshots for content deployment   Select this option if you want the job to use SQL Server database snapshots.

     Note

     This option is available only if Microsoft SQL Server 2008 Enterprise edition is installed.

8. In the Scope section, select one of the following:

   • Entire site collection   Select this option if you want to include all sites in the site collection in the deployment. This option is the default.

   • Specific sites within the site collection   Select this option if you want to specify sites within the site collection in the deployment. If you select this option, click Select sites to select the sites to include in the deployment.

     Note

     This option creates a scoped content deployment job, and it is assumed that all content in the site hierarchy above the specified scope has already been deployed to the destination. If you select this option for a content deployment job, you must also create a job that deploys the content above the specified level in the hierarchy.

9. In the Frequency section, check the Run this job on the following schedule box, and specify a schedule for when the job should run.

10. If you want to receive a notification e-mail about the status of the content deployment job, do one or both of the following in the Notification section:

    • Select the Send e-mail when the content deployment job succeeds check box.

    • Select the Send e-mail if the content deployment job fails check box.

11. Type one or more e-mail addresses in the Type e-mail addresses box.

Use the following procedure to create a new content deployment job by using Windows PowerShell.

To create a new content deployment job by using Windows PowerShell

1. Verify that you meet the following minimum requirements:

   • See Add-SPShellAdmin.

2. On the Start menu, click Administrative Tools.

3. Click SharePoint 2010 Management Shell.

4. From the Windows PowerShell command prompt (that is, PS C:\>), type the following command and press ENTER:

   New-SPContentDeploymentJob -Name <Name of the new deployment job> -SPContentDeploymentPath <GUID, name or a valid SPContentDeploymentPath object of the path to be used by the job>

   For more information, including additional parameters you can use, see New-SPContentDeploymentJob. You can also use the New-SPContentDeploymentJob cmdlet in a script. For information, see Scripting with Windows PowerShell.

Manually start a content deployment job

You can manually start a content deployment job by using either Central Administration or Windows PowerShell. You can also set a content deployment job to run at regular intervals. For more information about creating and scheduling content deployment jobs, see Create a new content deployment job. For information about creating a content deployment path, see Create a new content deployment path.

Use the following procedure to manually start a content deployment job by using Central Administration.

To manually start a content deployment job by using Central Administration

1. Verify that you have the following administrative credentials:

   • You must be a member of the Farm Administrators group on the Central Administration server.

2. On the Central Administration Web site, in the General Application Settings section, click Configure content deployment paths and jobs.

3. On the Manage Content Deployment Paths and Jobs page, on the menu for the job that you want to start, click Run Now.

   The status of the job is reported in the Status column.

Use the following procedure to manually start a content deployment job by using Windows PowerShell.

To manually start a content deployment job by using Windows PowerShell

1. Verify that you meet the following minimum requirements:

   • See Add-SPShellAdmin.

2. On the Start menu, click Administrative Tools.

3. Click SharePoint 2010 Management Shell.

4. From the Windows PowerShell command prompt (that is, PS C:\>), type the following command and press ENTER:

   Start-SPContentDeploymentJob –Identity <GUID, name or a valid SPContentDeploymentJob object of the job to be started>

   For more information, including additional parameters you can use, see Start-SPContentDeploymentJob. You can also use the Start-SPContentDeploymentJob cmdlet in a script. For more information, see Scripting with Windows PowerShell.

   We recommend that you use Windows PowerShell when performing command-line administrative tasks. The Stsadm command-line tool has been deprecated, but is included to support compatibility with previous product versions.

   For more information, see Runcontentdeploymentjob: Stsadm operation (Office SharePoint Server).

Edit a content deployment path

You can edit a content deployment path by using either Central Administration or Windows PowerShell. Use the following procedure to edit a content deployment path by using Central Administration.

To edit a content deployment path by using Central Administration

1. Verify that you have the following administrative credentials:

   • You must be a member of the Farm Administrators group on the Central Administration server.

2. On the Central Administration Web site, in the General Application Settings section, click Configure content deployment paths and jobs.

3. On the Manage Content Deployment Paths and Jobs page, on the menu for the path that you want to edit, click Edit.

   For more information about the settings that you can edit, see Create a new content deployment path.

Use the following procedure to edit a content deployment path by using Windows PowerShell.

To edit a content deployment path by using Windows PowerShell

1. Verify that you meet the following minimum requirements:

   • See Add-SPShellAdmin.

2. On the Start menu, click Administrative Tools.

3. Click SharePoint 2010 Management Shell.

4. From the Windows PowerShell command prompt (that is, PS C:\>), type the following command and press ENTER:

   Set-SPContentDeploymentPath –Identity <GUID, name or a valid SPContentDeploymentPath object of the path to be changed>

   For more information, including additional parameters you can use, see Set-SPContentDeploymentPath. You can also use the Set-SPContentDeploymentPath cmdlet in a script. For more information, see Scripting with Windows PowerShell.

   We recommend that you use Windows PowerShell when performing command-line administrative tasks. The Stsadm command-line tool has been deprecated, but is included to support compatibility with previous product versions.

   For more information, see Editcontentdeploymentpath: Stsadm operation (Office SharePoint Server).

Disable or delete a content deployment path

You can disable or delete a content deployment path by using Central Administration, and you can delete a content deployment path by using Windows PowerShell.

Use the following procedure to disable or delete a content deployment path by using Central Administration.

To disable or delete a content deployment path by using Central Administration

1. Verify that you have the following administrative credentials:

   • You must be a member of the Farm Administrators group on the Central Administration server.

2. On the Central Administration Web site, in the General Application Settings section, click Configure content deployment paths and jobs.

3. On the Manage Content Deployment Paths and Jobs page, click the menu for the path that you want to disable or delete, and then do one of the following:

   • To delete the path, click Delete, and then click OK in the message box that asks whether you want to proceed with the deletion.

   • To disable the path, click Disable.

Use the following procedure to delete a content deployment path by using Windows PowerShell.

To delete a content deployment path by using Windows PowerShell

1. Verify that you meet the following minimum requirements:

   • See Add-SPShellAdmin.

2. On the Start menu, click Administrative Tools.

3. Click SharePoint 2010 Management Shell.

4. From the Windows PowerShell command prompt (that is, PS C:\>), type the following command and press ENTER:

   Remove-SPContentDeploymentPath –Identity <GUID, name or a valid SPContentDeploymentPath object of the path to be deleted>

   For more information, including additional parameters you can use, see Remove-SPContentDeploymentPath. You can also use the Remove-SPContentDeploymentPath cmdlet in a script. For more information, see Scripting with Windows PowerShell.

   We recommend that you use Windows PowerShell when performing command-line administrative tasks. The Stsadm command-line tool has been deprecated, but is included to support compatibility with previous product versions.

Edit a content deployment job

You can edit a content deployment job by using either Central Administration or Windows PowerShell. For information about creating a content deployment job, see Create a new content deployment job.

Use the following procedure to edit a content deployment job by using Central Administration.

To edit a content deployment job by using Central Administration

1. Verify that you have the following administrative credentials:

   • You must be a member of the Farm Administrators group on the Central Administration server.

2. On the Central Administration Web site, in the General Application Settings section, click Configure content deployment paths and jobs.

3. On the Manage Content Deployment Paths and Jobs page, on the menu for the job that you want to edit, click Edit.

   For more information about the settings that you can edit, see Create a new content deployment job.

Use the following procedure to edit a content deployment job by using Windows PowerShell.

To edit a content deployment job by using Windows PowerShell

1. Verify that you meet the following minimum requirements:

   • See Add-SPShellAdmin.

2. On the Start menu, click Administrative Tools.

3. Click SharePoint 2010 Management Shell.

4. From the Windows PowerShell command prompt (that is, PS C:\>), type the following command and press ENTER:

   Set-SPContentDeploymentJob –Identity <GUID, name or a valid SPContentDeploymentJob object of the job to be changed>

   For more information, including additional parameters you can use, see Set-SPContentDeploymentJob. You can also use the Set-SPContentDeploymentJob cmdlet in a script. For more information, see Scripting with Windows PowerShell.

   We recommend that you use Windows PowerShell when performing command-line administrative tasks. The Stsadm command-line tool has been deprecated, but is included to support compatibility with previous product versions.

   For more information, see Setcontentdeploymentjobschedule: Stsadm operation (Office SharePoint Server).

Test a content deployment job

Use the following procedure to test a content deployment job. Testing a content deployment job is useful for testing export settings.

To test a content deployment job

1. Verify that you have the following administrative credentials:

   • You must be a member of the Farm Administrators group on the Central Administration server.

2. On the Central Administration Web site, in the General Application Settings section, click Configure content deployment paths and jobs.

3. On the Manage Content Deployment Paths and Jobs page, on the menu for the content deployment job that you want to test, click Test Job.

   The status of the job is reported in the Status column.

Cancel a content deployment job

Use the following procedure to cancel a content deployment job by using Central Administration. You cannot perform this task by using Windows PowerShell cmdlets. You must use the SharePoint Central Administration Web site instead.

To cancel a content deployment job

1. Verify that you have the following administrative credentials:

   • You must be a member of the Farm Administrators group on the Central Administration server.

2. On the Central Administration Web site, in the General Application Settings section, click Configure content deployment paths and jobs.

3. On the Manage Content Deployment Paths and Jobs page, on the menu for the job that you want to cancel, click Cancel.

   The status of the job is reported in the Status column.

Delete a content deployment job

You can delete a content deployment job by using either Central Administration or Windows PowerShell. Use the following procedure to delete a content deployment job by using Central Administration.

To delete a content deployment job by using Central Administration

1. Verify that you have the following administrative credentials:

   • You must be a member of the Farm Administrators group on the Central Administration server.

2. On the Central Administration Web site, in the General Application Settings section, click Configure content deployment paths and jobs.

3. On the Manage Content Deployment Paths and Jobs page, on the menu for the job that you want to delete, click Delete.

4. Click OK in the message box that asks whether you want to proceed with the deletion.

Use the following procedure to delete a content deployment job by using Windows PowerShell.

To delete a content deployment job by using Windows PowerShell

1. Verify that you meet the following minimum requirements:

   • See Add-SPShellAdmin.

2. On the Start menu, click Administrative Tools.

3. Click SharePoint 2010 Management Shell.

4. From the Windows PowerShell command prompt (that is, PS C:\>), type the following command and press ENTER:

   Remove-SPContentDeploymentJob -Identity <GUID, name or a valid SPContentDeploymentJob object of the job to be deleted>

   For more information, including additional parameters you can use, see Remove-SPContentDeploymentJob. You can also use the Remove-SPContentDeploymentJob cmdlet in a script. For more information, see Scripting with Windows PowerShell.

See Also

Concepts

Configure content deployment settings
Manage Quick Deploy jobs
View content deployment job reports and history
Content deployment overview (SharePoint Server 2010)